Symbian^3 Application Developer Library >

MPbk2CommandHandler Class Reference

class MPbk2CommandHandler

Phonebook 2 command handler interface.

Public Member Functions
void AddAndExecuteCommandL (MPbk2Command *)
void AddMenuCommandObserver ( MPbk2MenuCommandObserver &)
TAny * CommandHandlerExtension ( TUid )
void DynInitMenuPaneL ( TInt , CEikMenuPane *, CPbk2AppViewBase &, MPbk2ContactUiControl &)
void DynInitToolbarL ( TInt , CAknToolbar *, const CPbk2AppViewBase &, MPbk2ContactUiControl &)
TBool HandleCommandL (const TInt , MPbk2ContactUiControl &, const CPbk2AppViewBase *)
void OfferToolbarEventL ( TInt , MPbk2ContactUiControl &, const CPbk2AppViewBase *)
void RegisterAiwInterestL (const TInt , const TInt , const TInt , const TBool )
void RemoveMenuCommandObserver ( MPbk2MenuCommandObserver &)
TInt ServiceCmdByMenuCmd ( TInt )
Protected Member Functions
~MPbk2CommandHandler ()

Constructor & Destructor Documentation

~MPbk2CommandHandler()

~MPbk2CommandHandler ( ) [protected, inline, virtual]

Member Functions Documentation

AddAndExecuteCommandL(MPbk2Command *)

void AddAndExecuteCommandL ( MPbk2Command * aCommand ) [pure virtual]

Adds the command into the Phonebook 2 command store and executes it. Takes the ownership of the command.

Parameters

MPbk2Command * aCommand The command to be executed.

AddMenuCommandObserver(MPbk2MenuCommandObserver &)

void AddMenuCommandObserver ( MPbk2MenuCommandObserver & aObserver ) [pure virtual]

Adds a menu command observer.

Parameters

MPbk2MenuCommandObserver & aObserver Menu command observer to add.

CommandHandlerExtension(TUid)

TAny * CommandHandlerExtension ( TUid ) [inline, virtual]

Returns an extension point for this interface or NULL.

Parameters

TUid

DynInitMenuPaneL(TInt, CEikMenuPane *, CPbk2AppViewBase &, MPbk2ContactUiControl &)

void DynInitMenuPaneL ( TInt aResourceId,
CEikMenuPane * aMenuPane,
CPbk2AppViewBase & aViewBase,
MPbk2ContactUiControl & aControl
) [pure virtual]

Performs Phonebook 2 menu filtering.

Parameters

TInt aResourceId Resource id of the filtered menu pane.
CEikMenuPane * aMenuPane Menu pane to be filtered.
CPbk2AppViewBase & aViewBase Application view where the filtering takes place.
MPbk2ContactUiControl & aControl The UI control of the calling view.

DynInitToolbarL(TInt, CAknToolbar *, const CPbk2AppViewBase &, MPbk2ContactUiControl &)

void DynInitToolbarL ( TInt aResourceId,
CAknToolbar * aToolbar,
const CPbk2AppViewBase & aAppView,
MPbk2ContactUiControl & aControl
) [pure virtual]

Initialises toolbar before it is drawn.

Parameters

TInt aResourceId The resource id of the toolbar.
CAknToolbar * aToolbar The toolbar object.
const CPbk2AppViewBase & aAppView Application view from where the command is launched.
MPbk2ContactUiControl & aControl The UI control of the calling view.

HandleCommandL(const TInt, MPbk2ContactUiControl &, const CPbk2AppViewBase *)

TBool HandleCommandL ( const TInt aCommandId,
MPbk2ContactUiControl & aControl,
const CPbk2AppViewBase * aAppView
) [pure virtual]

Handles Phonebook 2 commands.

Parameters

const TInt aCommandId The id of the command to handle.
MPbk2ContactUiControl & aControl The UI control of the calling view.
const CPbk2AppViewBase * aAppView Application view from where the command is launched.

OfferToolbarEventL(TInt, MPbk2ContactUiControl &, const CPbk2AppViewBase *)

void OfferToolbarEventL ( TInt aCommand,
MPbk2ContactUiControl & aControl,
const CPbk2AppViewBase * aAppView
) [pure virtual]

Handles toolbar events for a certain toolbar item.

Parameters

TInt aCommand The command id of the toolbar item.
MPbk2ContactUiControl & aControl The UI control of the calling view.
const CPbk2AppViewBase * aAppView Application view from where the command is launched.

RegisterAiwInterestL(const TInt, const TInt, const TInt, const TBool)

void RegisterAiwInterestL ( const TInt aInterestId,
const TInt aMenuResourceId,
const TInt aInterestResourceId,
const TBool aAttachBaseService
) [pure virtual]

Registers (attaches) to an AIW service.

Parameters

const TInt aInterestId Id of the AIW interest.
const TInt aMenuResourceId Resource id of the menu to attach to the AIW interest.
const TInt aInterestResourceId Resource id of the AIW interest.
const TBool aAttachBaseService If ETrue, attaches the AIW resource id to the AIW base service also. This enables command handling via AIW without menus.

RemoveMenuCommandObserver(MPbk2MenuCommandObserver &)

void RemoveMenuCommandObserver ( MPbk2MenuCommandObserver & aObserver ) [pure virtual]

Removes a menu command observer.

Parameters

MPbk2MenuCommandObserver & aObserver Menu command observer to remove.

ServiceCmdByMenuCmd(TInt)

TInt ServiceCmdByMenuCmd ( TInt aMenuCmdId ) const [pure virtual]

Returns the AIW service command id associated to given menu command. If found, it means that there is a provider which can handle the menu command.

CAiwServiceHandler::ServiceCmdByMenuCmd

Parameters

TInt aMenuCmdId Menu command id to inspect.

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.