Class CQikToolbar

class CQikToolbar : public CEikBorderedControl, public MCoeControlObserver, public MEikButtonGroup;

Description

An area containing controls at the bottom of the application area.

The CQikToolbar class is an area containing buttons and/or other controls placed at the top, bottom, left or right side of the application area. This is also called north, south, east and west, see TQikToolbarOrientation . The toolbar is created from a resource file. It is possible to align buttons and controls to the left, right or center.

The resource struct defines the properties and controls of a UIQ application toolbar. The resource is used with CQikViewBase::SetViewToolbarL() or the toolbar member of an QIK_VIEW resource to construct a toolbar.

No runtime modification, such as adding or deleting controls, of the toolbar is supported. Controls can be made visible/invisible and dimmed/not dimmed.

It is possible to add the toolbar from this class using CQikAppUi::SetToolbarL(), but this is not recomended. The reason for this is that in UIQ 2.1 and earlier the toolbar was AppUi based, but since UIQ 3.0 the toolbar has become View based and it is therefor strongly recomended that you add it to a view.

Derivation

• MEikButtonGroup - Base class used in the derivation of CEikToolBar and others
• MCoeControlObserver - Interface for a control to send events to its observer control
• MEikBorderedControl - Interface for bordered controls

MObjectProvider - An interface that allows an object to be part of a network of object providers

CBase - Base class for all classes to be instantiated on the heap

• CCoeControl - Control base class from which all other controls are derived
• CEikBorderedControl - A control which is drawn surrounded by a rectangular border
• CQikToolbar - An area containing controls at the bottom of the application area

Members

Defined in CQikToolbar:
Height(), NewL(), NewL(), operator class MQikToolbar &(), operator class MQikToolbar *(), ~CQikToolbar()

Inherited from CBase:
Delete(), Extension_(), operator new()

Inherited from CCoeControl:
AccumulatedZoom(), ActivateGc(), BackedUpWindow(), Background(), CapturesPointer(), ClaimPointerGrab(), CloseWindow(), Components(), ControlContext(), ControlEnv(), CopyControlContextFrom(), CreateBackedUpWindowL(), CreateWindowL(), DeactivateGc(), DrawBackground(), DrawDeferred(), DrawForeground(), DrawNow(), DrawableWindow(), EAbsoluteZoom, ERelativeZoom, EnableDragEvents(), FindBackground(), FindFontProvider(), GetColor(), GetGc(), GrabbingComponent(), HandleComponentControlsResourceChange(), HandleRedrawEvent(), HitTest(), IgnoreEventsUntilNextPointerUp(), Index(), InitComponentArrayL(), IsActivated(), IsBackedUp(), IsBeingDestroyed(), IsBlank(), IsDimmed(), IsFocused(), IsNonFocusing(), IsReadyToDraw(), IsVisible(), LayoutManager(), MaximumWidth(), Observer(), OverrideColorL(), OwnsWindow(), Parent(), Position(), PositionRelativeToScreen(), Rect(), RecursivelyMergedInputCapabilities(), ReportEventL(), Reserved_CCoeControl_10(), Reserved_CCoeControl_11(), Reserved_CCoeControl_12(), Reserved_CCoeControl_13(), ResetGc(), ScreenFont(), SetAllowStrayPointers(), SetBackground(), SetBlank(), SetCanDrawOutsideRect(), SetComponentsToInheritVisibility(), SetControlContext(), SetCornerAndSize(), SetExtent(), SetExtentToWholeScreen(), SetFocus(), SetFocusing(), SetFontProviderL(), SetGc(), SetGloballyCapturing(), SetHitTest(), SetMaximumWidth(), SetMopParent(), SetNonFocusing(), SetObserver(), SetPointerCapture(), SetPosition(), SetRect(), SetSize(), SetSizeWithoutNotification(), SetUniqueHandle(), SetZoomFactorL(), Size(), SystemGc(), TZoomType, TextDrawer(), UniqueHandle(), Window(), ZoomWithType(), iCoeEnv, iContext, iPosition, iSize

Inherited from CEikBorderedControl:
ActivateL(), Border(), ComponentControl(), ConstructFromResourceL(), CountComponentControls(), Draw(), FocusChanged(), GetColorUseListL(), GetHelpContext(), HandleControlArrayEventL(), HandlePointerBufferReadyL(), HandlePointerEventL(), HandleResourceChange(), HasBorder(), InputCapabilities(), MakeVisible(), MinimumSize(), MopSupplyObject(), OfferKeyEventL(), PositionChanged(), PrepareForFocusGainL(), PrepareForFocusLossL(), RequestRelayout(), SetAdjacent(), SetBorder(), SetContainerWindowL(), SetDimmed(), SetLayoutManagerL(), SetNeighbor(), SetParent(), SetTextBaselineSpacing(), SizeChanged(), TextBaselineOffset(), WriteInternalStateL(), iBorder

Inherited from MCoeControlObserver:
EEventInteractionRefused, EEventPrepareFocusTransition, EEventRequestCancel, EEventRequestExit, EEventRequestFocus, EEventStateChanged, HandleControlEventL(), TCoeEvent

Inherited from MEikBorderedControl:
ETypeId, anonymous

Inherited from MEikButtonGroup:
AddCommandL(), AddCommandSetToStackL(), AddCommandToStackL(), AsControl(), ButtonCount(), ButtonGroupFlags(), CalcMinimumSizeL(), CommandId(), CommandPos(), DimCommand(), GroupControlAsButton(), GroupControlById(), IsCommandDimmed(), IsCommandVisible(), MakeCommandVisible(), ReduceRect(), RemoveCommandFromStack(), SetBoundingRect(), SetCommandL(), SetCommandSetL(), SetDefaultCommand()

Inherited from MObjectProvider:
MopGetObject(), MopGetObjectNoChaining()

See also:

• QIK_TOOLBAR
• QIK_VIEW
• TQikToolbarOrientation
• MEikCommandObserver

static IMPORT_C CQikToolbar *NewL(TInt aResourceId, MEikCommandObserver *aCommandObserver);

Description

Creates an instance of the CQikToolbar class.

Parameters

TInt aResourceId The resource ID used to create the toolbar. Can be 0. MEikCommandObserver *aCommandObserver The receiver of notifications from the toolbar.

Return value

CQikToolbar * Pointer to the toolbar instance.

static IMPORT_C CQikToolbar *NewL(CCoeControl *aParent, TInt aResourceId, MEikCommandObserver *aCommandObserver);

Description

Creates an instance of the CQikToolbar class.

Parameters

CCoeControl *aParent Parent for this control to take its window pointer from. TInt aResourceId The resource ID used to create the toolbar. Can be 0. MEikCommandObserver *aCommandObserver The receiver of notifications from the toolbar.

Return value

CQikToolbar * Pointer to the toolbar instance.

IMPORT_C ~CQikToolbar();

Description

Destructor.

IMPORT_C TInt Height() const;

Description

Gets the height of the toolbar.

Return value

TInt The height of the toolbar.

IMPORT_C operator class MQikToolbar *() const;

Description

Return value

IMPORT_C operator class MQikToolbar &() const;

Description

Return value