MEikMenuObserver Class Reference

class MEikMenuObserver : public MEikCommandObserver

Menu observer interface.

Menu observers cooperate with menu bars and menu panes, initialising them before display and responding to menu events appropriately. CEikAppUi implements MEikMenuObserver, so these functions may be implemented on an application's App UI.

Inherits from

Public Member Functions
IMPORT_C TBoolCheckHotKeyNotDimmedL(TInt)
IMPORT_C CCoeControl *CreateCustomCommandControlL(TInt)
IMPORT_C voidDynInitMenuBarL(TInt, CEikMenuBar *)
IMPORT_C voidDynInitMenuPaneL(TInt, CEikMenuPane *)
IMPORT_C voidHandleAttemptDimmedSelectionL(TInt)
IMPORT_C voidHandleSideBarMenuL(TInt, const TPoint &, TInt, const CEikHotKeyTable *)
IMPORT_C voidOfferKeyToAppL(const TKeyEvent &, TEventCode)
IMPORT_C voidRestoreMenuL(CCoeControl *, TInt, TMenuType)
voidSetEmphasis(CCoeControl *, TBool)
Protected Member Functions
MEikMenuObserver()
Private Member Functions
IMPORT_C voidMEikCommandObserver_Reserved1()
IMPORT_C voidMEikCommandObserver_Reserved2()
IMPORT_C voidReserved_1_MenuObserver()
IMPORT_C voidReserved_2_MenuObserver()
Inherited Functions
MEikCommandObserver::MEikCommandObserver()
MEikCommandObserver::ProcessCommandL(TInt)
Public Member Enumerations
enumTMenuType { EMenuPane, EMenuBar }
Private Attributes
TInt iMEikMenuObserver_Spare1

Constructor & Destructor Documentation

MEikMenuObserver()

IMPORT_CMEikMenuObserver()[protected]

Member Functions Documentation

CheckHotKeyNotDimmedL(TInt)

IMPORT_C TBoolCheckHotKeyNotDimmedL(TIntaCommandId)[virtual]

Parameters

TInt aCommandId

CreateCustomCommandControlL(TInt)

IMPORT_C CCoeControl *CreateCustomCommandControlL(TIntaControlType)[virtual]

Glue for creating custom controls.

This function can be called to create custom controls on request from their control ID. Custom controls are user-supplied control classes.

Given the ID of a custom control, this function should return a pointer to a newly-instantiated and fully constructed control. If the ID is unrecognised, NULL should be returned. The control returned will be owned by the caller.

By default, NULL.

Parameters

TInt aControlTypeA custom control ID.

DynInitMenuBarL(TInt, CEikMenuBar *)

IMPORT_C voidDynInitMenuBarL(TIntaResourceId,
CEikMenuBar *aMenuBar
)[virtual]

Parameters

TInt aResourceId
CEikMenuBar * aMenuBar

DynInitMenuPaneL(TInt, CEikMenuPane *)

IMPORT_C voidDynInitMenuPaneL(TIntaResourceId,
CEikMenuPane *aMenuPane
)[virtual]

Parameters

TInt aResourceId
CEikMenuPane * aMenuPane

HandleAttemptDimmedSelectionL(TInt)

IMPORT_C voidHandleAttemptDimmedSelectionL(TIntaCommandId)[virtual]

Parameters

TInt aCommandId

HandleSideBarMenuL(TInt, const TPoint &, TInt, const CEikHotKeyTable *)

IMPORT_C voidHandleSideBarMenuL(TIntaResourceId,
const TPoint &aPos,
TIntaModifiers,
const CEikHotKeyTable *aTable
)[virtual]

Parameters

TInt aResourceId
const TPoint & aPos
TInt aModifiers
const CEikHotKeyTable * aTable

MEikCommandObserver_Reserved1()

IMPORT_C voidMEikCommandObserver_Reserved1()[private, virtual]

MEikCommandObserver_Reserved2()

IMPORT_C voidMEikCommandObserver_Reserved2()[private, virtual]

OfferKeyToAppL(const TKeyEvent &, TEventCode)

IMPORT_C voidOfferKeyToAppL(const TKeyEvent &aKeyEvent,
TEventCodeaType
)[virtual]

Parameters

const TKeyEvent & aKeyEvent
TEventCode aType

Reserved_1_MenuObserver()

IMPORT_C voidReserved_1_MenuObserver()[private, virtual]

Reserved_2_MenuObserver()

IMPORT_C voidReserved_2_MenuObserver()[private, virtual]

RestoreMenuL(CCoeControl *, TInt, TMenuType)

IMPORT_C voidRestoreMenuL(CCoeControl *aMenuControl,
TIntaResourceId,
TMenuTypeaType
)[virtual]

Parameters

CCoeControl * aMenuControl
TInt aResourceId
TMenuType aType

SetEmphasis(CCoeControl *, TBool)

voidSetEmphasis(CCoeControl *aMenuControl,
TBoolaEmphasis
)[pure virtual]

Called by the Uikon framework to handle the emphasising or de-emphasising of a menu window.

CEikMenuBar objects call this on their observer to emphasise themselves when they are displayed, and de-emphasise themselves when they stop displaying.

Parameters

CCoeControl * aMenuControlThe menu control.
TBool aEmphasisETrue to emphasize the menu, EFalse otherwise.

Member Enumerations Documentation

Enum TMenuType

Menu types

Enumerators

EMenuPane

Menu pane.

EMenuBar

Menu bar.

Member Data Documentation

TInt iMEikMenuObserver_Spare1

TInt iMEikMenuObserver_Spare1[private]