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