|
1 /* |
|
2 * Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies). |
|
3 * All rights reserved. |
|
4 * This component and the accompanying materials are made available |
|
5 * under the terms of "Eclipse Public License v1.0" |
|
6 * which accompanies this distribution, and is available |
|
7 * at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
8 * |
|
9 * Initial Contributors: |
|
10 * Nokia Corporation - initial contribution. |
|
11 * |
|
12 * Contributors: |
|
13 * |
|
14 * Description: An observer interface for the tree list component. |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 #ifndef M_FSTREEVISUALIZEROBSERVER_H |
|
20 #define M_FSTREEVISUALIZEROBSERVER_H |
|
21 |
|
22 #include "fstreelistconstants.h" |
|
23 |
|
24 /** |
|
25 * MFsTreeObserver defines an interface which is used to observe tree list |
|
26 * events. |
|
27 * |
|
28 * Observer of the tree list is notified of changes in the tree list through |
|
29 * this interface with appropriate events. |
|
30 * @code |
|
31 * |
|
32 * @endcode |
|
33 * |
|
34 * @lib |
|
35 */ |
|
36 NONSHARABLE_CLASS( MFsTreeVisualizerObserver ) |
|
37 { |
|
38 public: |
|
39 |
|
40 enum TFsTreeVisualizerEvent |
|
41 { |
|
42 |
|
43 // <cmail> "Base class modifications for using touch" |
|
44 /** |
|
45 * Action started for selected tree item. |
|
46 */ |
|
47 EFsTreeItemTouchAction, |
|
48 |
|
49 /** |
|
50 * Long tap action started for selected tree item. |
|
51 */ |
|
52 EFsTreeItemTouchLongTap, |
|
53 |
|
54 /** |
|
55 * Touch focus for list gained. |
|
56 */ |
|
57 EFsTreeItemTouchFocused, |
|
58 |
|
59 // </cmail> |
|
60 |
|
61 |
|
62 /** |
|
63 * An item received focus. |
|
64 */ |
|
65 EFsTreeItemFocused, |
|
66 |
|
67 /** |
|
68 * Focus will be moved to the specified item/node. |
|
69 * Event triggered just before an item gets focus. |
|
70 * No action required. |
|
71 */ |
|
72 EFsTreeItemWillGetFocused, |
|
73 |
|
74 /** |
|
75 * An item has been selected. |
|
76 */ |
|
77 EFsTreeItemSelected, |
|
78 /** |
|
79 * An item with menu has been selected. |
|
80 */ |
|
81 EFsTreeItemWithMenuSelected, |
|
82 /** |
|
83 * Right arrow pressed. |
|
84 */ |
|
85 EFsTreeKeyRightArrow, |
|
86 /** |
|
87 * Left arrow pressed. |
|
88 */ |
|
89 EFsTreeKeyLeftArrow, |
|
90 |
|
91 /** |
|
92 * Event generated when the list is fully hidden. |
|
93 */ |
|
94 EFsTreeListVisualizerHidden, |
|
95 |
|
96 /** |
|
97 * Event generated when the list is fully shown. |
|
98 */ |
|
99 EFsTreeListVisualizerShown, |
|
100 |
|
101 // <cmail> |
|
102 /** |
|
103 * Event generated when a single node is collapsed. |
|
104 */ |
|
105 EFsTreeListItemCollapsed, |
|
106 /** |
|
107 * Event generated when a single node is expanded. |
|
108 */ |
|
109 EFsTreeListItemExpanded, |
|
110 /** |
|
111 * Event generated when all nodes are collapsed. |
|
112 */ |
|
113 EFsTreeListCollapsedAll, |
|
114 /** |
|
115 * Event generated when all nodes are expanded. |
|
116 */ |
|
117 EFsTreeListExpandedAll |
|
118 // </cmail> |
|
119 }; |
|
120 |
|
121 public: |
|
122 |
|
123 /** |
|
124 * Observer of the tree list is notified of changes in the tree list |
|
125 * through this function. |
|
126 * |
|
127 * @param aEvent Event which happend in the tree list. |
|
128 * @param aId Id of the node/item associated with the event. KFsTreeNoneID |
|
129 * means that the event is not associated with a node/item. |
|
130 */ |
|
131 // <cmail> Touch |
|
132 virtual void TreeVisualizerEventL( |
|
133 const TFsTreeVisualizerEvent aEvent, |
|
134 const TFsTreeItemId aId = KFsTreeNoneID ) const = 0; |
|
135 // </cmail> |
|
136 |
|
137 }; |
|
138 |
|
139 |
|
140 #endif // M_FSTREEVISUALIZEROBSERVER_H |