AknSelectionService Class Reference

Link against: avkon.lib eikcore.lib

Capability Information

Required Capabilities

None

#include <AknUtils.h>

Detailed Description

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.


Static Public Member Functions
static IMPORT_C void	HandleSelectionListProcessCommandL (TInt aCommand, CEikListBox *aListBox)
	Helper function to implement ProcessCommandL() for selection list dialogs.
static IMPORT_C void	HandleMultiselectionListProcessCommandL (TInt aCommand, CEikListBox *aListBox)
	Helper function to implement ProcessCommandL() for selection list dialogs.
static IMPORT_C void	HandleMarkableListProcessCommandL (TInt aCommand, CEikListBox *aListBox)
	Helper function to implement ProcessCommandL() for markable list dialogs.
static IMPORT_C TKeyResponse	HandleMenuListOfferKeyEventL (const TKeyEvent &aKeyEvent, TEventCode aType, CEikListBox *aListBox)
	Helper function to implement ProcessCommandL() for menu lists.
static IMPORT_C void	HandleMarkableListDynInitMenuPane (TInt aResourceId, CEikMenuPane aMenu, CEikListBox aListBox)
	Helper function to implement DynInitMenuPaneL() for markable list dialogs.
static IMPORT_C void	HandleMarkableListDynInitMenuItem (CEikMenuPane aMenu, CEikListBox aListBox, TInt aCommandId, TBool aCanBeAppliedToMultipleItems)
	Helper function to implement DynInitMenuPaneL() for markable list dialogs.
static IMPORT_C void	HandleMarkableListUpdateAfterCommandExecution (CEikListBox *aListBox)
	Helper function to implement command handling for markable list dialogs.
static IMPORT_C void	HandleItemRemovalAndPositionHighlightL (CEikListBox *aListBox, TInt aValueOfCurrentItemIndexBeforeRemoval, TBool aCurrentItemWasRemoved)
	Helper function to position list highlight correctly after item removal.
static IMPORT_C void	HandleItemRemovalAndPositionHighlightL (CEikListBox *aListBox, TInt aValueOfCurrentItemIndexBeforeRemoval, CArrayFix< TInt > &aIndexesOfRemovedItemsBeforeRemoval)
	Helper function to position list highlight correctly after item removal.

Member Function Documentation

static IMPORT_C void AknSelectionService::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.

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

Helper function to position list highlight correctly after item removal.

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

Helper function to implement DynInitMenuPaneL() for markable list dialogs.

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

Helper function to implement DynInitMenuPaneL() for markable list dialogs.

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

Helper function to implement ProcessCommandL() for markable list dialogs.

static IMPORT_C void AknSelectionService::HandleMarkableListUpdateAfterCommandExecution ( CEikListBox * aListBox ) [static]

Helper function to implement command handling for markable list dialogs.

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

Helper function to implement ProcessCommandL() for menu lists.

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

Helper function to implement ProcessCommandL() for selection list dialogs.

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