|
1 /* |
|
2 * Copyright (c) 2002-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: An interface class to the UI side. Through this interface it |
|
15 * is possible to perform actual operations |
|
16 * |
|
17 */ |
|
18 |
|
19 |
|
20 #ifndef MSATUIACTIONIMPLEMENTER_H |
|
21 #define MSATUIACTIONIMPLEMENTER_H |
|
22 |
|
23 // INCLUDES |
|
24 #include <msatuiobserver.h> |
|
25 |
|
26 // CLASS DECLARATION |
|
27 class CAknIconArray; |
|
28 |
|
29 /** |
|
30 * This class defines the interface between engine and UI. |
|
31 */ |
|
32 class MSatUiActionImplementer |
|
33 { |
|
34 public: |
|
35 |
|
36 /** |
|
37 * Returns CoeEnv. |
|
38 */ |
|
39 virtual CCoeEnv* CoeEnv() = 0; |
|
40 |
|
41 /** |
|
42 * Shows the wait note. |
|
43 */ |
|
44 virtual void ShowWaitNoteL() = 0; |
|
45 |
|
46 /** |
|
47 * Shows the wait note without delay |
|
48 */ |
|
49 virtual void ShowWaitNoteWithoutDelayL() = 0; |
|
50 |
|
51 /** |
|
52 * Removes the wait note from the screen. |
|
53 */ |
|
54 virtual void StopShowWaitNote() = 0; |
|
55 |
|
56 /** |
|
57 * Handles the DisplayText operation. |
|
58 * @param aText Text to be shown. |
|
59 * @param aSimApplicationName Sim Application name |
|
60 * @param aIconBitmapDisplayText Icon for dialog |
|
61 * @param aSustainedText Indicates is this text sustained ie. no timers |
|
62 * used if ETrue. |
|
63 * @param aDuration Duration for showing the text |
|
64 * @param aWaitUserToClear Indication if user is needed to clear |
|
65 * message |
|
66 * @return Information of the operation result. |
|
67 */ |
|
68 virtual TSatUiResponse DisplayTextL( const TDesC& aText, |
|
69 const TDesC& aSimApplicationName, |
|
70 CFbsBitmap* aIconBitmapDisplayText, |
|
71 const TBool aSelfExplanatoryIcon, |
|
72 const TBool aSustainedText, |
|
73 const TTimeIntervalSeconds aDuration, |
|
74 const TBool aWaitUserToClear ) = 0; |
|
75 |
|
76 /** |
|
77 * Removes Display Text Dialog from the screen. |
|
78 */ |
|
79 virtual void ClearScreen() = 0; |
|
80 |
|
81 /** |
|
82 * Asks a Yes/No answer from the user. |
|
83 * @param aText A question to be shown. |
|
84 * @param aCharacterSet The character range allowed. |
|
85 * @param aInkey Character user feeds. |
|
86 * @param aIconBitmap Icon for query dialog. |
|
87 * @param aSelfExplanatory Flag indicating if icon is self-explanatory. |
|
88 * @param aDuration Duration for showing the dialog. |
|
89 * @param aImmediateDigitResponse Indication if Immediate digit response |
|
90 * is needed. |
|
91 * @return Information of the operation result. |
|
92 */ |
|
93 virtual TSatUiResponse GetYesNoL( const TDesC& aText, |
|
94 const TSatCharacterSet aCharacterSet, |
|
95 TChar& aInkey, |
|
96 const CFbsBitmap* aIconBitmap, |
|
97 const TBool aSelfExplanatory, |
|
98 TUint& aDuration, |
|
99 const TBool aImmediateDigitResponse ) = 0; |
|
100 |
|
101 /** |
|
102 * Asks input from the user. |
|
103 * @param aText A question to be shown. |
|
104 * @param aCharacterSet The character range allowed. |
|
105 * @param aInput The input string. |
|
106 * @param aMinLength The minimum length of the input allowed. |
|
107 * @param aMaxLength The maximum length of the input allowed. |
|
108 * @param aHideInput A flag indicating if the input should be hidden. |
|
109 * @param aGetInkey A flag indicating if GetInkey command is used. |
|
110 * @param aIconBitmapGetInput Icon for query dialog. |
|
111 * @param aSelfExplanatory A flag indicating if icon is self-explanatory. |
|
112 * @param aDuration Duration for showing the dialog. |
|
113 * @return Information of the operation result. |
|
114 */ |
|
115 virtual TSatUiResponse GetInputL( const TDesC& aText, |
|
116 const TSatCharacterSet aCharacterSet, TDes& aInput, |
|
117 const TInt aMinLength, const TInt aMaxLength, |
|
118 const TBool aHideInput, const TBool aGetInkey, |
|
119 const CFbsBitmap* aIconBitmapGetInput, |
|
120 const TBool aSelfExplanatory, |
|
121 TUint& aDuration ) = 0; |
|
122 |
|
123 /** |
|
124 * Handles the SetUpMenu view. |
|
125 * @param aText The title text. |
|
126 * @param aMenuItems The array of menu item captions. |
|
127 * @param aMenuItemNextActions The array of menu item next action |
|
128 * indicator captions. |
|
129 * @param aIconBitmap The Context pane icon. |
|
130 * @param aItemsIconArray Array of item icons |
|
131 * @param aSelfExplanatoryItems Flag indicating if only icons are shown. |
|
132 * @param aHelpIsAvailable A flag indicating if SAT help is available. |
|
133 * @return Information of the operation result. |
|
134 */ |
|
135 virtual TSatUiResponse SetUpMenuL( const TDesC& aText, |
|
136 const MDesCArray& aMenuItems, |
|
137 const CArrayFixFlat<TSatAction>* aMenuItemNextActions, |
|
138 const CFbsBitmap* aIconBitmap, |
|
139 const CAknIconArray* aItemIconsArray, |
|
140 const TBool aSelfExplanatoryItems, |
|
141 const TBool aHelpIsAvailable ) = 0; |
|
142 |
|
143 /** |
|
144 * Handles the SelectItem view. |
|
145 * @param aText The title text. |
|
146 * @param aMenuItems The array of menu items. |
|
147 * @param aMenuItemNextActions The array of next action indicators. |
|
148 * @param aDefaultItem The item in focus. |
|
149 * @param aSelection The item index selected by the user. |
|
150 * @param aIconBitmap The Context Pane icon. |
|
151 * @param aItemsIconArray Array of item icons |
|
152 * @param aSelfExplanatoryItems Flag indicating if only icons are shown. |
|
153 * @param aHelpIsAvailable A flag indicating if SAT help is available. |
|
154 * @return Information of the operation result. |
|
155 */ |
|
156 virtual TSatUiResponse SelectItemL( const TDesC& aText, |
|
157 const MDesCArray& aMenuItems, |
|
158 const CArrayFixFlat<TSatAction>* aMenuItemNextActions, |
|
159 const TInt aDefaultItem, |
|
160 TUint8& aSelection, |
|
161 const CFbsBitmap* aIconBitmap, |
|
162 const CAknIconArray* aItemsIconArray, |
|
163 const TBool aSelfExplanatoryItems, |
|
164 const TBool aHelpIsAvailable ) = 0; |
|
165 |
|
166 /** |
|
167 * Handles Standard Tone playing. |
|
168 * @param aText The text to be displayed. |
|
169 * @param aFileName The name of the file corresponding to the tone. |
|
170 * @param aDuration The duration of the tone to be played. |
|
171 * @param aIconBitmap The tone playing note icon |
|
172 * @param aSelfExplanatory Flag indicating if icon is self-explanatory. |
|
173 * @return Information of the operation result. |
|
174 */ |
|
175 virtual TSatUiResponse PlayStandardToneL( const TDesC& aText, |
|
176 const TDesC8& aSequence, |
|
177 TTimeIntervalMicroSeconds aDuration, |
|
178 const CFbsBitmap* aIconBitmap, |
|
179 const TBool aSelfExplanatory ) = 0; |
|
180 |
|
181 /** |
|
182 * Shows the confirmation note about the SAT Send SMS, Send SS or |
|
183 * Send USSD command. |
|
184 * @param aText The text to be displayed. |
|
185 * @param aActionAccepted Indicates whether the command was accepted. |
|
186 * @param aType Type of the request (SMS, SS, USSD). |
|
187 * @return Information of the operation result. |
|
188 */ |
|
189 virtual TSatUiResponse ConfirmSendL( const TDesC& aText, |
|
190 TBool& aActionAccepted, TInt aType ) = 0; |
|
191 |
|
192 /** |
|
193 * Shows the wait note about the Send SMS command. |
|
194 * @param aText The text to be displayed. |
|
195 * @param aIconBitmapSendSM Sending dialog icon. |
|
196 * @param aSelfExplanatoryIcon A flag indicating if only icon is shown. |
|
197 */ |
|
198 virtual void ShowSmsWaitNoteL( const TDesC& aText, |
|
199 const CFbsBitmap* aIconBitmapSendSM, |
|
200 const TBool aSelfExplanatoryIcon ) = 0; |
|
201 |
|
202 /** |
|
203 * Shows the wait note about the Send SS command. |
|
204 * @param aText The text to be displayed. |
|
205 * @param aIconBitmap Sending dialog icon. |
|
206 * @param aSelfExplanatoryIcon A flag indicating if only icon is shown. |
|
207 */ |
|
208 virtual void ShowSsWaitNoteL( const TDesC& aText, |
|
209 const CFbsBitmap* aIconBitmap, |
|
210 const TBool aSelfExplanatoryIcon ) = 0; |
|
211 |
|
212 /** |
|
213 * Shows the confirmation note about the SAT Refresh command. |
|
214 * @param aActionAccepted Indicates whether the command was accepted. |
|
215 * @return Information of the operation result. |
|
216 */ |
|
217 virtual TSatUiResponse ConfirmRefreshL( |
|
218 TBool& aActionAccepted) = 0; |
|
219 |
|
220 /** |
|
221 * Notification of the SAT Call Control command. |
|
222 * @param aText The text string to be displayed. |
|
223 * @param aAlphaIdStatus Alpha Identifier status |
|
224 * @param aControlResult Call control general result |
|
225 * @return The response from the UI |
|
226 */ |
|
227 virtual TSatUiResponse CallControlL( |
|
228 const TDesC& aText, |
|
229 const TSatAlphaIdStatus aAlphaIdStatus ) = 0; |
|
230 |
|
231 /** |
|
232 * Notification of the SAT Launch browser confirmation request |
|
233 * @param aText The text to be displayed. |
|
234 * @param aActionAccepted Indicates whether the command was accepted. |
|
235 * @param aIconBitmap The confirm note icon |
|
236 * @param aSelfExplanatory Flag indicating if icon is self-explanatory. |
|
237 */ |
|
238 virtual void ConfirmLaunchBrowserL( |
|
239 const TDesC& aText, |
|
240 TBool& aActionAccepted, |
|
241 const CFbsBitmap* aIconBitmap, |
|
242 const TBool aSelfExplanatory ) = 0; |
|
243 |
|
244 /** |
|
245 * Notification of the SAT Mo Sm Control command. |
|
246 * @param aText The text string to be displayed. |
|
247 * @param aAlphaIdStatus Alpha Identifier status |
|
248 * @param aControlResult Mo Sm control general result |
|
249 * @return The response from the UI |
|
250 */ |
|
251 virtual TSatUiResponse MoSmControlL( |
|
252 const TDesC& aText, |
|
253 const TSatAlphaIdStatus aAlphaIdStatus ) = 0; |
|
254 |
|
255 /** |
|
256 * Shows the wait note while DTMF are being sent. |
|
257 * @param aText The text to be displayed. |
|
258 * @param aIconBitmap The confirm note icon |
|
259 * @param aSelfExplanatory Flag indicating if icon is self-explanatory. |
|
260 * @return Information on the operation result. |
|
261 */ |
|
262 virtual TSatUiResponse ShowDtmfWaitNoteL( const TDesC& aText, |
|
263 const CFbsBitmap* aIconBitmap, |
|
264 const TBool aSelfExplanatoryIcon ) = 0; |
|
265 |
|
266 /** Dispatch iWait to action implementer. |
|
267 * @param aWait Timer. |
|
268 */ |
|
269 virtual void DispatchTimer( CActiveSchedulerWait& aWait ) = 0; |
|
270 |
|
271 /** |
|
272 * Get flag which is indicating if end key is pressed. |
|
273 * @return A Boolean flag which is indicating if end key is pressed. |
|
274 */ |
|
275 virtual TBool GetEndKey() = 0; |
|
276 |
|
277 /** |
|
278 * Set a flag which is indicating if end key is pressed. |
|
279 * @param aValue Status of end key |
|
280 */ |
|
281 virtual void SetEndKey( TBool aValue ) = 0; |
|
282 |
|
283 /** |
|
284 * Set a flag which is indicating if proactive command is pending. |
|
285 * @param aValue Status of proactive command |
|
286 */ |
|
287 virtual void SetCommandPending( TBool aValue ) = 0; |
|
288 |
|
289 /** |
|
290 * Plays user selected tone. |
|
291 * @param aText The text to be displayed. |
|
292 * @param aDuration Play duration. |
|
293 * @param aTone Tone to be played. |
|
294 * @param aIconBitmap The tone playing note icon |
|
295 * @param aSelfExplanatory Flag indicating if icon is self-explanatory. |
|
296 * @return Information on the operation result. |
|
297 */ |
|
298 virtual TSatUiResponse PlayUserSelectedToneL( |
|
299 const TDesC& aText, |
|
300 TTimeIntervalMicroSeconds aDuration, |
|
301 TSatTone aTone, |
|
302 const CFbsBitmap* aIconBitmap, |
|
303 const TBool aSelfExplanatory ) = 0; |
|
304 |
|
305 /** |
|
306 * Confirm user permission for Open Channel. |
|
307 * @param aText The text to be displayed. |
|
308 * @param aActionAccepted Indicates whether the command was accepted. |
|
309 * @param aIconBitmapOpenChannel Icon for query dialog |
|
310 * @param aSelfExplanatory A flag indicating if icon is self-explanatory |
|
311 * @return Operation result |
|
312 */ |
|
313 virtual TSatUiResponse ConfirmOpenChannelL( |
|
314 const TDesC& aText, |
|
315 TBool& aActionAccepted, |
|
316 const CFbsBitmap* aIconBitmapOpenChannel, |
|
317 const TBool aSelfExplanatory ) = 0; |
|
318 |
|
319 /** |
|
320 * Shows the wait note while BIP packets are sent. |
|
321 * @param aCommand Command type. |
|
322 * @param aText The text to be displayed. |
|
323 * @param aIconBitmap Icon for query dialog |
|
324 * @param aSelfExplanatory A flag indicating if icon is self-explanatory |
|
325 */ |
|
326 virtual void ShowBIPNoteL( |
|
327 TInt aCommand, |
|
328 const TDesC& aText, |
|
329 const CFbsBitmap* aIconBitmap, |
|
330 const TBool aSelfExplanatory ) = 0; |
|
331 |
|
332 /** |
|
333 * Confirm user permission for SetUpCall |
|
334 * @param aText The text to be displayed. |
|
335 * @param aSimAppName Header for th equery |
|
336 * @param aActionAccepted Indicates whether the command was accepted. |
|
337 * @param aIconBitmap Icon for query dialog |
|
338 * @param aSelfExplanatory A flag indicating if icon is self-explanatory |
|
339 */ |
|
340 virtual void ConfirmSetUpCallL( |
|
341 const TDesC& aText, |
|
342 const TDesC& aSimAppName, |
|
343 TBool& aActionAccepted, |
|
344 const CFbsBitmap* aIconBitmap, |
|
345 const TBool aSelfExplanatory ) = 0; |
|
346 |
|
347 /** |
|
348 * Show note indicating SAT is not available. |
|
349 */ |
|
350 virtual void ShowNotAvailableNoteL() = 0; |
|
351 |
|
352 /** |
|
353 * Show the Ss error note. |
|
354 */ |
|
355 virtual void ShowSsErrorNoteL() = 0; |
|
356 |
|
357 /** |
|
358 * Start SatUi closing process. |
|
359 */ |
|
360 virtual void CloseSatUI() = 0; |
|
361 |
|
362 /** |
|
363 * Return current profile state. |
|
364 * @return current profile state. |
|
365 */ |
|
366 virtual TInt ProfileState() = 0; |
|
367 |
|
368 |
|
369 }; |
|
370 |
|
371 #endif // MSATUIACTIONIMPLEMENTER_H |
|
372 |
|
373 // End of File |