Symbian^3 Application Developer Library >

CEikButtonBase Class Reference

class CEikButtonBase : public CEikBorderedControl

Base class for button controls

This class defines behavior available to all button classes.

eikcoctl
Since
S60 1.0

Inherits from

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 ()
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)
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

Constructor & Destructor Documentation

CEikButtonBase()

IMPORT_C CEikButtonBase ( )

C++ constructor

~CEikButtonBase()

IMPORT_C ~CEikButtonBase ( )

C++ destructor

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

Parameters

CEikButtonBase * aTargetButton button to transfer the

DrawState()

IMPORT_C TDrawState DrawState ( ) const [protected]

Access the draw state defined in SLafButtonBase

ExtensionInterface(TUid)

IMPORT_C void * ExtensionInterface ( TUid aInterface ) [private, virtual]

From CAknControl

Interface for extending virtual functionality of CAknControl

Parameters

TUid aInterface

GetColorUseListL(CArrayFix< TCoeColorUse > &)

IMPORT_C void GetColorUseListL ( CArrayFix < TCoeColorUse > & aColorUseList ) const [virtual]

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.

Since
ER5U

Parameters

CArrayFix < TCoeColorUse > & 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

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.

Since
ER5U

Parameters

TInt aType Type of resouce changed

InputCapabilities()

IMPORT_C TCoeInputCapabilities InputCapabilities ( ) const [virtual]

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)

IMPORT_C TKeyResponse OfferKeyEventL ( const TKeyEvent & aKeyEvent,
TEventCode aType
) [virtual]

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)

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.

Parameters

TButtonBehavior aBehavior Behaviour to use

SetCoordinator(TEikButtonCoordinator *)

IMPORT_C void SetCoordinator ( TEikButtonCoordinator * aButCoord )

Sets the coordinator for the button.

Parameters

TEikButtonCoordinator * 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.

Parameters

TState aState The state the button is to be set to.

State()

IMPORT_C TState State ( ) const

Access the state

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.

Parameters

RWriteStream & aWriteStream Stream to write to.

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

TEikButtonCoordinator * iButCoord [private]

Button co-ordinator associated with this button

TInt iButFlags

TInt iButFlags [protected]

Flags for the button class hierarchy

TInt iSpare

TInt iSpare [private]

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.