CLiwMenuPane Class Reference

class CLiwMenuPane : public CBase

CLiwMenuPane for providers to have limited access to consumer menu.

LIW provider can get a reference to CLiwMenuPane in its InitializeMenuPaneL() method, which is derived from CLiwServiceIfMenu. With this reference, the provider can e.g. insert menu items to the consumer application's menu.

ServiceHandler.lib
Since
Series 60 2.6

Inherits from

Nested Classes and Structures

Constructor & Destructor Documentation

CLiwMenuPane(CEikMenuPane &, TInt)

IMPORT_CCLiwMenuPane(CEikMenuPane &aMenuPane,
TIntaBaseCmdId
)

Constructor.

Parameters

CEikMenuPane & aMenuPaneConsumer's menu pane handle.
TInt aBaseCmdIdBase command ID for new menu items, specified by consumer.

~CLiwMenuPane()

IMPORT_C~CLiwMenuPane()[virtual]

Destructor.

Member Functions Documentation

AddMenuItemL(TInt, CEikMenuPaneItem::SData &, TInt)

IMPORT_C voidAddMenuItemL(TIntaServiceCmd,
CEikMenuPaneItem::SData &aMenuItem,
TIntaIndex
)

Adds a menu item to consumer menu. For each addition a mapping element is created. This method should normally be called from provider's InitializeMenuPaneL().

Parameters

TInt aServiceCmdThe LIW service command the provider implements.
CEikMenuPaneItem::SData & aMenuItemThe menu item data.
TInt aIndexPosition of item where to add menu items.

AddMenuItemL(TInt, CEikMenuPaneItem::SData &, TInt, const TDesC &)

IMPORT_C voidAddMenuItemL(TIntaServiceCmd,
CEikMenuPaneItem::SData &aMenuItem,
TIntaIndex,
const TDesC &aExtraText
)

Adds a menu item to consumer menu. For each addition a mapping element is created. This method should normally be called from provider's InitializeMenuPaneL().

Parameters

TInt aServiceCmdThe LIW service command the provider implements.
CEikMenuPaneItem::SData & aMenuItemThe menu item data.
TInt aIndexPosition of item where to add menu items.
const TDesC & aExtraTextAltenative menu item text, if it is placed to a submenu.

AddMenuItemsL(TResourceReader &, TInt, TInt, TBool)

IMPORT_C voidAddMenuItemsL(TResourceReader &aReader,
TIntaServiceCmd,
TIntaIndex,
TBoolaAddSeperator = EFalse
)

Adds a menu item(s) to consumer menu from provider resource. This method should normally be called from provider's InitializeMenuPaneL().

Parameters

TResourceReader & aReaderResource reader pointing to the menu resource.
TInt aServiceCmdThe LIW service command the provider implements.
TInt aIndexPosition of item where to add menu items.
TBool aAddSeperator = EFalse

AddMenuItemsL(TFileName &, TInt, TInt, TInt, TBool)

IMPORT_C voidAddMenuItemsL(TFileName &aFileName,
TIntaResId,
TIntaServiceCmd,
TIntaIndex,
TBoolaAddSeperator = EFalse
)

Adds a menu item(s) to consumer menu from provider resource. This method should normally be called from provider's InitializeMenuPaneL().

Parameters

TFileName & aFileNameThe provider's resource where menu item(s) are defined.
TInt aResIdResource id of a MENU_PANE.
TInt aServiceCmdThe LIW service command the provider implements.
TInt aIndexPosition of item where to add menu items.
TBool aAddSeperator = EFalseCurrently not in use.

AddTitleItemL(const TDesC &, TInt)

IMPORT_C voidAddTitleItemL(const TDesC &aTitle,
TIntaIndex
)

Add sub menu title item. This item will not be visible in menus, but will be used as title for comsumer's LIW submenu (if consumer requests that).

Since
2.8

Parameters

const TDesC & aTitleTitle text
TInt aIndexPosition of title item in menu (can be anything, but if there is several title item definitions in menu, then the last one will be used).

CommandOwner(TInt)

CLiwServiceIfBase *CommandOwner(TIntaDynId)const [private]

Parameters

TInt aDynId

DynCmdId(TInt)

IMPORT_C TIntDynCmdId(TIntaMenuCmdId)const

Gets the dynamic menu command ID (generated by the LIW framework) from the provider's original menu command ID. There are usually multiple matching dynamic menu command IDs, so this method returns the first item found.

Parameters

TInt aMenuCmdIdProvider's original menu command ID.

ExtraText(TInt)

const TDesC &ExtraText(TIntaDynMenuCmdId)[private]

Parameters

TInt aDynMenuCmdId

FindCmdId(TInt)

TInt FindCmdId(TIntaIndex)[private]

Parameters

TInt aIndex

InitializingOwner()

CLiwServiceIfBase *InitializingOwner()const [private, inline]

IsCmdInRange(TInt, TInt)

TBool IsCmdInRange(TIntaCmdSpaceSize,
TIntaCmd
)[private]

Parameters

TInt aCmdSpaceSize
TInt aCmd

MenuCmdId(TInt)

IMPORT_C TIntMenuCmdId(TIntaDynCmdId)const

Gets the provider's original menu command ID from the dynamic menu command ID (generated by the LIW framework).

Parameters

TInt aDynCmdIdDynamic menu command ID.

MenuPane()

CEikMenuPane &MenuPane()[private, inline]

MenuResourceId()

TInt MenuResourceId()const [private, inline]

PaneOffset()

TInt PaneOffset()const [private, inline]

ResourceSlotId()

TInt ResourceSlotId()const [private, inline]

ServiceCmdId(TInt)

IMPORT_C TIntServiceCmdId(TIntaDynCmdId)const

Gets the LIW service command ID from the dynamic menu command ID (generated by the LIW framework).

Parameters

TInt aDynCmdIdDynamic menu command ID.

SetInitializingOwner(CLiwServiceIfBase *)

voidSetInitializingOwner(CLiwServiceIfBase *aOwner)[private, inline]

Parameters

CLiwServiceIfBase * aOwner

SetMenuResourceId(TInt)

voidSetMenuResourceId(TIntaMenuResourceId)[private, inline]

Parameters

TInt aMenuResourceId

SetPaneOffset(TInt)

voidSetPaneOffset(TIntaOffset)[private, inline]

Parameters

TInt aOffset

SetResourceSlotId(TInt)

voidSetResourceSlotId(TIntaSlot)[private, inline]

Parameters

TInt aSlot

Member Data Documentation

TInt iBaseCmdId

TInt iBaseCmdId[private]

void * iExtension

void *iExtension[private]

RArray< SMenuIdMap > iIdMap

RArray< SMenuIdMap >iIdMap[private]

CLiwServiceIfBase * iInitializingOwner

CLiwServiceIfBase *iInitializingOwner[private]

CEikMenuPane * iMenuPane

CEikMenuPane *iMenuPane[private]

TInt iMenuResourceId

TInt iMenuResourceId[private]

TInt iNextCmdId

TInt iNextCmdId[private]

TInt iPaneOffset

TInt iPaneOffset[private]

TInt iReserved_1

TInt iReserved_1[private]

TInt iResourceSlotId

TInt iResourceSlotId[private]