CAknToolbar Class Reference
#include
<mw/akntoolbar.h>
Link against: eikcoctl.lib
| class CAknToolbar : public CAknControl |
| Public Member Functions |
|---|
| ~CAknToolbar() |
| IMPORT_C void | AddItemL(CCoeControl *, const TInt, const TInt, const TInt) |
| IMPORT_C void | AddItemL(CCoeControl *, const TInt, const TInt, const TInt, const TInt) |
| virtual IMPORT_C CCoeControl * | ComponentControl(TInt) |
| IMPORT_C CCoeControl * | ControlOrNull(const TInt) |
| virtual IMPORT_C TInt | CountComponentControls() |
|
TInt
| CountFadedComponents() |
| IMPORT_C void | DisableToolbarL(TBool) |
| IMPORT_C void | Draw(CWindowGc &, const CCoeControl &, const TRect &) |
| void | DynInitExtensionL(CCoeControl *) |
| IMPORT_C TInt | EventModifiers() |
| void | ExtensionEventL(TInt) |
|
CCoeControl * | FadedComponent(TInt) |
| IMPORT_C TInt | FocusedItem() |
| IMPORT_C void | HandleControlEventL(CCoeControl *, TCoeEvent) |
| virtual IMPORT_C void | HandlePointerEventL(const TPointerEvent &) |
| virtual IMPORT_C void | HandleResourceChange(TInt) |
| IMPORT_C void | HideItem(const TInt, const TBool, const TBool) |
| IMPORT_C void | HideItemsAndDrawOnlyBackground(TBool) |
| IMPORT_C void | HideItemsAndDrawOnlyBackground(TBool, TInt) |
| virtual IMPORT_C TCoeInputCapabilities | InputCapabilities() |
| IMPORT_C TBool | IsShown() |
| IMPORT_C TBool | IsSupportedItemType(const TInt) |
| IMPORT_C TBool | IsToolbarDisabled() |
| IMPORT_C CAknToolbar * | NewL(const TInt) |
| IMPORT_C CAknToolbar * | NewLC(const TInt) |
| virtual IMPORT_C TKeyResponse | OfferKeyEventL(const TKeyEvent &, TEventCode) |
| virtual IMPORT_C void | PositionChanged() |
| virtual void | PrepareForFocusLossL() |
| IMPORT_C void | ProcessCommandL(TInt) |
|
TInt
| ReadyToSlide(TAny *) |
| void | ReduceRect(TRect &) |
| IMPORT_C void | RemoveItem(const TInt) |
| IMPORT_C void | SetCloseOnAllCommands(const TBool) |
| IMPORT_C void | SetCloseOnCommand(const TInt, const TBool) |
| virtual IMPORT_C void | SetDimmed(TBool) |
| IMPORT_C void | SetEmphasis(const TBool) |
| IMPORT_C void | SetFocusedItemL(const TInt) |
| IMPORT_C void | SetInitialFocusedItem(const TInt) |
| IMPORT_C void | SetItemDimmed(const TInt, const TBool, const TBool) |
| IMPORT_C void | SetOrientation(const TAknOrientation) |
| IMPORT_C void | SetSkinBackgroundId(const TAknsItemID &) |
| IMPORT_C void | SetSoftkeyResourceIdL(TInt) |
| IMPORT_C void | SetToolbarObserver(MAknToolbarObserver *) |
| IMPORT_C void | SetToolbarVisibility(const TBool) |
| IMPORT_C void | SetToolbarVisibility(const TBool, const TBool) |
| IMPORT_C void | SetWithSliding(const TBool) |
| void | ShowToolbarForBackgroundUpdate() |
| void | SlideWithIdle() |
| IMPORT_C CAknToolbarExtension * | ToolbarExtension() |
| IMPORT_C TInt | ToolbarFlags() |
| IMPORT_C MAknToolbarObserver * | ToolbarObserver() |
|
TInt
| ToolbarVisibleIndexByControl(const CCoeControl *) |
| IMPORT_C void | UpdateBackground() |
| Inherited Functions |
|---|
| | CAknControl::CAknControl() |
| | CAknControl::~CAknControl() |
| | CBase::CBase() |
| | CBase::Delete(CBase *) |
| | CBase::Extension_(TUint,TAny *&,TAny *) |
| | CBase::operator new(TUint) |
| | CBase::operator new(TUint,TAny *) |
| | CBase::operator new(TUint,TLeave) |
| | CBase::operator new(TUint,TLeave,TUint) |
| | CBase::operator new(TUint,TUint) |
| | CBase::~CBase() |
| | CCoeControl::AccumulatedZoom()const |
| | CCoeControl::ActivateGc()const |
| | CCoeControl::ActivateL() |
| | CCoeControl::BackedUpWindow()const |
| | CCoeControl::Background()const |
| | CCoeControl::CCoeControl() |
| | CCoeControl::CCoeControl(CCoeEnv *) |
| | CCoeControl::CCoeControl(const CCoeControl &) |
| | CCoeControl::CCoeControlArray |
| | CCoeControl::CapturesPointer()const |
| | CCoeControl::ClaimPointerGrab(TBool) |
| | CCoeControl::ClaimPointerGrab(TInt,TBool) |
| | CCoeControl::CloseWindow() |
| | CCoeControl::ComponentArrayExists()const |
| | CCoeControl::Components() |
| | CCoeControl::Components()const |
| | CCoeControl::ControlContext()const |
| | CCoeControl::ControlEnv()const |
| | CCoeControl::CopyControlContextFrom(const CCoeControl *) |
| | CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &) |
| | CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &,TDisplayMode) |
| | CCoeControl::CreateWindowL() |
| | CCoeControl::CreateWindowL(RWindowGroup *) |
| | CCoeControl::CreateWindowL(RWindowTreeNode &) |
| | CCoeControl::CreateWindowL(const CCoeControl *) |
| | CCoeControl::CustomGc()const |
| | CCoeControl::DeactivateGc()const |
| | CCoeControl::DrawBackground(const TRect &)const |
| | CCoeControl::DrawDeferred()const |
| | CCoeControl::DrawForeground(const TRect &)const |
| | CCoeControl::DrawNow()const |
| | CCoeControl::DrawNow(const TRect &)const |
| | CCoeControl::DrawableWindow()const |
| | CCoeControl::EnableDragEvents() |
| | CCoeControl::EnableReportControlStateChange(TBool) |
| | CCoeControl::EnableWindowTransparency() |
| | CCoeControl::FindBackground()const |
| | CCoeControl::FindFontProvider()const |
| | CCoeControl::GetColor(TInt,TRgb &)const |
| | CCoeControl::GetColorUseListL(CArrayFix< TCoeColorUse > &)const |
| | CCoeControl::GetGc()const |
| | CCoeControl::GetHelpContext(TCoeHelpContext &)const |
| | CCoeControl::GrabbingComponent()const |
| | CCoeControl::GrabbingComponent(TInt)const |
| | CCoeControl::HandleComponentControlsResourceChange(TInt) |
| | CCoeControl::HandleControlArrayEventL(CCoeControlArray::TEvent,const CCoeControlArray *,CCoeControl *,TInt) |
| | CCoeControl::HandlePointerBufferReadyL() |
| | CCoeControl::HandleRedrawEvent(const TRect &)const |
| | CCoeControl::HasBorder()const |
| | CCoeControl::HitTest()const |
| | CCoeControl::IgnoreEventsUntilNextPointerUp() |
| | CCoeControl::Index(const CCoeControl *)const |
| | CCoeControl::InitComponentArrayL() |
| | CCoeControl::IsActivated()const |
| | CCoeControl::IsBackedUp()const |
| | CCoeControl::IsBeingDestroyed()const |
| | CCoeControl::IsBlank()const |
| | CCoeControl::IsDimmed()const |
| | CCoeControl::IsFocused()const |
| | CCoeControl::IsNonFocusing()const |
| | CCoeControl::IsReadyToDraw()const |
| | CCoeControl::IsVisible()const |
| | CCoeControl::LayoutManager()const |
| | CCoeControl::MakeVisible(TBool) |
| | CCoeControl::MaximumWidth()const |
| | CCoeControl::MinimumSize() |
| | CCoeControl::NotifyFontChange(const CCoeFontProvider *) |
| | CCoeControl::Observer()const |
| | CCoeControl::OverrideColorL(TInt,TRgb) |
| | CCoeControl::OwnsWindow()const |
| | CCoeControl::Parent() |
| | CCoeControl::Parent()const |
| | CCoeControl::Position()const |
| | CCoeControl::PositionRelativeToScreen()const |
| | CCoeControl::PrepareForFocusGainL() |
| | CCoeControl::ProcessPointerBufferReadyL() |
| | CCoeControl::ProcessPointerEventL(const TPointerEvent &) |
| | CCoeControl::Rect()const |
| | CCoeControl::RecursivelyMergeInputCapabilities(TCoeInputCapabilities &)const |
| | CCoeControl::RecursivelyMergedInputCapabilities()const |
| | CCoeControl::RefetchPixelMappingL() |
| | CCoeControl::RemoveFromParent() |
| | CCoeControl::ReportEventL(MCoeControlObserver::TCoeEvent) |
| | CCoeControl::RequestRelayout(const CCoeControl *) |
| | CCoeControl::ResetGc()const |
| | CCoeControl::ScreenFont(const TCoeFont &)const |
| | CCoeControl::SetAdjacent(TInt) |
| | CCoeControl::SetAllowStrayPointers() |
| | CCoeControl::SetBackground(const MCoeControlBackground *) |
| | CCoeControl::SetBlank() |
| | CCoeControl::SetCanDrawOutsideRect() |
| | CCoeControl::SetComponentsToInheritVisibility(TBool) |
| | CCoeControl::SetContainerWindowL(RBackedUpWindow &) |
| | CCoeControl::SetContainerWindowL(RWindow &) |
| | CCoeControl::SetContainerWindowL(const CCoeControl &) |
| | CCoeControl::SetControlContext(MCoeControlContext *) |
| | CCoeControl::SetCornerAndSize(TGulAlignment,const TSize &) |
| | CCoeControl::SetCustomGc(CWindowGc *) |
| | CCoeControl::SetExtent(const TPoint &,const TSize &) |
| | CCoeControl::SetExtentToWholeScreen() |
| | CCoeControl::SetFocus(TBool,TDrawNow) |
| | CCoeControl::SetFocusing(TBool) |
| | CCoeControl::SetFontProviderL(const CCoeFontProvider &) |
| | CCoeControl::SetGc(CWindowGc *)const |
| | CCoeControl::SetGloballyCapturing(TBool) |
| | CCoeControl::SetHitTest(const MCoeControlHitTest *) |
| | CCoeControl::SetLayoutManagerL(MCoeLayoutManager *) |
| | CCoeControl::SetMaximumWidth(TInt) |
| | CCoeControl::SetMopParent(MObjectProvider *) |
| | CCoeControl::SetNeighbor(CCoeControl *) |
| | CCoeControl::SetNonFocusing() |
| | CCoeControl::SetObserver(MCoeControlObserver *) |
| | CCoeControl::SetParent(CCoeControl *) |
| | CCoeControl::SetPointerCapture(TBool) |
| | CCoeControl::SetPosition(const TPoint &) |
| | CCoeControl::SetRect(const TRect &) |
| | CCoeControl::SetSize(const TSize &) |
| | CCoeControl::SetSizeWithoutNotification(const TSize &) |
| | CCoeControl::SetTextBaselineSpacing(TInt) |
| | CCoeControl::SetUniqueHandle(TInt) |
| | CCoeControl::SetZoomFactorL(TInt,TZoomType) |
| | CCoeControl::Size()const |
| | CCoeControl::SystemGc()const |
| | CCoeControl::TextBaselineOffset(const TSize &)const |
| | CCoeControl::TextDrawer(TInt)const |
| | CCoeControl::UniqueHandle()const |
| | CCoeControl::Window()const |
| | CCoeControl::WriteInternalStateL(RWriteStream &)const |
| | CCoeControl::WriteInternalStateNowL(RWriteStream &)const |
| | CCoeControl::ZoomWithType()const |
| | CCoeControl::operator=(const CCoeControl &) |
| | CCoeControl::~CCoeControl() |
Detailed Description
The class to provide toolbar for the application
Member Enumeration Documentation
Enum TEventModifiers
| Enumerator | Value | Description |
|---|
| ELongPress | 1 | |
| ELongPressEnded | 2 | |
Constructor & Destructor Documentation
Member Function Documentation
AddItemL ( CCoeControl *, const TInt, const TInt, const TInt )
Adds one item to the end of the toolbar. Takes ownership. Leaves with value KErrNotSupported, if the control type is not supported by toolbar (see CAknToolbar::IsSupportedItemType()).
| Parameter | Description | | aItem | The control. |
| aType | The type of the new toolbar item. |
| aCommandId | The command ID for this item. |
| aFlags | The flags. |
AddItemL ( CCoeControl *, const TInt, const TInt, const TInt, const TInt )
Adds one item to the specified place. Takes ownership. Leaves with value KErrNotSupported, if the control type is not supported by toolbar (see CAknToolbar::IsSupportedItemType()).
| Parameter | Description | | aItem | The control. |
| aType | The type of the new toolbar item. |
| aCommandId | The command ID for this item. |
| aFlags | The flags. |
| aIndex | The index in array at which item should be added. |
ComponentControl ( TInt )
From CCoeControl. Gets the specified component of a compound control.
| Parameter | Description | | aIndex | The index of the control to get |
Returns: The component control with an index of aIndex.
ControlOrNull ( const TInt )
Gets a pointer to the specified control.
| Parameter | Description | | aControlId | The ID of the control for which a pointer is required. |
Returns: Pointer to the control with the specified ID.
CountComponentControls ( )
| IMPORT_C TInt | CountComponentControls | ( | ) | const [virtual] |
From CCoeControl. Gets the number of controls contained in a compound control.
Returns: The number of component controls contained by this control.
CountFadedComponents ( )
|
TInt
| CountFadedComponents | ( | ) | |
DisableToolbarL ( TBool )
| IMPORT_C void | DisableToolbarL | ( | TBool | aDisable | ) | |
Disables/Enables toolbar so that it cannot/can be activated from e.g. touch pane. Needed especially if a dialog is on the screen and toolbar is not wished to be shown. Leaves with value KErrToolbarShown if called when toolbar is shown.
| Parameter | Description | | aDisable | ETrue if toolbar should be disabled |
Draw ( CWindowGc &, const CCoeControl &, const TRect & )
From MCoeControlBackground. Draw the background for a given control. The text drawer that shall be used to draw text on the specific background can be fetched through the GetTextDrawer() method.
| Parameter | Description | | aGc | Graphics context used for drawing. |
| aControl | The control being drawn (may be a child of the drawer). |
| aRect | The area to be redrawn. |
DynInitExtensionL ( CCoeControl * )
Calls DynInitToolbar with extensions commmand id
EventModifiers ( )
| IMPORT_C TInt | EventModifiers | ( | ) | const |
Returns event modifiers defined in TEventModifiers in this header. This can be used by applications in OfferToolbarEventL to know if the event sent was for example a long press event. Information is valid only during OfferToolbarEventL.
ExtensionEventL ( TInt )
| void | ExtensionEventL | ( | TInt | aCommandId | ) | |
Extension notifies of its events using this method aCommandId command id of the button
ExtensionInterface ( TUid )
| IMPORT_C void * | ExtensionInterface | ( | TUid | aInterface | ) | [protected, virtual] |
| Parameter | Description | | aInterface | The ID for the extension interface. |
FocusChanged ( TDrawNow )
| IMPORT_C void | FocusChanged | ( | TDrawNow | aDrawNow | ) | [protected, virtual] |
From CCoeControl. This function is called whenever a control gains or loses focus.
| Parameter | Description | | aDrawNow | Contains the value that was passed to it by SetFocus(). |
FocusedItem ( )
| IMPORT_C TInt | FocusedItem | ( | ) | const |
Returns command id of focused item.
Returns: command id of focused item. Returns KErrNotFound if no item is focused.
HandleControlEventL ( CCoeControl *, TCoeEvent )
| IMPORT_C void | HandleControlEventL | ( | CCoeControl * | aControl, |
| | TCoeEvent | aEventType |
| | ) | |
| Parameter | Description | | aControl | The control which sent the event |
| aEventType | The event type |
HandlePointerEventL ( const TPointerEvent & )
| IMPORT_C void | HandlePointerEventL | ( | const TPointerEvent & | aPointerEvent | ) | [virtual] |
| Parameter | Description | | aPointerEvent | The pointer event. |
HandleResourceChange ( TInt )
| IMPORT_C void | HandleResourceChange | ( | TInt | aType | ) | [virtual] |
From CCoeControl. Handles a change to the control's resources.
| Parameter | Description | | aType | A message UID value. |
HideItem ( const TInt, const TBool, const TBool )
| IMPORT_C void | HideItem | ( | const TInt | aCommandId, |
| | const TBool | aHide, |
| | const TBool | aDrawNow |
| | ) | |
Hides or unhides a toolbar item.
| Parameter | Description | | aCommandId | The command (as defined in an .hrh file) associated with this toolbar item. This identifies the toolbar item, which will be set to hidden or unhidden. |
| aHide | Use ETrue to hide this toolbar item or EFalse to unhide this toolbar item. |
| aDrawNow | Should be ETrue for the toolbar to be redrawn. |
HideItemsAndDrawOnlyBackground ( TBool )
| IMPORT_C void | HideItemsAndDrawOnlyBackground | ( | TBool | aHide | ) | |
Hides/Unhides toolbar items temporarily. When called with ETrue toolbar draws just background in landscape and is hidden in portrait. Calling with EFalse returns the situation to normal, so drawing the items normally in portrait and landscape. Use this method only with fixed toolbar!
| Parameter | Description | | aHide | ETrue if hiding items, EFalse if unhiding. |
HideItemsAndDrawOnlyBackground ( TBool, TInt )
| IMPORT_C void | HideItemsAndDrawOnlyBackground | ( | TBool | aHide, |
| | TInt | aPriority |
| | ) | |
Hides/Unhides toolbar items temporarily. When called with ETrue toolbar draws just background in landscape and is hidden in portrait. Toolbar window priority is changed to priority passed in parameter. Priority should be one of the window priority values defined in TCoeWinPriority. Default priority is ECoeWinPriorityLow. Note that if toolbar is already hidden, the toolbar window priority is still changed to priority passed in parameter. Calling the function HideItemsAndDrawOnlyBackground with EFalse returns the situation to normal, so drawing the items normally in portrait and landscape. Use this method only with fixed toolbar!
| Parameter | Description | | aHide | ETrue if hiding items, EFalse if unhiding. |
| aPriority | Ordinal priority of toolbar window. |
InputCapabilities ( )
From CCoeControl. Gets the control's input capabilities.
Returns: The control's input capabilities.
IsShown ( )
| IMPORT_C TBool | IsShown | ( | ) | const |
Returns toolbar visibility at this moment
Returns: ETrue, if toolbar is shown.
IsSupportedItemType ( const TInt )
| IMPORT_C TBool | IsSupportedItemType | ( | const TInt | aType | ) | const |
Returns ETrue if the type of the item can be included in the toolbar.
Returns: ETrue for the supported type, otherwise EFalse.
IsToolbarDisabled ( )
| IMPORT_C TBool | IsToolbarDisabled | ( | ) | const |
Checks if toolbar is disabled.
Returns: ETrue if toolbar is disabled, EFalse if not
MopSupplyObject ( TTypeUid )
From CCoeControl. Retrieves an object of the same type as that encapsulated in aId.
| Parameter | Description | | aId | An encapsulated object type ID. |
Returns: Encapsulated pointer to the object provided. Note that the encapsulated pointer may be NULL.
NewL ( const TInt )
| Parameter | Description | | aResourceId | The ID for this component's resource |
Returns: Pointer to the created toolbar object
NewLC ( const TInt )
| Parameter | Description | | aResourceId | The ID for this component's resource |
Returns: Pointer to the created toolbar object
OfferKeyEventL ( const TKeyEvent &, TEventCode )
| Parameter | Description | | aKeyEvent | The key event |
| aType | The type of key event: EEventKey, EEventKeyUp or EEventKeyDown. |
Returns: TKeyResponse Indicates whether or not the key event was used by this control.
PositionChanged ( )
| IMPORT_C void | PositionChanged | ( | ) | [virtual] |
From CCoeControl. Responds to changes in the position of a toolbar.
PrepareForFocusLossL ( )
| void | PrepareForFocusLossL | ( | ) | [virtual] |
Takes focus away from edwin or other controls if needed. Called by AknAppUi from HandleWsEventL when a pointer event is targeted to other control than toolbar.
ProcessCommandL ( TInt )
| IMPORT_C void | ProcessCommandL | ( | TInt | aCommandId | ) | |
ReadyToSlide ( TAny * )
Callback for sliding toolbar.
ReduceRect ( TRect & )
| void | ReduceRect | ( | TRect & | aBoundingRect | ) | const |
RemoveItem ( const TInt )
| IMPORT_C void | RemoveItem | ( | const TInt | aCommandId | ) | |
Removes one item from the toolbar.
| Parameter | Description | | aCommandId | The ID of the item which should be removed. |
SetCloseOnAllCommands ( const TBool )
| IMPORT_C void | SetCloseOnAllCommands | ( | const TBool | aClose | ) | |
Sets whether the toolbar should be closed after a command is issued from the toolbar. This method affects every command on the toolbar.
| Parameter | Description | | aClose | ETrue, if toolbar should be closed. |
SetCloseOnCommand ( const TInt, const TBool )
| IMPORT_C void | SetCloseOnCommand | ( | const TInt | aCommandId, |
| | const TBool | aClose |
| | ) | |
Sets whether the toolbar should be closed or remain open after the specified command is issued from the toolbar.
| Parameter | Description | | aCommandId | The command. |
| aClose | ETrue, if toolbar should be close. |
SetDimmed ( TBool )
| IMPORT_C void | SetDimmed | ( | TBool | aDimmed | ) | [virtual] |
| Parameter | Description | | aDimmed | is ETrue to dim the toolbar, EFalse to set the toolbar as not dimmed |
SetEmphasis ( const TBool )
| IMPORT_C void | SetEmphasis | ( | const TBool | aEmphasis | ) | |
Called by the framework to handle the emphasising or de-emphasising of a toolbar window when it is needed.
| Parameter | Description | | aEmphasis | ETrue to emphasize the menu, EFalse otherwise. |
SetFocusedItemL ( const TInt )
| IMPORT_C void | SetFocusedItemL | ( | const TInt | aCommandId | ) | |
Moves highlight from one item to another. Leaves with value KErrNotFound if item not found.
| Parameter | Description | | aCommandId | command id of the item to be focused. |
SetInitialFocusedItem ( const TInt )
| IMPORT_C void | SetInitialFocusedItem | ( | const TInt | aCommandId | ) | |
Changes the command ID for the initially focused item when toolbar is shown or gain focus. Notice that, if this item is not visible, then focus will be according default behaviour. Normally, focus will be on the first item, if KAknToolbarMiddleItemFocused flag was not used.
| Parameter | Description | | aCommandId | The command ID for the item to get focus. |
SetItemDimmed ( const TInt, const TBool, const TBool )
| IMPORT_C void | SetItemDimmed | ( | const TInt | aCommandId, |
| | const TBool | aDimmed, |
| | const TBool | aDrawNow |
| | ) | |
Dims (greys out) or undims a toolbar item.
| Parameter | Description | | aCommandId | The command (as defined in an .hrh file) associated with this toolbar item. This identifies the toolbar item, whose text is to be dimmed or un-dimmed. |
| aDimmed | Use ETrue to dim this toolbar item or EFalse to un-dim this toolbar item. |
| aDrawNow | Should be ETrue for the item to be redrawn. |
SetOrientation ( const TAknOrientation )
Sets toolbar orientation.
| Parameter | Description | | aOrientation | Orientation that should be used for toolbar. |
SetSkinBackgroundId ( const TAknsItemID & )
| IMPORT_C void | SetSkinBackgroundId | ( | const TAknsItemID & | aIID | ) | |
Sets the skin background for fixed toolbar. The new background is used for all the subsequent drawing operations. This method does not itself cause a repaint.
SetSoftkeyResourceIdL ( TInt )
| IMPORT_C void | SetSoftkeyResourceIdL | ( | TInt | aSoftkeyResourceId | ) | |
Sets the resource id for toolbar softkeys. If cba allready exists then changes the existing softkeys and redraws toolbar cba.
- Since
- S60 3.2
| Parameter | Description | | aSoftkeyResourceId | ID of the resource structure specifying the command buttons. |
SetToolbarObserver ( MAknToolbarObserver * )
Sets the observer for the toolbar.
| Parameter | Description | | aObserver | A pointer to the observer. Ownership is not changed. |
SetToolbarVisibility ( const TBool )
| IMPORT_C void | SetToolbarVisibility | ( | const TBool | aVisible | ) | |
Shows or hides toolbar. Position of the top left corner should be set in advance. Toolbar set visible with this method is by default focusing. Does nothing if toolbar is disabled.
| Parameter | Description | | aVisible | ETrue to show it, EFalse to hide it. |
SetToolbarVisibility ( const TBool, const TBool )
| IMPORT_C void | SetToolbarVisibility | ( | const TBool | aVisible, |
| | const TBool | aFocusing |
| | ) | |
Shows or hides toolbar. Position of the top left corner should be set in advance. This overload of the method allows toolbar to be set non-focusing. Does nothing if toolbar is disabled.
| Parameter | Description | | aVisible | ETrue to show it, EFalse to hide it. |
| aFocusing | ETrue to set toolbar focusing, otherwise EFalse. |
SetWithSliding ( const TBool )
| IMPORT_C void | SetWithSliding | ( | const TBool | aSlide | ) | |
Specifies whether toolbar should be shown with sliding effect or not. By default toolbar is shown with sliding.
| Parameter | Description | | aSlide | ETrue for sliding effect, EFalse without sliding. |
ShowToolbarForBackgroundUpdate ( )
| void | ShowToolbarForBackgroundUpdate | ( | ) | |
Shows toolbar again after it has been hidden for background changing purposes
SizeChanged ( )
| IMPORT_C void | SizeChanged | ( | ) | [protected, virtual] |
From CCoeControl. Responds to size changes to sets the size and position of the contents of this control.
ToolbarExtension ( )
| IMPORT_C CAknToolbarExtension * | ToolbarExtension | ( | ) | const |
Returns pointer to toolbar extension if available
Returns: toolbar extension or NULL
ToolbarFlags ( )
| IMPORT_C TInt | ToolbarFlags | ( | ) | const |
Returns the flags of toolbar. Flags are defined in eikon.hrh.
- Since
- S60 3.2
ToolbarObserver ( )
Returns a pointer to the toolbar observer.
Returns: Pointer to the toolbar observer.
ToolbarVisibleIndexByControl ( const CCoeControl * )
Returns the index of the toolbar item inside of the iVisibleItems array.
| Parameter | Description | | aControl | The control which index is needed. |
Returns: Index of the toolbar item.
UpdateBackground ( )
| IMPORT_C void | UpdateBackground | ( | ) | |
Updates transparent toolbar's background.
- Since
- 3.2