Class CEikAutoMenuTitle

CEikAutoMenuTitle

Support

Supported from 6.0

Description

A menu title that will be added to a standard resource-constructed menu bar. If added to the CEikAutoMenuTitleArray stored by CEikonEnv during standard application start up, the menu pane specified will appear in all applications. The menu observer passed in is notified of any events on such menu panes in preference to the usual observer (C<MyApp>AppUi).

Derivation

CBase Base class for all classes to be instantiated on the heap CEikAutoMenuTitle A menu title that will be added to a standard resource-constructed menu bar

Defined in CEikAutoMenuTitle:
EEnd, EStart, NewLC(), TTitlePos, ~CEikAutoMenuTitle()

Inherited from CBase:
operator new()

static CEikAutoMenuTitle* NewLC(TTitlePos aPos,const TDesC& aText,
    MEikAutoMenuObserver& aMenuObserver, TInt aMenuPaneResourceId=0,
    CGulIcon* aIcon=NULL);

Description

Allocates and constructs a new CEikAutoMenuTitle object. This function takes ownership of aIcon and pushes it to the cleanup stack.

Parameters

TTitlePos aPos The position of the title within the menu bar. Const TDesC& aText The menu title’s text. MEikAutoMenuObserver& aMenuObserver The menu observer. TInt aMenuPaneResourceId=0 The menu pane’s resource ID. CGulIcon* aIcon=NULL The icon to include in the menu title.

Return value

CEikAutoMenuTitle* A newly-constructed menu title object.

~CEikAutoMenuTitle();

Description

Destructor

TTitlePos

Description

Specifies the position of a menu title in a menu. If an array of menu titles holds more than one menu title that is specified for the start or end of a menu, the menu titles are placed in the same order as that in which they appear in the array. This means the first menu title specified with EStart in an array will be the first on a menu bar and the last EEnd will be the last on a menu bar.

EStart Place the menu title first in a menu. EEnd Place the menu title last in a menu.