Symbian^3 Application Developer Library >

AknSelectionService Class Reference

class AknSelectionService

These are part of Selection service and they should be called by application's HandleCommandL() to get menus and cba's handled automatically for selection service.

The right way to implement these would be to have dialogs with names "Selection List", "MultiSelection List" and "Markable list" and make them keep a listbox inside it. (look at CAknPopupList , it does similar things)

See CAknSelectionListDialog and CAknMarkableListDialog from aknselectionlist.h, they provide better interface for applications.

Public Member Functions
IMPORT_C void HandleItemRemovalAndPositionHighlightL ( CEikListBox *, TInt , TBool )
IMPORT_C void HandleItemRemovalAndPositionHighlightL ( CEikListBox *, TInt , CArrayFix < TInt > &)
IMPORT_C void HandleMarkableListDynInitMenuItem ( CEikMenuPane *, CEikListBox *, TInt , TBool )
IMPORT_C void HandleMarkableListDynInitMenuPane ( TInt , CEikMenuPane *, CEikListBox *)
IMPORT_C void HandleMarkableListProcessCommandL ( TInt , CEikListBox *)
IMPORT_C void HandleMarkableListUpdateAfterCommandExecution ( CEikListBox *)
IMPORT_C TKeyResponse HandleMenuListOfferKeyEventL (const TKeyEvent &, TEventCode , CEikListBox *)
IMPORT_C void HandleMultiselectionListProcessCommandL ( TInt , CEikListBox *)
IMPORT_C void HandleSelectionListProcessCommandL ( TInt , CEikListBox *)

Member Functions Documentation

HandleItemRemovalAndPositionHighlightL(CEikListBox *, TInt, TBool)

IMPORT_C void HandleItemRemovalAndPositionHighlightL ( CEikListBox * aListBox,
TInt aValueOfCurrentItemIndexBeforeRemoval,
TBool aCurrentItemWasRemoved
) [static]

Helper function to position list highlight correctly after item removal

Parameters

CEikListBox * aListBox
TInt aValueOfCurrentItemIndexBeforeRemoval
TBool aCurrentItemWasRemoved

HandleItemRemovalAndPositionHighlightL(CEikListBox *, TInt, CArrayFix< TInt > &)

IMPORT_C void HandleItemRemovalAndPositionHighlightL ( CEikListBox * aListBox,
TInt aValueOfCurrentItemIndexBeforeRemoval,
CArrayFix < TInt > & aIndexesOfRemovedItemsBeforeRemoval
) [static]

Helper function to position list highlight correctly after item removal

It also updates selection index array based on information about which items were removed.

Parameters

CEikListBox * aListBox
TInt aValueOfCurrentItemIndexBeforeRemoval
CArrayFix < TInt > & aIndexesOfRemovedItemsBeforeRemoval

HandleMarkableListDynInitMenuItem(CEikMenuPane *, CEikListBox *, TInt, TBool)

IMPORT_C void HandleMarkableListDynInitMenuItem ( CEikMenuPane * aMenu,
CEikListBox * aListBox,
TInt aCommandId,
TBool aCanBeAppliedToMultipleItems
) [static]

Helper function to implement DynInitMenuPaneL() for markable list dialogs

Parameters

CEikMenuPane * aMenu
CEikListBox * aListBox
TInt aCommandId
TBool aCanBeAppliedToMultipleItems

HandleMarkableListDynInitMenuPane(TInt, CEikMenuPane *, CEikListBox *)

IMPORT_C void HandleMarkableListDynInitMenuPane ( TInt aResourceId,
CEikMenuPane * aMenu,
CEikListBox * aListBox
) [static]

Helper function to implement DynInitMenuPaneL() for markable list dialogs

Parameters

TInt aResourceId
CEikMenuPane * aMenu
CEikListBox * aListBox

HandleMarkableListProcessCommandL(TInt, CEikListBox *)

IMPORT_C void HandleMarkableListProcessCommandL ( TInt aCommand,
CEikListBox * aListBox
) [static]

Helper function to implement ProcessCommandL() for markable list dialogs

Parameters

TInt aCommand
CEikListBox * aListBox

HandleMarkableListUpdateAfterCommandExecution(CEikListBox *)

IMPORT_C void HandleMarkableListUpdateAfterCommandExecution ( CEikListBox * aListBox ) [static]

Helper function to implement command handling for markable list dialogs

Parameters

CEikListBox * aListBox

HandleMenuListOfferKeyEventL(const TKeyEvent &, TEventCode, CEikListBox *)

IMPORT_C TKeyResponse HandleMenuListOfferKeyEventL ( const TKeyEvent & aKeyEvent,
TEventCode aType,
CEikListBox * aListBox
) [static]

Helper function to implement ProcessCommandL() for menu lists

Parameters

const TKeyEvent & aKeyEvent
TEventCode aType
CEikListBox * aListBox

HandleMultiselectionListProcessCommandL(TInt, CEikListBox *)

IMPORT_C void HandleMultiselectionListProcessCommandL ( TInt aCommand,
CEikListBox * aListBox
) [static]

Helper function to implement ProcessCommandL() for selection list dialogs

Parameters

TInt aCommand
CEikListBox * aListBox

HandleSelectionListProcessCommandL(TInt, CEikListBox *)

IMPORT_C void HandleSelectionListProcessCommandL ( TInt aCommand,
CEikListBox * aListBox
) [static]

Helper function to implement ProcessCommandL() for selection list dialogs

Parameters

TInt aCommand
CEikListBox * aListBox

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.