Symbian Developer Library

SYMBIAN OS V6.1 EDITION FOR C++

[Index] [Glossary] [Previous] [Next]



Location: eikmnbut.h
Link against: eikcoctl.lib

Class CEikMenuButton

CEikMenuButton

Support

Supported from 6.0

Description

A menu button enables a user to initiate display of a menu.

Derivation

CBaseBase class for all classes to be instantiated on the heap
CCoeControlControl base class from which all other controls are derived
CEikBorderedControlA control which is drawn surrounded by a rectangular border
CEikButtonBaseThis is the base class from which concrete button controls (command buttons, option buttons and checkboxes) are derived
CEikCommandButtonCommand button
CEikCommandButtonBaseBase class for command buttons
CEikMenuButtonA menu button enables a user to initiate display of a menu
MCoeControlContextInterface to allow sharing of graphics settings between controls
MEikCommandObserverCommand observers respond to user commands, and have the secondary function of creating custom controls on request for classes such as CEikToolbar, or user-defined classes
MEikMenuObserverMenu observer interface

Defined in CEikMenuButton:
Animate(), CEikMenuButton(), ConstructFromResourceL(), LaunchPopupMenuL(), SetMenuPaneId(), ~CEikMenuButton()

Inherited from CBase:
operator new()

Inherited from CCoeControl:
ActivateGc(), BackedUpWindow(), CapturesPointer(), ClaimPointerGrab(), CloseWindow(), ControlContext(), ControlEnv(), CopyControlContextFrom(), CreateBackedUpWindowL(), CreateWindowL(), DeactivateGc(), DrawDeferred(), DrawNow(), DrawableWindow(), EnableDragEvents(), GetColor(), GetHelpContext(), GrabbingComponent(), HandleComponentControlsResourceChange(), HandlePointerBufferReadyL(), HandleRedrawEvent(), IgnoreEventsUntilNextPointerUp(), Index(), IsActivated(), IsBackedUp(), IsBeingDestroyed(), IsBlank(), IsDimmed(), IsFocused(), IsNonFocusing(), IsReadyToDraw(), IsVisible(), MakeVisible(), Observer(), OverrideColorL(), OwnsWindow(), Position(), PositionChanged(), PositionRelativeToScreen(), PrepareForFocusGainL(), PrepareForFocusLossL(), Rect(), RecursivelyMergedInputCapabilities(), ReportEventL(), ResetGc(), SetAllowStrayPointers(), SetBlank(), SetCanDrawOutsideRect(), SetComponentsToInheritVisibility(), SetContainerWindow(), SetControlContext(), SetCornerAndSize(), SetCornerAndSizeL(), SetExtent(), SetExtentL(), SetExtentToWholeScreen(), SetExtentToWholeScreenL(), SetFocus(), SetFocusing(), SetGloballyCapturing(), SetNeighbor(), SetNonFocusing(), SetObserver(), SetPointerCapture(), SetPosition(), SetRect(), SetRectL(), SetSize(), SetSizeL(), SetSizeWithoutNotification(), SetSizeWithoutNotificationL(), Size(), SizeChanged(), SizeChangedL(), SystemGc(), Window()

Inherited from CEikBorderedControl:
Border(), HasBorder(), SetAdjacent(), SetBorder(), iBorder

Inherited from CEikButtonBase:
CopyDrawStateTo(), DrawState(), EClear, EDrawClear, EDrawClearPressed, EDrawIndeterminate, EDrawIndeterminatePressed, EDrawSet, EDrawSetPressed, EEikButtonLatches, EEikButtonReportsOnPointerDown, EEikButtonStaysClear, EEikButtonStaysSet, EIndeterminate, ESet, HandlePointerEventL(), InputCapabilities(), IsPressed(), SetAllowTristate(), SetBehavior(), SetBubbleHelpTextL(), SetCoordinator(), SetIgnoreNextPointerUp(), SetReportOnPointerDown(), SetState(), State(), TButtonBehavior, TDrawState, TState, iButFlags

Inherited from CEikCommandButton:
AddCommandToStackL(), EPictureOnly, EShare, ETextAndPicture, ETextBottomPictureTop, ETextLeftPictureRight, ETextOnly, ETextRightPictureLeft, ETextTopPictureBottom, EToPicture, EToText, Label(), Picture(), PopCommandFromStack(), RemoveCommandFromStack(), SetButtonLayout(), SetCommandL(), SetDisplayContent(), SetExcessSpace(), SetPictureFromFileL(), SetPictureL(), SetTextL(), TDisplayContent, TExcess, TLayout, UpdateComponentAlignment()

Inherited from CEikCommandButtonBase:
ActivateL(), Behavior(), CheckCreateCommandStack(), ComponentControl(), ConstructImageFromResourceL(), ConstructLabelFromResourceL(), CountComponentControls(), Draw(), EBoth, EFirst, EFirstBottomSecondTop, EFirstLeftSecondRight, EFirstOnly, EFirstRightSecondLeft, EFirstTopSecondBottom, ESecond, ESecondOnly, EToFirst, EToSecond, FocusChanged(), GetColorUseListL(), HandleResourceChange(), LayoutComponents(), MinimumSize(), OfferKeyEventL(), SetContainerWindowL(), SetDefault(), SetDimmed(), StartConstructFromResourceL(), StateChanged(), TWhichComponent, iCmdFlags, iComponents[2]

Inherited from MCoeControlContext:
ActivateContext(), PrepareContext(), ResetContext()

Inherited from MEikCommandObserver:
CreateCustomCommandControlL(), ProcessCommandL()

Inherited from MEikMenuObserver:
CheckHotKeyNotDimmedL(), DynInitMenuBarL(), DynInitMenuPaneL(), EMenuBar, EMenuPane, HandleAttemptDimmedSelectionL(), HandleSideBarMenuL(), OfferKeyToAppL(), RestoreMenuL(), SetEmphasis(), TMenuType


Construction and destruction


CEikMenuButton()

CEikMenuButton();

Description

Constructor. See also ConstructFromResourceL().


ConstructFromResourceL()

void ConstructFromResourceL(TResourceReader& aReader);

Description

Completes construction of a menu button from resource.

Parameters

TResourceReader& aReader

The resource reader to use.


~CEikMenuButton()

~CEikMenuButton();

Description

Destructor, deletes any popup and removes it from the stack

[Top]


Public functions


Animate()

void Animate();

Description

Animates a button; showing the control as momentarily depressed.


LaunchPopupMenuL()

void LaunchPopupMenuL(MEikMenuObserver* aObserver);

Description

Requests the launch of a popup using the specified observer.

Parameters

MEikMenuObserver* aObserver

The observer to use to request launch of the popup.


SetMenuPaneId()

void SetMenuPaneId(TInt aMenuPaneId);

Description

Sets the menu pane ID.

Parameters

TInt aMenuPaneId

The menu pane ID.