Symbian
Symbian OS Library

SYMBIAN OS V9.3

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



Location: eikamnt.h
Link against: eikcore.lib

Class CEikAutoMenuTitle

class CEikAutoMenuTitle : public CBase;

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

Members

Defined in CEikAutoMenuTitle:
EEnd, ENominalTextLength, EStart, NewLC(), TTitlePos, anonymous, iIcon, iMenuObserver, iMenuPaneResourceId, iPos, iText, ~CEikAutoMenuTitle()

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


Construction and destruction


NewLC()

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

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

The menu pane's resource ID.

CGulIcon *aIcon

The icon to include in the menu title.

Return value

CEikAutoMenuTitle *

A newly-constructed menu title object.


~CEikAutoMenuTitle()

IMPORT_C ~CEikAutoMenuTitle();

Description

Destructor

[Top]


Member enumerations


Enum TTitlePos

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

The menu title is placed first in a menu.

EEnd

The menu title is placed last in a menu.


Enum anonymous

n/a

Description

ENominalTextLength

[Top]


Member data


iPos

TTitlePos iPos;

Description


iText

TBuf< ENominalTextLength > iText;

Description


iMenuObserver

MEikAutoMenuObserver & iMenuObserver;

Description


iMenuPaneResourceId

TInt iMenuPaneResourceId;

Description


iIcon

CGulIcon * iIcon;

Description