class CEikToolBar : public CEikControlGroup |
A vertical group of controls displayed down the right-hand side of the screen in an application.
It contains buttons which are used to issue application commands, and other controls. A toolband may also be created using this class, by setting the EEikToolBarHorizontal flag and initialising from a TOOLBAND resource.
Public Member Functions | |
---|---|
CEikToolBar() | |
~CEikToolBar() | |
IMPORT_C void | AddControlL(CCoeControl *, TInt) |
IMPORT_C void | AddControlL(TEikGroupControl &) |
void | AddControlTypeL(TInt) |
IMPORT_C void | ConstructFromResourceL(TResourceReader &) |
IMPORT_C void | ConstructL(MEikCommandObserver *, TInt, const TRect &) |
TBool | ControlIsButton(TInt) |
IMPORT_C void | CoordinateButtons(TInt, TInt, TEikButtonCoordinator *) |
IMPORT_C TBool | DelayActivation() |
IMPORT_C void | GetColorUseListL(CArrayFix< TCoeColorUse > &) |
IMPORT_C void | HandlePointerEventL(const TPointerEvent &) |
IMPORT_C void | HandleResourceChange(TInt) |
IMPORT_C void | ReduceRect(TRect &) |
void | RemoveControlType(TInt) |
IMPORT_C void | SetBoundingRect(const TRect &) |
IMPORT_C void | SetButtonStateOn(TInt, TBool) |
IMPORT_C void | SetCommandObserver(MEikCommandObserver *) |
IMPORT_C void | SetDimmed(TBool) |
IMPORT_C void | StaticConstructL(MEikCommandObserver *, TInt) |
Protected Member Functions | |
---|---|
IMPORT_C void | WriteInternalStateL(RWriteStream &) |
Inherited Enumerations | |
---|---|
CCoeControl:TZoomType | |
CEikControlGroup:@146 | |
CEikControlGroup:TOrientation | |
CEikControlGroup:TStartCorner |
Private Attributes | |
---|---|
CCoeBrushAndPenContext * | iBrushAndPenContext |
MEikCommandObserver * | iCommandObserver |
CArrayFix< TInt > * | iControlTypes |
TInt | iToolBarFlags |
Inherited Attributes | |
---|---|
CCoeControl::iCoeEnv | |
CCoeControl::iContext | |
CCoeControl::iPosition | |
CCoeControl::iSize | |
CEikBorderedControl::iBorder | |
CEikControlGroup::iControlArray |
IMPORT_C | CEikToolBar | ( | ) |
Default C++ constructor. Creates a new toolbar object, but does not initialise any of its heap-stored members.
IMPORT_C | ~CEikToolBar | ( | ) |
Destructor. Deletes the toolbar's brush and pen context and control types.
void | AddCommandL | ( | TInt | aPosition, |
TInt | aCommandId, | |||
const TDesC * | aText, | |||
const CFbsBitmap * | aBitmap, | |||
const CFbsBitmap * | aMask | |||
) | [private] |
TInt aPosition | |
TInt aCommandId | |
const TDesC * aText | |
const CFbsBitmap * aBitmap | |
const CFbsBitmap * aMask |
void | AddCommandSetToStackL | ( | TInt | aResourceId | ) | [private] |
TInt aResourceId |
void | AddCommandToStackL | ( | TInt | aPosition, |
TInt | aCommandId, | |||
const TDesC * | aText, | |||
const CFbsBitmap * | aBitmap, | |||
const CFbsBitmap * | aMask | |||
) | [private] |
TInt aPosition | |
TInt aCommandId | |
const TDesC * aText | |
const CFbsBitmap * aBitmap | |
const CFbsBitmap * aMask |
IMPORT_C void | AddControlL | ( | CCoeControl * | aControl, |
TInt | aId | |||
) | [virtual] |
From CEikControlGroup. Adds a control to the control group.
From CEikControlGroup
CCoeControl * aControl | The control to add to the control group |
TInt aId | The control's ID. |
IMPORT_C void | AddControlL | ( | TEikGroupControl & | aGroupControl | ) | [virtual] |
Adds a control wrapped with its ID and length to the control group.
From CEikControlGroup
TEikGroupControl & aGroupControl | The wrapped control to add. |
void | AddControlTypeL | ( | TInt | aType | ) |
Adds a control type to the control type array.
TInt aType |
void | AnimateCommandByPosition | ( | TInt | aPosition | ) | [private] |
TInt aPosition |
CEikCommandButton * | ButtonByIndex | ( | TInt | aIndex | ) | const [private] |
TInt aIndex |
IMPORT_C void | ConstructFromResourceL | ( | TResourceReader & | aReader | ) | [virtual] |
From CCoeControl. Second-phase construction from a resource. This is called by StaticConstructL() with an appropriate reader.
From CCoeControl
TResourceReader & aReader | A resource reader pointing at a TOOLBAR or TOOLBAND resource defining the toolbar. |
IMPORT_C void | ConstructL | ( | MEikCommandObserver * | aCommandObserver, |
TInt | aResourceId, | |||
const TRect & | aBoundingRect | |||
) |
Completes construction of a default-constructed toolbar.
The command observer interface defines a method for creating custom controls on the toolbar from user-defined IDs specified in the resource aResourceId.
IDs for controls which cannot be constructed using EikControlFactory::CreateByTypeL() are passed to this object's command observer for construction.
Applications requiring custom controls in their toolbars should override their AppUI's CreateCustomCommandControlL() method, inherited from MEikCommandObserver.
MEikCommandObserver * aCommandObserver | Sets the command observer for this toolbar. The observer's ProcessCommandL() function is invoked when a toolbar command is invoked by the user. |
TInt aResourceId | The ID of a TOOLBAR or TOOLBAND resource structure. |
const TRect & aBoundingRect | Defines the rectangle to which the toolbar's extent must be limited. This is typically given by CEikAppUi::ClientRect(), which returns the extent of the whole application window, less the extent of any toolbars that already exist and are owned by the AppUI. |
TBool | ControlIsButton | ( | TInt | aIndex | ) | const |
Used to check if a control is a button type control or not.
TInt aIndex |
IMPORT_C void | CoordinateButtons | ( | TInt | aId, |
TInt | aCount, | |||
TEikButtonCoordinator * | aCoordinator | |||
) |
Sets the button co-ordinator for a group of buttons in a toolbar.
TInt aId | Command identifying a toolbar button. |
TInt aCount | The number of buttons in the group. |
TEikButtonCoordinator * aCoordinator | The button coordinator. |
IMPORT_C TBool | DelayActivation | ( | ) | const |
Delays activation of the toolbar when constructed.
This function sets the toolbar flag EEikToolBarDelayActivation. If this flag is set when ConstructL() is called on the toolbar, the toolbar will be constructed but not activated.
The application can subsequently activate the toolbar by calling CCoeControl::ActivateL().
IMPORT_C void * | ExtensionInterface | ( | TUid | aInterface | ) | [private, virtual] |
From CAknControl
TUid aInterface |
IMPORT_C void | GetColorUseListL | ( | CArrayFix< TCoeColorUse > & | aColorUseList | ) | const [virtual] |
Gets the list of logical colours used to draw the control. Appends the list to aColorUseList paired with an explanation of how the colours are used.
From CCoeControl
Gets the list of logical colors employed in the drawing of the control, paired with an explanation of how they are used. Appends the list to aColorUseList.
CArrayFix< TCoeColorUse > & aColorUseList | The list of logical colours. |
CEikCommandButton * | GroupControlAsButton | ( | TInt | aCommandId | ) | const [private] |
TInt aCommandId |
CCoeControl * | GroupControlById | ( | TInt | aCommandId | ) | const [private] |
TInt aCommandId |
TEikGroupControl & | GroupControlByIndex | ( | TInt | aIndex | ) | const [private] |
TInt aIndex |
IMPORT_C void | HandleControlEventL | ( | CCoeControl * | aControl, |
TCoeEvent | aEvent | |||
) | [private] |
From MCoeControlObserver
CCoeControl * aControl | |
TCoeEvent aEvent |
IMPORT_C void | HandlePointerEventL | ( | const TPointerEvent & | aPointerEvent | ) | [virtual] |
Handles pointer events.
This function gets called whenever a pointer event occurs in the control, i.e. when the pointer is within the control's extent, or when the control has grabbed the pointer.
If overriding this method, the implementation must include a base call to this method.
From CCoeControl.
const TPointerEvent & aPointerEvent | The pointer event. |
IMPORT_C void | HandleResourceChange | ( | TInt | aType | ) | [virtual] |
Handles a change to the control's resources.
The types of resources handled are those which are shared across the environment, e.g. colours or fonts. For colour scheme changes, DrawDeferred() is called in order to redraw the control.
If overriding this method, the implementation must include a base call to this method.
From CCoeControl.
Handles a change to the control's resources of type aType which are shared across the environment, e.g. colors or fonts.
TInt aType | The type of resource that has changed. |
TBool | IsCommandDimmed | ( | TInt | aCommandId | ) | const [private] |
TInt aCommandId |
TBool | IsCommandDimmedByPosition | ( | TInt | aPosition | ) | const [private] |
TInt aPosition |
TBool | IsCommandVisible | ( | TInt | aCommandId | ) | const [private] |
TInt aCommandId |
TBool | IsCommandVisibleByPosition | ( | TInt | aPosition | ) | const [private] |
TInt aPosition |
void | MakeCommandVisibleByPosition | ( | TInt | aPosition, |
TBool | aVisible | |||
) | [private] |
IMPORT_C void | ReduceRect | ( | TRect & | aBoundingRect | ) | const |
Shrinks a rectangle to exclude the toolbar area. This function reduces the size of the rectangle passed into the function so that on return, the area occupied by the toolbar or toolband is removed from the rectangle. It is provided to prevent drawing over an existing toolbar or toolband.
From MEikButtonGroup
TRect & aBoundingRect | Specifies a rectangle which, on return, is shrunk to exclude the toolbar s extent. |
void | RemoveCommandFromStack | ( | TInt | aPosition, |
TInt | aCommandId | |||
) | [private] |
void | RemoveControlType | ( | TInt | aIndex | ) |
Removes a control type from the control type array.
TInt aIndex |
IMPORT_C void | SetBoundingRect | ( | const TRect & | aBoundingRect | ) |
From MEikButtonGroup. Sets the toolbar's bounding rectangle. This function has a different effect on the toolbar's extent, depending on whether the toolbar is vertical or horizontal.
For a vertical toolbar, sets the toolbar height to equal the height of the bounding rectangle.
For a horizontal toolbar (toolband), sets the toolband width to equal the width of the bounding rectangle.
From MEikButtonGroup
const TRect & aBoundingRect | The toolbar's bounding rectangle. |
IMPORT_C void | SetButtonStateOn | ( | TInt | aId, |
TBool | aState | |||
) |
Sets the state of the specified button and draws the button to show the new state.
void | SetCommandL | ( | TInt | aPosition, |
TInt | aCommandId, | |||
const TDesC * | aText, | |||
const CFbsBitmap * | aBitmap, | |||
const CFbsBitmap * | aMask | |||
) | [private] |
From MEikButtonGroup
TInt aPosition | |
TInt aCommandId | |
const TDesC * aText | |
const CFbsBitmap * aBitmap | |
const CFbsBitmap * aMask |
IMPORT_C void | SetCommandObserver | ( | MEikCommandObserver * | aCommandObserver | ) |
Sets the toolbar's command observer. Applications will not typically need to use this function.
MEikCommandObserver * aCommandObserver | The command observer for this toolbar. When a command is invoked in the toolbar, HandleCommandL() is called in the observer. |
IMPORT_C void | SetDimmed | ( | TBool | aDimmed | ) | [virtual] |
Sets the toolbar dimmed or not dimmed. Dimming usually indicates that user input is not accepted.
From CCoeControl
TBool aDimmed | ETrue to set as dimmed , EFalse to set as not dimmed. |
void | SetMSKCommandObserver | ( | MEikCommandObserver * | aCommandObserver | ) | [private] |
MEikCommandObserver * aCommandObserver |
IMPORT_C void | StaticConstructL | ( | MEikCommandObserver * | aCommandObserver, |
TInt | aResourceId | |||
) |
Creates a toolbar from a resource definition, but does not set its extent or activate it.
This function is used by ConstructL(), applications will not typically need to use it.
MEikCommandObserver * aCommandObserver | Specifies the object in which HandleCommandL() is called when a toolbar command is invoked, typically the application's AppUI. |
TInt aResourceId | The resource that defines the toolbar. |
IMPORT_C void | WriteInternalStateL | ( | RWriteStream & | aWriteStream | ) | const [protected, virtual] |
Writes the internal state of the control and its components to aWriteStream. Does nothing in release mode.
Designed to be overridden and base called from subclasses.
From CCoeControl
Writes the internal state of the control and its components to aStream. Does nothing in release mode. Designed to be overidden and base called by subclasses.
RWriteStream & aWriteStream | A connected write stream. |
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.