|
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 __TPHONECMDPARAMINCALLINDICATORDATA_H |
|
21 #define __TPHONECMDPARAMINCALLINDICATORDATA_H |
|
22 |
|
23 // INCLUDES |
|
24 |
|
25 #include <w32std.h> |
|
26 #include "tphonecommandparam.h" |
|
27 |
|
28 // DATA TYPES |
|
29 |
|
30 // CLASS DECLARATION |
|
31 |
|
32 /** |
|
33 * A parameter class for call header information. |
|
34 */ |
|
35 class TPhoneCmdParamIncallIndicatorData : public TPhoneUICommandParam |
|
36 { |
|
37 public: |
|
38 |
|
39 /** |
|
40 * C++ default constructor. |
|
41 */ |
|
42 IMPORT_C TPhoneCmdParamIncallIndicatorData(); |
|
43 |
|
44 public: |
|
45 |
|
46 /** |
|
47 * Sets the incall indicator call state. |
|
48 * @param aCallState is the call state |
|
49 */ |
|
50 IMPORT_C void SetCallState( TInt aCallState ); |
|
51 |
|
52 /** |
|
53 * Sets the incall indicator mode. |
|
54 * @param aMode is the mode status |
|
55 */ |
|
56 IMPORT_C void SetMode( TInt aMode ); |
|
57 |
|
58 /** |
|
59 * Sets the incall indicator mute status. |
|
60 * @param aMute is the mute status |
|
61 */ |
|
62 IMPORT_C void SetMute( TBool aMute ); |
|
63 |
|
64 /** |
|
65 * Sets the incall indicator ciphering status. |
|
66 * @param aCiphering is ETrue if ciphering is on. |
|
67 */ |
|
68 IMPORT_C void SetCiphering( TBool aCiphering ); |
|
69 |
|
70 /** |
|
71 * Sets the incall indicator emergency status. |
|
72 * @param aEmergency is ETrue if emergency mode is on. |
|
73 */ |
|
74 IMPORT_C void SetEmergency( TBool aEmergency ); |
|
75 |
|
76 /** |
|
77 * Sets the incall indicator line2 status. |
|
78 * @param aLine2 is the line2 status |
|
79 */ |
|
80 IMPORT_C void SetLine2( TBool aLine2 ); |
|
81 |
|
82 /** |
|
83 * Returns the incall indicator call state. |
|
84 * @return Returns the call state |
|
85 */ |
|
86 IMPORT_C TInt CallState() const; |
|
87 |
|
88 /** |
|
89 * Returns the incall indicator mode. |
|
90 * @return Returns the call state |
|
91 */ |
|
92 IMPORT_C TInt Mode() const; |
|
93 |
|
94 /** |
|
95 * Returns the incall indicator mute status. |
|
96 * @return Returns ETrue if mute is on |
|
97 */ |
|
98 IMPORT_C TBool Mute() const; |
|
99 |
|
100 /** |
|
101 * Returns the incall indicator ciphering status. |
|
102 * @return Returns ETrue if ciphering is on |
|
103 */ |
|
104 IMPORT_C TBool Ciphering() const; |
|
105 |
|
106 /** |
|
107 * Returns the incall indicator emergency status. |
|
108 * @return Returns ETrue if emergency mode is on |
|
109 */ |
|
110 IMPORT_C TBool Emergency() const; |
|
111 |
|
112 /** |
|
113 * Returns the incall indicator line2 status. |
|
114 * @return Returns ETrue if call is in line2 |
|
115 */ |
|
116 IMPORT_C TBool Line2() const; |
|
117 |
|
118 /** |
|
119 * Sets the little bubble visible or hidden |
|
120 * @param aVisible EFalse to prevent little bubble from showing |
|
121 * ETrue to set visible |
|
122 */ |
|
123 IMPORT_C void SetLittleBubbleVisible( TBool aVisible ); |
|
124 |
|
125 /** |
|
126 * Returns the little bubble visible status |
|
127 * @return Returns EFalse when little bubble is wanted to be hidden |
|
128 * ETrue to be visible |
|
129 */ |
|
130 IMPORT_C TBool LittleBubbleVisible() const; |
|
131 |
|
132 /** |
|
133 * Sets the ciphering indicator allowed or hidden |
|
134 * @param aAllowed EFalse to prevent ciphering indicator from showing |
|
135 * ETrue to enable |
|
136 */ |
|
137 IMPORT_C void SetCipheringIndicatorAllowed( TBool aAllowed ); |
|
138 |
|
139 /** |
|
140 * Returns the ciphering indicator allowed status |
|
141 * @return Returns EFalse when ciphering indicator is wanted to be disabled |
|
142 * ETrue to be allowed |
|
143 */ |
|
144 IMPORT_C TBool CipheringIndicatorAllowed() const; |
|
145 |
|
146 private: |
|
147 |
|
148 /** |
|
149 * Incall indicator call state |
|
150 */ |
|
151 TInt iCallState; |
|
152 |
|
153 /** |
|
154 * Incall indicator mode |
|
155 */ |
|
156 TInt iMode; |
|
157 |
|
158 /** |
|
159 * Incall indicator mute status |
|
160 */ |
|
161 TBool iMute; |
|
162 |
|
163 /** |
|
164 * Incall indicator ciphering status |
|
165 */ |
|
166 TBool iCiphering; |
|
167 |
|
168 /** |
|
169 * Incall indicator emergency status |
|
170 */ |
|
171 TBool iEmergency; |
|
172 |
|
173 /** |
|
174 * Incall indicator line2 status |
|
175 */ |
|
176 TBool iLine2; |
|
177 |
|
178 /** |
|
179 * Should the little bubble be visible or not |
|
180 */ |
|
181 TBool iLittleBubbleVisible; |
|
182 |
|
183 /** |
|
184 * Should the ciphering indicator be visible or not |
|
185 */ |
|
186 TBool iCipheringIndicatorAllowed; |
|
187 |
|
188 }; |
|
189 |
|
190 #endif // __TPHONECMDPARAMINCALLINDICATORDATA_H |
|
191 |
|
192 // End of File |