MQikListBoxObserver in Qikon

class MQikListBoxObserver;

Description

List box observer interface.

Each list box observer may be registered with a number of list boxes; each of these send events to the list box observer through its HandeListBoxEventL() method.

Members

Defined in MQikListBoxObserver:
EEventBottomReached, EEventCustomStart, EEventDimmedItemConfirmedAttempt, EEventEmptyListBoxActioned, EEventHighlightMoved, EEventItemConfirmed, EEventItemHighlighted, EEventItemTapped, EEventMatchBufferChanged, EEventMatchBufferFull, EEventSelectionChanged, EEventSlotIndexChanged, EEventTopReached, HandleListBoxEventL(), TQikListBoxEvent

virtual void HandleListBoxEventL(CQikListBox *aListBox, TQikListBoxEvent aEventType, TInt aItemIndex, TInt aSlotId)=0;

Description

Handles list box events.

This pure virtual function is invoked by CQikListBox to notify the observer of list box events.

The List Box observer must never alter the state of the List Box or any of its components while in between a MQikListBoxModel::ModelBeginUpdateLC and a MQikListBoxModel::ModelEndUpdateL call. Further more each event either allows or forbids altering of the List Box and its components upon receving the particular event, see TQikListBoxEvent for further information on this.

Parameters

`CQikListBox *aListBox`	The originating list box.
`TQikListBoxEvent aEventType`	A code for the event. Further information may be obtained by accessing the list box itself.
`TInt aItemIndex`	The item index, if applicable, else EQikListBoxParamNotApplicable.
`TInt aSlotId`	The item slot id the event was generated in, if applicable, else EQikListBoxParamNotApplicable.

TQikListBoxEvent

Description

List box event codes.

`EEventItemTapped`	This event is reported when an item is tapped, and denotes a user action on an item. This event is reported somewhat differently for items having a highlight layout and those that does not. When an item, having only a normal layout, is tapped on this event is triggered. An item that has a highlight layout, needs to be highlighted and then tapped for this event to be reported. The observer is allowed to change the state of the List Box and its components when receiving this event.
`EEventItemHighlighted`	This event is reported when a item having a highlight layout but not currently highlighted, is tapped. In this case a `EEventHighlightMoved` event will be reported first, followed by this event. Can be used as a way to distinguish between pen or key cause of highlight moved. The observer is allowed to change the state of the List Box and its components when receiving this event.
`EEventItemConfirmed`	Item confirm event. When an item is selected using select soft key. The observer is allowed to change the state of the List Box and its components when receiving this event.
`EEventSelectionChanged`	An item has been selected or deselected in a multiple slect enabled List Box. If more then one item is affected the event will be reported with index parameters having value EQikListBoxParamNotApplicable. The observer must not alter the state of any List Box components when receiving this event.
`EEventMatchBufferChanged`	The buffer that holds the characters that has currently been matched, has changed. The observer must not alter the state of any List Box components when receiving this event.
`EEventTopReached`	The top of the list has been reached. Event generated when standing on top item and trying to go up. The observer must not alter the state of any List Box components when receiving this event.
`EEventBottomReached`	The bottom of the list has been reached. Event generated when standing on last item and trying to go down. The observer must not alter the state of any List Box components when receiving this event.
`EEventEmptyListBoxActioned`	A tap in an empty List Box generates this event. The observer is allowed to change the state of the List Box and its components when receiving this event.
`EEventHighlightMoved`	The highlight has moved. The observer must not alter the state of any List Box components when receiving this event.
`EEventSlotIndexChanged`	The index on the slot has changed. The observer must not alter the state of any List Box components when receiving this event.
`EEventDimmedItemConfirmedAttempt`	An attempt to confirm a dimmed item has been made. The observer is allowed to change the state of the List Box and its components when receiving this event.
`EEventMatchBufferFull`	The incremental match buffer is full, the maximum number of characters to match on has been reached. The observer must not alter the state of any List Box components when receiving this event.
`EEventCustomStart`	Custom events section start. The observer must not alter the state of any List Box components when receiving this event.

Class `MQikListBoxObserver`

Description

Members

Member functions

`HandleListBoxEventL()`

Description

Parameters

Member enumerations

Enum `TQikListBoxEvent`

Description

Class MQikListBoxObserver

Description

Members

Member functions

HandleListBoxEventL()

Description

Parameters

Member enumerations

Enum TQikListBoxEvent

Description

Class `MQikListBoxObserver`

`HandleListBoxEventL()`

Enum `TQikListBoxEvent`