|
1 /* |
|
2 * Copyright (c) 2005 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 TPHONECMDPARAMRINGTONE_H |
|
21 #define TPHONECMDPARAMRINGTONE_H |
|
22 |
|
23 // INCLUDES |
|
24 |
|
25 #include "tphonecommandparam.h" |
|
26 |
|
27 // DATA TYPES |
|
28 |
|
29 enum TPhoneRingToneType |
|
30 { |
|
31 EPhoneRingToneProfile, |
|
32 EPhoneRingTonePersonal |
|
33 }; |
|
34 |
|
35 // CLASS DECLARATION |
|
36 |
|
37 /** |
|
38 * A parameter class for ring tone information. |
|
39 */ |
|
40 class TPhoneCmdParamRingTone : public TPhoneUICommandParam |
|
41 { |
|
42 public: |
|
43 |
|
44 /** |
|
45 * C++ default constructor. |
|
46 */ |
|
47 IMPORT_C TPhoneCmdParamRingTone(); |
|
48 |
|
49 public: |
|
50 |
|
51 /** |
|
52 * Sets the ring tone type |
|
53 * @param aRingToneType is the ring tone type |
|
54 */ |
|
55 IMPORT_C void SetType( const TPhoneRingToneType aType ); |
|
56 |
|
57 /** |
|
58 * Sets the ring tone volume |
|
59 * @param aVolume is the ring tone volume |
|
60 */ |
|
61 IMPORT_C void SetVolume( TInt aVolume ); |
|
62 |
|
63 /** |
|
64 * Sets the ring tone ringing type. |
|
65 * @param aRingingType is the ring tone ringing type |
|
66 */ |
|
67 IMPORT_C void SetRingingType( TInt aRingingType ); |
|
68 |
|
69 /** |
|
70 * Sets the ring tone |
|
71 * @param aRingTone is the ring tone |
|
72 */ |
|
73 IMPORT_C void SetRingTone( const TDesC& aRingTone ); |
|
74 |
|
75 /** |
|
76 * Sets the text to say |
|
77 * @param aTextToSay is the text to say |
|
78 */ |
|
79 IMPORT_C void SetTextToSay( const TDesC& aTextToSay ); |
|
80 |
|
81 /** |
|
82 * Returns the ring tone type |
|
83 * @return Returns the ring tone type |
|
84 */ |
|
85 IMPORT_C TPhoneRingToneType Type() const; |
|
86 |
|
87 /** |
|
88 * Returns the ring tone volume |
|
89 * @return Returns the ring tone volume |
|
90 */ |
|
91 IMPORT_C TInt Volume() const; |
|
92 |
|
93 /** |
|
94 * Returns the ring tone ringing type. |
|
95 * @return Returns the ring tone ringing type |
|
96 */ |
|
97 IMPORT_C TInt RingingType() const; |
|
98 |
|
99 /** |
|
100 * Returns the ring tone. |
|
101 * @return Returns the ring tone |
|
102 */ |
|
103 IMPORT_C const TDesC& RingTone() const; |
|
104 |
|
105 /** |
|
106 * Returns the text to say. |
|
107 * @return Returns the text to say |
|
108 */ |
|
109 IMPORT_C const TDesC& TextToSay() const; |
|
110 |
|
111 /** |
|
112 * Sets status of caller text |
|
113 * @param aStatus, caller text status |
|
114 */ |
|
115 IMPORT_C void SetCallerTextStatus( TBool aStatus ); |
|
116 |
|
117 /** |
|
118 * Returns status of caller text |
|
119 * @return Returns ETrue if used |
|
120 */ |
|
121 IMPORT_C TBool IsCallerText(); |
|
122 |
|
123 /** |
|
124 * Sets status of caller image |
|
125 * @param aStatus, caller image status |
|
126 */ |
|
127 IMPORT_C void SetCallerImageStatus( TBool aStatus ); |
|
128 |
|
129 /** |
|
130 * Returns status of caller image |
|
131 * @return Returns ETrue if used |
|
132 */ |
|
133 IMPORT_C TBool IsCallerImage(); |
|
134 |
|
135 private: |
|
136 |
|
137 /** |
|
138 * Ring tone |
|
139 */ |
|
140 TPtrC iRingTone; |
|
141 |
|
142 /** |
|
143 * Ring tone text to say |
|
144 */ |
|
145 TPtrC iTextToSay; |
|
146 |
|
147 /** |
|
148 * Ring tone type |
|
149 */ |
|
150 TPhoneRingToneType iType; |
|
151 |
|
152 /** |
|
153 * Ring tone volume |
|
154 */ |
|
155 TInt iVolume; |
|
156 |
|
157 /** |
|
158 * Ring tone ringing type |
|
159 */ |
|
160 TInt iRingingType; |
|
161 |
|
162 /** |
|
163 * Status of caller text |
|
164 */ |
|
165 TBool iIsCallerText; |
|
166 |
|
167 /** |
|
168 * Status of caller image |
|
169 */ |
|
170 TBool iIsCallerImage; |
|
171 }; |
|
172 |
|
173 #endif // __TPHONECMDPARAMCALLHEADERDATA_H |
|
174 |
|
175 // End of File |