CAknToolbar Class Reference

Enumerator:

ELongPress
ELongPressEnded

Destructor.

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()).

Parameters:

	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.

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()).

Parameters:

	aItem	The control.
	aType	The type of the new toolbar item.
	aCommandId	The command ID for this item.
	aFlags	The flags.

From CCoeControl.

Gets the specified component of a compound control.

Parameters:

aIndex

The index of the control to get

Returns:

The component control with an index of aIndex.

Gets a pointer to the specified control.

Parameters:

aControlId

The ID of the control for which a pointer is required.

Returns:

Pointer to the control with the specified ID.

From CCoeControl.

Gets the number of controls contained in a compound control.

Returns:

The number of component controls contained by this control.

CountFadedComponents() returns number of items in the array.

Reimplemented from MAknFadedComponent.

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.

Parameters:

aDisable

ETrue if toolbar should be disabled

Since:

S60 3.2

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.

Parameters:

	aGc	Graphics context used for drawing.
	aControl	The control being drawn (may be a child of the drawer).
	aRect	The area to be redrawn.

Calls DynInitToolbar with extensions commmand id.

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.

Returns:

event modifiers

Since:

S60 3.2

Extension notifies of its events using this method aCommandId command id of the button.

From CAknControl.

For future extensions.

Parameters:

aInterface

The ID for the extension interface.

Reimplemented from CAknControl.

FadedComponent() returns specific controls from the array based on index.

Reimplemented from MAknFadedComponent.

From CCoeControl.

This function is called whenever a control gains or loses focus.

Parameters:

aDrawNow

Contains the value that was passed to it by SetFocus().

Returns command id of focused item.

Returns:

command id of focused item. Returns KErrNotFound if no item is focused.

Since:

S60 3.2

From MCoeControlObserver.

Handles an event from an observed toolbar item.

Parameters:

	aControl	The control which sent the event
	aEventType	The event type

From CCoeControl.

Handles pointer events.

Parameters:

aPointerEvent

The pointer event.

From CCoeControl.

Handles a change to the control's resources.

Parameters:

aType

A message UID value.

Hides or unhides a toolbar item.

Parameters:

	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.

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!

Parameters:

	aHide	ETrue if hiding items, EFalse if unhiding.
	aPriority	Ordinal priority of toolbar window.

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!

Parameters:

aHide

ETrue if hiding items, EFalse if unhiding.

From CCoeControl.

Gets the control's input capabilities.

Returns:

The control's input capabilities.

Returns toolbar visibility at this moment.

Returns:

ETrue, if toolbar is shown.

Returns ETrue if the type of the item can be included in the toolbar.

Returns:

ETrue for the supported type, otherwise EFalse.

Checks if toolbar is disabled.

Returns:

ETrue if toolbar is disabled, EFalse if not

Since:

S60 3.2

From CCoeControl.

Retrieves an object of the same type as that encapsulated in aId.

Parameters:

aId

An encapsulated object type ID.

Returns:

Encapsulated pointer to the object provided. Note that the encapsulated pointer may be NULL.

Two-phased constructor.

Parameters:

aResourceId

The ID for this component's resource

Returns:

Pointer to the created toolbar object

Two-phased constructor.

Parameters:

aResourceId

The ID for this component's resource

Returns:

Pointer to the created toolbar object

From CCoeControl.

Handles key events.

Parameters:

	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.

From CCoeControl.

Responds to changes in the position of a toolbar.

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.

Since:

S60 3.2

From MEikCommandObserver.

Processes user commands.

Parameters:

TInt

aCommandId ID of the command to respond to.

Callback for sliding toolbar.

Removes one item from the toolbar.

Parameters:

aCommandId

The ID of the item which should be removed.

Sets whether the toolbar should be closed after a command is issued from the toolbar.

This method affects every command on the toolbar.

Parameters:

aClose

ETrue, if toolbar should be closed.

Sets whether the toolbar should be closed or remain open after the specified command is issued from the toolbar.

Parameters:

	aCommandId	The command.
	aClose	ETrue, if toolbar should be close.

From CCoeControl.

Sets toolbar dimmed. Doesn't redraw.

Parameters:

aDimmed

is ETrue to dim the toolbar, EFalse to set the toolbar as not dimmed

Called by the framework to handle the emphasising or de-emphasising of a toolbar window when it is needed.

Parameters:

aEmphasis

ETrue to emphasize the menu, EFalse otherwise.

Moves highlight from one item to another.

Leaves with value KErrNotFound if item not found.

Parameters:

aCommandId

command id of the item to be focused.

Since:

S60 3.2

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.

Parameters:

aCommandId

The command ID for the item to get focus.

Dims (greys out) or undims a toolbar item.

Parameters:

	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.

Sets toolbar orientation.

Parameters:

aOrientation

Orientation that should be used for toolbar.

Since:

3.2

Sets the resource id for toolbar softkeys.

If cba allready exists then changes the existing softkeys and redraws toolbar cba.

Parameters:

aSoftkeyResourceId

ID of the resource structure specifying the command buttons.

Since:

S60 3.2

Sets the observer for the toolbar.

Parameters:

aObserver

A pointer to the observer. Ownership is not changed.

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.

Parameters:

	aVisible	ETrue to show it, EFalse to hide it.
	aFocusing	ETrue to set toolbar focusing, otherwise EFalse.

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.

Parameters:

aVisible

ETrue to show it, EFalse to hide it.

Specifies whether toolbar should be shown with sliding effect or not.

By default toolbar is shown with sliding.

Parameters:

aSlide

ETrue for sliding effect, EFalse without sliding.

Shows toolbar again after it has been hidden for background changing purposes.

Since:

3.2

From CCoeControl.

Responds to size changes to sets the size and position of the contents of this control.

Slide toolbar.

Returns pointer to toolbar extension if available.

Returns:

toolbar extension or NULL

Returns the flags of toolbar.

Flags are defined in eikon.hrh.

Returns:

toolbar flags

Since:

S60 3.2

Returns a pointer to the toolbar observer.

Returns:

Pointer to the toolbar observer.

Returns the index of the toolbar item inside of the iVisibleItems array.

Parameters:

aControl

The control which index is needed.

Returns:

Index of the toolbar item.

Updates transparent toolbar's background.

Since:

3.2