CEikButtonBase Class Reference
| class CEikButtonBase : public CEikBorderedControl |
Base class for button controls
This class defines behavior available to all button classes.
| 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::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) |
Constructor & Destructor Documentation
~CEikButtonBase()
| IMPORT_C | ~CEikButtonBase | ( | ) | |
Member Functions 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
ClickCompleted()
|
TBool
| ClickCompleted | ( | ) | [private] |
CopyDrawStateTo(CEikButtonBase *)
| IMPORT_C void | CopyDrawStateTo | ( | CEikButtonBase * | aTargetButton | ) | const [protected] |
Transfers the draw state to the referenced button
ExtensionInterface(TUid)
| IMPORT_C void * | ExtensionInterface | ( | TUid | aInterface | ) | [private, virtual] |
GetColorUseListL(CArrayFix< TCoeColorUse > &)
From CCoeControl
Obtain the color use list for this control
Gets the list of logical colors employed in the drawing of the control, paired with an explanation of how they are used. Appends the list to aColorUseList.
HandlePointerEventL(const TPointerEvent &)
| IMPORT_C void | HandlePointerEventL | ( | const TPointerEvent & | aPointerEvent | ) | [virtual] |
From CCoeControl
A pointer event is being routed to this control for handling
Parameters
| const TPointerEvent & 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.
Handles a change to the control's resources of type aType which are shared across the environment, e.g. colors or fonts.
Parameters
| TInt aType | Type of resouce changed |
InputCapabilities()
From CCoeControl
Interface used by the FEP or others to determine what type of input the control requires.
IsPressed()
| IMPORT_C TBool | IsPressed | ( | ) | const [protected] |
Returns whether the button is currently pressed.
OfferKeyEventL(const TKeyEvent &, TEventCode)
From CCoeControl
A key event is being being given to the control for handling
Parameters
| const TKeyEvent & aKeyEvent | Key event code |
| TEventCode aType | Type of event (i.e.. EEventKey, EEventKeyUp, EEventKeyDown) |
Reserved_2()
| IMPORT_C void | Reserved_2 | ( | ) | [private, virtual] |
Reserved_3()
| IMPORT_C void | Reserved_3 | ( | ) | [private, virtual] |
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.
SetCoordinator(TEikButtonCoordinator *)
Sets the coordinator for the 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.
Parameters
| TState aState | The state the button is to be set to. |
StateChanged()
| IMPORT_C void | StateChanged | ( | ) | [private, virtual] |
Called but button framework when the state of the control has changed
WriteInternalStateL(RWriteStream &)
| IMPORT_C void | WriteInternalStateL | ( | RWriteStream & | aWriteStream | ) | const [virtual] |
From CCoeControl
Serialize the control's state. For testing
Writes the internal state of the control and its components to aStream. Does nothing in release mode. Designed to be overidden and base called by subclasses.
Member Enumerations Documentation
Enum TDrawState
The draw state of the button.
Enumerators
| 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.
Enumerators
| EClear = 0 | |
| ESet = 1 | |
| EIndeterminate = 2 | |
Member Data Documentation
TEikButtonCoordinator * iButCoord
Button co-ordinator associated with this button
TInt
iButFlags
|
TInt
| iButFlags | [protected] |
Flags for the button class hierarchy
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.