»
UIQ 3.1 SDK »
UIQ API reference »
C++ component reference »
QEikStd »
CEikButtonGroupContainer
Location:
EIKBTGPC.H
Link against: eikcoctl.lib
Class CEikButtonGroupContainer
| Interface status: | deprecated | 6.0
|
class CEikButtonGroupContainer : public CCoeControl, public MEikCommandObserver;
Description
Provides a wrapper around the different button arrays used in both pen, and no-pen devices. Requesting aUse as either EView or EDialog will create the default button set for the host device; the other options are included primarily for testing.
Derivation
MEikCommandObserver - Command observers respond to user commands, and have the secondary function of creating custom controls on request for classes such as CEikToolbar, or user-defined classes
MObjectProvider - An interface that allows an object to be part of a network of object providersCBase - Base class for all classes to be instantiated on the heapCCoeControl - Control base class from which all other controls are derivedCEikButtonGroupContainer - Provides a wrapper around the different button arrays used in both pen, and no-pen devices
Members
Defined in CEikButtonGroupContainer:
AddCommandL(), AddCommandL(), AddCommandL(), AddCommandL(), AddCommandL(), AddCommandSetToStackL(), AddCommandToStackL(), AddCommandToStackL(), AddCommandToStackL(), AddCommandToStackL(), AddCommandToStackL(), AddCommandToStackL(), AnimateCommand(), ButtonById(), ButtonCount(), CalcMinimumSizeL(), CleanupCommandPop(), CleanupCommandPop(), CleanupCommandPopAndDestroy(), CleanupCommandPopAndDestroy(), CleanupCommandPushL(), CommandButtonOrNull(), CommandIds(), ComponentControl(), ControlOrNull(), CountComponentControls(), CreateCustomCommandControlL(), Current(), DelayActivation(), DimCommand(), EAddToStack, EDelayActivation, EDeviceCustomEnd, EDeviceCustomStart, EDialog, EDialogButtons, EExternal, EHorizontal, EInternal, EPlainHotKey, EShowHotKey, EToolbar, EUseMaxSize, EVertical, EView, IsCommandDimmed(), IsCommandVisible(), Location(), MakeCommandVisible(), MaxCommands(), MinimumSize(), NewL(), NewL(), OfferKeyEventL(), PositionById(), ProcessCommandL(), ReduceRect(), RemoveCommandFromStack(), RemoveCommandObserver(), SetBoundingRect(), SetCommandL(), SetCommandL(), SetCommandL(), SetCommandL(), SetCommandL(), SetCommandL(), SetCommandL(), SetCommandL(), SetCommandL(), SetCommandL(), SetCommandL(), SetCommandSetL(), SetDefaultCommand(), SizeChanged(), TFlags, THotKeyFlags, TLocation, TOrientation, TUse, UpdateCommandObserverL(), UpdateHotKey(), WriteInternalStateL(), ~CEikButtonGroupContainer()
Inherited from CBase:
Delete(),
Extension_(),
operator new()
Inherited from CCoeControl:
AccumulatedZoom(),
ActivateGc(),
ActivateL(),
BackedUpWindow(),
Background(),
CapturesPointer(),
ClaimPointerGrab(),
CloseWindow(),
ComponentArrayExists(),
Components(),
ConstructFromResourceL(),
ControlContext(),
ControlEnv(),
CopyControlContextFrom(),
CreateBackedUpWindowL(),
CreateWindowL(),
DeactivateGc(),
Draw(),
DrawBackground(),
DrawDeferred(),
DrawForeground(),
DrawNow(),
DrawableWindow(),
EAbsoluteZoom,
ERelativeZoom,
EnableDragEvents(),
FindBackground(),
FindFontProvider(),
FocusChanged(),
GetColor(),
GetColorUseListL(),
GetGc(),
GetHelpContext(),
GetTextDrawer(),
GrabbingComponent(),
HandleComponentControlsResourceChange(),
HandleControlArrayEventL(),
HandlePointerBufferReadyL(),
HandlePointerEventL(),
HandleRedrawEvent(),
HandleResourceChange(),
HasBorder(),
HitTest(),
IgnoreEventsUntilNextPointerUp(),
Index(),
InitComponentArrayL(),
InputCapabilities(),
IsActivated(),
IsBackedUp(),
IsBeingDestroyed(),
IsBlank(),
IsDimmed(),
IsFocused(),
IsNonFocusing(),
IsReadyToDraw(),
IsVisible(),
LayoutManager(),
MakeVisible(),
MaximumWidth(),
MopNext(),
MopSupplyObject(),
Observer(),
OverrideColorL(),
OwnsWindow(),
Parent(),
Position(),
PositionChanged(),
PositionRelativeToScreen(),
PrepareForFocusGainL(),
PrepareForFocusLossL(),
Rect(),
RecursivelyMergedInputCapabilities(),
ReportEventL(),
RequestRelayout(),
Reserved_2(),
ResetGc(),
ScreenFont(),
SetAdjacent(),
SetAllowStrayPointers(),
SetBackground(),
SetBlank(),
SetCanDrawOutsideRect(),
SetComponentsToInheritVisibility(),
SetContainerWindowL(),
SetControlContext(),
SetCornerAndSize(),
SetDimmed(),
SetExtent(),
SetExtentToWholeScreen(),
SetFocus(),
SetFocusing(),
SetFontProviderL(),
SetGc(),
SetGloballyCapturing(),
SetHitTest(),
SetLayoutManagerL(),
SetMaximumWidth(),
SetMopParent(),
SetNeighbor(),
SetNonFocusing(),
SetObserver(),
SetParent(),
SetPointerCapture(),
SetPosition(),
SetRect(),
SetSize(),
SetSizeWithoutNotification(),
SetTextBaselineSpacing(),
SetUniqueHandle(),
SetZoomFactorL(),
Size(),
SystemGc(),
TZoomType,
TextBaselineOffset(),
TextDrawer(),
UniqueHandle(),
Window(),
ZoomWithType(),
iCoeEnv,
iContext,
iPosition,
iSize
Inherited from MEikCommandObserver:
MEikCommandObserver_Reserved1(),
MEikCommandObserver_Reserved2()
Inherited from MObjectProvider:
MObjectProvider_Reserved1(),
MObjectProvider_Reserved2(),
MopGetObject(),
MopGetObjectNoChaining()
Construction and destruction
| Interface status: | deprecated | Inherited from: CEikButtonGroupContainer |
static IMPORT_C CEikButtonGroupContainer *NewL(TUse aUse, TOrientation aOrientation, MEikCommandObserver *aCommandObserver, TInt aResourceId, TUint aFlags=EAddToStack);
Description
Creates a button group container in its own window. Requesting aUse as either EView or EDialog will create the default button set for the host device; the other options are included primarily for testing. aOrientation is required only for dialogs on pen based machines that may layout their buttons either horizontally or vertically. aResourceId may be NULL if buttons are to be added dynamically.
Parameters
Return value
| Interface status: | deprecated | Inherited from: CEikButtonGroupContainer |
static IMPORT_C CEikButtonGroupContainer *NewL(TUse aUse, TOrientation aOrientation, MEikCommandObserver *aCommandObserver, TInt aResourceId, const CCoeControl &aParent, TUint aFlags=EAddToStack);
Description
Creates a button group container in its own window, or if specified, in its parent control's window.
Parameters
Return value
~CEikButtonGroupContainer()
| Interface status: | deprecated | Inherited from: CEikButtonGroupContainer |
IMPORT_C ~CEikButtonGroupContainer();
Description
Destructor.
| Interface status: | deprecated | Inherited from: CEikButtonGroupContainer |
static IMPORT_C CEikButtonGroupContainer *Current();
Description
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.
Return value
| Interface status: | deprecated | Inherited from: CEikButtonGroupContainer |
inline void SetCommandL(TInt aPosition, TInt aCommandId, const TDesC &aText);
Description
Sets a command button's content, overwriting any previous contents at that position.
There are several overloads of this function which allow the command button's image and text to be optionally set. All these functions will raise a panic if the supplied position is out of range.If an image is set, a mask must also be specified to guarantee compliance with different colour schemes. Ownership of bitmap arguments is transferred at the end of the function.If a button position is not supplied, CEikButtonGroupContainer attempts to identify which button to overwrite by command ID. If two buttons have the same ID, which will be altered is not defined. The behaviour is also undefined if aCommandId can't be matched to any button.
Parameters
| Interface status: | deprecated | Inherited from: CEikButtonGroupContainer |
inline void SetCommandL(TInt aPosition, TInt aCommandId, const CFbsBitmap &aBitmap, const CFbsBitmap &aMask);
Description
Sets a command button's content, overwriting any previous contents at that position.
There are several overloads of this function which allow the command button's image and text to be optionally set. All these functions will raise a panic if the supplied position is out of range.If an image is set, a mask must also be specified to guarantee compliance with different colour schemes. Ownership of bitmap arguments is transferred at the end of the function.If a button position is not supplied, CEikButtonGroupContainer attempts to identify which button to overwrite by command ID. If two buttons have the same ID, which will be altered is not defined. The behaviour is also undefined if aCommandId can't be matched to any button.
Parameters
| Interface status: | deprecated | Inherited from: CEikButtonGroupContainer |
inline void SetCommandL(TInt aPosition, TInt aCommandId, const TDesC &aText, const CFbsBitmap &aBitmap, const CFbsBitmap &aMask);
Description
Sets a command button's content, overwriting any previous contents at that position.
There are several overloads of this function which allow the command button's image and text to be optionally set. All these functions will raise a panic if the supplied position is out of range.If an image is set, a mask must also be specified to guarantee compliance with different colour schemes. Ownership of bitmap arguments is transferred at the end of the function.If a button position is not supplied, CEikButtonGroupContainer attempts to identify which button to overwrite by command ID. If two buttons have the same ID, which will be altered is not defined. The behaviour is also undefined if aCommandId can't be matched to any button.
Parameters
| Interface status: | deprecated | Inherited from: CEikButtonGroupContainer |
inline void SetCommandL(TInt aPosition, TInt aCommandId, const TDesC &aFile, TInt aBitmapId, TInt aMaskId);
Description
Sets a command button's content, overwriting any previous contents at that position.
There are several overloads of this function which allow the command button's image and text to be optionally set. All these functions will raise a panic if the supplied position is out of range.If an image is set, a mask must also be specified to guarantee compliance with different colour schemes. Ownership of bitmap arguments is transferred at the end of the function.If a button position is not supplied, CEikButtonGroupContainer attempts to identify which button to overwrite by command ID. If two buttons have the same ID, which will be altered is not defined. The behaviour is also undefined if aCommandId can't be matched to any button.
Parameters
| Interface status: | deprecated | Inherited from: CEikButtonGroupContainer |
inline void SetCommandL(TInt aPosition, TInt aCommandId, const TDesC &aText, const TDesC &aFile, TInt aBitmapId, TInt aMaskId);
Description
Sets a command button's content, overwriting any previous contents at that position.
There are several overloads of this function which allow the command button's image and text to be optionally set. All these functions will raise a panic if the supplied position is out of range.If an image is set, a mask must also be specified to guarantee compliance with different colour schemes. Ownership of bitmap arguments is transferred at the end of the function.If a button position is not supplied, CEikButtonGroupContainer attempts to identify which button to overwrite by command ID. If two buttons have the same ID, which will be altered is not defined. The behaviour is also undefined if aCommandId can't be matched to any button.
Parameters
| Interface status: | deprecated | Inherited from: CEikButtonGroupContainer |
inline void SetCommandL(TInt aPosition, TInt aResourceId);
Description
Sets a command button's content, overwriting any previous contents at that position.
There are several overloads of this function which allow the command button's image and text to be optionally set. All these functions will raise a panic if the supplied position is out of range.If an image is set, a mask must also be specified to guarantee compliance with different colour schemes. Ownership of bitmap arguments is transferred at the end of the function.If a button position is not supplied, CEikButtonGroupContainer attempts to identify which button to overwrite by command ID. If two buttons have the same ID, which will be altered is not defined. The behaviour is also undefined if aCommandId can't be matched to any button.
Parameters
| Interface status: | deprecated | Inherited from: CEikButtonGroupContainer |
inline void SetCommandL(TInt aCommandId, const TDesC &aText);
Description
Sets a command button's content, overwriting any previous contents at that position.
There are several overloads of this function which allow the command button's image and text to be optionally set. All these functions will raise a panic if the supplied position is out of range.If an image is set, a mask must also be specified to guarantee compliance with different colour schemes. Ownership of bitmap arguments is transferred at the end of the function.If a button position is not supplied, CEikButtonGroupContainer attempts to identify which button to overwrite by command ID. If two buttons have the same ID, which will be altered is not defined. The behaviour is also undefined if aCommandId can't be matched to any button.
Parameters
| Interface status: | deprecated | Inherited from: CEikButtonGroupContainer |
inline void SetCommandL(TInt aCommandId, const CFbsBitmap &aBitmap, const CFbsBitmap &aMask);
Description
Sets a command button's content, overwriting any previous contents at that position.
There are several overloads of this function which allow the command button's image and text to be optionally set. All these functions will raise a panic if the supplied position is out of range.If an image is set, a mask must also be specified to guarantee compliance with different colour schemes. Ownership of bitmap arguments is transferred at the end of the function.If a button position is not supplied, CEikButtonGroupContainer attempts to identify which button to overwrite by command ID. If two buttons have the same ID, which will be altered is not defined. The behaviour is also undefined if aCommandId can't be matched to any button.
Parameters
| Interface status: | deprecated | Inherited from: CEikButtonGroupContainer |
inline void SetCommandL(TInt aCommandId, const TDesC &aText, const CFbsBitmap &aBitmap, const CFbsBitmap &aMask);
Description
Sets a command button's content, overwriting any previous contents at that position.
There are several overloads of this function which allow the command button's image and text to be optionally set. All these functions will raise a panic if the supplied position is out of range.If an image is set, a mask must also be specified to guarantee compliance with different colour schemes. Ownership of bitmap arguments is transferred at the end of the function.If a button position is not supplied, CEikButtonGroupContainer attempts to identify which button to overwrite by command ID. If two buttons have the same ID, which will be altered is not defined. The behaviour is also undefined if aCommandId can't be matched to any button.
Parameters
| Interface status: | deprecated | Inherited from: CEikButtonGroupContainer |
inline void SetCommandL(TInt aCommandId, const TDesC &aFile, TInt aBitmapId, TInt aMaskId);
Description
Sets a command button's content, overwriting any previous contents at that position.
There are several overloads of this function which allow the command button's image and text to be optionally set. All these functions will raise a panic if the supplied position is out of range.If an image is set, a mask must also be specified to guarantee compliance with different colour schemes. Ownership of bitmap arguments is transferred at the end of the function.If a button position is not supplied, CEikButtonGroupContainer attempts to identify which button to overwrite by command ID. If two buttons have the same ID, which will be altered is not defined. The behaviour is also undefined if aCommandId can't be matched to any button.
Parameters
| Interface status: | deprecated | Inherited from: CEikButtonGroupContainer |
inline void SetCommandL(TInt aCommandId, const TDesC &aText, const TDesC &aFile, TInt aBitmapId, TInt aMaskId);
Description
Sets a command button's content, overwriting any previous contents at that position.
There are several overloads of this function which allow the command button's image and text to be optionally set. All these functions will raise a panic if the supplied position is out of range.If an image is set, a mask must also be specified to guarantee compliance with different colour schemes. Ownership of bitmap arguments is transferred at the end of the function.If a button position is not supplied, CEikButtonGroupContainer attempts to identify which button to overwrite by command ID. If two buttons have the same ID, which will be altered is not defined. The behaviour is also undefined if aCommandId can't be matched to any button.
Parameters
| Interface status: | deprecated | Inherited from: CEikButtonGroupContainer |
IMPORT_C void SetCommandSetL(TInt aResourceId);
Description
Sets the buttons' text, bitmaps and command ids from a resource.
The type of resource depends on the type of button.
Parameters
| Interface status: | deprecated | Inherited from: CEikButtonGroupContainer |
inline void AddCommandL(TInt aPosition, TInt aCommandId, const TDesC &aText);
Description
Adds a command button at the specified position in the container.
The button may have an optional text string or a bitmap image; bitmaps may optionally have a mask.
Parameters
| Interface status: | deprecated | Inherited from: CEikButtonGroupContainer |
inline void AddCommandL(TInt aPosition, TInt aCommandId, const CFbsBitmap &aBitmap, const CFbsBitmap &aMask);
Description
Adds a command button at the specified position in the container.
The button may have an optional text string or a bitmap image; bitmaps may optionally have a mask.
Parameters
| Interface status: | deprecated | Inherited from: CEikButtonGroupContainer |
inline void AddCommandL(TInt aPosition, TInt aCommandId, const TDesC &aText, const CFbsBitmap &aBitmap, const CFbsBitmap &aMask);
Description
Adds a command button at the specified position in the container.
The button may have an optional text string or a bitmap image; bitmaps may optionally have a mask.
Parameters
| Interface status: | deprecated | Inherited from: CEikButtonGroupContainer |
inline void AddCommandL(TInt aPosition, TInt aCommandId, const TDesC &aFile, TInt aBitmapId, TInt aMaskId);
Description
Adds a button containing the bitmaps specified at aPosition. Panics if aPosition is out of range.
Parameters
| Interface status: | deprecated | Inherited from: CEikButtonGroupContainer |
inline void AddCommandL(TInt aPosition, TInt aCommandId, const TDesC &aText, const TDesC &aFile, TInt aBitmapId, TInt aMaskId);
Description
Adds a command button at the specified position in the container.
The button may have an optional text string or a bitmap image; bitmaps may optionally have a mask.
Parameters
| Interface status: | deprecated | Inherited from: CEikButtonGroupContainer |
inline void AddCommandToStackL(TInt aPosition, TInt aCommandId, const TDesC &aText);
Description
Pushes a command button onto a position's button stack.
As with SetCommandL() but allows the previous command to be retrieved at any time by calling RemoveCommand() . There are several overloads of this function which allow the command button's image and text to be optionally set. All these functions will raise a panic if the supplied position is out of range.If an image is set, a mask must also be specified to guarantee compliance with different colour schemes. Ownership of bitmap arguments is transferred at the end of the function.If a button position is not supplied, CEikButtonGroupContainer attempts to identify which button to overwrite by command ID. If two buttons have the same ID, which will be altered is not defined. The behaviour is also undefined if aCommandId can't be matched to any button.
Parameters
| Interface status: | deprecated | Inherited from: CEikButtonGroupContainer |
inline void AddCommandToStackL(TInt aPosition, TInt aCommandId, const CFbsBitmap &aBitmap, const CFbsBitmap &aMask);
Description
Pushes a command button onto a position's button stack.
As with SetCommandL() but allows the previous command to be retrieved at any time by calling RemoveCommand() . There are several overloads of this function which allow the command button's image and text to be optionally set. All these functions will raise a panic if the supplied position is out of range.If an image is set, a mask must also be specified to guarantee compliance with different colour schemes. Ownership of bitmap arguments is transferred at the end of the function.If a button position is not supplied, CEikButtonGroupContainer attempts to identify which button to overwrite by command ID. If two buttons have the same ID, which will be altered is not defined. The behaviour is also undefined if aCommandId can't be matched to any button.
Parameters
| Interface status: | deprecated | Inherited from: CEikButtonGroupContainer |
inline void AddCommandToStackL(TInt aPosition, TInt aCommandId, const TDesC &aText, const CFbsBitmap &aBitmap, const CFbsBitmap &aMask);
Description
Pushes a command button onto a position's button stack.
As with SetCommandL() but allows the previous command to be retrieved at any time by calling RemoveCommand() . There are several overloads of this function which allow the command button's image and text to be optionally set. All these functions will raise a panic if the supplied position is out of range.If an image is set, a mask must also be specified to guarantee compliance with different colour schemes. Ownership of bitmap arguments is transferred at the end of the function.If a button position is not supplied, CEikButtonGroupContainer attempts to identify which button to overwrite by command ID. If two buttons have the same ID, which will be altered is not defined. The behaviour is also undefined if aCommandId can't be matched to any button.
Parameters
| Interface status: | deprecated | Inherited from: CEikButtonGroupContainer |
inline void AddCommandToStackL(TInt aPosition, TInt aCommandId, const TDesC &aFile, TInt aBitmapId, TInt aMaskId);
Description
Pushes a command button onto a position's button stack.
As with SetCommandL() but allows the previous command to be retrieved at any time by calling RemoveCommand() . There are several overloads of this function which allow the command button's image and text to be optionally set. All these functions will raise a panic if the supplied position is out of range.If an image is set, a mask must also be specified to guarantee compliance with different colour schemes. Ownership of bitmap arguments is transferred at the end of the function.If a button position is not supplied, CEikButtonGroupContainer attempts to identify which button to overwrite by command ID. If two buttons have the same ID, which will be altered is not defined. The behaviour is also undefined if aCommandId can't be matched to any button.
Parameters
| Interface status: | deprecated | Inherited from: CEikButtonGroupContainer |
inline void AddCommandToStackL(TInt aPosition, TInt aCommandId, const TDesC &aText, const TDesC &aFile, TInt aBitmapId, TInt aMaskId);
Description
Pushes a command button onto a position's button stack.
As with SetCommandL() but allows the previous command to be retrieved at any time by calling RemoveCommand() . There are several overloads of this function which allow the command button's image and text to be optionally set. All these functions will raise a panic if the supplied position is out of range.If an image is set, a mask must also be specified to guarantee compliance with different colour schemes. Ownership of bitmap arguments is transferred at the end of the function.If a button position is not supplied, CEikButtonGroupContainer attempts to identify which button to overwrite by command ID. If two buttons have the same ID, which will be altered is not defined. The behaviour is also undefined if aCommandId can't be matched to any button.
Parameters
| Interface status: | deprecated | Inherited from: CEikButtonGroupContainer |
inline void AddCommandToStackL(TInt aPosition, TInt aResourceId);
Description
Pushes a command button onto a position's button stack.
As with SetCommandL() but allows the previous command to be retrieved at any time by calling RemoveCommand() . There are several overloads of this function which allow the command button's image and text to be optionally set. All these functions will raise a panic if the supplied position is out of range.If an image is set, a mask must also be specified to guarantee compliance with different colour schemes. Ownership of bitmap arguments is transferred at the end of the function.If a button position is not supplied, CEikButtonGroupContainer attempts to identify which button to overwrite by command ID. If two buttons have the same ID, which will be altered is not defined. The behaviour is also undefined if aCommandId can't be matched to any button.
Parameters
| Interface status: | deprecated | Inherited from: CEikButtonGroupContainer |
IMPORT_C void AddCommandSetToStackL(TInt aResourceId);
Description
As with SetCommandL() but for a set of buttons, also allows the previous command to be retrieved at any time by calling RemoveCommand() .
Parameters
| Interface status: | deprecated | Inherited from: CEikButtonGroupContainer |
IMPORT_C void RemoveCommandFromStack(TInt aPosition, TInt aCommandId);
Description
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 .
Parameters
| Interface status: | deprecated | Inherited from: CEikButtonGroupContainer |
IMPORT_C void SetDefaultCommand(TInt aCommandId);
Description
Sets the default command ID for buttons in this container.
Parameters
| Interface status: | deprecated | Inherited from: CEikButtonGroupContainer |
IMPORT_C TSize CalcMinimumSizeL(TInt aResourceId) const;
Description
Calculates minimum size required to display the buttons defined in the specified resource structure.
Parameters
Return value
TSize
|
"TSize" Minimum size required to display the button group defined in the specified resource structure. |
|
| Interface status: | deprecated | Inherited from: CEikButtonGroupContainer |
IMPORT_C void CleanupCommandPushL(TInt aPosition);
Description
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.
Parameters
![[Index]](../../../../../_stock/btn_index_wt.gif){kind=small}
![[Spacer]](../../../../../_stock/btn_spacer.gif){kind=small}
![[Previous]](../../../../../_stock/btn_prev_wt.gif){kind=small}
![[Next]](../../../../../_stock/btn_next_wt.gif){kind=small}
![[Top]](../../../../../_stock/arrow_up_2.gif){kind=icon}