MAknCollection Class Reference

class MAknCollection

Collection state provider.

This interface is intended for those collections (e.g. lists) that need to share information of its state and receive collection notifications.

eikcoctl
Since
S60 v5.2
Public Member Functions
TInt CollectionExtension(TUint, TAny *&, TAny *)
TUint CollectionState()
voidItemActionMenuClosed()
Public Member Enumerations
enumTExtensionType { EAknMarkingCollection = 1 }
enumTStateFlag { EStateCollectionVisible = 0x00000001, EStateHighlightVisible = 0x00000002, EStateMultipleSelection = 0x00000004, EStateViewOnly = 0x00000008, EStateMarkedItems = 0x00000010 }

Member Functions Documentation

CollectionExtension(TUint, TAny *&, TAny *)

TInt CollectionExtension(TUintaExtensionId,
TAny *&a0,
TAny *a1
)[pure virtual]

Extension function.

Parameters

TUint aExtensionIdExtension id.
TAny *& a0First extension method parameter.
TAny * a1Second extension method parameter.

CollectionState()

TUint CollectionState()const [pure virtual]

Returns the collection state. The state is combination of flags defined in TStateFlag.

ItemActionMenuClosed()

voidItemActionMenuClosed()[pure virtual]

Notifies that item action menu (CAknItemActionMenu) was closed.

Member Enumerations Documentation

Enum TExtensionType

Enum for collection extension types.

Enumerators

EAknMarkingCollection = 1

Collection supports multiple marking mode

Enum TStateFlag

Enum for collection state flags.

Enumerators

EStateCollectionVisible = 0x00000001

Collection is currently visible.

EStateHighlightVisible = 0x00000002

Collection has currently a visible highlight.

EStateMultipleSelection = 0x00000004

Collection can have multiple items selected.

EStateViewOnly = 0x00000008

Collection is view-only (no highlight ever).

EStateMarkedItems = 0x00000010

Collection has marked items.