API published in: S60 1st Ed
Link against: eikcoctl.lib avkon.lib
Required Capabilities
None
#include <eikbutb.h>
Inherits CEikBorderedControl.
Inherited by CEikCommandButtonBase, and CEikScrollButton.
This class defines behavior available to all button classes.
Public Types |
|
enum | TState { EClear = 0, ESet = 1, EIndeterminate = 2 } |
States that the button can be in. More... |
|
Public Member Functions |
|
IMPORT_C | CEikButtonBase () |
C++ constructor. |
|
IMPORT_C | ~CEikButtonBase () |
C++ destructor. |
|
IMPORT_C TState | State () const |
Access the state. |
|
IMPORT_C void | SetState (TState aState) |
Set the state of the button. |
|
virtual IMPORT_C void | Animate () |
Cause the button to animate. |
|
IMPORT_C void | SetCoordinator (TEikButtonCoordinator *aButCoord) |
Sets the coordinator for the button. |
|
IMPORT_C void | SetBehavior (TButtonBehavior aBehavior) |
Sets the button’s behaviour. |
|
IMPORT_C void | SetIgnoreNextPointerUp () |
Sets the control to ignore the next pointer up event. |
|
virtual IMPORT_C void | GetColorUseListL (CArrayFix< TCoeColorUse > &aColorUseList) const |
From CCoeControl. |
|
virtual IMPORT_C void | HandleResourceChange (TInt aType) |
From CCoeControl. |
|
IMPORT_C void | WriteInternalStateL (RWriteStream &aWriteStream) const |
From CCoeControl. |
|
IMPORT_C void | HandlePointerEventL (const TPointerEvent &aPointerEvent) |
From CCoeControl. |
|
IMPORT_C TKeyResponse | OfferKeyEventL (const TKeyEvent &aKeyEvent, TEventCode aType) |
From CCoeControl. |
|
IMPORT_C TCoeInputCapabilities | InputCapabilities () const |
From CCoeControl. |
|
Protected Types |
|
enum | TDrawState { EDrawClear = SLafButtonBase::EDrawClear, EDrawSet = SLafButtonBase::EDrawSet, EDrawIndeterminate = SLafButtonBase::EDrawIndeterminate, EDrawClearPressed = SLafButtonBase::EDrawClearPressed, EDrawSetPressed = SLafButtonBase::EDrawSetPressed, EDrawIndeterminatePressed = SLafButtonBase::EDrawIndeterminatePressed } |
The draw state of the button. More... |
|
Protected Member Functions |
|
IMPORT_C void | SetReportOnPointerDown () |
Set whether the control should report on pointer down. |
|
IMPORT_C TDrawState | DrawState () const |
Access the draw state defined in SLafButtonBase. |
|
IMPORT_C TBool | IsPressed () const |
Returns whether the button is currently pressed. |
|
IMPORT_C void | SetAllowTristate () |
Sets the button to be tri-state. |
|
IMPORT_C void | CopyDrawStateTo (CEikButtonBase *aTargetButton) const |
Transfers the draw state to the referenced button. |
|
Protected Attributes |
|
TInt | iButFlags |
Flags for the button class hierarchy. |
|
The draw state of the button. |
|
States that the button can be in. |
|
C++ constructor. |
|
C++ destructor. |
|
Cause the button to animate. The appearance changes to the "pressed in" state. Subsequent behaviour depends upon the SetBehavior setting Reimplemented in CEikMenuButton. |
|
Transfers the draw state to the referenced button.
|
|
Access the draw state defined in SLafButtonBase.
|
|
From CCoeControl. Obtain the color use list for this control
Reimplemented from CEikBorderedControl. Reimplemented in CEikCommandButtonBase. |
|
From CCoeControl. A pointer event is being routed to this control for handling
Reimplemented from CEikBorderedControl. Reimplemented in CEikCommandButtonBase, CEikCommandButton, CEikTwoPictureCommandButton, CEikInverterCommandButton, CEikTextButton, CEikBitmapButton, CEikMenuButton, and CEikScrollButton. |
|
From CCoeControl. Perform necessary operations when resource changes. This includes layout switches, or other events that affect appearance.
Reimplemented from CEikBorderedControl. Reimplemented in CEikCommandButtonBase. |
|
From CCoeControl. Interface used by the FEP or others to determine what type of input the control requires.
|
|
Returns whether the button is currently pressed.
|
|
From CCoeControl. A key event is being being given to the control for handling
Reimplemented in CEikCommandButtonBase. |
|
Sets the button to be tri-state. |
|
Sets the button’s behaviour. A button can be made to stay set or stay clear. It can also be made a latching button.
|
|
Sets the coordinator for the button.
|
|
Sets the control to ignore the next pointer up event. |
|
Set whether the control should report on pointer down. |
|
Set the state of the button.
|
|
Access the state.
|
|
From CCoeControl. Serialize the control's state. For testing
Reimplemented from CEikBorderedControl. Reimplemented in CEikCommandButtonBase, CEikTwoPictureCommandButton, CEikInverterCommandButton, and CEikMenuButton. |
|
Flags for the button class hierarchy. |