UIQ Technology
Symbian OS Library

UIQ 3.1 SDK        UIQ developer portal

[Index] [Spacer] [Previous] [Next]



Location: EIKBTPAN.H
Link against: eikcoctl.lib

Class CEikButtonPanel

Interface status: deprecated

class CEikButtonPanel : public CCoeControl, public MCoeControlObserver, public MEikButtonGroup;

Description

Deprecated class.

Derivation

Members

Defined in CEikButtonPanel:
ActivateL(), AddButtonL(), AddButtonL(), AddCommandL(), AddCommandSetToStackL(), AddCommandToStackL(), AddCommandToStackL(), AsControl(), AsControl(), ButtonById(), ButtonCount(), ButtonForKey(), ButtonGroupFlags(), ButtonId(), CEikButtonPanel(), CalcMinimumSizeL(), CommandId(), CommandPos(), ComponentControl(), ConstructFromResourceL(), ConstructL(), CountComponentControls(), DimCommand(), GetColorUseListL(), GroupControlAsButton(), GroupControlById(), HandleControlEventL(), HandleResourceChange(), IsCommandDimmed(), IsCommandVisible(), LabeledButtonById(), MakeButtonVisible(), MakeCommandVisible(), MinimumSize(), OfferKeyEventL(), ReduceRect(), RemoveCommandFromStack(), Reserved_2(), ResetMinimumSize(), SetBoundingRect(), SetCommandL(), SetCommandL(), SetCommandObserver(), SetCommandSetL(), SetDefaultCommand(), SetHorizontal(), SetMinButtonWidth(), SizeChanged(), WriteInternalStateL(), ~CEikButtonPanel()

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

Inherited from CCoeControl:
AccumulatedZoom(), ActivateGc(), BackedUpWindow(), Background(), CapturesPointer(), ClaimPointerGrab(), CloseWindow(), ComponentArrayExists(), Components(), ControlContext(), ControlEnv(), CopyControlContextFrom(), CreateBackedUpWindowL(), CreateWindowL(), DeactivateGc(), Draw(), DrawBackground(), DrawDeferred(), DrawForeground(), DrawNow(), DrawableWindow(), EAbsoluteZoom, ERelativeZoom, EnableDragEvents(), FindBackground(), FindFontProvider(), FocusChanged(), GetColor(), GetGc(), GetHelpContext(), GetTextDrawer(), GrabbingComponent(), HandleComponentControlsResourceChange(), HandleControlArrayEventL(), HandlePointerBufferReadyL(), HandlePointerEventL(), HandleRedrawEvent(), HasBorder(), HitTest(), IgnoreEventsUntilNextPointerUp(), Index(), InitComponentArrayL(), InputCapabilities(), IsActivated(), IsBackedUp(), IsBeingDestroyed(), IsBlank(), IsDimmed(), IsFocused(), IsNonFocusing(), IsReadyToDraw(), IsVisible(), LayoutManager(), MakeVisible(), MaximumWidth(), MopNext(), MopSupplyObject(), Observer(), OverrideColorL(), OwnsWindow(), Parent(), Position(), PositionChanged(), PositionRelativeToScreen(), PrepareForFocusGainL(), PrepareForFocusLossL(), Rect(), RecursivelyMergedInputCapabilities(), ReportEventL(), RequestRelayout(), ResetGc(), ScreenFont(), SetAdjacent(), SetAllowStrayPointers(), SetBackground(), SetBlank(), SetCanDrawOutsideRect(), SetComponentsToInheritVisibility(), SetContainerWindowL(), SetControlContext(), SetCornerAndSize(), SetDimmed(), SetExtent(), SetExtentToWholeScreen(), SetFocus(), SetFocusing(), SetFontProviderL(), SetGc(), SetGloballyCapturing(), SetHitTest(), SetLayoutManagerL(), SetMaximumWidth(), SetMopParent(), SetNeighbor(), SetNonFocusing(), SetObserver(), SetParent(), SetPointerCapture(), SetPosition(), SetRect(), SetSize(), SetSizeWithoutNotification(), SetTextBaselineSpacing(), SetUniqueHandle(), SetZoomFactorL(), Size(), SystemGc(), TZoomType, TextBaselineOffset(), TextDrawer(), UniqueHandle(), Window(), ZoomWithType(), iCoeEnv, iContext, iPosition, iSize

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

Inherited from MObjectProvider:
MObjectProvider_Reserved1(), MObjectProvider_Reserved2(), MopGetObject(), MopGetObjectNoChaining()


Construction and destruction


CEikButtonPanel()

Interface status: deprecatedInherited from: CEikButtonPanel

IMPORT_C CEikButtonPanel();

Description


~CEikButtonPanel()

Interface status: deprecatedInherited from: CEikButtonPanel

IMPORT_C ~CEikButtonPanel();

Description


ConstructL()

Interface status: deprecatedInherited from: CEikButtonPanel

IMPORT_C void ConstructL();

Description

[Top]


Member functions


AddButtonL()

Interface status: deprecatedInherited from: CEikButtonPanel

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

Description

Parameters

CEikLabeledButton *aButton

TInt aId


AddButtonL()

Interface status: deprecatedInherited from: CEikButtonPanel

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

Description

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


SetHorizontal()

Interface status: deprecatedInherited from: CEikButtonPanel

IMPORT_C void SetHorizontal();

Description


ButtonId()

Interface status: deprecatedInherited from: CEikButtonPanel

IMPORT_C TInt ButtonId(CCoeControl *aControl) const;

Description

Parameters

CCoeControl *aControl

Return value

TInt


ButtonById()

Interface status: deprecatedInherited from: CEikButtonPanel

IMPORT_C CEikCommandButtonBase *ButtonById(TInt aButtonId) const;

Description

Parameters

TInt aButtonId

Return value

CEikCommandButtonBase *


LabeledButtonById()

Interface status: deprecatedInherited from: CEikButtonPanel

IMPORT_C CEikLabeledButton *LabeledButtonById(TInt aButtonId) const;

Description

Parameters

TInt aButtonId

Return value

CEikLabeledButton *


MakeButtonVisible()

Interface status: deprecatedInherited from: CEikButtonPanel

IMPORT_C void MakeButtonVisible(TInt aButtonId, TBool aVisible);

Description

Parameters

TInt aButtonId

TBool aVisible


ButtonForKey()

Interface status: deprecatedInherited from: CEikButtonPanel

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

Description

Parameters

TInt aChar

TInt &aButtonId

Return value

CEikCommandButtonBase *


ResetMinimumSize()

Interface status: deprecatedInherited from: CEikButtonPanel

IMPORT_C void ResetMinimumSize();

Description


SetMinButtonWidth()

Interface status: deprecatedInherited from: CEikButtonPanel

IMPORT_C void SetMinButtonWidth(TInt aWidth);

Description

Parameters

TInt aWidth


SetCommandObserver()

Interface status: deprecatedInherited from: CEikButtonPanel

IMPORT_C void SetCommandObserver(MEikCommandObserver *aCommandObserver);

Description

Parameters

MEikCommandObserver *aCommandObserver


ConstructFromResourceL()

Interface status: deprecatedInherited from: CEikButtonPanel

virtual IMPORT_C void ConstructFromResourceL(TResourceReader &aReader);

Description

Parameters

TResourceReader &aReader


MinimumSize()

Interface status: deprecatedInherited from: CEikButtonPanel

virtual IMPORT_C TSize MinimumSize();

Description

Return value

TSize


GetColorUseListL()

Interface status: deprecatedInherited from: CEikButtonPanel

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

Description

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.

Parameters

CArrayFix< TCoeColorUse > &aColorUseList


HandleResourceChange()

Interface status: deprecatedInherited from: CEikButtonPanel

virtual IMPORT_C void HandleResourceChange(TInt aType);

Description

Handles a change to the control's resources of type aType which are shared across the environment, e.g. colors or fonts.

Parameters

TInt aType


OfferKeyEventL()

Interface status: deprecatedInherited from: CEikButtonPanel

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

Description

Parameters

const TKeyEvent &aKeyEvent

TEventCode aType

Return value

TKeyResponse


WriteInternalStateL()

Interface status: deprecatedInherited from: CEikButtonPanel

protected: virtual IMPORT_C void WriteInternalStateL(RWriteStream &aWriteStream) const;

Description

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


HandleControlEventL()

Interface status: deprecatedInherited from: CEikButtonPanel

virtual IMPORT_C void HandleControlEventL(CCoeControl *aControl, TCoeEvent aEventType);

Description

Handles an event from an observed control.

This function is called when a control for which this control is the observer calls CCoeControl::ReportEventL(). It should be implemented by the observer control, and should handle all events sent by controls it observes.

Parameters

CCoeControl *aControl

The control that sent the event.

TCoeEvent aEventType

The event type.


SetCommandL()

Interface status: deprecatedInherited from: CEikButtonPanel

private: virtual void SetCommandL(TInt aPosition, TInt aCommandId, const TDesC *aText, const CFbsBitmap *aBitmap, const CFbsBitmap *aMask);

Description

Parameters

TInt aPosition

TInt aCommandId

const TDesC *aText

const CFbsBitmap *aBitmap

const CFbsBitmap *aMask


SetCommandL()

Interface status: deprecatedInherited from: CEikButtonPanel

private: virtual void SetCommandL(TInt aPosition, TInt aResourceId);

Description

Parameters

TInt aPosition

TInt aResourceId


SetCommandSetL()

Interface status: deprecatedInherited from: CEikButtonPanel

private: virtual void SetCommandSetL(TInt aResourceId);

Description

Parameters

TInt aResourceId


AddCommandL()

Interface status: deprecatedInherited from: CEikButtonPanel

private: virtual void AddCommandL(TInt aPosition, TInt aCommandId, const TDesC *aText, const CFbsBitmap *aBitmap, const CFbsBitmap *aMask);

Description

Parameters

TInt aPosition

TInt aCommandId

const TDesC *aText

const CFbsBitmap *aBitmap

const CFbsBitmap *aMask


AddCommandToStackL()

Interface status: deprecatedInherited from: CEikButtonPanel

private: virtual void AddCommandToStackL(TInt aPosition, TInt aCommandId, const TDesC *aText, const CFbsBitmap *aBitmap, const CFbsBitmap *aMask);

Description

Parameters

TInt aPosition

TInt aCommandId

const TDesC *aText

const CFbsBitmap *aBitmap

const CFbsBitmap *aMask


AddCommandToStackL()

Interface status: deprecatedInherited from: CEikButtonPanel

private: virtual void AddCommandToStackL(TInt aPosition, TInt aResourceId);

Description

Parameters

TInt aPosition

TInt aResourceId


AddCommandSetToStackL()

Interface status: deprecatedInherited from: CEikButtonPanel

private: virtual void AddCommandSetToStackL(TInt aResourceId);

Description

Parameters

TInt aResourceId


SetDefaultCommand()

Interface status: deprecatedInherited from: CEikButtonPanel

private: virtual void SetDefaultCommand(TInt aCommandId);

Description

Parameters

TInt aCommandId


CalcMinimumSizeL()

Interface status: deprecatedInherited from: CEikButtonPanel

private: virtual TSize CalcMinimumSizeL(TInt aResourceId);

Description

Parameters

TInt aResourceId

Return value

TSize


RemoveCommandFromStack()

Interface status: deprecatedInherited from: CEikButtonPanel

private: virtual void RemoveCommandFromStack(TInt aPosition, TInt aCommandId);

Description

Parameters

TInt aPosition

TInt aCommandId


CommandPos()

Interface status: deprecatedInherited from: CEikButtonPanel

private: virtual TInt CommandPos(TInt aCommandId) const;

Description

Parameters

TInt aCommandId

Return value

TInt


DimCommand()

Interface status: deprecatedInherited from: CEikButtonPanel

private: virtual void DimCommand(TInt aCommandId, TBool aDimmed);

Description

Parameters

TInt aCommandId

TBool aDimmed


IsCommandDimmed()

Interface status: deprecatedInherited from: CEikButtonPanel

private: virtual TBool IsCommandDimmed(TInt aCommandId) const;

Description

Parameters

TInt aCommandId

Return value

TBool


MakeCommandVisible()

Interface status: deprecatedInherited from: CEikButtonPanel

private: virtual void MakeCommandVisible(TInt aCommandId, TBool aVisible);

Description

Parameters

TInt aCommandId

TBool aVisible


IsCommandVisible()

Interface status: deprecatedInherited from: CEikButtonPanel

private: virtual TBool IsCommandVisible(TInt aCommandId) const;

Description

Parameters

TInt aCommandId

Return value

TBool


AsControl()

Interface status: deprecatedInherited from: CEikButtonPanel

private: virtual CCoeControl *AsControl();

Description

Return value

CCoeControl *


AsControl()

Interface status: deprecatedInherited from: CEikButtonPanel

private: virtual const CCoeControl *AsControl() const;

Description

Return value

const CCoeControl *


SetBoundingRect()

Interface status: deprecatedInherited from: CEikButtonPanel

private: virtual void SetBoundingRect(const TRect &aBoundingRect);

Description

Parameters

const TRect &aBoundingRect


ReduceRect()

Interface status: deprecatedInherited from: CEikButtonPanel

private: virtual void ReduceRect(TRect &aBoundingRect) const;

Description

Parameters

TRect &aBoundingRect


GroupControlById()

Interface status: deprecatedInherited from: CEikButtonPanel

private: virtual CCoeControl *GroupControlById(TInt aCommandId) const;

Description

Parameters

TInt aCommandId

Return value

CCoeControl *


GroupControlAsButton()

Interface status: deprecatedInherited from: CEikButtonPanel

private: virtual CEikCommandButton *GroupControlAsButton(TInt aCommandId) const;

Description

Parameters

TInt aCommandId

Return value

CEikCommandButton *


CommandId()

Interface status: deprecatedInherited from: CEikButtonPanel

private: virtual TInt CommandId(TInt aCommandPos) const;

Description

Parameters

TInt aCommandPos

Return value

TInt


ButtonCount()

Interface status: deprecatedInherited from: CEikButtonPanel

private: virtual TInt ButtonCount() const;

Description

Return value

TInt


ButtonGroupFlags()

Interface status: deprecatedInherited from: CEikButtonPanel

private: virtual TUint ButtonGroupFlags() const;

Description

Return value

TUint


ActivateL()

Interface status: deprecatedInherited from: CEikButtonPanel

private: virtual IMPORT_C void ActivateL();

Description


CountComponentControls()

Interface status: deprecatedInherited from: CEikButtonPanel

private: virtual IMPORT_C TInt CountComponentControls() const;

Description

Return value

TInt


ComponentControl()

Interface status: deprecatedInherited from: CEikButtonPanel

private: virtual IMPORT_C CCoeControl *ComponentControl(TInt aIndex) const;

Description

Parameters

TInt aIndex

Return value

CCoeControl *


SizeChanged()

Interface status: deprecatedInherited from: CEikButtonPanel

private: virtual IMPORT_C void SizeChanged();

Description


Reserved_2()

Interface status: deprecatedInherited from: CEikButtonPanel

private: virtual IMPORT_C void Reserved_2();

Description