CEikButtonBase Class Reference
| class CEikButtonBase : public CEikBorderedControl |
| Inherited Functions |
|---|
| | CAknControl::CAknControl() |
| | CAknControl::~CAknControl() |
| | CBase::CBase() |
| | CBase::Delete(CBase *) |
| | CBase::Extension_(TUint,TAny *&,TAny *) |
| | CBase::operator new(TUint) |
| | CBase::operator new(TUint,TAny *) |
| | CBase::operator new(TUint,TLeave) |
| | CBase::operator new(TUint,TLeave,TUint) |
| | CBase::operator new(TUint,TUint) |
| | CBase::~CBase() |
| | CCoeControl::AccumulatedZoom()const |
| | CCoeControl::ActivateGc()const |
| | CCoeControl::ActivateL() |
| | CCoeControl::BackedUpWindow()const |
| | CCoeControl::Background()const |
| | CCoeControl::CCoeControl() |
| | CCoeControl::CCoeControl(CCoeEnv *) |
| | CCoeControl::CCoeControl(const CCoeControl &) |
| | CCoeControl::CCoeControlArray |
| | CCoeControl::CapturesPointer()const |
| | CCoeControl::ClaimPointerGrab(TBool) |
| | CCoeControl::ClaimPointerGrab(TInt,TBool) |
| | CCoeControl::CloseWindow() |
| | CCoeControl::ComponentArrayExists()const |
| | CCoeControl::ComponentControl(TInt)const |
| | CCoeControl::Components() |
| | CCoeControl::Components()const |
| | CCoeControl::ConstructFromResourceL(TResourceReader &) |
| | CCoeControl::ControlContext()const |
| | CCoeControl::ControlEnv()const |
| | CCoeControl::CopyControlContextFrom(const CCoeControl *) |
| | CCoeControl::CountComponentControls()const |
| | CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &) |
| | CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &,TDisplayMode) |
| | CCoeControl::CreateWindowL() |
| | CCoeControl::CreateWindowL(RWindowGroup *) |
| | CCoeControl::CreateWindowL(RWindowTreeNode &) |
| | CCoeControl::CreateWindowL(const CCoeControl *) |
| | CCoeControl::CustomGc()const |
| | CCoeControl::DeactivateGc()const |
| | CCoeControl::DrawBackground(const TRect &)const |
| | CCoeControl::DrawDeferred()const |
| | CCoeControl::DrawForeground(const TRect &)const |
| | CCoeControl::DrawNow()const |
| | CCoeControl::DrawNow(const TRect &)const |
| | CCoeControl::DrawableWindow()const |
| | CCoeControl::EnableDragEvents() |
| | CCoeControl::EnableReportControlStateChange(TBool) |
| | CCoeControl::EnableWindowTransparency() |
| | CCoeControl::FindBackground()const |
| | CCoeControl::FindFontProvider()const |
| | CCoeControl::FocusChanged(TDrawNow) |
| | CCoeControl::GetColor(TInt,TRgb &)const |
| | CCoeControl::GetGc()const |
| | CCoeControl::GetHelpContext(TCoeHelpContext &)const |
| | CCoeControl::GrabbingComponent()const |
| | CCoeControl::GrabbingComponent(TInt)const |
| | CCoeControl::HandleComponentControlsResourceChange(TInt) |
| | CCoeControl::HandleControlArrayEventL(CCoeControlArray::TEvent,const CCoeControlArray *,CCoeControl *,TInt) |
| | CCoeControl::HandlePointerBufferReadyL() |
| | CCoeControl::HandleRedrawEvent(const TRect &)const |
| | CCoeControl::HitTest()const |
| | CCoeControl::IgnoreEventsUntilNextPointerUp() |
| | CCoeControl::Index(const CCoeControl *)const |
| | CCoeControl::InitComponentArrayL() |
| | CCoeControl::IsActivated()const |
| | CCoeControl::IsBackedUp()const |
| | CCoeControl::IsBeingDestroyed()const |
| | CCoeControl::IsBlank()const |
| | CCoeControl::IsDimmed()const |
| | CCoeControl::IsFocused()const |
| | CCoeControl::IsNonFocusing()const |
| | CCoeControl::IsReadyToDraw()const |
| | CCoeControl::IsVisible()const |
| | CCoeControl::LayoutManager()const |
| | CCoeControl::MakeVisible(TBool) |
| | CCoeControl::MaximumWidth()const |
| | CCoeControl::MinimumSize() |
| | CCoeControl::MopSupplyObject(TTypeUid) |
| | CCoeControl::NotifyFontChange(const CCoeFontProvider *) |
| | CCoeControl::Observer()const |
| | CCoeControl::OverrideColorL(TInt,TRgb) |
| | CCoeControl::OwnsWindow()const |
| | CCoeControl::Parent() |
| | CCoeControl::Parent()const |
| | CCoeControl::Position()const |
| | CCoeControl::PositionChanged() |
| | CCoeControl::PositionRelativeToScreen()const |
| | CCoeControl::PrepareForFocusGainL() |
| | CCoeControl::PrepareForFocusLossL() |
| | CCoeControl::ProcessPointerBufferReadyL() |
| | CCoeControl::ProcessPointerEventL(const TPointerEvent &) |
| | CCoeControl::Rect()const |
| | CCoeControl::RecursivelyMergeInputCapabilities(TCoeInputCapabilities &)const |
| | CCoeControl::RecursivelyMergedInputCapabilities()const |
| | CCoeControl::RefetchPixelMappingL() |
| | CCoeControl::RemoveFromParent() |
| | CCoeControl::ReportEventL(MCoeControlObserver::TCoeEvent) |
| | CCoeControl::RequestRelayout(const CCoeControl *) |
| | CCoeControl::ResetGc()const |
| | CCoeControl::ScreenFont(const TCoeFont &)const |
| | CCoeControl::SetAllowStrayPointers() |
| | CCoeControl::SetBackground(const MCoeControlBackground *) |
| | CCoeControl::SetBlank() |
| | CCoeControl::SetCanDrawOutsideRect() |
| | CCoeControl::SetComponentsToInheritVisibility(TBool) |
| | CCoeControl::SetContainerWindowL(RBackedUpWindow &) |
| | CCoeControl::SetContainerWindowL(RWindow &) |
| | CCoeControl::SetContainerWindowL(const CCoeControl &) |
| | CCoeControl::SetControlContext(MCoeControlContext *) |
| | CCoeControl::SetCornerAndSize(TGulAlignment,const TSize &) |
| | CCoeControl::SetCustomGc(CWindowGc *) |
| | CCoeControl::SetDimmed(TBool) |
| | CCoeControl::SetExtent(const TPoint &,const TSize &) |
| | CCoeControl::SetExtentToWholeScreen() |
| | CCoeControl::SetFocus(TBool,TDrawNow) |
| | CCoeControl::SetFocusing(TBool) |
| | CCoeControl::SetFontProviderL(const CCoeFontProvider &) |
| | CCoeControl::SetGc(CWindowGc *)const |
| | CCoeControl::SetGloballyCapturing(TBool) |
| | CCoeControl::SetHitTest(const MCoeControlHitTest *) |
| | CCoeControl::SetLayoutManagerL(MCoeLayoutManager *) |
| | CCoeControl::SetMaximumWidth(TInt) |
| | CCoeControl::SetMopParent(MObjectProvider *) |
| | CCoeControl::SetNeighbor(CCoeControl *) |
| | CCoeControl::SetNonFocusing() |
| | CCoeControl::SetObserver(MCoeControlObserver *) |
| | CCoeControl::SetParent(CCoeControl *) |
| | CCoeControl::SetPointerCapture(TBool) |
| | CCoeControl::SetPosition(const TPoint &) |
| | CCoeControl::SetRect(const TRect &) |
| | CCoeControl::SetSize(const TSize &) |
| | CCoeControl::SetSizeWithoutNotification(const TSize &) |
| | CCoeControl::SetTextBaselineSpacing(TInt) |
| | CCoeControl::SetUniqueHandle(TInt) |
| | CCoeControl::SetZoomFactorL(TInt,TZoomType) |
| | CCoeControl::Size()const |
| | CCoeControl::SizeChanged() |
| | CCoeControl::SystemGc()const |
| | CCoeControl::TextBaselineOffset(const TSize &)const |
| | CCoeControl::TextDrawer(TInt)const |
| | CCoeControl::UniqueHandle()const |
| | CCoeControl::Window()const |
| | CCoeControl::WriteInternalStateNowL(RWriteStream &)const |
| | CCoeControl::ZoomWithType()const |
| | CCoeControl::operator=(const CCoeControl &) |
| | CCoeControl::~CCoeControl() |
| | CEikBorderedControl::Border()const |
| | CEikBorderedControl::CEikBorderedControl() |
| | CEikBorderedControl::CEikBorderedControl(const TGulBorder &) |
| | CEikBorderedControl::Draw(const TRect &)const |
| | CEikBorderedControl::HasBorder()const |
| | CEikBorderedControl::SetAdjacent(TInt) |
| | CEikBorderedControl::SetBorder(TGulBorder::TBorderType) |
| | CEikBorderedControl::SetBorder(TInt) |
Detailed Description
Base class for button controls
This class defines behavior available to all button classes.
Member Attribute Documentation
iButFlags
|
TInt
| iButFlags | [protected] |
Flags for the button class hierarchy
Member Enumeration Documentation
Enum TDrawState
The draw state of the button.
| Enumerator | Value | Description |
|---|
| EDrawClear | SLafButtonBase::EDrawClear | |
| EDrawSet | SLafButtonBase::EDrawSet | |
| EDrawIndeterminate | SLafButtonBase::EDrawIndeterminate | |
| EDrawClearPressed | SLafButtonBase::EDrawClearPressed | |
| EDrawSetPressed | SLafButtonBase::EDrawSetPressed | |
| EDrawIndeterminatePressed | SLafButtonBase::EDrawIndeterminatePressed | |
Enum TState
States that the button can be in.
| Enumerator | Value | Description |
|---|
| EClear | 0 | |
| ESet | 1 | |
| EIndeterminate | 2 | |
Constructor & Destructor Documentation
~CEikButtonBase ( )
| IMPORT_C | ~CEikButtonBase | ( | ) | |
Member Function Documentation
Animate ( )
| 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
CopyDrawStateTo ( CEikButtonBase * )
| IMPORT_C void | CopyDrawStateTo | ( | CEikButtonBase * | aTargetButton | ) | const [protected] |
Transfers the draw state to the referenced button
| Parameter | Description | | aTargetButton | button to transfer the |
DrawState ( )
Returns: The draw state of the control
GetColorUseListL ( CArrayFix< TCoeColorUse > & )
From CCoeControl
Obtain the color use list for this control
| Parameter | Description | | aColorUseList | Output; upon non-leaving return, constains the color use list |
HandlePointerEventL ( const TPointerEvent & )
| IMPORT_C void | HandlePointerEventL | ( | const TPointerEvent & | aPointerEvent | ) | [virtual] |
From CCoeControl
A pointer event is being routed to this control for handling
| Parameter | Description | | aPointerEvent | Wserv pointer event |
HandleResourceChange ( TInt )
| 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.
| Parameter | Description | | aType | Type of resouce changed |
InputCapabilities ( )
From CCoeControl
Interface used by the FEP or others to determine what type of input the control requires.
Returns: A value indicating what input is required.
IsPressed ( )
| IMPORT_C TBool | IsPressed | ( | ) | const [protected] |
Returns whether the button is currently pressed.
Returns: EFalse if the button is not pressed
OfferKeyEventL ( const TKeyEvent &, TEventCode )
From CCoeControl
A key event is being being given to the control for handling
| Parameter | Description | | aKeyEvent | Key event code |
| aType | Type of event (i.e.. EEventKey, EEventKeyUp, EEventKeyDown) |
Returns: EKeyWasConsumed or EKeyWasNotConsumed
SetAllowTristate ( )
| IMPORT_C void | SetAllowTristate | ( | ) | [protected] |
Sets the button to be tri-state
SetBehavior ( TButtonBehavior )
Sets the button s behaviour. A button can be made to stay set or stay clear. It can also be made a latching button.
| Parameter | Description | | aBehavior | Behaviour to use |
SetCoordinator ( TEikButtonCoordinator * )
Sets the coordinator for the button.
| Parameter | Description | | aButCoord | The coordinator to set for these button |
SetIgnoreNextPointerUp ( )
| IMPORT_C void | SetIgnoreNextPointerUp | ( | ) | |
Sets the control to ignore the next pointer up event
SetReportOnPointerDown ( )
| IMPORT_C void | SetReportOnPointerDown | ( | ) | [protected] |
Set whether the control should report on pointer down
SetState ( TState )
| IMPORT_C void | SetState | ( | TState | aState | ) | |
Set the state of the button.
| Parameter | Description | | aState | The state the button is to be set to. |
State ( )
Returns: The state of the button
WriteInternalStateL ( RWriteStream & )
| IMPORT_C void | WriteInternalStateL | ( | RWriteStream & | aWriteStream | ) | const [virtual] |
From CCoeControl
Serialize the control's state. For testing
| Parameter | Description | | aWriteStream | Stream to write to. |