MAknMarkingCollection Class Reference

class MAknMarkingCollection

Collection marking mode handler.

This interface is intended for those collections that implement multiple marking mode and wish to use mode directly from options menu.

eikcoctl
Since
S60 v5.2
Public Member Functions
TBool CurrentItemMarkable()
TBool ExitMarkingMode()
voidMarkAllL()
voidMarkCurrentItemL()
TUint MarkingState()
voidSetMultipleMarkingState(TBool)
voidUnmarkAll()
Public Member Enumerations
enumTStateFlag { EStateMarkingMode = 0x00000001, EStateMarkedItems = 0x00000002, EStateCollectionEmpty = 0x00000004 }

Member Functions Documentation

CurrentItemMarkable()

TBool CurrentItemMarkable()[pure virtual]

ExitMarkingMode()

TBool ExitMarkingMode()[pure virtual]

Request to end marking mode

MarkAllL()

voidMarkAllL()[pure virtual]

Marks all items in the collection.

MarkCurrentItemL()

voidMarkCurrentItemL()[pure virtual]

Marks the currently selected item.

MarkingState()

TUint MarkingState()const [pure virtual]

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

SetMultipleMarkingState(TBool)

voidSetMultipleMarkingState(TBoolaActive)[pure virtual]

Sets multiple marking state.

Parameters

TBool aActiveETrue if multiple marking should be active.

UnmarkAll()

voidUnmarkAll()[pure virtual]

Unmarks all items in the collection.

Member Enumerations Documentation

Enum TStateFlag

Enum for collection state flags.

Enumerators

EStateMarkingMode = 0x00000001

Collection is in multiple marking mode.

EStateMarkedItems = 0x00000002

Collection has marked items.

EStateCollectionEmpty = 0x00000004

Collection is empty