Symbian^3 Application Developer Library >

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

Public Member Functions
~CLiwServiceIfMenu ()
void HandleMenuCmdL ( TInt , const CLiwGenericParamList &, CLiwGenericParamList &, TUint , const MLiwNotifyCallback *)
void InitializeMenuPaneL ( CLiwMenuPane &, TInt , TInt , const CLiwGenericParamList &)
IMPORT_C const CLiwMenuPane * MenuPane ()
Protected Member Functions
IMPORT_C void * ExtensionInterface ( TUid )
Private Member Functions
void HandleMenuCmdHookL ( CLiwMenuPane *, TInt , const CLiwGenericParamList &, CLiwGenericParamList &, TUint , const MLiwNotifyCallback *)
void InitializeMenuPaneHookL ( CLiwMenuPane *, TInt , TInt , const CLiwGenericParamList &)
Inherited Functions
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()
CLiwServiceIfBase::HandleServiceCmdL(const TDesC8 &,const CLiwGenericParamList &,CLiwGenericParamList &,TUint,const MLiwNotifyCallback *)
CLiwServiceIfBase::HandleServiceCmdL(const TInt &,const CLiwGenericParamList &,CLiwGenericParamList &,TUint,const MLiwNotifyCallback *)
CLiwServiceIfBase::InitialiseL(MLiwNotifyCallback &,const RCriteriaArray &)
CLiwServiceIfBase::~CLiwServiceIfBase()
Private Attributes
CLiwMenuPane * iMenuPane
TAny * iSpare

Constructor & Destructor Documentation

~CLiwServiceIfMenu()

IMPORT_C ~CLiwServiceIfMenu ( ) [virtual]

Destructor.

Member Functions Documentation

ExtensionInterface(TUid)

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

Parameters

TUid aInterface

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

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

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

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

Parameters

CLiwMenuPane * aMenuPane
TInt aIndex
TInt aCascadeId
const CLiwGenericParamList & aInParamList

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

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

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.