CEikButtonPanel Class Reference

class CEikButtonPanel : public CAknControl

Inherits from

Public Member Functions
CEikButtonPanel()
~CEikButtonPanel()
IMPORT_C voidAddButtonL(CEikLabeledButton *, TInt)
IMPORT_C voidAddButtonL(CEikLabeledButton *, TInt, TInt)
IMPORT_C CEikCommandButtonBase *ButtonById(TInt)
IMPORT_C CEikCommandButtonBase *ButtonForKey(TInt, TInt &)
IMPORT_C TIntButtonId(CCoeControl *)
IMPORT_C voidConstructFromResourceL(TResourceReader &)
IMPORT_C voidConstructL()
IMPORT_C voidGetColorUseListL(CArrayFix< TCoeColorUse > &)
IMPORT_C voidHandleControlEventL(CCoeControl *, TCoeEvent)
IMPORT_C voidHandlePointerEventL(const TPointerEvent &)
IMPORT_C voidHandleResourceChange(TInt)
IMPORT_C CEikLabeledButton *LabeledButtonById(TInt)
IMPORT_C voidMakeButtonVisible(TInt, TBool)
IMPORT_C TSizeMinimumSize()
IMPORT_C TKeyResponseOfferKeyEventL(const TKeyEvent &, TEventCode)
IMPORT_C voidResetMinimumSize()
IMPORT_C voidSetCommandObserver(MEikCommandObserver *)
IMPORT_C voidSetHorizontal()
IMPORT_C voidSetMinButtonWidth(TInt)
voidUpdateHotKeyL(TInt, CEikLabeledButton::TFlags, TInt)
Protected Member Functions
IMPORT_C voidWriteInternalStateL(RWriteStream &)
Private Member Functions
IMPORT_C voidActivateL()
voidAddCommandL(TInt, TInt, const TDesC *, const CFbsBitmap *, const CFbsBitmap *)
voidAddCommandSetToStackL(TInt)
voidAddCommandToStackL(TInt, TInt, const TDesC *, const CFbsBitmap *, const CFbsBitmap *)
voidAddCommandToStackL(TInt, TInt)
voidAdjustMarginsToFit(TInt8 &, TInt8 &, TInt &)
voidAnimateCommandByPosition(TInt)
voidAppendNewLineL()
CCoeControl *AsControl()
const CCoeControl *AsControl()
TInt ButtonCount()
TUint ButtonGroupFlags()
TBool ButtonsConsumedKeyL(TInt)
TSize CalcMinimumSizeL(TInt)
TInt CommandId(TInt)
TInt CommandPos(TInt)
IMPORT_C CCoeControl *ComponentControl(TInt)
IMPORT_C TIntCountComponentControls()
voidDimCommand(TInt, TBool)
voidDimCommandByPosition(TInt, TBool)
IMPORT_C void *ExtensionInterface(TUid)
CEikCommandButton *GroupControlAsButton(TInt)
CCoeControl *GroupControlById(TInt)
TBool IsCommandDimmed(TInt)
TBool IsCommandDimmedByPosition(TInt)
TBool IsCommandVisible(TInt)
TBool IsCommandVisibleByPosition(TInt)
CEikLabeledButton *LabeledButtonByPosition(TInt, TInt &)
CEikLabeledButton *LabeledButtonByPosition(TInt)
voidMakeCommandVisible(TInt, TBool)
voidMakeCommandVisibleByPosition(TInt, TBool)
voidReduceRect(TRect &)
TInt RelativePosition(TInt, TInt &)
voidRemoveCommandFromStack(TInt, TInt)
IMPORT_C voidReserved_2()
voidSetBoundingRect(const TRect &)
voidSetButtonWidths()
voidSetCommandL(TInt, TInt, const TDesC *, const CFbsBitmap *, const CFbsBitmap *)
voidSetCommandL(TInt, TInt)
voidSetCommandSetL(TInt)
voidSetDefaultCommand(TInt)
voidSetMSKCommandObserver(MEikCommandObserver *)
IMPORT_C voidSizeChanged()
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::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::Components()
CCoeControl::Components()const
CCoeControl::ControlContext()const
CCoeControl::ControlEnv()const
CCoeControl::CopyControlContextFrom(const CCoeControl *)
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::HasBorder()const
CCoeControl::HitTest()const
CCoeControl::IgnoreEventsUntilNextPointerUp()
CCoeControl::Index(const CCoeControl *)const
CCoeControl::InitComponentArrayL()
CCoeControl::InputCapabilities()const
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::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::SetAdjacent(TInt)
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::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()
Inherited Enumerations
CCoeControl:TZoomType
Private Attributes
TInt iButWidth
MEikCommandObserver *iCommandObserver
CArrayPtrFlat< CEikControlGroup > *iControlGroups
TInt iCount
TInt iMinButWidth
TSize iMinSize
TInt iSpare
Inherited Attributes
CCoeControl::iCoeEnv
CCoeControl::iContext
CCoeControl::iPosition
CCoeControl::iSize

Constructor & Destructor Documentation

CEikButtonPanel()

IMPORT_CCEikButtonPanel()

~CEikButtonPanel()

IMPORT_C~CEikButtonPanel()

Member Functions Documentation

ActivateL()

IMPORT_C voidActivateL()[private, virtual]

AddButtonL(CEikLabeledButton *, TInt)

IMPORT_C voidAddButtonL(CEikLabeledButton *aButton,
TIntaId
)

Parameters

CEikLabeledButton * aButton
TInt aId

AddButtonL(CEikLabeledButton *, TInt, TInt)

IMPORT_C voidAddButtonL(CEikLabeledButton *aButton,
TIntaId,
TIntaRow
)

Takes ownership of aButton, with asociated id, aId and adds it to the row of buttons aRow. Creates aRow if it does not already exist. Should not be used for vertical button layout. Leaves in out of memory conditions.

@ since Uikon1.2

Parameters

CEikLabeledButton * aButton
TInt aId
TInt aRow

AddCommandL(TInt, TInt, const TDesC *, const CFbsBitmap *, const CFbsBitmap *)

voidAddCommandL(TIntaPosition,
TIntaCommandId,
const TDesC *aText,
const CFbsBitmap *aBitmap,
const CFbsBitmap *aMask
)[private]

Parameters

TInt aPosition
TInt aCommandId
const TDesC * aText
const CFbsBitmap * aBitmap
const CFbsBitmap * aMask

AddCommandSetToStackL(TInt)

voidAddCommandSetToStackL(TIntaResourceId)[private]

Parameters

TInt aResourceId

AddCommandToStackL(TInt, TInt, const TDesC *, const CFbsBitmap *, const CFbsBitmap *)

voidAddCommandToStackL(TIntaPosition,
TIntaCommandId,
const TDesC *aText,
const CFbsBitmap *aBitmap,
const CFbsBitmap *aMask
)[private]

Parameters

TInt aPosition
TInt aCommandId
const TDesC * aText
const CFbsBitmap * aBitmap
const CFbsBitmap * aMask

AddCommandToStackL(TInt, TInt)

voidAddCommandToStackL(TIntaPosition,
TIntaResourceId
)[private]

Parameters

TInt aPosition
TInt aResourceId

AdjustMarginsToFit(TInt8 &, TInt8 &, TInt &)

voidAdjustMarginsToFit(TInt8 &aLeftBorder,
TInt8 &aRightBorder,
TInt &aGapBetweenButtons
)[private]

Parameters

TInt8 & aLeftBorder
TInt8 & aRightBorder
TInt & aGapBetweenButtons

AnimateCommandByPosition(TInt)

voidAnimateCommandByPosition(TIntaPosition)[private]

Parameters

TInt aPosition

AppendNewLineL()

voidAppendNewLineL()[private]

AsControl()

CCoeControl *AsControl()[private]

AsControl()

const CCoeControl *AsControl()const [private]

ButtonById(TInt)

IMPORT_C CEikCommandButtonBase *ButtonById(TIntaButtonId)const

Parameters

TInt aButtonId

ButtonCount()

TInt ButtonCount()const [private]

ButtonForKey(TInt, TInt &)

IMPORT_C CEikCommandButtonBase *ButtonForKey(TIntaChar,
TInt &aButtonId
)const

Parameters

TInt aChar
TInt & aButtonId

ButtonGroupFlags()

TUint ButtonGroupFlags()const [private]

ButtonId(CCoeControl *)

IMPORT_C TIntButtonId(CCoeControl *aControl)const

Parameters

CCoeControl * aControl

ButtonsConsumedKeyL(TInt)

TBool ButtonsConsumedKeyL(TIntaCode)[private]

Parameters

TInt aCode

CalcMinimumSizeL(TInt)

TSize CalcMinimumSizeL(TIntaResourceId)[private]

Parameters

TInt aResourceId

CommandId(TInt)

TInt CommandId(TIntaCommandPos)const [private]

Parameters

TInt aCommandPos

CommandPos(TInt)

TInt CommandPos(TIntaCommandId)const [private]

Parameters

TInt aCommandId

ComponentControl(TInt)

IMPORT_C CCoeControl *ComponentControl(TIntaIndex)const [private, virtual]

Parameters

TInt aIndex

ConstructFromResourceL(TResourceReader &)

IMPORT_C voidConstructFromResourceL(TResourceReader &aReader)[virtual]

Parameters

TResourceReader & aReader

ConstructL()

IMPORT_C voidConstructL()

CountComponentControls()

IMPORT_C TIntCountComponentControls()const [private, virtual]

DimCommand(TInt, TBool)

voidDimCommand(TIntaCommandId,
TBoolaDimmed
)[private]

Parameters

TInt aCommandId
TBool aDimmed

DimCommandByPosition(TInt, TBool)

voidDimCommandByPosition(TIntaPosition,
TBoolaDimmed
)[private]

Parameters

TInt aPosition
TBool aDimmed

ExtensionInterface(TUid)

IMPORT_C void *ExtensionInterface(TUidaInterface)[private, virtual]

Parameters

TUid aInterface

GetColorUseListL(CArrayFix< TCoeColorUse > &)

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

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

GroupControlAsButton(TInt)

CEikCommandButton *GroupControlAsButton(TIntaCommandId)const [private]

Parameters

TInt aCommandId

GroupControlById(TInt)

CCoeControl *GroupControlById(TIntaCommandId)const [private]

Parameters

TInt aCommandId

HandleControlEventL(CCoeControl *, TCoeEvent)

IMPORT_C voidHandleControlEventL(CCoeControl *aControl,
TCoeEventaEventType
)

Parameters

CCoeControl * aControl
TCoeEvent aEventType

HandlePointerEventL(const TPointerEvent &)

IMPORT_C voidHandlePointerEventL(const TPointerEvent &aPointerEvent)[virtual]

Parameters

const TPointerEvent & aPointerEvent

HandleResourceChange(TInt)

IMPORT_C voidHandleResourceChange(TIntaType)[virtual]

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

IsCommandDimmed(TInt)

TBool IsCommandDimmed(TIntaCommandId)const [private]

Parameters

TInt aCommandId

IsCommandDimmedByPosition(TInt)

TBool IsCommandDimmedByPosition(TIntaPosition)const [private]

Parameters

TInt aPosition

IsCommandVisible(TInt)

TBool IsCommandVisible(TIntaCommandId)const [private]

Parameters

TInt aCommandId

IsCommandVisibleByPosition(TInt)

TBool IsCommandVisibleByPosition(TIntaPosition)const [private]

Parameters

TInt aPosition

LabeledButtonById(TInt)

IMPORT_C CEikLabeledButton *LabeledButtonById(TIntaButtonId)const

Parameters

TInt aButtonId

LabeledButtonByPosition(TInt, TInt &)

CEikLabeledButton *LabeledButtonByPosition(TIntaPosition,
TInt &aGroupIndex
)const [private]

Parameters

TInt aPosition
TInt & aGroupIndex

LabeledButtonByPosition(TInt)

CEikLabeledButton *LabeledButtonByPosition(TIntaPosition)const [private]

Parameters

TInt aPosition

MakeButtonVisible(TInt, TBool)

IMPORT_C voidMakeButtonVisible(TIntaButtonId,
TBoolaVisible
)

Parameters

TInt aButtonId
TBool aVisible

MakeCommandVisible(TInt, TBool)

voidMakeCommandVisible(TIntaCommandId,
TBoolaVisible
)[private]

Parameters

TInt aCommandId
TBool aVisible

MakeCommandVisibleByPosition(TInt, TBool)

voidMakeCommandVisibleByPosition(TIntaPosition,
TBoolaVisible
)[private]

Parameters

TInt aPosition
TBool aVisible

MinimumSize()

IMPORT_C TSizeMinimumSize()[virtual]

OfferKeyEventL(const TKeyEvent &, TEventCode)

IMPORT_C TKeyResponseOfferKeyEventL(const TKeyEvent &aKeyEvent,
TEventCodeaType
)[virtual]

Parameters

const TKeyEvent & aKeyEvent
TEventCode aType

ReduceRect(TRect &)

voidReduceRect(TRect &aBoundingRect)const [private]

Parameters

TRect & aBoundingRect

RelativePosition(TInt, TInt &)

TInt RelativePosition(TIntaCommandPos,
TInt &aGroupIndex
)const [private]

Parameters

TInt aCommandPos
TInt & aGroupIndex

RemoveCommandFromStack(TInt, TInt)

voidRemoveCommandFromStack(TIntaPosition,
TIntaCommandId
)[private]

Parameters

TInt aPosition
TInt aCommandId

Reserved_2()

IMPORT_C voidReserved_2()[private, virtual]

ResetMinimumSize()

IMPORT_C voidResetMinimumSize()

SetBoundingRect(const TRect &)

voidSetBoundingRect(const TRect &aBoundingRect)[private]

Parameters

const TRect & aBoundingRect

SetButtonWidths()

voidSetButtonWidths()[private]

SetCommandL(TInt, TInt, const TDesC *, const CFbsBitmap *, const CFbsBitmap *)

voidSetCommandL(TIntaPosition,
TIntaCommandId,
const TDesC *aText,
const CFbsBitmap *aBitmap,
const CFbsBitmap *aMask
)[private]

Parameters

TInt aPosition
TInt aCommandId
const TDesC * aText
const CFbsBitmap * aBitmap
const CFbsBitmap * aMask

SetCommandL(TInt, TInt)

voidSetCommandL(TIntaPosition,
TIntaResourceId
)[private]

Parameters

TInt aPosition
TInt aResourceId

SetCommandObserver(MEikCommandObserver *)

IMPORT_C voidSetCommandObserver(MEikCommandObserver *aCommandObserver)

Parameters

MEikCommandObserver * aCommandObserver

SetCommandSetL(TInt)

voidSetCommandSetL(TIntaResourceId)[private]

Parameters

TInt aResourceId

SetDefaultCommand(TInt)

voidSetDefaultCommand(TIntaCommandId)[private]

Parameters

TInt aCommandId

SetHorizontal()

IMPORT_C voidSetHorizontal()

SetMSKCommandObserver(MEikCommandObserver *)

voidSetMSKCommandObserver(MEikCommandObserver *aCommandObserver)[private]

Parameters

MEikCommandObserver * aCommandObserver

SetMinButtonWidth(TInt)

IMPORT_C voidSetMinButtonWidth(TIntaWidth)

Parameters

TInt aWidth

SizeChanged()

IMPORT_C voidSizeChanged()[private, virtual]

UpdateHotKeyL(TInt, CEikLabeledButton::TFlags, TInt)

voidUpdateHotKeyL(TIntaCommandId,
CEikLabeledButton::TFlagsaFlags,
TIntaKeyCode
)

Parameters

TInt aCommandId
CEikLabeledButton::TFlags aFlags
TInt aKeyCode

WriteInternalStateL(RWriteStream &)

IMPORT_C voidWriteInternalStateL(RWriteStream &aWriteStream)const [protected, virtual]

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

Member Data Documentation

TInt iButWidth

TInt iButWidth[private]

MEikCommandObserver * iCommandObserver

MEikCommandObserver *iCommandObserver[private]

CArrayPtrFlat< CEikControlGroup > * iControlGroups

CArrayPtrFlat< CEikControlGroup > *iControlGroups[private]

TInt iCount

TInt iCount[private]

TInt iMinButWidth

TInt iMinButWidth[private]

TSize iMinSize

TSize iMinSize[private]

TInt iSpare

TInt iSpare[private]