Symbian^3 Application Developer Library >

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

Public Member Functions
~CAiwServiceIfMenu ()
void HandleMenuCmdL ( TInt , const CAiwGenericParamList &, CAiwGenericParamList &, TUint , const MAiwNotifyCallback *)
void InitializeMenuPaneL ( CAiwMenuPane &, TInt , TInt , const CAiwGenericParamList &)
IMPORT_C const CAiwMenuPane * MenuPane ()
Protected Member Functions
IMPORT_C void * ExtensionInterface ( TUid )
Private Member Functions
void HandleMenuCmdHookL ( CAiwMenuPane *, TInt , const CAiwGenericParamList &, CAiwGenericParamList &, TUint , const MAiwNotifyCallback *)
void InitializeMenuPaneHookL ( CAiwMenuPane *, TInt , TInt , const CAiwGenericParamList &)
Inherited Functions
CAiwServiceIfBase::HandleServiceCmdL(const TInt &,const CAiwGenericParamList &,CAiwGenericParamList &,TUint,const MAiwNotifyCallback *)
CAiwServiceIfBase::InitialiseL(MAiwNotifyCallback &,const RCriteriaArray &)
CAiwServiceIfBase::~CAiwServiceIfBase()
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
Private Attributes
CAiwMenuPane * iMenuPane
TAny * iSpare

Constructor & Destructor Documentation

~CAiwServiceIfMenu()

IMPORT_C ~CAiwServiceIfMenu ( ) [virtual]

Destructor.

Member Functions Documentation

ExtensionInterface(TUid)

IMPORT_C void * ExtensionInterface ( TUid aInterface ) [protected, virtual]

Parameters

TUid aInterface

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

void HandleMenuCmdHookL ( CAiwMenuPane * aMenuPane,
TInt aMenuCmdId,
const CAiwGenericParamList & aInParamList,
CAiwGenericParamList & aOutParamList,
TUint aCmdOptions = 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 *)

void HandleMenuCmdL ( TInt aMenuCmdId,
const CAiwGenericParamList & aInParamList,
CAiwGenericParamList & aOutParamList,
TUint aCmdOptions = 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 aMenuCmdId Original provider specific ommand ID for the menu command. Defined in the provider's menu item resource.
const CAiwGenericParamList & aInParamList Input parameters, can be an empty list.
CAiwGenericParamList & aOutParamList Output parameters, can be an empty list.
TUint aCmdOptions = 0 Options for the command, see KAiwCmdOpt* in AiwCommon.hrh.
const MAiwNotifyCallback * aCallback = NULL Callback 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 &)

void InitializeMenuPaneHookL ( CAiwMenuPane * aMenuPane,
TInt aIndex,
TInt aCascadeId,
const CAiwGenericParamList & aInParamList
) [private]

Parameters

CAiwMenuPane * aMenuPane
TInt aIndex
TInt aCascadeId
const CAiwGenericParamList & aInParamList

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

void InitializeMenuPaneL ( CAiwMenuPane & aMenuPane,
TInt aIndex,
TInt aCascadeId,
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 & aMenuPane Menu pane handle.
TInt aIndex The position of the item where to add menu items.
TInt aCascadeId ID of cascade menu item.
const CAiwGenericParamList & aInParamList Input 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]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.