| class CEikButtonGroupContainer : public CAknControl |
The CEikButtonGroupContainer class provides a wrapper around the different button arrays used in pen and no-pen devices.
eikcoctl.lib S60 0.9
| Private Member Functions | |
|---|---|
| CEikButtonGroupContainer(TUse) | |
| CCoeControl * | ButtonGroupAsControl() |
| void | CleanupCommandDestroy(TAny *) |
| CCoeControl * | ComponentControl(TInt) |
| void | ConstructL(TOrientation, MEikCommandObserver *, TInt, RWindowGroup *, TUint) |
| TInt | CountComponentControls() |
| CCoeControl * | CreateCustomCommandControlL(TInt) |
| TCmdPos | DoCleanupCommandPop() |
| void | DoCleanupCommandPopAndDestroy() |
| IMPORT_C void | DoSetCommandL(TInt, TInt, const TDesC *, const CFbsBitmap *, const CFbsBitmap *, TCommandOp) |
| IMPORT_C void | DoSetCommandL(TInt, TInt, const TDesC *, const TDesC &, TInt, TInt, TCommandOp) |
| IMPORT_C void | DoSetCommandL(TInt, const TDesC *, const CFbsBitmap *, const CFbsBitmap *, TCommandOp) |
| IMPORT_C void | DoSetCommandL(TInt, const TDesC *, const TDesC &, TInt, TInt, TCommandOp) |
| IMPORT_C void | DoSetCommandL(TInt, TInt, TCommandOp) |
| void | ProcessCommandL(TInt) |
| void | SizeChanged() |
| void | UpdateRect() |
| Public Member Enumerations | |
|---|---|
| enum | TCommandPosition { ELeftSoftkeyPosition = 0, ERightSoftkeyPosition = 2, EMiddleSoftkeyPosition = 3 } |
| enum | TFlags { EAddToStack = 0x01, EDelayActivation = 0x02, EUseMaxSize = 0x04, EIsEmbedded = 0x08, EParentIsControl = 0x10 } |
| enum | THotKeyFlags { EShowHotKey = 0x01, EPlainHotKey = 0x02 } |
| enum | TLocation { EInternal = SLafButtonGroupContainer::EInternal, EExternal = SLafButtonGroupContainer::EExternal } |
| enum | TOrientation { EVertical = SLafButtonGroupContainer::EVertical, EHorizontal = SLafButtonGroupContainer::EHorizontal } |
| enum | TUse { EView = SLafButtonGroupContainer::EView, EDialog = SLafButtonGroupContainer::EDialog, EToolbar = SLafButtonGroupContainer::EToolbar, ECba = SLafButtonGroupContainer::ECba, EDialogButtons = SLafButtonGroupContainer::EDialogButtons } |
| Private Member Enumerations | |
|---|---|
| enum | TCommandOp { ESet, EAdd, EPush } |
| Inherited Enumerations | |
|---|---|
| CCoeControl:TZoomType | |
| Private Attributes | |
|---|---|
| TDblQueLink | iBtLink |
| MEikButtonGroup * | iButtonGroup |
| MEikCommandObserver * | iCommandObserver |
| CArrayFix< TCmdPos > * | iCommandsCleanup |
| CEikListBox * | iMSKObserverOwner |
| CCmdObserverArray * | iObserverArray |
| TInt | iSpare |
| TUse | iUse |
| TInt | iValid |
| Inherited Attributes | |
|---|---|
| CCoeControl::iCoeEnv | |
| CCoeControl::iContext | |
| CCoeControl::iPosition | |
| CCoeControl::iSize | |
| void | AddCommandL | ( | TInt | aPosition, |
| TInt | aCommandId, | |||
| const TDesC & | aText | |||
| ) | [inline] | |||
Adds a command button with a text label and command ID.
| void | AddCommandL | ( | TInt | aPosition, |
| TInt | aCommandId, | |||
| const CFbsBitmap & | aBitmap, | |||
| const CFbsBitmap & | aMask | |||
| ) | [inline] | |||
Adds a command button with a bitmap label and command ID.
| TInt aPosition | The position in the button group for the new button. |
| TInt aCommandId | Command ID for the new button. |
| const CFbsBitmap & aBitmap | Bitmap for the button. |
| const CFbsBitmap & aMask | Mask bitmap for aBitmap. |
| void | AddCommandL | ( | TInt | aPosition, |
| TInt | aCommandId, | |||
| const TDesC & | aText, | |||
| const CFbsBitmap & | aBitmap, | |||
| const CFbsBitmap & | aMask | |||
| ) | [inline] | |||
Adds a command button with a command ID and a label containing both a bitmap and text.
| TInt aPosition | The position in the button group for the new button. |
| TInt aCommandId | Command ID for the new button. |
| const TDesC & aText | Text for the button. |
| const CFbsBitmap & aBitmap | Bitmap for the button. |
| const CFbsBitmap & aMask | Mask bitmap for aBitmap. |
| void | AddCommandL | ( | TInt | aPosition, |
| TInt | aCommandId, | |||
| const TDesC & | aFile, | |||
| TInt | aBitmapId, | |||
| TInt | aMaskId | |||
| ) | [inline] | |||
Adds a command button with a command ID and a bitmap which is read from a file.
| void | AddCommandL | ( | TInt | aPosition, |
| TInt | aCommandId, | |||
| const TDesC & | aText, | |||
| const TDesC & | aFile, | |||
| TInt | aBitmapId, | |||
| TInt | aMaskId | |||
| ) | [inline] | |||
Adds a command button with a command ID and a label containing both a bitmap and text. The bitmap and mask are read from file.
| TInt aPosition | The position in the button group for the new button. |
| TInt aCommandId | Command ID for the new button. |
| const TDesC & aText | Text for the button. |
| const TDesC & aFile | Multi-bitmap file containing the bitmap and mask. |
| TInt aBitmapId | ID of the bitmap within aFile. |
| TInt aMaskId | ID of the mask within aFile. |
| IMPORT_C void | AddCommandSetToStackL | ( | TInt | aResourceId | ) |
As with SetCommandL() but for a set of buttons, also allows the previous command button to be retrieved by calling RemoveCommand().
| TInt aResourceId | Resource describing the set of command buttons. |
| void | AddCommandToStackL | ( | TInt | aPosition, |
| TInt | aCommandId, | |||
| const TDesC & | aText | |||
| ) | [inline] | |||
Pushes a command button with a text label and command ID onto a position's button stack. This function behaves similarly to SetCommandL() but allows the previous command button to be retrieved by calling RemoveCommandFromStack().
| void | AddCommandToStackL | ( | TInt | aPosition, |
| TInt | aCommandId, | |||
| const CFbsBitmap & | aBitmap, | |||
| const CFbsBitmap & | aMask | |||
| ) | [inline] | |||
Pushes a command button with a bitmap, mask and command ID onto a position's button stack. This function behaves similarly to SetCommandL() but allows the previous command button to be retrieved by calling RemoveCommandFromStack().
| TInt aPosition | The position in the button group at which to add the command button. |
| TInt aCommandId | Command ID the button will send. |
| const CFbsBitmap & aBitmap | Bitmap for the button. |
| const CFbsBitmap & aMask | Mask bitmap for aBitmap. |
| void | AddCommandToStackL | ( | TInt | aPosition, |
| TInt | aCommandId, | |||
| const TDesC & | aText, | |||
| const CFbsBitmap & | aBitmap, | |||
| const CFbsBitmap & | aMask | |||
| ) | [inline] | |||
Pushes a command button with text, bitmap, mask and a command ID onto a position's button stack. This function behaves similarly to SetCommandL() but allows the previous command button to be retrieved by calling RemoveCommandFromStack().
| TInt aPosition | The position in the button group at which to add the command button. |
| TInt aCommandId | Command ID the button will send. |
| const TDesC & aText | Text for the button. |
| const CFbsBitmap & aBitmap | Bitmap for the button. |
| const CFbsBitmap & aMask | Mask bitmap for aBitmap. |
| void | AddCommandToStackL | ( | TInt | aPosition, |
| TInt | aCommandId, | |||
| const TDesC & | aFile, | |||
| TInt | aBitmapId, | |||
| TInt | aMaskId | |||
| ) | [inline] | |||
Pushes a command button with a bitmap, mask and command ID onto a position's button stack. The bitmap and mask are read from a file. This function behaves similarly to SetCommandL() but allows the previous command button to be retrieved by calling RemoveCommandFromStack().
| TInt aPosition | The position in the button group at which to add the command button. |
| TInt aCommandId | Command ID the button will send. |
| const TDesC & aFile | A multi-bitmap file containing mask and bitmap. |
| TInt aBitmapId | Index into the file of the bitmap. |
| TInt aMaskId | Index into the file of the bitmap mask. |
| void | AddCommandToStackL | ( | TInt | aPosition, |
| TInt | aCommandId, | |||
| const TDesC & | aText, | |||
| const TDesC & | aFile, | |||
| TInt | aBitmapId, | |||
| TInt | aMaskId | |||
| ) | [inline] | |||
Pushes a command button with text, bitmap, mask and command button onto a position's button stack. The bitmap and mask are read from a file. This function behaves similarly to SetCommandL() but allows the previous command button to be retrieved by calling RemoveCommandFromStack().
| TInt aPosition | The position in the button group at which to push the command button. |
| TInt aCommandId | Command ID the button will send. |
| const TDesC & aText | Text for the button. |
| const TDesC & aFile | A multi-bitmap file containing mask and bitmap. |
| TInt aBitmapId | Index into the file of the bitmap. |
| TInt aMaskId | Index into the file of the bitmap mask. |
| void | AddCommandToStackL | ( | TInt | aPosition, |
| TInt | aResourceId | |||
| ) | [inline] | |||
Pushes a command button onto a position's button stack. The text, bitmap, mask and command ID are all read from resource. This function behaves similarly to SetCommandL() but allows the previous command button to be retrieved by calling RemoveCommandFromStack().
| IMPORT_C void | AnimateCommand | ( | TInt | aCommandId | ) |
Animates the button with id aCommandId. If two buttons have the same id, the button to be animated is undefined.
S60 3.1
| TInt aCommandId | The id for command to be animated. |
| IMPORT_C void | AnimateCommandByPosition | ( | TCommandPosition | aPosition | ) |
Animates the button with position aPosition.
S60 3.1
| TCommandPosition aPosition | The position for command to be animated. |
| IMPORT_C CEikCommandButton * | ButtonById | ( | TInt | aCommandId | ) | const |
Gets a pointer to the the button with the specified command Id.
The button object.
| TInt aCommandId | Command ID of the button to obtain. |
| IMPORT_C TInt | ButtonCount | ( | ) | const |
Gets the total number of buttons currently present in the group.
The number of buttons.
| MEikButtonGroup * | ButtonGroup | ( | ) | [inline] |
Returns the container's button group.
Pointer to the button group object. Ownership is not transferred.
| TUse | ButtonGroupType | ( | ) | [inline] |
Returns the button group type.
The button group type.
| IMPORT_C TSize | CalcMinimumSizeL | ( | TInt | aResourceId | ) | const |
Calculates minimum size required to display the buttons defined in the specified resource structure.
Minimum size required to display the button group defined in the specified resource structure.
| TInt aResourceId | The ID of the resource structure describing the button group. |
| void | CleanupCommandDestroy | ( | TAny * | aPtr | ) | [private, static] |
| TAny * aPtr |
| void | CleanupCommandPop | ( | ) | [inline] |
Removes a command from the cleanup stack without destroying it.
| IMPORT_C void | CleanupCommandPop | ( | TInt | aCount | ) |
Removes one or more commands from the cleanup stack without destroying them.
| TInt aCount | Number of commands to pop. |
| void | CleanupCommandPopAndDestroy | ( | ) | [inline] |
Removes a single command which was pushed onto the cleanup stack. It does this by calling CleanupCommandPushL(), rolling back to the previous details. The command button popped is destroyed.
| void | CleanupCommandPopAndDestroy | ( | TInt | aCount | ) | [inline] |
Removes one or more commands which were pushed onto the cleanup stack. It does this by calling CleanupCommandPushL(), rolling back to the previous details. The command buttons popped are destroyed.
| TInt aCount | Number of commands to pop and destroy. |
| IMPORT_C void | CleanupCommandPushL | ( | TInt | aPosition | ) |
Places the command in position aPosition in the group on the cleanup stack. Typically used when a control or view changes the contents of two or more buttons on receipt of focus. After altering one command with a call to AddCommandToStackL() the push is made to guarantee the display will be left in a consistent state if the second (and any subsequent) calls to AddCommandToStackL() fail. Only a single command can be pushed for each position.
| TInt aPosition | Position in the container of the button to push. |
| IMPORT_C CEikCommandButton * | CommandButtonOrNull | ( | TInt | aCommandId | ) | const |
Gets a pointer to the command button with the specified command Id.
Pointer to the command button CEikCommandButton, NULL if there was no button with Id aCommandId.
| TInt aCommandId | Command ID of the button. |
| CCoeControl * | ComponentControl | ( | TInt | aIndex | ) | const [private, virtual] |
| TInt aIndex |
| void | ConstructL | ( | TOrientation | aOrientation, |
| MEikCommandObserver * | aCommandObserver, | |||
| TInt | aResourceId, | |||
| RWindowGroup * | aParentWg, | |||
| TUint | aFlags | |||
| ) | [private] | |||
| TOrientation aOrientation | |
| MEikCommandObserver * aCommandObserver | |
| TInt aResourceId | |
| RWindowGroup * aParentWg | |
| TUint aFlags |
| IMPORT_C CCoeControl * | ControlOrNull | ( | TInt | aCommandId | ) | const |
Gets a pointer to the control (button) with the specified command ID. This method is intended to allow access to standard CCoeControl functionality only. Casting the return value is likely to fail on different devices.
Pointer to a CCoeControl, NULL if there was no button at aCommandId.
| TInt aCommandId | Command ID of the button to get. |
| CCoeControl * | CreateCustomCommandControlL | ( | TInt | aControlType | ) | [private] |
| TInt aControlType |
| IMPORT_C CEikButtonGroupContainer * | Current | ( | ) | [static] |
Gets a pointer to an application's currently active CEikButtonGroupContainer (if any).
Returns NULL if there are no containers active or none suitable for sharing. Ownership of the returned pointer is not transferred.
Pointer to the button group container.
| IMPORT_C TBool | DelayActivation | ( | ) | const |
Tests whether the button group has explicitly been instructed to suppress redraws. Some button groups may not activate themselves during construction, in which case, they need to be activated by the client. This method allows the client to enquire whether this is necessary.
ETrue if the button group will suppress redraws, otherwise EFalse.
| IMPORT_C void | DimCommand | ( | TInt | aCommandId, |
| TBool | aDimmed | |||
| ) | ||||
Dims (but doesn't draw) the button with id aCommandId if aDimmed is ETrue. If two buttons have the same id, the button to be dimmed is undefined.
| IMPORT_C void | DimCommandByPosition | ( | TCommandPosition | aPosition, |
| TBool | aDimmed | |||
| ) | ||||
Dims (but doesn't draw) the button with position aPosition.
S60 3.1
| TCommandPosition aPosition | The position for command to be dimmed. |
| TBool aDimmed | ETrue for dimming. |
| IMPORT_C void | DoSetCommandL | ( | TInt | aPosition, |
| TInt | aCommandId, | |||
| const TDesC * | aText, | |||
| const CFbsBitmap * | aBitmap, | |||
| const CFbsBitmap * | aMask, | |||
| TCommandOp | aOp | |||
| ) | [private] | |||
| TInt aPosition | |
| TInt aCommandId | |
| const TDesC * aText | |
| const CFbsBitmap * aBitmap | |
| const CFbsBitmap * aMask | |
| TCommandOp aOp |
| IMPORT_C void | DoSetCommandL | ( | TInt | aPosition, |
| TInt | aCommandId, | |||
| const TDesC * | aText, | |||
| const TDesC & | aFile, | |||
| TInt | aBitmapId, | |||
| TInt | aMaskId, | |||
| TCommandOp | aOp | |||
| ) | [private] | |||
| IMPORT_C void | DoSetCommandL | ( | TInt | aCommandId, |
| const TDesC * | aText, | |||
| const CFbsBitmap * | aBitmap, | |||
| const CFbsBitmap * | aMask, | |||
| TCommandOp | aOp | |||
| ) | [private] | |||
| TInt aCommandId | |
| const TDesC * aText | |
| const CFbsBitmap * aBitmap | |
| const CFbsBitmap * aMask | |
| TCommandOp aOp |
| IMPORT_C void | DoSetCommandL | ( | TInt | aCommandId, |
| const TDesC * | aText, | |||
| const TDesC & | aFile, | |||
| TInt | aBitmapId, | |||
| TInt | aMaskId, | |||
| TCommandOp | aOp | |||
| ) | [private] | |||
| IMPORT_C void | DoSetCommandL | ( | TInt | aPosition, |
| TInt | aResourceId, | |||
| TCommandOp | aOp | |||
| ) | [private] | |||
| TInt aPosition | |
| TInt aResourceId | |
| TCommandOp aOp |
| IMPORT_C TBool | IsCommandDimmed | ( | TInt | aCommandId | ) | const |
Returns ETrue if the button with id aCommandId is dimmed. If two buttons have the same id, the results of this check are undefined.
The state of the button.
| TInt aCommandId | The id for command to be checked. |
| IMPORT_C TBool | IsCommandDimmedByPosition | ( | TCommandPosition | aPosition | ) | const |
Returns ETrue if the button with position aPosition is dimmed.
S60 3.1
The state of the button.
| TCommandPosition aPosition | The position for command to be checked. |
| IMPORT_C TBool | IsCommandInGroup | ( | const TInt | aCommandId | ) | const |
Used to check if a certain command have been approved to the current command set
S60 3.2
ETrue if command is in control group, otherwise EFalse.
| const TInt aCommandId | The id for command which existence should be checked. |
| IMPORT_C TBool | IsCommandVisible | ( | TInt | aCommandId | ) | const |
Returns ETrue if the button with id aCommandId is visible. If two buttons have the same id, the results are undefined.
The state of the button.
| TInt aCommandId | The id for command to be checked. |
| IMPORT_C TBool | IsCommandVisibleByPosition | ( | TCommandPosition | aPosition | ) | const |
Returns ETrue if the button with position aPosition is visible.
S60 3.1
The state of the button.
| TCommandPosition aPosition | The position for command to be checked. |
| IMPORT_C TLocation | Location | ( | ) | const |
Gets the button group's location. Typically the button group is external to the view which is using it. In some cases, such as in dialogs with button panels, the button group is internal to the control which is using it.
The button group's location.
| IMPORT_C void | MakeCommandVisible | ( | TInt | aCommandId, |
| TBool | aVisible | |||
| ) | ||||
Sets the the button with id aCommandId to be visible if aVisible is ETrue. If two buttons have the same id, the button to be altered is undefined.
| IMPORT_C void | MakeCommandVisibleByPosition | ( | TCommandPosition | aPosition, |
| TBool | aVisible | |||
| ) | ||||
Sets the the button with position aPosition to be visible if aVisible is ETrue.
S60 3.1
| TCommandPosition aPosition | The position for command to be made visible. |
| TBool aVisible | EFalse for making button invisible. |
| 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. |
| IMPORT_C TInt | MaxCommands | ( | ) | const |
Gets the maximum number of buttons that can be supported by the device.
The number of command buttons supported.
| IMPORT_C TSize | MinimumSize | ( | ) | [virtual] |
From CCoeControl. Gets the control's minimum required size.
The minimum size required by the control.
| IMPORT_C CEikButtonGroupContainer * | NewL | ( | TUse | aUse, |
| TOrientation | aOrientation, | |||
| MEikCommandObserver * | aCommandObserver, | |||
| TInt | aResourceId, | |||
| TUint | aFlags = EAddToStack | |||
| ) | [static] | |||
Creates a button group container in its own window.
Button group container object.
| TUse aUse | The button group's type. |
| TOrientation aOrientation | The button group's orientation. You need specify this only for devices that can layout their buttons either horizontally or vertically. |
| MEikCommandObserver * aCommandObserver | A command observer to be notified of commands on the container. |
| TInt aResourceId | A resource containing descriptions of buttons in the group. This can be NULL if buttons are to be added dynamically. |
| TUint aFlags = EAddToStack | The button group's flags. |
| IMPORT_C CEikButtonGroupContainer * | NewL | ( | TUse | aUse, |
| TOrientation | aOrientation, | |||
| MEikCommandObserver * | aCommandObserver, | |||
| TInt | aResourceId, | |||
| const CCoeControl & | aParent, | |||
| TUint | aFlags = EAddToStack | |||
| ) | [static] | |||
Creates a button group container in its parent control's window.
Button group container object.
| TUse aUse | The button group's type. |
| TOrientation aOrientation | The button group's orientation. You need specify this only for devices that can layout their buttons either horizontally or vertically. |
| MEikCommandObserver * aCommandObserver | A command observer to be notified of commands on the container. |
| TInt aResourceId | A resource containing descriptions of buttons in the group. This can be NULL if buttons are to be added dynamically. |
| const CCoeControl & aParent | The control's parent. |
| TUint aFlags = EAddToStack | The button group's flags. |
| IMPORT_C CEikButtonGroupContainer * | NewL | ( | TUse | aUse, |
| TOrientation | aOrientation, | |||
| MEikCommandObserver * | aCommandObserver, | |||
| TInt | aResourceId, | |||
| RWindowGroup & | aParentWg, | |||
| TUint | aFlags = EAddToStack | |||
| ) | [static] | |||
Creates a button group container in given window group.
Button group container object.
| TUse aUse | The button group's type. |
| TOrientation aOrientation | The button group's orientation. You need specify this only for devices that can layout their buttons either horizontally or vertically. |
| MEikCommandObserver * aCommandObserver | A command observer to be notified of commands on the container. |
| TInt aResourceId | A resource containing descriptions of buttons in the group. This can be NULL if buttons are to be added dynamically. |
| RWindowGroup & aParentWg | The parent window group. |
| TUint aFlags = EAddToStack | The button group's flags. |
| IMPORT_C void | OfferCommandListL | ( | const RArray< TInt > & | aCommandList | ) |
Used to offer list of commands for softkeys.
S60 3.2
| IMPORT_C void | OfferCommandListL | ( | const TInt | aResourceId | ) |
Used to offer list of commands for softkeys.
S60 3.2
| const TInt aResourceId | Id for CBA resource that defines enhanced cba buttons. |
| IMPORT_C 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. |
| IMPORT_C TInt | PositionById | ( | TInt | aCommandId | ) | const |
Gets the position in the group of the button with the specified command Id. The return value is undefined if two buttons share the same id.
The command's container position.
| TInt aCommandId | Identifies the command. |
| IMPORT_C void | ReduceRect | ( | TRect & | aBoundingRect | ) | const |
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 | Rectangle to be modified. |
| IMPORT_C void | RemoveCommandFromStack | ( | TInt | aPosition, |
| TInt | aCommandId | |||
| ) | ||||
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.
| IMPORT_C void | RemoveCommandObserver | ( | TInt | aPos | ) |
Removes the temporary observer for the button at aPos, replacing it with the observer that was present when UpdateCommandObserverL() was called.
| TInt aPos | The button's position. |
| IMPORT_C void | ReplaceCommand | ( | const TInt | aCommandId, |
| const TInt | aResourceId | |||
| ) | ||||
Replaces command with another.
S60 3.2
| IMPORT_C void | Reserved_MtsmObject | ( | ) | [virtual] |
Formerly from MTopSetMember<CEikButtonGroupContainer>, now reserved.
| IMPORT_C void | Reserved_MtsmPosition | ( | ) | [virtual] |
Formerly from MTopSetMember<CEikButtonGroupContainer>, now reserved.
| IMPORT_C void | SetBoundingRect | ( | const TRect & | aRect | ) |
Sets the boundary rectangle for externally-positioned button groups. For use by EExternal button groups only.
| const TRect & aRect | The boundary rectangle to use. The button group attaches itself to the inside of this rectangle. |
| void | SetCommandL | ( | TInt | aPosition, |
| TInt | aCommandId, | |||
| const TDesC & | aText | |||
| ) | [inline] | |||
Sets a command button's text label and command ID.
| void | SetCommandL | ( | TInt | aPosition, |
| TInt | aCommandId, | |||
| const CFbsBitmap & | aBitmap, | |||
| const CFbsBitmap & | aMask | |||
| ) | [inline] | |||
Sets a command button's bitmap and command ID.
| TInt aPosition | The position within the button group of the button to change. If the position is out of range this function raises a panic. |
| TInt aCommandId | Command ID the button will send. |
| const CFbsBitmap & aBitmap | The bitmap for the button. |
| const CFbsBitmap & aMask | The mask bitmap for aBitmap. |
| void | SetCommandL | ( | TInt | aPosition, |
| TInt | aCommandId, | |||
| const TDesC & | aText, | |||
| const CFbsBitmap & | aBitmap, | |||
| const CFbsBitmap & | aMask | |||
| ) | [inline] | |||
Sets a command button's bitmap, text and command ID.
| TInt aPosition | The position within the button group of the button to change. If the position is out of range, the function raises a panic. |
| TInt aCommandId | Command ID the button will send. |
| const TDesC & aText | The text for the button. |
| const CFbsBitmap & aBitmap | The bitmap for the button. |
| const CFbsBitmap & aMask | The mask bitmap for aBitmap. |
| void | SetCommandL | ( | TInt | aPosition, |
| TInt | aCommandId, | |||
| const TDesC & | aFile, | |||
| TInt | aBitmapId, | |||
| TInt | aMaskId | |||
| ) | [inline] | |||
Sets a command button's bitmap and command ID. The bitmap and its mask are read from a file.
| TInt aPosition | The position within the button group of the button to change. If the position is out of range, the function raises a panic. |
| TInt aCommandId | Command ID the button will send. |
| const TDesC & aFile | A multi-bitmap file, containing mask and bitmap images. |
| TInt aBitmapId | ID of the bitmap within aFile. |
| TInt aMaskId | ID of the mask within aFile. |
| void | SetCommandL | ( | TInt | aPosition, |
| TInt | aCommandId, | |||
| const TDesC & | aText, | |||
| const TDesC & | aFile, | |||
| TInt | aBitmapId, | |||
| TInt | aMaskId | |||
| ) | [inline] | |||
Sets a command button's bitmap, text label and command ID. The bitmap and its mask are read from a file.
| TInt aPosition | The position within the button group of the button to change. If the position is out of range, the function raises a panic. |
| TInt aCommandId | Command ID the button will send. |
| const TDesC & aText | The text for the button. |
| const TDesC & aFile | A multi-bitmap file, containing mask and bitmap images. |
| TInt aBitmapId | ID of the bitmap within aFile. |
| TInt aMaskId | ID of the mask within aFile. |
| void | SetCommandL | ( | TInt | aPosition, |
| TInt | aResourceId | |||
| ) | [inline] | |||
Sets a command button's bitmap, text label and command ID. The bitmap, mask, text and command ID are all read from resource.
| void | SetCommandL | ( | TInt | aCommandId, |
| const TDesC & | aText | |||
| ) | [inline] | |||
Sets a command button's text. The button to change is identified by its command ID.
leave
KErrNotFound The ID cannot be matched to any button.
| void | SetCommandL | ( | TInt | aCommandId, |
| const CFbsBitmap & | aBitmap, | |||
| const CFbsBitmap & | aMask | |||
| ) | [inline] | |||
Sets a command button's bitmap and mask. The button to change is identified by its command ID.
leave
KErrNotFound The ID cannot be matched to any button.
| TInt aCommandId | Command ID of the button to change. |
| const CFbsBitmap & aBitmap | Bitmap for the button. |
| const CFbsBitmap & aMask | Mask bitmap for aBitmap. |
| void | SetCommandL | ( | TInt | aCommandId, |
| const TDesC & | aText, | |||
| const CFbsBitmap & | aBitmap, | |||
| const CFbsBitmap & | aMask | |||
| ) | [inline] | |||
Sets a command button's bitmap, mask and text. The button to change is identified by its command ID.
| TInt aCommandId | Command ID of the button to change. |
| const TDesC & aText | Text for the button. |
| const CFbsBitmap & aBitmap | Bitmap for the button. |
| const CFbsBitmap & aMask | Mask bitmap for aBitmap. |
| void | SetCommandL | ( | TInt | aCommandId, |
| const TDesC & | aFile, | |||
| TInt | aBitmapId, | |||
| TInt | aMaskId | |||
| ) | [inline] | |||
Sets a command button's bitmap and mask. The bitmap and mask are read from a multi bitmap file. The button to change is identified by its command ID.
| void | SetCommandL | ( | TInt | aCommandId, |
| const TDesC & | aText, | |||
| const TDesC & | aFile, | |||
| TInt | aBitmapId, | |||
| TInt | aMaskId | |||
| ) | [inline] | |||
Sets a command button's bitmap, mask and text. The bitmap and its mask are read from a multi bitmap file. The button to change is identified by its command ID.
| IMPORT_C void | SetCommandSetL | ( | TInt | aResourceId | ) |
Initialises the group of command buttons from a resource.
| TInt aResourceId | ID of the resource structure specifying the command buttons. |
| IMPORT_C void | SetDefaultCommand | ( | TInt | aCommandId | ) |
Sets the default command ID for buttons in this container.
| TInt aCommandId | Command to issue if no other is specified. |
| IMPORT_C void | UpdateCommandObserverL | ( | TInt | aPos, |
| MEikCommandObserver & | aCommandObserver | |||
| ) | ||||
Changes the command observer for the button at aPos to aCommandObserver. Panics if an updated observer is already present. This function should be followed by RemoveCommandObserver() when you need to put back the original observer.
| TInt aPos | The button's position. |
| MEikCommandObserver & aCommandObserver | The command observer. |
| IMPORT_C void | UpdateHotKey | ( | TInt | aCommandId, |
| THotKeyFlags | aFlags, | |||
| TInt | aKeyId | |||
| ) | ||||
Updates a command's hotkey and whether the key is displayed. This function is only supported by containers being used for dialog buttons.
| TInt aCommandId | Identifies the command to update. |
| THotKeyFlags aFlags | Whether to display the hotkey. |
| TInt aKeyId | Hotkey identifier. |
| void | UpdateMSKCommandObserver | ( | CEikListBox * | aMSKObserverOwner, |
| MEikCommandObserver * | aCommandObserver | |||
| ) | ||||
Internal method for setting markable list's MSK observer. This observer is called before default CBA observer if MSK is pressed. Observer is removed by passing NULL as parameter.
S60 3.1
| CEikListBox * aMSKObserverOwner | |
| MEikCommandObserver * aCommandObserver |
| IMPORT_C TBool | UpdatedCommandObserverExists | ( | TCommandPosition | aPosition | ) | const |
Checks for existence of updated command observer for the button at aPosition.
S60 3.2
ETrue, if updated command observer exists.
| TCommandPosition aPosition | The position for button to be checked. |
| IMPORT_C void | WriteInternalStateL | ( | RWriteStream & | aWriteStream | ) | const [virtual] |
From CCoeControl. Writes the internal state of the control and its components to aStream. Does nothing in release mode.
| RWriteStream & aWriteStream | The output stream. |
Defines the positions for each command.
| ELeftSoftkeyPosition = 0 | |
| ERightSoftkeyPosition = 2 | |
| EMiddleSoftkeyPosition = 3 |
Additional flags.
| EAddToStack = 0x01 | |
| EDelayActivation = 0x02 | |
| EUseMaxSize = 0x04 | |
| EIsEmbedded = 0x08 | |
| EParentIsControl = 0x10 |
Flags for the display of hotkeys.
| EShowHotKey = 0x01 | |
| EPlainHotKey = 0x02 |
Relative positions of the container and the control which uses it.
| EInternal = SLafButtonGroupContainer::EInternal |
The button group is internal to the control which is using it. E.g. dialog buttons. |
| EExternal = SLafButtonGroupContainer::EExternal |
The button group is external to the control which is using it. E.g. toolbar or cba. |
Describes the orientation of the container.
| EVertical = SLafButtonGroupContainer::EVertical | |
| EHorizontal = SLafButtonGroupContainer::EHorizontal |
Describes how the container is being used.
The enumeration is used by the system to create the appropriate (UI variant-specific) button group for the specified type.
| EView = SLafButtonGroupContainer::EView | |
| EDialog = SLafButtonGroupContainer::EDialog | |
| EToolbar = SLafButtonGroupContainer::EToolbar | |
| ECba = SLafButtonGroupContainer::ECba | |
| EDialogButtons = SLafButtonGroupContainer::EDialogButtons |