CAiwServiceIfMenu Class Reference

class CAiwServiceIfMenu : public CAiwServiceIfBase

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 CAiwServiceIfBase instead.

ServiceHandler.lib
Since
Series 60 2.6
CAiwServiceIfBase

Inherits from

Constructor & Destructor Documentation

~CAiwServiceIfMenu()

IMPORT_C~CAiwServiceIfMenu()[virtual]

Destructor.

Member Functions Documentation

ExtensionInterface(TUid)

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

Parameters

TUid aInterface

HandleMenuCmdHookL(CAiwMenuPane *, TInt, const CAiwGenericParamList &, CAiwGenericParamList &, TUint, const MAiwNotifyCallback *)

voidHandleMenuCmdHookL(CAiwMenuPane *aMenuPane,
TIntaMenuCmdId,
const CAiwGenericParamList &aInParamList,
CAiwGenericParamList &aOutParamList,
TUintaCmdOptions = 0,
const MAiwNotifyCallback *aCallback = NULL
)[private]

Parameters

CAiwMenuPane * aMenuPane
TInt aMenuCmdId
const CAiwGenericParamList & aInParamList
CAiwGenericParamList & aOutParamList
TUint aCmdOptions = 0
const MAiwNotifyCallback * aCallback = NULL

HandleMenuCmdL(TInt, const CAiwGenericParamList &, CAiwGenericParamList &, TUint, const MAiwNotifyCallback *)

voidHandleMenuCmdL(TIntaMenuCmdId,
const CAiwGenericParamList &aInParamList,
CAiwGenericParamList &aOutParamList,
TUintaCmdOptions = 0,
const MAiwNotifyCallback *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 CAiwGenericParamList & aInParamListInput parameters, can be an empty list.
CAiwGenericParamList & aOutParamListOutput parameters, can be an empty list.
TUint aCmdOptions = 0Options for the command, see KAiwCmdOpt* in AiwCommon.hrh.
const MAiwNotifyCallback * 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(CAiwMenuPane *, TInt, TInt, const CAiwGenericParamList &)

voidInitializeMenuPaneHookL(CAiwMenuPane *aMenuPane,
TIntaIndex,
TIntaCascadeId,
const CAiwGenericParamList &aInParamList
)[private]

Parameters

CAiwMenuPane * aMenuPane
TInt aIndex
TInt aCascadeId
const CAiwGenericParamList & aInParamList

InitializeMenuPaneL(CAiwMenuPane &, TInt, TInt, const CAiwGenericParamList &)

voidInitializeMenuPaneL(CAiwMenuPane &aMenuPane,
TIntaIndex,
TIntaCascadeId,
const CAiwGenericParamList &aInParamList
)[pure virtual]

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

Parameters

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

MenuPane()

IMPORT_C const CAiwMenuPane *MenuPane()const

Returns current AIW menu pane for this menu service provider.

Member Data Documentation

CAiwMenuPane * iMenuPane

CAiwMenuPane *iMenuPane[private]

TAny * iSpare

TAny *iSpare[private]