|
1 /* |
|
2 * Copyright (c) 2008 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: Definition of class CFscContactActionMenuItemImpl. |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 #ifndef C_FSCCONTACTACTIONMENUITEMIMPL_H |
|
20 #define C_FSCCONTACTACTIONMENUITEMIMPL_H |
|
21 |
|
22 #include <e32base.h> |
|
23 #include "cfsccontactactionmenuitem.h" |
|
24 |
|
25 // FORWARD DECLARATIONS |
|
26 class CGulIcon; |
|
27 |
|
28 /** |
|
29 * Contact Action Menu Item implementation. |
|
30 * |
|
31 * @since S60 3.1 |
|
32 */ |
|
33 class CFscContactActionMenuItemImpl : public CFscContactActionMenuItem |
|
34 { |
|
35 |
|
36 public: // Public constructor and destructor |
|
37 |
|
38 /** |
|
39 * Two-phased constructor. |
|
40 * |
|
41 * @return New instance of the component |
|
42 */ |
|
43 static CFscContactActionMenuItemImpl* NewL(); |
|
44 |
|
45 /** |
|
46 * Two-phased constructor. |
|
47 * |
|
48 * @return New instance of the component |
|
49 */ |
|
50 static CFscContactActionMenuItemImpl* NewLC(); |
|
51 |
|
52 /** |
|
53 * Two-phased constructor. |
|
54 * |
|
55 * @param aMenuText Menu text |
|
56 * @param aIcon Icon |
|
57 * @param aPriority Priority |
|
58 * @param aStatic Is static |
|
59 * @param aUid Item Uid |
|
60 * @return New instance of the component |
|
61 */ |
|
62 static CFscContactActionMenuItemImpl* NewL( |
|
63 const TDesC& aMenuText, |
|
64 const CGulIcon* aIcon, |
|
65 TInt aPriority, |
|
66 TBool aStatic, |
|
67 TUid aUid = KFscDefaultItemUid ); |
|
68 |
|
69 /** |
|
70 * Two-phased constructor. |
|
71 * |
|
72 * @param aMenuText Menu text |
|
73 * @param aIcon Icon |
|
74 * @param aPriority Priority |
|
75 * @param aStatic Is static |
|
76 * @param aUid Item Uid |
|
77 * @return New instance of the component |
|
78 */ |
|
79 static CFscContactActionMenuItemImpl* NewLC( |
|
80 const TDesC& aMenuText, |
|
81 const CGulIcon* aIcon, |
|
82 TInt aPriority, |
|
83 TBool aStatic, |
|
84 TUid aUid = KFscDefaultItemUid ); |
|
85 |
|
86 /** |
|
87 * Destructor. |
|
88 */ |
|
89 virtual ~CFscContactActionMenuItemImpl(); |
|
90 |
|
91 public: // Public methods from base class |
|
92 |
|
93 /** |
|
94 * Set menu text |
|
95 * |
|
96 * @param aMenuText New menu text |
|
97 */ |
|
98 void SetMenuTextL( const TDesC& aMenuText ); |
|
99 |
|
100 /** |
|
101 * Get menu text |
|
102 * |
|
103 * @return Menu text |
|
104 */ |
|
105 const TDesC& MenuText() const; |
|
106 |
|
107 /** |
|
108 * Set icon |
|
109 * |
|
110 * @param aIcon New icon |
|
111 */ |
|
112 void SetIcon( const CGulIcon* aIcon ); |
|
113 |
|
114 /** |
|
115 * Get icon |
|
116 * |
|
117 * @return Item's icon |
|
118 */ |
|
119 const CGulIcon* Icon() const; |
|
120 |
|
121 /** |
|
122 * Set priority |
|
123 * |
|
124 * @param aPriority Item priority |
|
125 */ |
|
126 void SetPriority( TInt aPriority ); |
|
127 |
|
128 /** |
|
129 * Get priority |
|
130 * |
|
131 * @return Item's priority |
|
132 */ |
|
133 TInt Priority() const; |
|
134 |
|
135 /** |
|
136 * Set implementation uid |
|
137 * |
|
138 * @param aUid Implementation Uid of the item |
|
139 */ |
|
140 void SetImplementationUid( TUid aUid ); |
|
141 |
|
142 /** |
|
143 * Get implementation Uid |
|
144 * |
|
145 * @return Item's implementation Uid |
|
146 */ |
|
147 TUid ImplementationUid() const; |
|
148 |
|
149 /** |
|
150 * Set item dimmed |
|
151 * |
|
152 * @param aDimmed ETrue if item is dimmed |
|
153 */ |
|
154 void SetDimmed( TBool aDimmed ); |
|
155 |
|
156 /** |
|
157 * Is item dimmed |
|
158 * |
|
159 * @return ETrue if item is dimmed, otherwise EFalse |
|
160 */ |
|
161 TBool Dimmed() const; |
|
162 |
|
163 /** |
|
164 * Set dimm reason |
|
165 * |
|
166 * @param aDimmReason dimm reason |
|
167 */ |
|
168 void SetDimmReasonL( const TDesC& aDimmReason ); |
|
169 |
|
170 /** |
|
171 * Get dimm reason |
|
172 * |
|
173 * @return dimm reason |
|
174 */ |
|
175 const TDesC& DimmReason() const; |
|
176 |
|
177 /** |
|
178 * Set item hidden |
|
179 * |
|
180 * @param aHidden ETrue if item is hidden |
|
181 */ |
|
182 void SetHidden( TBool aHidden ); |
|
183 |
|
184 /** |
|
185 * Is item hidden |
|
186 * |
|
187 * @return ETrue if item is hidden, otherwise EFalse |
|
188 */ |
|
189 TBool Hidden() const; |
|
190 |
|
191 /** |
|
192 * Set item static |
|
193 * Static items are ment to be kept in the menu longer than non-static. |
|
194 * Normal use case for static items are special items set by Action Menu's |
|
195 * client. These special items are always in the menu so client does not |
|
196 * want to set them again after clearing other items from the menu. All CAS |
|
197 * based items are non-static and therefore they can easily be removed from |
|
198 * the menu without removing static items also. |
|
199 * |
|
200 * @param aStatic ETrue if item is hidden |
|
201 */ |
|
202 void SetStatic( TBool aStatic ); |
|
203 |
|
204 /** |
|
205 * Is item static |
|
206 * |
|
207 * @return ETrue if item is static, otherwise EFalse |
|
208 */ |
|
209 TBool Static() const; |
|
210 |
|
211 protected: |
|
212 |
|
213 /** |
|
214 * Constructor. |
|
215 * |
|
216 * @param aIcon Icon |
|
217 * @param aPriority Priority |
|
218 * @param aStatic Is static |
|
219 * @param aUid Item Uid |
|
220 */ |
|
221 CFscContactActionMenuItemImpl( |
|
222 const CGulIcon* aIcon, |
|
223 TInt aPriority, |
|
224 TBool aStatic, |
|
225 TUid aUid ); |
|
226 |
|
227 /** |
|
228 * Second phase constructor. |
|
229 * |
|
230 * @param aMenuText Menu text |
|
231 */ |
|
232 void ConstructL( const TDesC& aMenuText ); |
|
233 |
|
234 protected: // data |
|
235 |
|
236 /** |
|
237 * Menu item text |
|
238 * Owned |
|
239 */ |
|
240 HBufC* iMenuText; |
|
241 |
|
242 /** |
|
243 * Menu item icon |
|
244 * Not owned |
|
245 */ |
|
246 const CGulIcon* iIcon; |
|
247 |
|
248 /** |
|
249 * Priority of the menu item |
|
250 */ |
|
251 TInt iPriority; |
|
252 |
|
253 /** |
|
254 * Action implementation uid |
|
255 */ |
|
256 TUid iImplementationUid; |
|
257 |
|
258 /** |
|
259 * Dimmed flag |
|
260 */ |
|
261 TBool iDimmed; |
|
262 |
|
263 /** |
|
264 * Dimming reason. |
|
265 * Owned |
|
266 */ |
|
267 HBufC* iDimmReason; |
|
268 |
|
269 /** |
|
270 * Hidden flag |
|
271 */ |
|
272 TBool iHidden; |
|
273 |
|
274 /** |
|
275 * Static flag |
|
276 */ |
|
277 TBool iStatic; |
|
278 |
|
279 }; |
|
280 |
|
281 #endif // C_FSCCONTACTACTIONMENUITEMIMPL_H |
|
282 |