|
1 /* |
|
2 * Copyright (c) 2006 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 #ifndef TPHONECMDPARAMSPEEDDIAL_H |
|
20 #define TPHONECMDPARAMSPEEDDIAL_H |
|
21 |
|
22 // INCLUDES |
|
23 #include "tphonecommandparam.h" |
|
24 |
|
25 // DATA TYPES |
|
26 |
|
27 /** |
|
28 * Phone number types |
|
29 * |
|
30 * EPhoneNumberTypeNotFound - phone number's type was not found |
|
31 * EPhoneNumberTypeCS - CS call can be made to the phone number |
|
32 * EPhoneNumberTypeVideo - video call can be made to the phone number |
|
33 * EPhoneNumberTypeVoip - VoIP call can be made to the address. |
|
34 */ |
|
35 enum TPhoneNumberType |
|
36 { |
|
37 EPhoneNumberTypeNotFound = -1, |
|
38 EPhoneNumberTypeCS = 0, |
|
39 EPhoneNumberTypeVideo, |
|
40 EPhoneNumberTypeVoip |
|
41 }; |
|
42 |
|
43 // CLASS DECLARATION |
|
44 |
|
45 /** |
|
46 * A concrete parameter class for one TDesC and TInt value. |
|
47 * |
|
48 */ |
|
49 class TPhoneCmdParamSpeedDial : public TPhoneUICommandParam |
|
50 { |
|
51 public: |
|
52 |
|
53 /** |
|
54 * C++ default constructor. |
|
55 */ |
|
56 IMPORT_C TPhoneCmdParamSpeedDial(); |
|
57 |
|
58 public: |
|
59 |
|
60 /** |
|
61 * Sets the phone number. |
|
62 * @param aPhoneNumber is phone number in string format |
|
63 */ |
|
64 IMPORT_C void SetPhoneNumber( TPtr* aPhoneNumber ); |
|
65 |
|
66 /** |
|
67 * Returns the phone number. |
|
68 * @return Returns the carried phone number string |
|
69 */ |
|
70 IMPORT_C TPtr* PhoneNumber(); |
|
71 |
|
72 /** |
|
73 * Sets the phone number's type. |
|
74 * @param aNumberType number type |
|
75 */ |
|
76 IMPORT_C void SetNumberType( TPhoneNumberType aNumberType ); |
|
77 |
|
78 /** |
|
79 * Returns the phone number's type. |
|
80 * @return phone number's type |
|
81 */ |
|
82 IMPORT_C TPhoneNumberType NumberType(); |
|
83 |
|
84 /** |
|
85 * Sets the speed dial location. |
|
86 * @param aLocation location to be set |
|
87 */ |
|
88 IMPORT_C void SetLocation( TInt aLocation ); |
|
89 |
|
90 /** |
|
91 * Returns the speed dial location. |
|
92 * @return values from 1 to 9 for succesfull location. |
|
93 * Values below 0 indicate unsuccesfull location fetch. |
|
94 */ |
|
95 IMPORT_C TInt Location(); |
|
96 |
|
97 /** |
|
98 * Sets the serviceId |
|
99 * @param aServiceId The serviceId user has selected for speeddial |
|
100 */ |
|
101 IMPORT_C void SetServiceId( TUint aServiceId ); |
|
102 |
|
103 /** |
|
104 * Returns the serviceId |
|
105 * @param aServiceId serviceId |
|
106 */ |
|
107 IMPORT_C TUint ServiceId() const; |
|
108 |
|
109 private: |
|
110 |
|
111 /** |
|
112 * The phone number |
|
113 */ |
|
114 TPtr* iPhoneNumber; |
|
115 |
|
116 /** |
|
117 * The phone number's type |
|
118 */ |
|
119 TPhoneNumberType iNumberType; |
|
120 |
|
121 /** |
|
122 * Speed dial location |
|
123 */ |
|
124 TInt iLocation; |
|
125 /** |
|
126 * The serviceId |
|
127 */ |
|
128 TUint iServiceId; |
|
129 }; |
|
130 |
|
131 #endif // TPHONECMDPARAMSPEEDDIAL_H |
|
132 |
|
133 // End of File |