MAknTreeListObserver Class Reference

Link against: aknhlist.lib

#include <akntreelistobserver.h>

Detailed Description

Observer interface for hierarchical list.

Notifications of common hierarhicial list events are sent to the list client through this interface. All hierarhical list clients must provide an implementation for the interface and then register it with CAknTreeList::AddObserverL() method.

List specializations can also provide extended observer interfaces derived from this interface, if this interface is not sufficient for the usage of some hierarhical list specialization.

Since:
S60 v3.2

Public Types

enum  TEvent {
  ENodeExpanded, ENodeCollapsed, EItemFocused, EItemSelected,
  EItemRemoved, EMarkingModeEnabled, EMarkingModeDisabled, EItemMarked,
  EItemUnmarked
}
 Hierarchical list events. More...

Public Member Functions

virtual TInt HandleTreeListEvent (CAknTreeList &aList, TAknTreeItemID aItem, TEvent aEvent)=0
 The list client is notified of hierarchical list events with this method.

Member Enumeration Documentation

enum MAknTreeListObserver::TEvent
 

Hierarchical list events.

These events are sent to hierarchical list observer with HandleTreeListEvent() method.

Enumerator:
ENodeExpanded  Node is being expanded.

At this point the list client should update the content of expanded node, or add the content, if it has not been added or was removed when the node was collapsed.

ENodeCollapsed  Node is being collapsed.

This event is sent before a node is collapsed. After the event, all the content of the node is deleted unless it has been set persistent.

EItemFocused  Focused item is changed.

This event indicates that the focus is moved to another list item. The client can use this information, for example, for showing some additional information about the focused item.

EItemSelected  Item is selected.

This event indicates that the focused item is selected with some key or pointer event. The client should respond to selection event, for example, by opening the selected item.

EItemRemoved  Item was removed from the list.

The specified item ID is no longer usable.

EMarkingModeEnabled  Marking mode enabled.

This event is used for notifying the client that markable list has entered marking mode as a result of user keeping shift, control, edit, or hash key pressed. During marking mode, the list controls the MSK key, and to ensure proper MSK functionality, the client should not change MSK content.

EMarkingModeDisabled  Marking mode disabled.

This event is sent when markable list exits the marking mode. After this, the list no longer controls the MSK key.

EItemMarked  Item has been marked.

This event is sent when either a node or a leaf has been marked. Note that when marked item is a node, its content is also set marked, but separate events are not sent for all of the marked descendants.

EItemUnmarked  Item has been unmarked.

This event is sent when either a node or a leaf has been unmarked. Note that when unmarked item is a node, its content is also set unmarked, but separate events are not sent for all of the unmarked descendants.

Member Function Documentation

virtual TInt MAknTreeListObserver::HandleTreeListEvent ( CAknTreeList &  aList,
TAknTreeItemID  aItem,
TEvent  aEvent
)  [pure virtual]
 

The list client is notified of hierarchical list events with this method.

Hierarchical list instance, item ID of the referred list item, and the event code are sent to the client.

Note: New events may be added to the MAknTreeListObserver::TEvent enumeration in the future, and it should be taken in account in the implementations of this method, and not, for example, panic when receiving some currently unspecified event.

Parameters:
aList The hierarchical list from where the event is originated.
aItem Item ID of the list item the event is referring to.
aEvent The hierarchical list event.
Returns:
Return value currently not used, value KErrNone should be used.
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top