| class CEikCba : public CEikControlGroup |
Defines a Control Button Array control, used in Avkon to define the softkeys in the control pane.
eikcoctl.lib S60 0.9
| Protected Member Functions | |
|---|---|
| void | Draw(const TRect &) |
| void | HandleScrollEventL(CEikScrollBar *, TEikScrollEvent) |
| TTypeUid::Ptr | MopSupplyObject(TTypeUid) |
| Inherited Enumerations | |
|---|---|
| CCoeControl:TZoomType | |
| CEikControlGroup:@142 | |
| CEikControlGroup:TOrientation | |
| CEikControlGroup:TStartCorner | |
| Private Attributes | |
|---|---|
| CAknsBasicBackgroundControlContext * | iBgContext |
| TAknsItemID | iBgIID |
| CCoeBrushAndPenContext * | iBrushAndPenContext |
| TUint | iCbaFlags |
| TAknsItemID | iClockIndicBgIID |
| MEikCommandObserver * | iCommandObserver |
| CEikCommandTable * | iCommandTable |
| CEikCbaExtension * | iExtension |
| TBitFlags | iFlags |
| TBool | iIsClockIndicBgIIDSet |
| const CFont * | iLabelFont |
| const CEikCba * | iLink |
| CAknsMaskedLayerBackgroundControlContext * | iMLBgContext |
| MEikCommandObserver * | iMSKCommandObserver |
| TBool | iMSKEnabledInPlatform |
| TBool | iMSKset |
| RWindowGroup * | iParentWg |
| TBool | iPopupVisible |
| const CFont * | iRightPaneLabelFont |
| CEikCbaScrollBarFrame * | iSBFrame |
| CAknsLayeredBackgroundControlContext * | iStaconBgContext |
| CAknsMaskedLayerBackgroundControlContext * | iStaconBgContextBottom |
| CAknsMaskedLayerBackgroundControlContext * | iStaconBgContextTop |
| const CFont * | iStaconLabelFont |
| Inherited Attributes | |
|---|---|
| CCoeControl::iCoeEnv | |
| CCoeControl::iContext | |
| CCoeControl::iPosition | |
| CCoeControl::iSize | |
| CEikBorderedControl::iBorder | |
| CEikControlGroup::iControlArray | |
| CEikCba | ( | const CEikCba * | aPrevious, |
| MEikCommandObserver * | aCommandObserver, | ||
| RWindowGroup * | aParentWg, | ||
| TUint | aFlags = 0 | ||
| ) | [private] | ||
| const CEikCba * aPrevious | |
| MEikCommandObserver * aCommandObserver | |
| RWindowGroup * aParentWg | |
| TUint aFlags = 0 |
| void | AddCommandL | ( | TInt | aPosition, |
| TInt | aCommandId, | |||
| const TDesC * | aText, | |||
| const CFbsBitmap * | aBitmap, | |||
| const CFbsBitmap * | aMask | |||
| ) | ||||
From MEikButtonGroup. Not supported.
| TInt aPosition | |
| TInt aCommandId | |
| const TDesC * aText | |
| const CFbsBitmap * aBitmap | |
| const CFbsBitmap * aMask |
| void | AddCommandSetToStackL | ( | TInt | aResourceId | ) |
From MEikButtonGroup. As with SetCommandL() but for a set of buttons, also allows the previous command button to be retrieved by calling RemoveCommand(). Note that this implementation does not support bitmap and mask.
| TInt aResourceId |
| void | AddCommandToStackL | ( | TInt | aPosition, |
| TInt | aCommandId, | |||
| const TDesC * | aText, | |||
| const CFbsBitmap * | aBitmap, | |||
| const CFbsBitmap * | aMask | |||
| ) | ||||
From MEikButtonGroup. Pushes a command button with text and a command ID onto a position's button stack. Note that this implementation does not support bitmap and mask.
| TInt aPosition | |
| TInt aCommandId | |
| const TDesC * aText | |
| const CFbsBitmap * aBitmap | |
| const CFbsBitmap * aMask |
| void | AddCommandToStackL | ( | TInt | aPosition, |
| TInt | aResourceId | |||
| ) | ||||
From MEikButtonGroup. Pushes a command button onto a position's button stack. The text and command ID are all read from resource. Note that this implementation does not support bitmap and mask.
| void | AddCommandToStackWithoutSizeChangedL | ( | TInt | aPosition, |
| TInt | aCommandId, | |||
| const TDesC * | aText | |||
| ) | [private] | |||
A better version of AddCommandToStackL Pushes a command button with text and a command ID onto a position's button stack. SizeChanged() is not called, so it need to be done after that. Note that this implementation does not support bitmap and mask.
| void | AnimateCommand | ( | TInt | aCommandId | ) |
From MEikButtonGroup. Not supported.
| TInt aCommandId |
| void | AnimateCommandByPosition | ( | TInt | aPosition | ) |
From MEikButtonGroup. Not supported.
| TInt aPosition |
| const CCoeControl * | AsControl | ( | ) | const |
From MEikButtonGroup. Returns the button group as a control.
| void | BroadcastPostingTransparency | ( | TBool | aEnable | ) | [private] |
Broadcasts transparency information to CEikCbaButtons.
| TBool aEnable |
| TInt | ButtonCount | ( | ) | const |
From MEikButtonGroup. Gets the total number of buttons currently present in the group.
| TRect | ButtonRectByPosition | ( | TInt | aPosition, |
| TBool | aRelativeToScreen | |||
| ) | ||||
Returns a group control (a button) as a control. Gets a CBA button rectangle. This can be used in touch layouts to get the whole rectangle of the CBA button, as the button areas are larger than the actual button control in touch layouts.
Rectangle of the specified button.
| TInt aPosition | Position of the button. |
| TBool aRelativeToScreen | If ETrue, the returned rectangle coordinates are relative to the screen rectangle, otherwise they are relative to the CBA area. Note that this parameter is only taken into account in touch layouts, and in nHD landscape mode the returned rectangle is always relative to the screen regardless of this parameter. |
| TSize | CalcMinimumSizeL | ( | TInt | aResourceId | ) |
From MEikButtonGroup. Calculates minimum size required to display the buttons defined in the specified resource structure.
| TInt aResourceId |
| TInt | CommandId | ( | TInt | aCommandPos | ) | const |
From MEikButtonGroup. Returns the command id by position.
| TInt aCommandPos |
| TInt | CommandPos | ( | TInt | aCommandId | ) | const |
From MEikButtonGroup. Returns the command position by command id.
| TInt aCommandId |
| void | ConstructFromResourceL | ( | TResourceReader & | aReader | ) | [private, virtual] |
| TResourceReader & aReader |
| void | CreateArrowHeadScrollBarL | ( | ) |
Replaces empty scroll bar with actual arrow head scroll bar.
| void | DimCommand | ( | TInt | aCommandId, |
| TBool | aDimmed | |||
| ) | ||||
From MEikButtonGroup. Dims or undims a button without drawing it.
| void | DimCommandByPosition | ( | TInt | aPosition, |
| TBool | aDimmed | |||
| ) | ||||
From MEikButtonGroup. Dims (but doesn't draw) the button with position aPosition.
| void | DoSetLayers | ( | const TAknsItemID & | aIID | ) | [private] |
| const TAknsItemID & aIID |
| void | Draw | ( | const TRect & | aRect | ) | const [protected, virtual] |
From CCoeControl. Draws the control.
| const TRect & aRect | Rectangle to draw on. |
| void | DrawEmbeddedSoftkey | ( | TEikGroupControl & | aGroupControl, |
| const TRect & | aRect, | |||
| CWindowGc & | aGc, | |||
| CFbsBitmap * | aMask | |||
| ) | const [private] | |||
Draws embedded softkey.
| TEikGroupControl & aGroupControl | |
| const TRect & aRect | |
| CWindowGc & aGc | |
| CFbsBitmap * aMask |
| IMPORT_C void | EnableItemSpecificSoftkey | ( | TBool | aEnable | ) |
Enables or disables item specific softkey. If enabled then SK1's visibility is determined by the screen content. If there's a list or grid with visible highlight (i.e. highlight is brought visible via hardware keys) on the display or SK1's associated command is EAknSoftkeyOptions then SK1 is visible, otherwise it's hidden. This method has no effect if the the application isn't single click enabled. Item specific softkey is enabled by default.
S60 5.2
| TBool aEnable | ETrue to enable item specific softkey, EFalse to disable. |
| void | EnablePostingTransparency | ( | TBool | aEnable | ) |
Enable or disable transparent rendering.
| TBool aEnable |
| IMPORT_C void * | ExtensionInterface | ( | TUid | aInterface | ) | [private, virtual] |
From CAknControl
| TUid aInterface |
| void | GetColorUseListL | ( | CArrayFix< TCoeColorUse > & | aColorUseList | ) | const [virtual] |
From CCoeControl. Gets the list of logical colours used to draw the control. The list includes an explanation of how each colour is used.
| CArrayFix< TCoeColorUse > & aColorUseList | The colour list. |
| CEikCommandButton * | GroupControlAsButton | ( | TInt | aCommandId | ) | const |
From MEikButtonGroup. Not supported, because it is not possible to convert a CBA button to a CEikCommandButton. Calling this in debug build causes a panic, otherwise NULL is just returned.
| TInt aCommandId |
| CCoeControl * | GroupControlById | ( | TInt | aCommandId | ) |
Returns a group control (a button) as a control.
| TInt aCommandId |
| CCoeControl * | GroupControlById | ( | TInt | aCommandId | ) | const |
From MEikButtonGroup. Returns a group control (a button) as a control.
| TInt aCommandId |
| void | HandleControlEventL | ( | CCoeControl * | aControl, |
| TCoeEvent | aEventType | |||
| ) | ||||
| CCoeControl * aControl | |
| TCoeEvent aEventType |
| void | HandlePointerEventL | ( | const TPointerEvent & | aPointerEvent | ) | [virtual] |
From CCoeControl. Handles pointer events.
| const TPointerEvent & aPointerEvent | The pointer event |
| void | HandleResourceChange | ( | TInt | aType | ) | [virtual] |
From CCoeControl. Handles a change to the control's resources.
| TInt aType | A message UID value. |
| void | HandleScrollEventL | ( | CEikScrollBar * | aScrollBar, |
| TEikScrollEvent | aEventType | |||
| ) | [protected, virtual] | |||
From MEikScrollBarObserver Handles scroll events. This function is called by the CEikScrollBar object with which this scroll bar observer object is registered. Implementations should handle scroll events appropriately.
| CEikScrollBar * aScrollBar | Pointer to the originating scroll bar object. |
| TEikScrollEvent aEventType | A scroll event. |
| void | InsertControlL | ( | TEikGroupControl & | aGroupControl, |
| TInt | aIndex | |||
| ) | ||||
From CEikControlGroup. Adds a wrapped control to the control group array at the given index position. Overridden to prevent setting container window.
| TEikGroupControl & aGroupControl | The control to add to the group. |
| TInt aIndex | The index for the added control. |
| TBool | IsCommandDimmed | ( | TInt | aCommandId | ) | const |
From MEikButtonGroup. Determines whether the button with the specified command ID is dimmed.
| TInt aCommandId |
| TBool | IsCommandDimmedByPosition | ( | TInt | aPosition | ) | const |
From MEikButtonGroup. Returns ETrue if the button with position aPosition is dimmed.
| TInt aPosition |
| IMPORT_C TBool | IsCommandInGroup | ( | const TInt | aCommandId | ) | const |
From MEikEnhancedButtonGroup. Used to check if a certain command have been approved to the current command set.
ETrue if command is in control group, otherwise EFalse.
| const TInt aCommandId | The id for command which existence should be checked. |
| TBool | IsCommandVisible | ( | TInt | aCommandId | ) | const |
From MEikButtonGroup. Tests whether the button with the specified command ID is visible.
| TInt aCommandId |
| TBool | IsCommandVisibleByPosition | ( | TInt | aPosition | ) | const |
From MEikButtonGroup. Returns ETrue if the button with position aPosition is visible.
| TInt aPosition |
| IMPORT_C TBool | IsEmpty | ( | ) | const |
Checks if the CBA contains no commands. Note that this returns always EFalse if the CBA belongs to a full screen query.
| TEikGroupControl * | ItemSpecificSoftkey | ( | ) | const |
Returns item specific softkey if it state should be updated.
Item specific softkey.
| void | LayoutControl | ( | CCoeControl * | aControl, |
| const TRect & | aRect | |||
| ) | [private] | |||
Layouts given cba control to it's rect correctly. This function is used to layout every text and image inside of CEikCba.
| CCoeControl * aControl | CBA Control that is to be layouted |
| const TRect & aRect | the rect where control should be layouted. |
| TInt | MSKEnabledInPlatform | ( | ) | const |
For checking whether the middle softkey is supported in the platform.
| void | MakeCommandVisible | ( | TInt | aCommandId, |
| TBool | aVisible | |||
| ) | ||||
From MEikButtonGroup. Makes the button with the specified id either visible, or invisible.
| void | MakeCommandVisibleByPosition | ( | TInt | aPosition, |
| TBool | aVisible | |||
| ) | ||||
From MEikButtonGroup. Sets the the button with position aPosition to be visible if aVisible is ETrue.
| void | MakeVisible | ( | TBool | aVisible | ) | [virtual] |
From CCoeControl. Sets this control as visible or invisible.
| TBool aVisible | ETrue to make the control visible, EFalse to make it invisible. |
| TInt | MaxCommands | ( | ) | const |
Gets the maximum number of buttons that can be supported by the device.
| TSize | MinimumSize | ( | ) | [virtual] |
From CCoeControl. Sets the control's minimum required size.
The minimum size required by the control.
| TTypeUid::Ptr | MopSupplyObject | ( | TTypeUid | aId | ) | [protected] |
From CCoeControl Retrieves an object of the same type as that encapsulated in aId. This function is used to allow controls to ask their owners for access to other objects that they own.
Encapsulates the pointer to the object provided. Note that the encapsulated pointer may be NULL.
| TTypeUid aId | An encapsulated object type ID. |
| CEikCba * | NewL | ( | const CEikCba * | aPrevious, |
| MEikCommandObserver * | aCommandObserver, | |||
| RWindowGroup * | aParentWg | |||
| ) | [static] | |||
Creates a new control button array.
| const CEikCba * aPrevious | |
| MEikCommandObserver * aCommandObserver | |
| RWindowGroup * aParentWg |
| CEikCba * | NewL | ( | TInt | aResourceId, |
| const CEikCba * | aPrevious, | |||
| MEikCommandObserver * | aCommandObserver, | |||
| RWindowGroup * | aParentWg | |||
| ) | [static] | |||
Creates a new control button array.
| TInt aResourceId | |
| const CEikCba * aPrevious | |
| MEikCommandObserver * aCommandObserver | |
| RWindowGroup * aParentWg |
| CEikCba * | NewLC | ( | const CEikCba * | aPrevious, |
| MEikCommandObserver * | aCommandObserver, | |||
| RWindowGroup * | aParentWg | |||
| ) | [static] | |||
Creates a new control button array.
| const CEikCba * aPrevious | |
| MEikCommandObserver * aCommandObserver | |
| RWindowGroup * aParentWg |
| CEikCba * | NewLC | ( | const CEikCba * | aPrevious, |
| MEikCommandObserver * | aCommandObserver, | |||
| RWindowGroup * | aParentWg, | |||
| TUint | aFlags | |||
| ) | [static] | |||
Creates a new control button array
S60 5.2
| const CEikCba * aPrevious | |
| MEikCommandObserver * aCommandObserver | |
| RWindowGroup * aParentWg | |
| TUint aFlags |
| CEikCba * | NewLC | ( | TInt | aResourceId, |
| const CEikCba * | aPrevious, | |||
| MEikCommandObserver * | aCommandObserver, | |||
| RWindowGroup * | aParentWg | |||
| ) | [static] | |||
Creates a new control button array.
| TInt aResourceId | |
| const CEikCba * aPrevious | |
| MEikCommandObserver * aCommandObserver | |
| RWindowGroup * aParentWg |
| CEikCba * | NewLC | ( | TInt | aResourceId, |
| const CEikCba * | aPrevious, | |||
| MEikCommandObserver * | aCommandObserver, | |||
| RWindowGroup * | aParentWg, | |||
| TUint | aFlags | |||
| ) | [static] | |||
Creates a new control button array
S60 5.2
| TInt aResourceId | |
| const CEikCba * aPrevious | |
| MEikCommandObserver * aCommandObserver | |
| RWindowGroup * aParentWg | |
| TUint aFlags |
| IMPORT_C void | OfferCommandListL | ( | const RArray< TInt > & | aCommandList | ) |
From MEikEnhancedButtonGroup. Used to offer list of commands for softkeys.
| IMPORT_C void | OfferCommandListL | ( | const TInt | aResourceId | ) |
From MEikEnhancedButtonGroup. Used to offer list of commands for softkeys.
| const TInt aResourceId | Id for CBA resource that defines enhanced cba buttons. |
| TKeyResponse | OfferKeyEventL | ( | const TKeyEvent & | aKeyEvent, |
| TEventCode | aType | |||
| ) | [virtual] | |||
From CCoeControl. Handles key events.
Indicates whether or not the key event was used by this control.
| const TKeyEvent & aKeyEvent | The key event. |
| TEventCode aType | The type of key event: EEventKey, EEventKeyUp or EEventKeyDown. |
| void | ReduceRect | ( | TRect & | aBoundingRect | ) | const |
From MEikButtonGroup. Subtracts the area occupied by the button group from the specified bounding rectangle. This method should be used in preference to querying the container's area at all times. For use by EExternal button groups only.
| TRect & aBoundingRect |
| void | RemoveCommandFromStack | ( | TInt | aPosition, |
| TInt | aCommandId | |||
| ) | ||||
From MEikButtonGroup. Removes the command identified by aCommandId, in position aPosition in the group, from the command stack. Automatically retrieves the previous command details. Commands are added to the stack by calling AddCommandToStackL.
| void | RemovePreviousCommand | ( | TInt | aPosition | ) |
Removes previous command.
| TInt aPosition |
| void | RemovePreviousCommandWithoutSizeChanged | ( | TInt | aPosition | ) | [private] |
Removes previous command but do not call SizeChanged And SetMSKIconL.
| TInt aPosition |
| IMPORT_C void | ReplaceCommand | ( | const TInt | aCommandId, |
| const TInt | aResourceId | |||
| ) | ||||
From MEikEnhancedButtonGroup. Replace existing command with a new command.
| void | ReportContentChangedEvent | ( | ) | [private] |
Reports state changed event if cba changed from empty to non-empty or vice versa.
| void | Reserved_MtsmObject | ( | ) | [virtual] |
Formerly from MTopSetMember<CEikCba>, now reserved.
| void | Reserved_MtsmPosition | ( | ) | [virtual] |
Formerly from MTopSetMember<CEikCba>, now reserved.
| void | SetBoundingRect | ( | const TRect & | aBoundingRect | ) |
From MEikButtonGroup. Sets the boundary rectangle for externally-positioned button groups. For use by EExternal button groups only.
| const TRect & aBoundingRect |
| IMPORT_C void | SetButtonGroupFlags | ( | TInt | aFlags | ) |
Sets the button group flags.
| TInt aFlags |
| void | SetCommandL | ( | TInt | aPosition, |
| TInt | aCommandId, | |||
| const TDesC * | aText, | |||
| const CFbsBitmap * | aBitmap, | |||
| const CFbsBitmap * | aMask | |||
| ) | ||||
From MEikButtonGroup. Sets a command button's text and command ID. Note that this implementation does not support bitmap and mask.
| TInt aPosition | The position within the button group of the button to change. |
| TInt aCommandId | Command ID the button will send. |
| const TDesC * aText | The text for the button. |
| const CFbsBitmap * aBitmap | Not used. |
| const CFbsBitmap * aMask | Not used. |
| void | SetCommandL | ( | TInt | aPosition, |
| TInt | aResourceId | |||
| ) | ||||
From MEikButtonGroup. Sets a command button's text label and command ID. The text and command ID are all read from resource. Note that this implementation does not support bitmap and mask.
| void | SetCommandSetL | ( | TInt | aResourceId | ) |
From MEikButtonGroup. Initialises the group of command buttons from a resource. Note that this implementation does not support bitmap and mask.
| TInt aResourceId |
| void | SetContainerWindowL | ( | const CCoeControl & | aContainer | ) | [virtual] |
From CCoeControl. Sets the control's containing window by copying it from aContainer.
| const CCoeControl & aContainer | The compound control that is the container for this control |
| void | SetContentObserver | ( | TCallBack | aCallBack | ) |
Sets content observer.
| TCallBack aCallBack |
| void | SetDefaultCommand | ( | TInt | aCommandId | ) |
From MEikButtonGroup. Not supported.
| TInt aCommandId |
| void | SetMSKCommandObserver | ( | MEikCommandObserver * | aCommandObserver | ) |
From MEikButtonGroup. Sets the middle softkey command observer.
| MEikCommandObserver * aCommandObserver |
| void | SetSBFrameObserver | ( | MEikScrollBarObserver * | aObserver | ) |
Sets the scroll bar frame observer.
| MEikScrollBarObserver * aObserver |
| void | SetScrollBarModelL | ( | TEikScrollBarModel * | aModel | ) |
Sets the scroll bar model.
| TEikScrollBarModel * aModel |
| IMPORT_C void | SetSkinBackgroundId | ( | const TAknsItemID & | aIID | ) |
Sets the skin background for this control button array. The new background is used for all the subsequent drawing operations. This method does not itself cause a repaint.
| const TAknsItemID & aIID |
| void | SizeChangedInPopup | ( | ) | [private] |
Handles size change events in case of embedded softkeys.
| TBool | SoftkeyStatusChangeAllowed | ( | TInt | aSofkeyPosition, |
| TBool | aDisabled | |||
| ) | ||||
Returns ETrue if softkey status change is allowed.
ETrue if softkey status change is allowed.
| void | UpdateCbaLabels | ( | TBool | aScrollerOn | ) |
Updates the cba labels.
| TBool aScrollerOn |
| void | UpdateItemSpecificSoftkey | ( | TBool | aVisibleCollection = ETrue | ) |
Updates item specific softkey.
| TBool aVisibleCollection = ETrue | ETrue if state should be updated according to visible collection. |
| void | UpdateItemSpecificSoftkey | ( | CCoeControl & | aControl, |
| TBool | aEnable | |||
| ) | [private] | |||
Updates item specific softkey.
| CCoeControl & aControl | Item specifc softkey control. |
| TBool aEnable | ETrue if control should be enabled, EFalse if disabled. |
| void | UpdateLabels | ( | TBool | aDrawDeferred | ) | [private] |
Updates softkey labels in case of embedded softkeys.
| TBool aDrawDeferred | ETrue to cause a redraw event. |
| IMPORT_C TBool | UpdateMSKIconL | ( | const TAknsItemID & | aId, |
| const TDesC & | aBmpFile, | |||
| const TInt32 | aBmp, | |||
| const TInt32 | aBmpM, | |||
| TBool | aEnable | |||
| ) | ||||
For external set the MSK icon Returns ETrue if option is ok, EFalse is not.
| const TAknsItemID & aId | icon bitmap IID |
| const TDesC & aBmpFile | file path. |
| const TInt32 aBmp | Bitmap ID. |
| const TInt32 aBmpM | Bitmap mask ID. |
| TBool aEnable | ETrue for set icon, EFalse for use default icon. |
| CAknScrollBar * | VScrollBarAsControl | ( | ) |
Returns the vertical scroll bar as a control.
| CAknsBasicBackgroundControlContext * | iBgContext | [private] |
Old background context.
| TAknsItemID | iClockIndicBgIID | [private] |
Skin background ID for the status pane controlled region of the CBA area in bottom softkey landscape mode.
| CEikCommandTable * | iCommandTable | [private] |
New member variable that stores commands in correct order.
| const CEikCba * | iLink | [private] |
Used to maintain the original settings if a client needs to temporarily change its cba.
| CAknsMaskedLayerBackgroundControlContext * | iMLBgContext | [private] |
Masked layer backgrounds.
| MEikCommandObserver * | iMSKCommandObserver | [private] |
Additional observer for MSK. This is called first and default observer after that.
| CAknsLayeredBackgroundControlContext * | iStaconBgContext | [private] |
Old stacon background context.
| CAknsMaskedLayerBackgroundControlContext * | iStaconBgContextBottom | [private] |