AlertScreen.h
15.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
/*****************************************************************************
* Copyright Statement:
* --------------------
* This software is protected by Copyright and the information contained
* herein is confidential. The software may not be copied and the information
* contained herein may not be used or disclosed except with the written
* permission of MediaTek Inc. (C) 2005
*
* BY OPENING THIS FILE, BUYER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
* THAT THE SOFTWARE/FIRMWARE AND ITS DOCUMENTATIONS ("MEDIATEK SOFTWARE")
* RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES ARE PROVIDED TO BUYER ON
* AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL WARRANTIES,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
* NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
* SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
* SUPPLIED WITH THE MEDIATEK SOFTWARE, AND BUYER AGREES TO LOOK ONLY TO SUCH
* THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. MEDIATEK SHALL ALSO
* NOT BE RESPONSIBLE FOR ANY MEDIATEK SOFTWARE RELEASES MADE TO BUYER'S
* SPECIFICATION OR TO CONFORM TO A PARTICULAR STANDARD OR OPEN FORUM.
*
* BUYER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND CUMULATIVE
* LIABILITY WITH RESPECT TO THE MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
* AT MEDIATEK'S OPTION, TO REVISE OR REPLACE THE MEDIATEK SOFTWARE AT ISSUE,
* OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY BUYER TO
* MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE.
*
* THE TRANSACTION CONTEMPLATED HEREUNDER SHALL BE CONSTRUED IN ACCORDANCE
* WITH THE LAWS OF THE STATE OF CALIFORNIA, USA, EXCLUDING ITS CONFLICT OF
* LAWS PRINCIPLES. ANY DISPUTES, CONTROVERSIES OR CLAIMS ARISING THEREOF AND
* RELATED THERETO SHALL BE SETTLED BY ARBITRATION IN SAN FRANCISCO, CA, UNDER
* THE RULES OF THE INTERNATIONAL CHAMBER OF COMMERCE (ICC).
*
*****************************************************************************/
/*******************************************************************************
* Filename:
* ---------
* AlertScreen.h
*
* Project:
* --------
* MAUI
*
* Description:
* ------------
* header file for AlertScreen.c
*
* Author:
* -------
* -------
*
*==============================================================================
* HISTORY
* Below this line, this part is controlled by PVCS VM. DO NOT MODIFY!!
*------------------------------------------------------------------------------
* removed!
*
* removed!
* removed!
* removed!
*
* removed!
* removed!
* removed!
*
* removed!
* removed!
* removed!
*
* removed!
* removed!
* removed!
*
* removed!
* removed!
* removed!
*
* removed!
* removed!
* removed!
*
* removed!
* removed!
* removed!
*
* removed!
* removed!
* removed!
*
* removed!
* removed!
* removed!
*
* removed!
* removed!
* removed!
* removed!
* removed!
*
* removed!
* removed!
* removed!
* removed!
* removed!
*
* removed!
* removed!
* removed!
*
* removed!
* removed!
* removed!
*
* removed!
* removed!
* removed!
*
* removed!
* removed!
* removed!
*
* removed!
* removed!
* removed!
*
*
*------------------------------------------------------------------------------
* Upper this line, this part is controlled by PVCS VM. DO NOT MODIFY!!
*==============================================================================
******************* ************************************************************/
#ifndef __ALERT_SCREEN_H__
#define __ALERT_SCREEN_H__
#include "MMI_features.h"
#include "ScreenRotationGprot.h"
#include "MMIDataType.h"
#include "ProfilesSrvGprot.h"
#include "kal_general_types.h"
#include "mmi_frm_events_gprot.h"
#ifdef __cplusplus
extern "C"
{
#endif /* __cplusplus */
/*****************************************************************************
* Define
*****************************************************************************/
#define MMI_CONFIRM_SOFTKEY_NUM (3)
/* alert callback result */
typedef enum _mmi_alert_result_enum
{
/* time-out, press any key excluding END key (backward compatible only) */
MMI_POPUP_NORMAL_EXIT,
/* Interrupt event come (backward compatible only) */
MMI_POPUP_INTERRUPT_EXIT,
/* time-out, press any key excluding END key [popup] */
MMI_ALERT_NORMAL_EXIT = MMI_POPUP_NORMAL_EXIT,
/* Interrupt event come [popup, confirm] */
MMI_ALERT_INTERRUPT_EXIT = MMI_POPUP_INTERRUPT_EXIT,
/* alert is not displayed [popup, confirm] */
MMI_ALERT_NO_SHOW,
/* confirm OK is clicked [confirm] */
MMI_ALERT_CNFM_OK,
/* confirm YES is clicked [confirm] */
MMI_ALERT_CNFM_YES,
/* confirm NO is clicked [confirm] */
MMI_ALERT_CNFM_NO,
/* confirm CANCEL is clicked [confirm] */
MMI_ALERT_CNFM_CANCEL,
/* confirm 1 is clicked (only for CNFM_TYPE_USER_DEFINE) [confirm] */
MMI_ALERT_CNFM_1,
/* confirm 2 is clicked (only for CNFM_TYPE_USER_DEFINE) [confirm] */
MMI_ALERT_CNFM_2,
/* confirm 3 is clicked (only for CNFM_TYPE_USER_DEFINE) [confirm] */
MMI_ALERT_CNFM_3,
MMI_ALERT_END
}mmi_alert_result_enum;
/************************************************************************
* alert result event struct (please sync. to
* mmi_event_popoupcallback_result_struct for backward compatible before
* 10A).
************************************************************************/
typedef struct _mmi_alert_result_evt_struct
{
MMI_EVT_PARAM_HEADER /* basic event header */
void *user_tag; /***********************************************
* caller tag for multi instance in parent proc
***********************************************/
MMI_ID alert_id; /* alert id (both group and screen) */
mmi_alert_result_enum result; /* alert callback result */
} mmi_alert_result_evt_struct;
/* popup property struct */
typedef struct {
mmi_proc_func callback; /* callback proc */
void * user_tag; /* user parameter that will pass to callback proc */
mmi_frm_screen_rotate_enum rotation; /* rotation type */
U32 f_sliding_effect : 1; /* enable sliding effect or not (default: true) */
U32 f_msg_icon : 1; /* show msg icon or not (default: true) */
U32 f_auto_dismiss : 1; /* auto dismiss or not (default: true) */
U32 f_play_tone : 1; /* play tone or not (default: true) */
MMI_ID parent_id; /* parent group id */
U32 duration; /* duration in ms. */
U16 msg_icon; /* img id for msg icon. only works if f_msg_icon is true */
srv_prof_tone_enum tone_id; /* tone id. only works if f_play_tone is true */
} mmi_popup_property_struct;
/* confirm softkey struct */
typedef struct {
WCHAR* str; /* String for softkey */
PS8 img; /* Image for softkey */
} mmi_confirm_softkey_struct;
/* confirm type */
typedef enum {
CNFM_TYPE_OK, /* Softkey only show "OK" */
CNFM_TYPE_YESNO, /* Softkey is "Yes" and "No" */
CNFM_TYPE_CANCEL, /* Softkey only show "Cancel" */
CNFM_TYPE_OKCANCEL, /* Softkey is "OK" and "Cancel" */
CNFM_TYPE_YESNOCANCEL,/* Softkey is "Yes" "No" and "Cancel" */
CNFM_TYPE_USER_DEFINE,/* Softkey is defined by caller */
CNFM_TYPE_END
} mmi_confirm_type_enum;
/* confirm property struct */
typedef struct {
mmi_proc_func callback; /* callback proc */
void * user_tag; /* user parameter that will pass to callback proc */
mmi_confirm_softkey_struct softkey[MMI_CONFIRM_SOFTKEY_NUM]; /* str/img info of softkeys */
mmi_confirm_type_enum ctype; /* confirm type */
U32 f_sliding_effect : 1; /* enable sliding effect or not (default: true) */
U32 f_msg_icon : 1; /* show msg icon or not (default: true) */
U32 f_enter_history : 1; /* enter history or not (default: false) */
U32 f_auto_dismiss : 1; /* auto dismiss or not (default: true) */
U32 f_auto_map_empty_softkey : 1; /* auto map empty softkey or not (default: true) */
U32 f_auto_question_mark : 1;
MMI_ID parent_id; /* parent group id */
mmi_frm_screen_rotate_enum rotation; /* rotation type */
U16 msg_icon; /* img id for msg icon. only works if f_msg_icon is true */
srv_prof_tone_enum tone_id; /* tone id. only works if f_play_tone is true */
} mmi_confirm_property_struct;
/*****************************************************************************
* External function
*****************************************************************************/
/*****************************************************************************
* FUNCTION
* mmi_popup_property_init
* DESCRIPTION
* initialize popup property struct. please do this before using mmi_popup_display
* PARAMETERS
* arg : [IN] pointer to popup property
* RETURNS
* void
*****************************************************************************/
extern void mmi_popup_property_init(mmi_popup_property_struct *arg);
/******************************************************************
* Description
* \FUNCTION: mmi_confirm_property_init
* initialize confirm property struct. please do this before using
* mmi_confirm_display.
* Parameters
* arg : [IN] pointer to confirm property
* ctype : [IN] confirm type
* Returns
* void
******************************************************************/
extern void mmi_confirm_property_init(mmi_confirm_property_struct *arg, mmi_confirm_type_enum ctype);
/*****************************************************************************
* FUNCTION
* mmi_popup_display_simple
* DESCRIPTION
* simply display popup without setting extra properties.
* PARAMETERS
* title : [IN] pointer to title string
* event_type : [IN] alert event type
* parent_id : [IN] parent id of this popup
* user_tag : [IN] user tag to use when callback proc invoked
* RETURNS
* alert id
*****************************************************************************/
extern MMI_ID mmi_popup_display_simple(
WCHAR* title,
mmi_event_notify_enum event_type,
MMI_ID parent_id,
void * user_tag);
/*****************************************************************************
* FUNCTION
* mmi_popup_display_simple_ext
* DESCRIPTION
* simply display popup without setting extra properties.
* PARAMETERS
* title_id : [IN] title string id
* event_type : [IN] alert event type
* parent_id : [IN] parent id of this popup
* user_tag : [IN] user tag to use when callback proc invoked
* RETURNS
* alert id
*****************************************************************************/
extern MMI_ID mmi_popup_display_simple_ext(
MMI_STR_ID title,
mmi_event_notify_enum event_type,
MMI_ID parent_id,
void * user_tag);
/*****************************************************************************
* FUNCTION
* mmi_popup_display
* DESCRIPTION
* display popup with given properties.
* PARAMETERS
* title : [IN] pointer to title string
* event_type : [IN] alert event type
* arg : [IN] pointer to popup property
* RETURNS
* alert id
*****************************************************************************/
extern MMI_ID mmi_popup_display(
WCHAR* title,
mmi_event_notify_enum event_type,
mmi_popup_property_struct *arg);
/*****************************************************************************
* FUNCTION
* mmi_popup_display_ext
* DESCRIPTION
* display popup with given properties.
* PARAMETERS
* title_id : [IN] title string id
* event_type : [IN] alert event type
* arg : [IN] pointer to popup property
* RETURNS
* alert id
*****************************************************************************/
extern MMI_ID mmi_popup_display_ext(
MMI_STR_ID title_id,
mmi_event_notify_enum event_type,
mmi_popup_property_struct *arg);
/*****************************************************************************
* FUNCTION
* mmi_confirm_display
* DESCRIPTION
* display confirm with given properties.
* PARAMETERS
* title : [IN] pointer to title string
* event_type : [IN] alert event type
* arg : [IN] pointer to confirm property
* RETURNS
* confirm id
*****************************************************************************/
extern MMI_ID mmi_confirm_display(
WCHAR* title,
mmi_event_notify_enum event_type,
mmi_confirm_property_struct *arg);
/*****************************************************************************
* FUNCTION
* mmi_confirm_display_ext
* DESCRIPTION
* display confirm with given properties.
* PARAMETERS
* title_id : [IN] title string ID
* event_type : [IN] alert event type
* arg : [IN] pointer to confirm property
* RETURNS
* confirm id
*****************************************************************************/
extern MMI_ID mmi_confirm_display_ext(
MMI_STR_ID title_id,
mmi_event_notify_enum event_type,
mmi_confirm_property_struct *arg);
/*****************************************************
* FUNCTION
* mmi_alert_dismiss
* DESCRIPTION
* dismiss alert (popup/confirm) with given alert id.
* Parameters
* id : [IN] alert (popup or confirm) id to dismiss
* Returns
* if alert does not exist, return false.
*****************************************************/
extern MMI_BOOL mmi_alert_dismiss(MMI_ID id);
/*****************************************************************************
* FUNCTION
* mmi_alert_normal_exit_helper
* DESCRIPTION
* helper callback to call desired ap callback for normal popup exit.
* please assign this as callback, and ap's callback in user_tag.
* then ap's callback will be invoked when popup normal exit.
* PARAMETERS
* evt : [IN] alert quit event
* RETURNS
* result
*****************************************************************************/
extern mmi_ret mmi_alert_normal_exit_helper(mmi_event_struct *evt);
#ifdef __cplusplus
}
#endif
#endif /* __ALERT_SCREEN_H__ */