CLiwServiceIfMenu Class Reference

class CLiwServiceIfMenu : public CLiwServiceIfBase

This is the menu service interface to access providers that offer menu services.

Menu service providers should inherit this class. Providers offering only base services should inherit CLiwServiceIfBase instead.

ServiceHandler.lib
Since
Series 60 2.6
CLiwServiceIfBase

Inherits from

Constructor & Destructor Documentation

~CLiwServiceIfMenu()

IMPORT_C~CLiwServiceIfMenu()[virtual]

Destructor.

Member Functions Documentation

ExtensionInterface(TUid)

IMPORT_C void *ExtensionInterface(TUidaInterface)[protected, virtual]

Parameters

TUid aInterface

HandleMenuCmdHookL(CLiwMenuPane *, TInt, const CLiwGenericParamList &, CLiwGenericParamList &, TUint, const MLiwNotifyCallback *)

voidHandleMenuCmdHookL(CLiwMenuPane *aMenuPane,
TIntaMenuCmdId,
const CLiwGenericParamList &aInParamList,
CLiwGenericParamList &aOutParamList,
TUintaCmdOptions = 0,
const MLiwNotifyCallback *aCallback = NULL
)[private]

Parameters

CLiwMenuPane * aMenuPane
TInt aMenuCmdId
const CLiwGenericParamList & aInParamList
CLiwGenericParamList & aOutParamList
TUint aCmdOptions = 0
const MLiwNotifyCallback * aCallback = NULL

HandleMenuCmdL(TInt, const CLiwGenericParamList &, CLiwGenericParamList &, TUint, const MLiwNotifyCallback *)

voidHandleMenuCmdL(TIntaMenuCmdId,
const CLiwGenericParamList &aInParamList,
CLiwGenericParamList &aOutParamList,
TUintaCmdOptions = 0,
const MLiwNotifyCallback *aCallback = NULL
)[pure virtual]

Provider should implement this method to handle a menu command. Called by the Service Handler when a consumer calls ExecuteMenuCmdL().

leave
KErrNotSupported Callback is not supported.

Parameters

TInt aMenuCmdIdOriginal provider specific ommand ID for the menu command. Defined in the provider's menu item resource.
const CLiwGenericParamList & aInParamListInput parameters, can be an empty list.
CLiwGenericParamList & aOutParamListOutput parameters, can be an empty list.
TUint aCmdOptions = 0Options for the command, see KLiwCmdOpt* in LiwCommon.hrh.
const MLiwNotifyCallback * aCallback = NULLCallback if asynchronous command handling is wanted by consumer. The provider may or may not support this. A provider should leave with KErrNotSupported, if not.

InitializeMenuPaneHookL(CLiwMenuPane *, TInt, TInt, const CLiwGenericParamList &)

voidInitializeMenuPaneHookL(CLiwMenuPane *aMenuPane,
TIntaIndex,
TIntaCascadeId,
const CLiwGenericParamList &aInParamList
)[private]

Parameters

CLiwMenuPane * aMenuPane
TInt aIndex
TInt aCascadeId
const CLiwGenericParamList & aInParamList

InitializeMenuPaneL(CLiwMenuPane &, TInt, TInt, const CLiwGenericParamList &)

voidInitializeMenuPaneL(CLiwMenuPane &aMenuPane,
TIntaIndex,
TIntaCascadeId,
const CLiwGenericParamList &aInParamList
)[pure virtual]

Provider should implement this method to initialise a menu pane by adding provider specific menu items. The LIW framework gives the parameters to be used in the addition process.

Parameters

CLiwMenuPane & aMenuPaneMenu pane handle.
TInt aIndexThe position of the item where to add menu items.
TInt aCascadeIdID of cascade menu item.
const CLiwGenericParamList & aInParamListInput parameter list for provider's parameter checking.

MenuPane()

IMPORT_C const CLiwMenuPane *MenuPane()const

Returns current LIW menu pane for this menu service provider.

Member Data Documentation

CLiwMenuPane * iMenuPane

CLiwMenuPane *iMenuPane[private]

TAny * iSpare

TAny *iSpare[private]