CEikToolBar Class Reference

class CEikToolBar : public CEikControlGroup

A vertical group of controls displayed down the right-hand side of the screen in an application.

It contains buttons which are used to issue application commands, and other controls. A toolband may also be created using this class, by setting the EEikToolBarHorizontal flag and initialising from a TOOLBAND resource.

eikcoctl.lib
Since
S60 0.9
Public Member Functions
CEikToolBar ()
~CEikToolBar ()
IMPORT_C void AddControlL ( CCoeControl *, TInt )
IMPORT_C void AddControlL ( TEikGroupControl &)
void AddControlTypeL ( TInt )
IMPORT_C void ConstructFromResourceL ( TResourceReader &)
IMPORT_C void ConstructL ( MEikCommandObserver *, TInt , const TRect &)
TBool ControlIsButton ( TInt )
IMPORT_C void CoordinateButtons ( TInt , TInt , TEikButtonCoordinator *)
IMPORT_C TBool DelayActivation ()
IMPORT_C void GetColorUseListL ( CArrayFix < TCoeColorUse > &)
IMPORT_C void HandlePointerEventL (const TPointerEvent &)
IMPORT_C void HandleResourceChange ( TInt )
IMPORT_C void ReduceRect ( TRect &)
void RemoveControlType ( TInt )
IMPORT_C void SetBoundingRect (const TRect &)
IMPORT_C void SetButtonStateOn ( TInt , TBool )
IMPORT_C void SetCommandObserver ( MEikCommandObserver *)
IMPORT_C void SetDimmed ( TBool )
IMPORT_C void StaticConstructL ( MEikCommandObserver *, TInt )
Protected Member Functions
IMPORT_C void WriteInternalStateL ( RWriteStream &)
Private Member Functions
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 AnimateCommandByPosition ( TInt )
CCoeControl * AsControl ()
const CCoeControl * AsControl ()
void BaseConstructL ()
CEikCommandButton * ButtonByIndex ( TInt )
TInt ButtonCount ()
TUint ButtonGroupFlags ()
TSize CalcMinimumSizeL ( TInt )
TInt CommandId ( TInt )
TInt CommandPos ( TInt )
TInt ControlCount ()
TInt CurrentId ( TInt )
void DimCommand ( TInt , TBool )
void DimCommandByPosition ( TInt , TBool )
IMPORT_C void * ExtensionInterface ( TUid )
CEikCommandButton * GroupControlAsButton ( TInt )
CCoeControl * GroupControlById ( TInt )
TEikGroupControl & GroupControlByIndex ( TInt )
IMPORT_C void HandleControlEventL ( CCoeControl *, TCoeEvent)
TInt IndexFromPosition ( TInt )
TBool IsCommandDimmed ( TInt )
TBool IsCommandDimmedByPosition ( TInt )
TBool IsCommandVisible ( TInt )
TBool IsCommandVisibleByPosition ( TInt )
void MakeCommandVisible ( TInt , TBool )
void MakeCommandVisibleByPosition ( TInt , TBool )
void RemoveCommandFromStack ( TInt , TInt )
IMPORT_C void Reserved_2 ()
void SetCommandL ( TInt , TInt , const TDesC *, const CFbsBitmap *, const CFbsBitmap *)
void SetCommandL ( TInt , TInt )
void SetCommandSetL ( TInt )
void SetCurrentId ( TInt , TInt )
void SetDefaultCommand ( TInt )
void SetMSKCommandObserver ( MEikCommandObserver *)
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::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::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::OfferKeyEventL(const TKeyEvent &,TEventCode)
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::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()
CEikBorderedControl::Border()const
CEikBorderedControl::CEikBorderedControl()
CEikBorderedControl::CEikBorderedControl(const TGulBorder &)
CEikBorderedControl::HasBorder()const
CEikBorderedControl::SetAdjacent(TInt)
CEikBorderedControl::SetBorder(TGulBorder::TBorderType)
CEikBorderedControl::SetBorder(TInt)
CEikControlGroup::CEikControlGroup()
CEikControlGroup::ComponentControl(TInt)const
CEikControlGroup::ConstructL(TStartCorner,TOrientation)
CEikControlGroup::Control(TInt)const
CEikControlGroup::ControlArray()const
CEikControlGroup::ControlById(TInt)const
CEikControlGroup::ControlId(CCoeControl *)const
CEikControlGroup::ControlSpacing(TInt &,TInt &)const
CEikControlGroup::CountComponentControls()const
CEikControlGroup::DeleteControl(TInt,TInt)
CEikControlGroup::IndexById(TInt)const
CEikControlGroup::InsertControlL(TEikGroupControl &,TInt)
CEikControlGroup::LayoutControls()
CEikControlGroup::MinimumSize()
CEikControlGroup::Orientation()const
CEikControlGroup::Reset()
CEikControlGroup::SetBreadthInPixels(TInt)
CEikControlGroup::SetControlLayout(TStartCorner,TOrientation)
CEikControlGroup::SetControlSpacing(TInt,TInt)
CEikControlGroup::SetControlsAllSameSize()
CEikControlGroup::SetLengthInPixels(TInt)
CEikControlGroup::SetMSKVisibility(TBool)
CEikControlGroup::SetNumberOfLines(TInt,TBool)
CEikControlGroup::~CEikControlGroup()
Inherited Enumerations
CCoeControl:TZoomType
CEikControlGroup:@146
CEikControlGroup:TOrientation
CEikControlGroup:TStartCorner
Private Attributes
CCoeBrushAndPenContext * iBrushAndPenContext
MEikCommandObserver * iCommandObserver
CArrayFix < TInt > * iControlTypes
TInt iToolBarFlags
Inherited Attributes
CCoeControl::iCoeEnv
CCoeControl::iContext
CCoeControl::iPosition
CCoeControl::iSize
CEikBorderedControl::iBorder
CEikControlGroup::iControlArray

Constructor & Destructor Documentation

CEikToolBar()

IMPORT_C CEikToolBar ( )

Default C++ constructor. Creates a new toolbar object, but does not initialise any of its heap-stored members.

~CEikToolBar()

IMPORT_C ~CEikToolBar ( )

Destructor. Deletes the toolbar's brush and pen context and control types.

Member Functions Documentation

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

AddControlL(CCoeControl *, TInt)

IMPORT_C void AddControlL ( CCoeControl * aControl,
TInt aId
) [virtual]

From CEikControlGroup . Adds a control to the control group.

From CEikControlGroup

panic
EIKCOCTL-26 If the control does not exist.

Parameters

CCoeControl * aControl The control to add to the control group
TInt aId The control's ID.

AddControlL(TEikGroupControl &)

IMPORT_C void AddControlL ( TEikGroupControl & aGroupControl ) [virtual]

Adds a control wrapped with its ID and length to the control group.

From CEikControlGroup

panic
EIKCOCTL-26 If the control does not exist.

Parameters

TEikGroupControl & aGroupControl The wrapped control to add.

AddControlTypeL(TInt)

void AddControlTypeL ( TInt aType )

Adds a control type to the control type array.

Parameters

TInt aType

AnimateCommandByPosition(TInt)

void AnimateCommandByPosition ( TInt aPosition ) [private]

Parameters

TInt aPosition

AsControl()

CCoeControl * AsControl ( ) [private]

AsControl()

const CCoeControl * AsControl ( ) const [private]

BaseConstructL()

void BaseConstructL ( ) [private]

ButtonByIndex(TInt)

CEikCommandButton * ButtonByIndex ( TInt aIndex ) const [private]

Parameters

TInt aIndex

ButtonCount()

TInt ButtonCount ( ) const [private]

ButtonGroupFlags()

TUint ButtonGroupFlags ( ) const [private]

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

ConstructFromResourceL(TResourceReader &)

IMPORT_C void ConstructFromResourceL ( TResourceReader & aReader ) [virtual]

From CCoeControl . Second-phase construction from a resource. This is called by StaticConstructL() with an appropriate reader.

From CCoeControl

panic
EIKCOCTL-36 If the control on the toolbar cannot be constructed.

Parameters

TResourceReader & aReader A resource reader pointing at a TOOLBAR or TOOLBAND resource defining the toolbar.

ConstructL(MEikCommandObserver *, TInt, const TRect &)

IMPORT_C void ConstructL ( MEikCommandObserver * aCommandObserver,
TInt aResourceId,
const TRect & aBoundingRect
)

Completes construction of a default-constructed toolbar.

The command observer interface defines a method for creating custom controls on the toolbar from user-defined IDs specified in the resource aResourceId .

IDs for controls which cannot be constructed using EikControlFactory::CreateByTypeL() are passed to this object's command observer for construction.

Applications requiring custom controls in their toolbars should override their AppUI's CreateCustomCommandControlL() method, inherited from MEikCommandObserver .

MEikCommandObserver::ProcessCommandL() . Typically the observer is the application's AppUI.
panic
EIKCOCTL-36 If the control on the toolbar cannot be constructed.

Parameters

MEikCommandObserver * aCommandObserver Sets the command observer for this toolbar. The observer's ProcessCommandL() function is invoked when a toolbar command is invoked by the user.
TInt aResourceId The ID of a TOOLBAR or TOOLBAND resource structure.
const TRect & aBoundingRect Defines the rectangle to which the toolbar's extent must be limited. This is typically given by CEikAppUi::ClientRect(), which returns the extent of the whole application window, less the extent of any toolbars that already exist and are owned by the AppUI.

ControlCount()

TInt ControlCount ( ) const [private]

ControlIsButton(TInt)

TBool ControlIsButton ( TInt aIndex ) const

Used to check if a control is a button type control or not.

Parameters

TInt aIndex

CoordinateButtons(TInt, TInt, TEikButtonCoordinator *)

IMPORT_C void CoordinateButtons ( TInt aId,
TInt aCount,
TEikButtonCoordinator * aCoordinator
)

Sets the button co-ordinator for a group of buttons in a toolbar.

Parameters

TInt aId Command identifying a toolbar button.
TInt aCount The number of buttons in the group.
TEikButtonCoordinator * aCoordinator The button coordinator.

CurrentId(TInt)

TInt CurrentId ( TInt aPosition ) const [private]

Parameters

TInt aPosition

DelayActivation()

IMPORT_C TBool DelayActivation ( ) const

Delays activation of the toolbar when constructed.

This function sets the toolbar flag EEikToolBarDelayActivation . If this flag is set when ConstructL() is called on the toolbar, the toolbar will be constructed but not activated.

The application can subsequently activate the toolbar by calling CCoeControl::ActivateL() .

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]

Parameters

TUid aInterface

GetColorUseListL(CArrayFix< TCoeColorUse > &)

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

Gets the list of logical colours used to draw the control. Appends the list to aColorUseList paired with an explanation of how the colours are used.

From CCoeControl

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 The list of logical colours.

GroupControlAsButton(TInt)

CEikCommandButton * GroupControlAsButton ( TInt aCommandId ) const [private]

Parameters

TInt aCommandId

GroupControlById(TInt)

CCoeControl * GroupControlById ( TInt aCommandId ) const [private]

Parameters

TInt aCommandId

GroupControlByIndex(TInt)

TEikGroupControl & GroupControlByIndex ( TInt aIndex ) const [private]

Parameters

TInt aIndex

HandleControlEventL(CCoeControl *, TCoeEvent)

IMPORT_C void HandleControlEventL ( CCoeControl * aControl,
TCoeEvent aEvent
) [private]

Parameters

CCoeControl * aControl
TCoeEvent aEvent

HandlePointerEventL(const TPointerEvent &)

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

Handles pointer events.

This function gets called whenever a pointer event occurs in the control, i.e. when the pointer is within the control's extent, or when the control has grabbed the pointer.

If overriding this method, the implementation must include a base call to this method.

From CCoeControl .

Parameters

const TPointerEvent & aPointerEvent The pointer event.

HandleResourceChange(TInt)

IMPORT_C void HandleResourceChange ( TInt aType ) [virtual]

Handles a change to the control's resources.

The types of resources handled are those which are shared across the environment, e.g. colours or fonts. For colour scheme changes, DrawDeferred() is called in order to redraw the control.

If overriding this method, the implementation must include a base call to this method.

From CCoeControl .

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 The type of resource that has changed.

IndexFromPosition(TInt)

TInt IndexFromPosition ( TInt aPos ) const [private]

Parameters

TInt aPos

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

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

ReduceRect(TRect &)

IMPORT_C void ReduceRect ( TRect & aBoundingRect ) const

Shrinks a rectangle to exclude the toolbar area. This function reduces the size of the rectangle passed into the function so that on return, the area occupied by the toolbar or toolband is removed from the rectangle. It is provided to prevent drawing over an existing toolbar or toolband.

From MEikButtonGroup

Parameters

TRect & aBoundingRect Specifies a rectangle which, on return, is shrunk to exclude the toolbar s extent.

RemoveCommandFromStack(TInt, TInt)

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

Parameters

TInt aPosition
TInt aCommandId

RemoveControlType(TInt)

void RemoveControlType ( TInt aIndex )

Removes a control type from the control type array.

Parameters

TInt aIndex

Reserved_2()

IMPORT_C void Reserved_2 ( ) [private, virtual]

SetBoundingRect(const TRect &)

IMPORT_C void SetBoundingRect ( const TRect & aBoundingRect )

From MEikButtonGroup . Sets the toolbar's bounding rectangle. This function has a different effect on the toolbar's extent, depending on whether the toolbar is vertical or horizontal.

For a vertical toolbar, sets the toolbar height to equal the height of the bounding rectangle.

For a horizontal toolbar (toolband), sets the toolband width to equal the width of the bounding rectangle.

From MEikButtonGroup

Parameters

const TRect & aBoundingRect The toolbar's bounding rectangle.

SetButtonStateOn(TInt, TBool)

IMPORT_C void SetButtonStateOn ( TInt aId,
TBool aState
)

Sets the state of the specified button and draws the button to show the new state.

Parameters

TInt aId The command that identifies the button.
TBool aState ETrue to set the button, EFalse to clear the button.

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 )

Sets the toolbar's command observer. Applications will not typically need to use this function.

Parameters

MEikCommandObserver * aCommandObserver The command observer for this toolbar. When a command is invoked in the toolbar, HandleCommandL() is called in the observer.

SetCommandSetL(TInt)

void SetCommandSetL ( TInt aResourceId ) [private]

Parameters

TInt aResourceId

SetCurrentId(TInt, TInt)

void SetCurrentId ( TInt aPosition,
TInt aId
) [private]

Parameters

TInt aPosition
TInt aId

SetDefaultCommand(TInt)

void SetDefaultCommand ( TInt aCommandId ) [private]

Parameters

TInt aCommandId

SetDimmed(TBool)

IMPORT_C void SetDimmed ( TBool aDimmed ) [virtual]

Sets the toolbar dimmed or not dimmed. Dimming usually indicates that user input is not accepted.

From CCoeControl

Parameters

TBool aDimmed ETrue to set as dimmed , EFalse to set as not dimmed.

SetMSKCommandObserver(MEikCommandObserver *)

void SetMSKCommandObserver ( MEikCommandObserver * aCommandObserver ) [private]

Parameters

MEikCommandObserver * aCommandObserver

StaticConstructL(MEikCommandObserver *, TInt)

IMPORT_C void StaticConstructL ( MEikCommandObserver * aCommandObserver,
TInt aResourceId
)

Creates a toolbar from a resource definition, but does not set its extent or activate it.

This function is used by ConstructL() , applications will not typically need to use it.

panic
EIKCOCTL-36 If the control on the toolbar cannot be constructed.

Parameters

MEikCommandObserver * aCommandObserver Specifies the object in which HandleCommandL() is called when a toolbar command is invoked, typically the application's AppUI.
TInt aResourceId The resource that defines the toolbar.

WriteInternalStateL(RWriteStream &)

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

Writes the internal state of the control and its components to aWriteStream . Does nothing in release mode.

Designed to be overridden and base called from subclasses.

From CCoeControl

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 A connected write stream.

Member Data Documentation

CCoeBrushAndPenContext * iBrushAndPenContext

CCoeBrushAndPenContext * iBrushAndPenContext [private]

MEikCommandObserver * iCommandObserver

MEikCommandObserver * iCommandObserver [private]

CArrayFix< TInt > * iControlTypes

CArrayFix < TInt > * iControlTypes [private]

TInt iToolBarFlags

TInt iToolBarFlags [private]