|
1 /* |
|
2 * Copyright (c) 2005-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: |
|
15 * See class description. |
|
16 * |
|
17 */ |
|
18 |
|
19 |
|
20 #ifndef __TPHONECMDPARAMCALLHEADERDATA_H |
|
21 #define __TPHONECMDPARAMCALLHEADERDATA_H |
|
22 |
|
23 // INCLUDES |
|
24 |
|
25 #include <w32std.h> |
|
26 #include <cntdef.h> |
|
27 #include "tphonecommandparam.h" |
|
28 #include "phoneconstants.h" |
|
29 |
|
30 // DATA TYPES |
|
31 |
|
32 // CLASS DECLARATION |
|
33 class CFbsBitmap; |
|
34 |
|
35 /** |
|
36 * A parameter class for call header information. |
|
37 */ |
|
38 class TPhoneCmdParamCallHeaderData : public TPhoneUICommandParam |
|
39 { |
|
40 public: |
|
41 // CLI used in conference call participant list. |
|
42 enum TPhoneParticipantListCLI |
|
43 { |
|
44 EPhoneParticipantCLIText, |
|
45 EPhoneParticipantCNAPText, |
|
46 }; |
|
47 |
|
48 enum TPhoneTextClippingDirection |
|
49 { |
|
50 ERight, |
|
51 ELeft |
|
52 }; |
|
53 |
|
54 public: |
|
55 |
|
56 /** |
|
57 * C++ default constructor. |
|
58 */ |
|
59 IMPORT_C TPhoneCmdParamCallHeaderData(); |
|
60 |
|
61 public: |
|
62 |
|
63 /** |
|
64 * Sets the call header label text. |
|
65 * @param aLabel is the label |
|
66 */ |
|
67 IMPORT_C void SetLabelText( const TDesC& aLabelText ); |
|
68 |
|
69 /** |
|
70 * Sets the call header short label text |
|
71 * @param aShortLabel is the short label |
|
72 */ |
|
73 IMPORT_C void SetShortLabelText( const TDesC& aShortLabelText ); |
|
74 |
|
75 /** |
|
76 * Sets the call header call state. |
|
77 * @param aCallState is the call state |
|
78 */ |
|
79 IMPORT_C void SetCallState( TInt aCallState ); |
|
80 |
|
81 /** |
|
82 * Sets the call header call type. |
|
83 * @param aCallType is the call type |
|
84 */ |
|
85 IMPORT_C void SetCallType( TInt aCallType ); |
|
86 |
|
87 /** |
|
88 * Sets the call header number type. |
|
89 * @param aNumberType is the number type |
|
90 */ |
|
91 IMPORT_C void SetNumberType( TInt aNumberType ); |
|
92 |
|
93 /** |
|
94 * Sets the call header voice privacy status. |
|
95 * @param aCiphering is ETrue if voice privacy is on. |
|
96 */ |
|
97 IMPORT_C void SetCiphering( TBool aCiphering ); |
|
98 |
|
99 /** |
|
100 * Sets the call header CLI text |
|
101 * @param aCLI is the CLI text |
|
102 * @param aDirection Clipping direction of the CLI text. |
|
103 */ |
|
104 IMPORT_C void SetCLIText( const TDesC& aCLIText, |
|
105 TPhoneTextClippingDirection aDirection ); |
|
106 |
|
107 /** |
|
108 * Sets the call header CNAP text |
|
109 * @param aCNAP is the CNAP text |
|
110 * @param aDirection Clipping direction of the CNAP text. |
|
111 */ |
|
112 IMPORT_C void SetCNAPText( const TDesC& aCNAPText, |
|
113 TPhoneTextClippingDirection aDirection ); |
|
114 |
|
115 /** |
|
116 * Sets the call header picture |
|
117 * @param aPicture is the picture data |
|
118 */ |
|
119 IMPORT_C void SetPicture( const TDesC& aPicture ); |
|
120 |
|
121 /** |
|
122 * Sets the call header diverted status. |
|
123 * @param call flag |
|
124 */ |
|
125 IMPORT_C void SetDiverted( TBool aDiverted ); |
|
126 |
|
127 /** |
|
128 * Sets the call header line2 status. |
|
129 * @param aLine2 is ETrue if line2 is active. |
|
130 */ |
|
131 IMPORT_C void SetLine2( TBool aLine2 ); |
|
132 |
|
133 /** |
|
134 * Returns the call header label text |
|
135 * @return Returns the label |
|
136 */ |
|
137 IMPORT_C const TDesC& LabelText() const; |
|
138 |
|
139 /** |
|
140 * Returns the call header short label text. |
|
141 * @return Returns the short label |
|
142 */ |
|
143 IMPORT_C const TDesC& ShortLabelText() const; |
|
144 |
|
145 /** |
|
146 * Returns the call header call state. |
|
147 * @return Returns the call state |
|
148 */ |
|
149 IMPORT_C TInt CallState() const; |
|
150 |
|
151 /** |
|
152 * Returns the call header call type. |
|
153 * @return Returns the call type |
|
154 */ |
|
155 IMPORT_C TInt CallType() const; |
|
156 |
|
157 /** |
|
158 * Returns the call header number type. |
|
159 * @return Returns the number type |
|
160 */ |
|
161 IMPORT_C TInt NumberType() const; |
|
162 |
|
163 /** |
|
164 * Returns the call header ciphering status. |
|
165 * @return Returns ETrue if ciphering is on |
|
166 */ |
|
167 IMPORT_C TBool Ciphering() const; |
|
168 |
|
169 /** |
|
170 * Returns the call header CLI text. |
|
171 * @return Returns the CLI text |
|
172 */ |
|
173 IMPORT_C const TDesC& CLIText() const; |
|
174 |
|
175 /** |
|
176 * Returns the clipping direction of the CLI text. |
|
177 * @return Clipping direction of the CLI text. |
|
178 */ |
|
179 IMPORT_C TPhoneTextClippingDirection CLITextClippingDirection() const; |
|
180 |
|
181 /** |
|
182 * Returns the clipping direction of the CNAP text. |
|
183 * @return Clipping direction of the CNAP text. |
|
184 */ |
|
185 IMPORT_C TPhoneTextClippingDirection CNAPTextClippingDirection() const; |
|
186 |
|
187 /** |
|
188 * Returns the call header CNAP text. |
|
189 * @return Returns the CNAP text |
|
190 */ |
|
191 IMPORT_C const TDesC& CNAPText() const; |
|
192 |
|
193 /** |
|
194 * Returns the call header picture. |
|
195 * @return Returns the picture |
|
196 */ |
|
197 IMPORT_C const TDesC& Picture() const; |
|
198 |
|
199 /** |
|
200 * Returns call diverted status. |
|
201 * @return Returns ETrue if diverted call. |
|
202 */ |
|
203 IMPORT_C TBool Diverted() const; |
|
204 |
|
205 /** |
|
206 * Returns the call header line 2 active. |
|
207 * @return Returns ETrue if line2 is on |
|
208 */ |
|
209 IMPORT_C TBool Line2() const; |
|
210 |
|
211 /** |
|
212 * Returns the Thumbnail. |
|
213 * @return Returns pointer to the thumbnail image |
|
214 */ |
|
215 IMPORT_C CFbsBitmap* Thumbnail() const; |
|
216 |
|
217 /** |
|
218 * Sets the Thumbnail |
|
219 * @param aThumbnail is pointer to the thumbnail image |
|
220 */ |
|
221 IMPORT_C void SetThumbnail( CFbsBitmap* aThumbnail ); |
|
222 |
|
223 /** |
|
224 * Sets the call header Caller text |
|
225 * @param aCallerText is the Caller text |
|
226 */ |
|
227 IMPORT_C void SetCallerText( const TDesC& aCallerText ); |
|
228 |
|
229 /** |
|
230 * Returns the call Caller text. |
|
231 * @return Returns the Caller text |
|
232 */ |
|
233 IMPORT_C const TDesC& CallerText() const; |
|
234 |
|
235 /** |
|
236 * Sets CLI used in conference call participant list. |
|
237 * @param aCLIType CLI type. |
|
238 */ |
|
239 IMPORT_C void SetParticipantListCLI( |
|
240 TPhoneParticipantListCLI aCLIType ); |
|
241 |
|
242 /** |
|
243 * Gets CLI type used in conference call participant list. |
|
244 * @return CLI type. |
|
245 */ |
|
246 IMPORT_C TPhoneParticipantListCLI ParticipantCLI() const; |
|
247 |
|
248 /** |
|
249 * Returns the status of Thumbnail. |
|
250 * @return Returns ETrue if thumbnail exist in contact |
|
251 */ |
|
252 IMPORT_C TBool HasThumbnail() const; |
|
253 |
|
254 /** |
|
255 * Sets the Thumbnail status |
|
256 * @param aStatus status of thumbnail in contact |
|
257 */ |
|
258 IMPORT_C void SetHasThumbnail( TBool aStatus ); |
|
259 |
|
260 /** |
|
261 * Sets the ciphering indicator allowed or hidden |
|
262 * @param aAllowed EFalse to prevent ciphering indicator from showing |
|
263 * ETrue to enable |
|
264 */ |
|
265 IMPORT_C void SetCipheringIndicatorAllowed( TBool aAllowed ); |
|
266 |
|
267 /** |
|
268 * Returns the ciphering indicator allowed status |
|
269 * @return Returns EFalse when ciphering indicator is wanted to be disabled |
|
270 * ETrue to be allowed |
|
271 */ |
|
272 IMPORT_C TBool CipheringIndicatorAllowed() const; |
|
273 |
|
274 /** |
|
275 * Set service id. See Service Provider Settings API |
|
276 * @param Service id. |
|
277 */ |
|
278 IMPORT_C void SetServiceId( TUint32 aServiceId ); |
|
279 |
|
280 /** |
|
281 * Returns service id. See Service Provider Settings API |
|
282 * @return Service id. |
|
283 */ |
|
284 IMPORT_C TUint32 ServiceId() const; |
|
285 |
|
286 /** |
|
287 * Sets contact store link. See Virtual Phonebook API |
|
288 * @param aContactStoreLink Contact store link |
|
289 */ |
|
290 IMPORT_C void SetContactLink( const TDesC8& aContactLink ); |
|
291 |
|
292 /** |
|
293 * Returns contact store link. See Virtual Phonebook API |
|
294 * @return Contact store link |
|
295 */ |
|
296 IMPORT_C const TDesC8& ContactLink() const; |
|
297 |
|
298 /** |
|
299 * Sets remote end phone number. |
|
300 * @param aRemoteNumber Number to be set. |
|
301 */ |
|
302 IMPORT_C void SetRemotePhoneNumber( const TDesC& aPhoneNumber ); |
|
303 |
|
304 /** |
|
305 * Remote phone number. |
|
306 * @return Phone number for remote end. |
|
307 */ |
|
308 IMPORT_C const TDesC& RemotePhoneNumber() const; |
|
309 private: |
|
310 |
|
311 /** |
|
312 * Call header label text |
|
313 */ |
|
314 TBuf<KPhoneCallHeaderLabelMaxLength> iLabelText; |
|
315 |
|
316 /** |
|
317 * Call header short label text |
|
318 */ |
|
319 TBuf<KPhoneCallHeaderLabelMaxLength> iShortLabelText; |
|
320 |
|
321 /** |
|
322 * Call header call state |
|
323 */ |
|
324 TInt iCallState; |
|
325 |
|
326 /** |
|
327 * Call header call type |
|
328 */ |
|
329 TInt iCallType; |
|
330 |
|
331 /** |
|
332 * Call header number type |
|
333 */ |
|
334 TInt iNumberType; |
|
335 |
|
336 /** |
|
337 * Call header ciphering status |
|
338 */ |
|
339 TBool iCiphering; |
|
340 |
|
341 /** |
|
342 * Call header CLI Text |
|
343 */ |
|
344 TBuf<KCntMaxTextFieldLength> iCLIText; |
|
345 |
|
346 /** |
|
347 * Clipping direction of the CLI text. |
|
348 */ |
|
349 TPhoneTextClippingDirection iCLITextClippingDirection; |
|
350 |
|
351 /** |
|
352 * Clipping direction of the CLI text. |
|
353 */ |
|
354 // CBubbleManager::TPhoneClippingDirection iCNAPTextClippingDirection; |
|
355 TPhoneTextClippingDirection iCNAPTextClippingDirection; |
|
356 |
|
357 /** |
|
358 * Call header CNAP Text |
|
359 */ |
|
360 TBuf<KCntMaxTextFieldLength> iCNAPText; |
|
361 |
|
362 /** |
|
363 * Call header picture data |
|
364 */ |
|
365 TPtrC iPicture; |
|
366 |
|
367 TBool iLine2; |
|
368 |
|
369 /** |
|
370 * Thumbnail image |
|
371 */ |
|
372 CFbsBitmap* iThumbnail; |
|
373 |
|
374 /** |
|
375 * Caller text |
|
376 */ |
|
377 TPtrC iCallerText; |
|
378 |
|
379 /** |
|
380 * Conference call participant list CLI. |
|
381 */ |
|
382 TPhoneParticipantListCLI iParticipantListCLI; |
|
383 |
|
384 /** |
|
385 * Thumbnail contact status |
|
386 */ |
|
387 TBool iHasThumbnail; |
|
388 |
|
389 /** |
|
390 * Ciphering indicator allowed status |
|
391 */ |
|
392 TBool iCipheringIndicatorAllowed; |
|
393 |
|
394 /** |
|
395 * Service id |
|
396 * See Service Provider Settings API |
|
397 */ |
|
398 TUint32 iServiceId; |
|
399 |
|
400 /** |
|
401 * Contact store link |
|
402 * See Virtual Phonebook API |
|
403 */ |
|
404 TPtrC8 iContactLink; |
|
405 |
|
406 /** |
|
407 * Remote phone number |
|
408 */ |
|
409 TPtrC iRemotePhoneNumber; |
|
410 |
|
411 /** |
|
412 * Call divert status. |
|
413 */ |
|
414 TBool iDiverted; |
|
415 }; |
|
416 |
|
417 #endif // __TPHONECMDPARAMCALLHEADERDATA_H |
|
418 |
|
419 // End of File |