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