Symbian^3 Application Developer Library >

CEikButtonPanel Class Reference

class CEikButtonPanel : public CAknControl

Inherits from

Public Member Functions
CEikButtonPanel ()
~CEikButtonPanel ()
IMPORT_C void AddButtonL ( CEikLabeledButton *, TInt )
IMPORT_C void AddButtonL ( CEikLabeledButton *, TInt , TInt )
IMPORT_C CEikCommandButtonBase * ButtonById ( TInt )
IMPORT_C CEikCommandButtonBase * ButtonForKey ( TInt , TInt &)
IMPORT_C TInt ButtonId ( CCoeControl *)
IMPORT_C void ConstructFromResourceL ( TResourceReader &)
IMPORT_C void ConstructL ()
IMPORT_C void GetColorUseListL ( CArrayFix < TCoeColorUse > &)
IMPORT_C void HandleControlEventL ( CCoeControl *, TCoeEvent)
IMPORT_C void HandlePointerEventL (const TPointerEvent &)
IMPORT_C void HandleResourceChange ( TInt )
IMPORT_C CEikLabeledButton * LabeledButtonById ( TInt )
IMPORT_C void MakeButtonVisible ( TInt , TBool )
IMPORT_C TSize MinimumSize ()
IMPORT_C TKeyResponse OfferKeyEventL (const TKeyEvent &, TEventCode )
IMPORT_C void ResetMinimumSize ()
IMPORT_C void SetCommandObserver ( MEikCommandObserver *)
IMPORT_C void SetHorizontal ()
IMPORT_C void SetMinButtonWidth ( TInt )
void UpdateHotKeyL ( TInt , CEikLabeledButton::TFlags , TInt )
Protected Member Functions
IMPORT_C void WriteInternalStateL ( RWriteStream &)
Private Member Functions
IMPORT_C void ActivateL ()
void AddCommandL ( TInt , TInt , const TDesC *, const CFbsBitmap *, const CFbsBitmap *)
void AddCommandSetToStackL ( TInt )
void AddCommandToStackL ( TInt , TInt , const TDesC *, const CFbsBitmap *, const CFbsBitmap *)
void AddCommandToStackL ( TInt , TInt )
void AdjustMarginsToFit ( TInt8 &, TInt8 &, TInt &)
void AnimateCommandByPosition ( TInt )
void AppendNewLineL ()
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 TInt CountComponentControls ()
void DimCommand ( TInt , TBool )
void DimCommandByPosition ( 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 )
void MakeCommandVisible ( TInt , TBool )
void MakeCommandVisibleByPosition ( TInt , TBool )
void ReduceRect ( TRect &)
TInt RelativePosition ( TInt , TInt &)
void RemoveCommandFromStack ( TInt , TInt )
IMPORT_C void Reserved_2 ()
void SetBoundingRect (const TRect &)
void SetButtonWidths ()
void SetCommandL ( TInt , TInt , const TDesC *, const CFbsBitmap *, const CFbsBitmap *)
void SetCommandL ( TInt , TInt )
void SetCommandSetL ( TInt )
void SetDefaultCommand ( TInt )
void SetMSKCommandObserver ( MEikCommandObserver *)
IMPORT_C void SizeChanged ()
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_C CEikButtonPanel ( )

~CEikButtonPanel()

IMPORT_C ~CEikButtonPanel ( )

Member Functions Documentation

ActivateL()

IMPORT_C void ActivateL ( ) [private, virtual]

AddButtonL(CEikLabeledButton *, TInt)

IMPORT_C void AddButtonL ( CEikLabeledButton * aButton,
TInt aId
)

Parameters

CEikLabeledButton * aButton
TInt aId

AddButtonL(CEikLabeledButton *, TInt, TInt)

IMPORT_C void AddButtonL ( CEikLabeledButton * aButton,
TInt aId,
TInt aRow
)

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

void AddCommandL ( TInt aPosition,
TInt aCommandId,
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)

void AddCommandSetToStackL ( TInt aResourceId ) [private]

Parameters

TInt aResourceId

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

void AddCommandToStackL ( TInt aPosition,
TInt aCommandId,
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)

void AddCommandToStackL ( TInt aPosition,
TInt aResourceId
) [private]

Parameters

TInt aPosition
TInt aResourceId

AdjustMarginsToFit(TInt8 &, TInt8 &, TInt &)

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

Parameters

TInt8 & aLeftBorder
TInt8 & aRightBorder
TInt & aGapBetweenButtons

AnimateCommandByPosition(TInt)

void AnimateCommandByPosition ( TInt aPosition ) [private]

Parameters

TInt aPosition

AppendNewLineL()

void AppendNewLineL ( ) [private]

AsControl()

CCoeControl * AsControl ( ) [private]

AsControl()

const CCoeControl * AsControl ( ) const [private]

ButtonById(TInt)

IMPORT_C CEikCommandButtonBase * ButtonById ( TInt aButtonId ) const

Parameters

TInt aButtonId

ButtonCount()

TInt ButtonCount ( ) const [private]

ButtonForKey(TInt, TInt &)

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

Parameters

TInt aChar
TInt & aButtonId

ButtonGroupFlags()

TUint ButtonGroupFlags ( ) const [private]

ButtonId(CCoeControl *)

IMPORT_C TInt ButtonId ( CCoeControl * aControl ) const

Parameters

CCoeControl * aControl

ButtonsConsumedKeyL(TInt)

TBool ButtonsConsumedKeyL ( TInt aCode ) [private]

Parameters

TInt aCode

CalcMinimumSizeL(TInt)

TSize CalcMinimumSizeL ( TInt aResourceId ) [private]

Parameters

TInt aResourceId

CommandId(TInt)

TInt CommandId ( TInt aCommandPos ) const [private]

Parameters

TInt aCommandPos

CommandPos(TInt)

TInt CommandPos ( TInt aCommandId ) const [private]

Parameters

TInt aCommandId

ComponentControl(TInt)

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

Parameters

TInt aIndex

ConstructFromResourceL(TResourceReader &)

IMPORT_C void ConstructFromResourceL ( TResourceReader & aReader ) [virtual]

Parameters

TResourceReader & aReader

ConstructL()

IMPORT_C void ConstructL ( )

CountComponentControls()

IMPORT_C TInt CountComponentControls ( ) const [private, virtual]

DimCommand(TInt, TBool)

void DimCommand ( TInt aCommandId,
TBool aDimmed
) [private]

Parameters

TInt aCommandId
TBool aDimmed

DimCommandByPosition(TInt, TBool)

void DimCommandByPosition ( TInt aPosition,
TBool aDimmed
) [private]

Parameters

TInt aPosition
TBool aDimmed

ExtensionInterface(TUid)

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

From CAknControl

Parameters

TUid aInterface

GetColorUseListL(CArrayFix< TCoeColorUse > &)

IMPORT_C void GetColorUseListL ( 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 ( TInt aCommandId ) const [private]

Parameters

TInt aCommandId

GroupControlById(TInt)

CCoeControl * GroupControlById ( TInt aCommandId ) const [private]

Parameters

TInt aCommandId

HandleControlEventL(CCoeControl *, TCoeEvent)

IMPORT_C void HandleControlEventL ( CCoeControl * aControl,
TCoeEvent aEventType
)

Parameters

CCoeControl * aControl
TCoeEvent aEventType

HandlePointerEventL(const TPointerEvent &)

IMPORT_C void HandlePointerEventL ( const TPointerEvent & aPointerEvent ) [virtual]

Parameters

const TPointerEvent & aPointerEvent

HandleResourceChange(TInt)

IMPORT_C void HandleResourceChange ( TInt aType ) [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 ( TInt aCommandId ) const [private]

Parameters

TInt aCommandId

IsCommandDimmedByPosition(TInt)

TBool IsCommandDimmedByPosition ( TInt aPosition ) const [private]

Parameters

TInt aPosition

IsCommandVisible(TInt)

TBool IsCommandVisible ( TInt aCommandId ) const [private]

Parameters

TInt aCommandId

IsCommandVisibleByPosition(TInt)

TBool IsCommandVisibleByPosition ( TInt aPosition ) const [private]

Parameters

TInt aPosition

LabeledButtonById(TInt)

IMPORT_C CEikLabeledButton * LabeledButtonById ( TInt aButtonId ) const

Parameters

TInt aButtonId

LabeledButtonByPosition(TInt, TInt &)

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

Parameters

TInt aPosition
TInt & aGroupIndex

LabeledButtonByPosition(TInt)

CEikLabeledButton * LabeledButtonByPosition ( TInt aPosition ) const [private]

Parameters

TInt aPosition

MakeButtonVisible(TInt, TBool)

IMPORT_C void MakeButtonVisible ( TInt aButtonId,
TBool aVisible
)

Parameters

TInt aButtonId
TBool aVisible

MakeCommandVisible(TInt, TBool)

void MakeCommandVisible ( TInt aCommandId,
TBool aVisible
) [private]

Parameters

TInt aCommandId
TBool aVisible

MakeCommandVisibleByPosition(TInt, TBool)

void MakeCommandVisibleByPosition ( TInt aPosition,
TBool aVisible
) [private]

Parameters

TInt aPosition
TBool aVisible

MinimumSize()

IMPORT_C TSize MinimumSize ( ) [virtual]

OfferKeyEventL(const TKeyEvent &, TEventCode)

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

Parameters

const TKeyEvent & aKeyEvent
TEventCode aType

ReduceRect(TRect &)

void ReduceRect ( TRect & aBoundingRect ) const [private]

Parameters

TRect & aBoundingRect

RelativePosition(TInt, TInt &)

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

Parameters

TInt aCommandPos
TInt & aGroupIndex

RemoveCommandFromStack(TInt, TInt)

void RemoveCommandFromStack ( TInt aPosition,
TInt aCommandId
) [private]

Parameters

TInt aPosition
TInt aCommandId

Reserved_2()

IMPORT_C void Reserved_2 ( ) [private, virtual]

ResetMinimumSize()

IMPORT_C void ResetMinimumSize ( )

SetBoundingRect(const TRect &)

void SetBoundingRect ( const TRect & aBoundingRect ) [private]

Parameters

const TRect & aBoundingRect

SetButtonWidths()

void SetButtonWidths ( ) [private]

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

void SetCommandL ( TInt aPosition,
TInt aCommandId,
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)

void SetCommandL ( TInt aPosition,
TInt aResourceId
) [private]

Parameters

TInt aPosition
TInt aResourceId

SetCommandObserver(MEikCommandObserver *)

IMPORT_C void SetCommandObserver ( MEikCommandObserver * aCommandObserver )

Parameters

MEikCommandObserver * aCommandObserver

SetCommandSetL(TInt)

void SetCommandSetL ( TInt aResourceId ) [private]

Parameters

TInt aResourceId

SetDefaultCommand(TInt)

void SetDefaultCommand ( TInt aCommandId ) [private]

Parameters

TInt aCommandId

SetHorizontal()

IMPORT_C void SetHorizontal ( )

SetMSKCommandObserver(MEikCommandObserver *)

void SetMSKCommandObserver ( MEikCommandObserver * aCommandObserver ) [private]

Parameters

MEikCommandObserver * aCommandObserver

SetMinButtonWidth(TInt)

IMPORT_C void SetMinButtonWidth ( TInt aWidth )

Parameters

TInt aWidth

SizeChanged()

IMPORT_C void SizeChanged ( ) [private, virtual]

UpdateHotKeyL(TInt, CEikLabeledButton::TFlags, TInt)

void UpdateHotKeyL ( TInt aCommandId,
CEikLabeledButton::TFlags aFlags,
TInt aKeyCode
)

Parameters

TInt aCommandId
CEikLabeledButton::TFlags aFlags
TInt aKeyCode

WriteInternalStateL(RWriteStream &)

IMPORT_C void WriteInternalStateL ( 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]

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.