#include <mw/eiklbbut.h>
| class CEikLabeledButton : public CAknControl |
| Public Member Enumerations | |
|---|---|
| enum | TFlags { EShowHotKey, EPlainHotKey } |
| Public Member Functions | |
|---|---|
| CEikLabeledButton() | |
| ~CEikLabeledButton() | |
| IMPORT_C void | Animate() |
| IMPORT_C CEikCommandButtonBase * | Button() |
| virtual IMPORT_C void | ConstructFromResourceL(TResourceReader &) |
| IMPORT_C void | ConstructL(CEikCommandButtonBase *, TInt, TInt) |
| virtual IMPORT_C void | GetColorUseListL(CArrayFix< TCoeColorUse > &) |
| virtual IMPORT_C void | HandlePointerEventL(const TPointerEvent &) |
| virtual IMPORT_C void | HandleResourceChange(TInt) |
| IMPORT_C TInt | HotKeyCode() |
| virtual IMPORT_C TCoeInputCapabilities | InputCapabilities() |
| IMPORT_C CEikLabel * | Label() |
| virtual IMPORT_C TSize | MinimumSize() |
| virtual IMPORT_C TKeyResponse | OfferKeyEventL(const TKeyEvent &, TEventCode) |
| IMPORT_C TBool | PlainHotKey() |
| virtual IMPORT_C void | SetContainerWindowL(const CCoeControl &) |
| virtual IMPORT_C void | SetDimmed(TBool) |
| IMPORT_C TBool | ShowsHotKey() |
| IMPORT_C void | UpdateHotKey(TInt, TFlags) |
| Protected Member Functions | |
|---|---|
| virtual IMPORT_C void | WriteInternalStateL(RWriteStream &) |
| Inherited Attributes | |
|---|---|
| CCoeControl::iCoeEnv | |
| CCoeControl::iContext | |
| CCoeControl::iPosition | |
| CCoeControl::iSize | |
| Inherited Enumerations | |
|---|---|
| CCoeControl:TZoomType | |
This class combines a command button with a label and a hotkey binding.
The label is used to display a text describing a hotkey. The hotkey is set via API or resource, as the ASCII code of the key that is combined with CTRL to form the hotkey combination. E.g. setting the hotkey to decimal 65 will bind CTRL+'A' as the hotkey. "CTRL+A" will be displayed in the label.
This class does not implement S60 look-and-feel and is not skinned.
| IMPORT_C CEikCommandButtonBase * | Button | ( | ) | const |
Access to the button component of the labeled button
Returns: Pointer to the button component. No ownership is transferred.
| IMPORT_C void | ConstructFromResourceL | ( | TResourceReader & | aReader | ) | [virtual] |
Reimplemented from CCoeControl::ConstructFromResourceL(TResourceReader &)
From CCoeControl
Construct the object from resource
| Parameter | Description |
|---|---|
| aReader | Fully constructed resource reader |
| IMPORT_C void | ConstructL | ( | CEikCommandButtonBase * | aButton, |
| TInt | aHotKeyCode, | |||
| TInt | aFlags | |||
| ) | ||||
2nd Stage constructor
| Parameter | Description |
|---|---|
| aButton | Sets the button to use as the active part of the CEikLabeledButton |
| IMPORT_C void | GetColorUseListL | ( | CArrayFix< TCoeColorUse > & | aColorUseList | ) | const [virtual] |
Reimplemented from CCoeControl::GetColorUseListL(CArrayFix< TCoeColorUse > &)const
From CCoeControl
Obtain the list of colors to be used by this control
| IMPORT_C void | HandlePointerEventL | ( | const TPointerEvent & | aPointerEvent | ) | [virtual] |
Reimplemented from CCoeControl::HandlePointerEventL(const TPointerEvent &)
From CCoeControl
Handle a pointer event coming from the CONE framework
| Parameter | Description |
|---|---|
| aPointerEvent | Event to handle |
| IMPORT_C void | HandleResourceChange | ( | TInt | aType | ) | [virtual] |
Reimplemented from CCoeControl::HandleResourceChange(TInt)
From CCoeControl
This is called when resource or layout or other display-affecting setting has changed. Change the internals of the control so that it is ready for a subsequent SizeChanged call.
| Parameter | Description |
|---|---|
| aType | Type of resource or setting that has changed |
| IMPORT_C TCoeInputCapabilities | InputCapabilities | ( | ) | const [virtual] |
Reimplemented from CCoeControl::InputCapabilities()const
From CCoeControl
Report the input capabilities of the control
Returns: A copy of the object holding the capabilities of this control
| IMPORT_C CEikLabel * | Label | ( | ) | const |
Access to the label component of the labeled button
Returns: Pointer to the CEikLabel component. No ownership is transferred.
| IMPORT_C TSize | MinimumSize | ( | ) | [virtual] |
Reimplemented from CCoeControl::MinimumSize()
From CCoeControl
Reports to the caller the minimum size that the control can be, given its contents.
Returns: The minimum size
| IMPORT_C TKeyResponse | OfferKeyEventL | ( | const TKeyEvent & | aKeyEvent, |
| TEventCode | aType | |||
| ) | [virtual] | |||
Reimplemented from CCoeControl::OfferKeyEventL(const TKeyEvent &,TEventCode)
From CCoeControl
CONE framework is requesting that the passed-in key be handled.
| Parameter | Description |
|---|---|
| aKeyEvent | Wserv event type |
| IMPORT_C TBool | PlainHotKey | ( | ) | const |
Access the key display mode
Returns: EFalse if the key mode is not set to Plain
| IMPORT_C void | SetContainerWindowL | ( | const CCoeControl & | aContainer | ) | [virtual] |
Reimplemented from CCoeControl::SetContainerWindowL(const CCoeControl &)
From CCoeControl
Sets the control whose window is to be used as a container for this control
| Parameter | Description |
|---|---|
| aContainer | control |
| IMPORT_C void | SetDimmed | ( | TBool | aDimmed | ) | [virtual] |
Reimplemented from CCoeControl::SetDimmed(TBool)
From CCoeControl
Sets the button to be inactive. The button is drawn with a dimmed effect.
| Parameter | Description |
|---|---|
| aDimmed | If not EFalse, set the state to dimmed. Otherwise set to non-dimmed |
| IMPORT_C TBool | ShowsHotKey | ( | ) | const |
Access to hot key setting
Returns: EFase iff ShowsHotKeys is not set
| IMPORT_C void | WriteInternalStateL | ( | RWriteStream & | aWriteStream | ) | const [protected, virtual] |
Reimplemented from CCoeControl::WriteInternalStateL(RWriteStream &)const
From CCoeControl
Serialize the state of the control
| Parameter | Description |
|---|---|
| aWriteStream | Output stream for the serialization |