MEikAutoMenuObserver Class Reference

class MEikAutoMenuObserver : public MEikMenuObserver

Provides additional functionality to an auto menu title, in the form of an OfferHotKeyL() method, which is not required in the normal MEikMenuObserver.

Auto menu titles are used to ensure that some menu panes appear in every menu constructed for an application.

Inherits from

Constructor & Destructor Documentation

MEikAutoMenuObserver()

IMPORT_CMEikAutoMenuObserver()[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]

OfferHotKeyL(const TKeyEvent &, TEventCode)

TKeyResponse OfferHotKeyL(const TKeyEvent &aKeyEvent,
TEventCodeaType
)[pure virtual]

Offers the specified hot key to the auto menu title.

Implement this function if you expect to handle any events from an auto menu.

The auto menu title's response.

Parameters

const TKeyEvent & aKeyEventThe key event.
TEventCode aTypeThe type of key event.

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)

IMPORT_C voidSetEmphasis(CCoeControl *aMenuControl,
TBoolaEmphasis
)[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 Data Documentation

TInt iMEikAutoMenuObserver_Spare1

TInt iMEikAutoMenuObserver_Spare1[private]