| class CEikButtonBase : public CEikBorderedControl |
Base class for button controls
This class defines behavior available to all button classes.
eikcoctl S60 1.0
| Public Member Functions | |
|---|---|
| CEikButtonBase() | |
| ~CEikButtonBase() | |
| IMPORT_C void | Animate() |
| IMPORT_C void | GetColorUseListL(CArrayFix< TCoeColorUse > &) |
| IMPORT_C void | HandlePointerEventL(const TPointerEvent &) |
| IMPORT_C void | HandleResourceChange(TInt) |
| IMPORT_C TCoeInputCapabilities | InputCapabilities() |
| IMPORT_C TKeyResponse | OfferKeyEventL(const TKeyEvent &, TEventCode) |
| IMPORT_C void | SetBehavior(TButtonBehavior) |
| IMPORT_C void | SetCoordinator(TEikButtonCoordinator *) |
| IMPORT_C void | SetIgnoreNextPointerUp() |
| IMPORT_C void | SetState(TState) |
| IMPORT_C TState | State() |
| IMPORT_C void | WriteInternalStateL(RWriteStream &) |
| Protected Member Functions | |
|---|---|
| IMPORT_C void | CopyDrawStateTo(CEikButtonBase *) |
| IMPORT_C TDrawState | DrawState() |
| IMPORT_C TBool | IsPressed() |
| IMPORT_C void | SetAllowTristate() |
| IMPORT_C void | SetReportOnPointerDown() |
| Private Member Functions | |
|---|---|
| TBool | ClickCompleted() |
| IMPORT_C void * | ExtensionInterface(TUid) |
| IMPORT_C void | Reserved_2() |
| IMPORT_C void | Reserved_3() |
| IMPORT_C void | StateChanged() |
| Public Member Enumerations | |
|---|---|
| enum | TState { EClear = 0, ESet = 1, EIndeterminate = 2 } |
| Protected Member Enumerations | |
|---|---|
| enum | TDrawState { EDrawClear = SLafButtonBase::EDrawClear, EDrawSet = SLafButtonBase::EDrawSet, EDrawIndeterminate = SLafButtonBase::EDrawIndeterminate, EDrawClearPressed = SLafButtonBase::EDrawClearPressed, EDrawSetPressed = SLafButtonBase::EDrawSetPressed, EDrawIndeterminatePressed = SLafButtonBase::EDrawIndeterminatePressed } |
| Inherited Enumerations | |
|---|---|
| CCoeControl:TZoomType | |
| Protected Attributes | |
|---|---|
| TInt | iButFlags |
| Private Attributes | |
|---|---|
| TEikButtonCoordinator * | iButCoord |
| TInt | iSpare |
| Inherited Attributes | |
|---|---|
| CCoeControl::iCoeEnv | |
| CCoeControl::iContext | |
| CCoeControl::iPosition | |
| CCoeControl::iSize | |
| CEikBorderedControl::iBorder | |
| IMPORT_C void | Animate | ( | ) | [virtual] |
Cause the button to animate. The appearance changes to the "pressed in" state. Subsequent behaviour depends upon the SetBehavior setting
| IMPORT_C void | CopyDrawStateTo | ( | CEikButtonBase * | aTargetButton | ) | const [protected] |
Transfers the draw state to the referenced button
| CEikButtonBase * aTargetButton | button to transfer the |
| IMPORT_C TDrawState | DrawState | ( | ) | const [protected] |
Access the draw state defined in SLafButtonBase
The draw state of the control
| IMPORT_C void * | ExtensionInterface | ( | TUid | aInterface | ) | [private, virtual] |
From CAknControl
Interface for extending virtual functionality of CAknControl
| TUid aInterface |
| IMPORT_C void | GetColorUseListL | ( | CArrayFix< TCoeColorUse > & | aColorUseList | ) | const [virtual] |
From CCoeControl
Obtain the color use list for this control
| CArrayFix< TCoeColorUse > & aColorUseList | Output; upon non-leaving return, constains the color use list |
| IMPORT_C void | HandlePointerEventL | ( | const TPointerEvent & | aPointerEvent | ) | [virtual] |
From CCoeControl
A pointer event is being routed to this control for handling
| const TPointerEvent & aPointerEvent | Wserv pointer event |
| IMPORT_C void | HandleResourceChange | ( | TInt | aType | ) | [virtual] |
From CCoeControl
Perform necessary operations when resource changes. This includes layout switches, or other events that affect appearance.
| TInt aType | Type of resouce changed |
| IMPORT_C TCoeInputCapabilities | InputCapabilities | ( | ) | const [virtual] |
From CCoeControl
Interface used by the FEP or others to determine what type of input the control requires.
A value indicating what input is required.
| IMPORT_C TBool | IsPressed | ( | ) | const [protected] |
Returns whether the button is currently pressed.
EFalse if the button is not pressed
| IMPORT_C TKeyResponse | OfferKeyEventL | ( | const TKeyEvent & | aKeyEvent, |
| TEventCode | aType | |||
| ) | [virtual] | |||
From CCoeControl
A key event is being being given to the control for handling
EKeyWasConsumed or EKeyWasNotConsumed
| const TKeyEvent & aKeyEvent | Key event code |
| TEventCode aType | Type of event (i.e.. EEventKey, EEventKeyUp, EEventKeyDown) |
| IMPORT_C void | SetBehavior | ( | TButtonBehavior | aBehavior | ) |
Sets the button s behaviour. A button can be made to stay set or stay clear. It can also be made a latching button.
| TButtonBehavior aBehavior | Behaviour to use |
| IMPORT_C void | SetCoordinator | ( | TEikButtonCoordinator * | aButCoord | ) |
Sets the coordinator for the button.
| TEikButtonCoordinator * aButCoord | The coordinator to set for these button |
| IMPORT_C void | SetIgnoreNextPointerUp | ( | ) |
Sets the control to ignore the next pointer up event
| IMPORT_C void | SetReportOnPointerDown | ( | ) | [protected] |
Set whether the control should report on pointer down
| IMPORT_C void | SetState | ( | TState | aState | ) |
Set the state of the button.
| TState aState | The state the button is to be set to. |
| IMPORT_C void | StateChanged | ( | ) | [private, virtual] |
Called but button framework when the state of the control has changed
| IMPORT_C void | WriteInternalStateL | ( | RWriteStream & | aWriteStream | ) | const [virtual] |
From CCoeControl
Serialize the control's state. For testing
| RWriteStream & aWriteStream | Stream to write to. |
The draw state of the button.
| EDrawClear = SLafButtonBase::EDrawClear | |
| EDrawSet = SLafButtonBase::EDrawSet | |
| EDrawIndeterminate = SLafButtonBase::EDrawIndeterminate | |
| EDrawClearPressed = SLafButtonBase::EDrawClearPressed | |
| EDrawSetPressed = SLafButtonBase::EDrawSetPressed | |
| EDrawIndeterminatePressed = SLafButtonBase::EDrawIndeterminatePressed |
| TEikButtonCoordinator * | iButCoord | [private] |
Button co-ordinator associated with this button