CommonScreens.h 60.2 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 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488
/*****************************************************************************
*  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:
 * ---------
 *  CommonScreens.h
 *
 * Project:
 * --------
 *  MAUI
 *
 * Description:
 * ------------
 *  
 *
 * 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!
 * 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!
 *
 * 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!
 * 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!
 * removed!
 * removed!
 *
 *------------------------------------------------------------------------------
 * Upper this line, this part is controlled by PVCS VM. DO NOT MODIFY!! 
 *==============================================================================
 *******************************************************************************/

/**
 * Copyright Notice
 * (c) 2002 - 2003, Pixtel Communications, Inc., 1489 43rd Ave. W.,
 * Vancouver, B.C. V6M 4K8 Canada. All Rights Reserved.
 *  (It is illegal to remove this copyright notice from this software or any
 *  portion of it)
 */

/**************************************************************

   FILENAME : CommonScreens.h

   PURPOSE     : Common screens used by applications

   REMARKS     : 

   AUTHOR      : manju

   DATE     : Aug-06-2003

**************************************************************/

/* MTK Add Terry  for multi language IME */
#include "MMI_features.h"
/* MTK End */
#include "ScreenRotationGprot.h"
#include "AlertScreen.h"
#include "gui_effect_oem.h"
#include "lcd_sw_inc.h"
#include "MMIDataType.h"
#include "gui_data_types.h"
#include "kal_general_types.h"
#include "mmi_frm_events_gprot.h"
#include "ProfilesSrvGprot.h"
#include "wgui_categories_list.h"
#include "MenuCuiGprot.h"
#include "mmi_rp_srv_editor_def.h"

#ifndef __COMMONSCREENS_H__
#define __COMMONSCREENS_H__

#ifdef __cplusplus
extern "C"
{
#endif /* __cplusplus */ 

/*****************************************************************************
 *  Define
 *****************************************************************************/
    /*  POPUP behavior defined by mask */

/* Disable all popup */
#define  POPUP_ALL_OFF  0x00
/* Disable popup display */
#define  POPUP_DSPL_ON  0x01
/* Disable popup tone */
#define  POPUP_TONE_ON  0x02
#define  POPUP_PMIC_ON  0x04
/* Enable all popup*/
#define  POPUP_ALL_ON   0xFF

    /*  POPUP screen attribute  */
#define UI_POPUP_NOTIFYDURATION_TIME            1000
#define UI_POPUP_NOTIFYDURATION_TIME_2000       2000

/* Disable popup sliding effect */
#define MMI_POPUP_DISABLE_SLIDING_EFFECT    0x00000001
/* Disable popup icon for long string*/
#define MMI_POPUP_DISABLE_SHOW_ICON         0x00000002
/* goback proc disable switch screen id in entry popupcallback proc, internal use*/
#define MMI_POPUP_DISABLE_SWITCH_SCREEN     0x10000000

#define CASCADING_MENU_MAX_LEVEL                2   /* ONLY SUPPORT 2 NOW */
#define MMI_CASCADING_ASM_BUFFER_SIZE           MAIN_LCD_DEVICE_WIDTH * MAIN_LCD_DEVICE_HEIGHT * GUI_EFFECT_LAYER_BYTE_PER_PIXEL

#define MAX_GLOBAL_IMAGE_LIST                   30  /* gIndexIconsImageList size */

/*****************************************************************************
 *  Typedef
 *****************************************************************************/
 /* the first U8** is the table for ap to fill their own symbol, the S32 is the size of symbol table ap could configure *
   * the second U8** is the base symbol table, S32 is the size of the base symbol table                                     */



/*****************************************************************************
 * External function
 *****************************************************************************/

typedef enum
{
    PHNSET_HANDWRITING_FAST,				/* fast handwriting speed */
    PHNSET_HANDWRITING_MEDIUM,				/* medium handwriting speed */
    PHNSET_HANDWRITING_SLOW					/* slow handwriting speed */
} PHNSET_HANDWRITING_SPEED_ENUM;

#if defined(__MMI_TOUCH_SCREEN__) && !defined(__MMI_NO_HANDWRITING__)
extern void EntryHandWritingSettingScr(MMI_ID parent_gid);
extern mmi_ret mmi_phnset_handwriting_proc(mmi_event_struct *param);
#endif

#ifndef __MMI_NO_HANDWRITING__
extern color PhnsetGetHandwritingColor(void);
extern PHNSET_HANDWRITING_SPEED_ENUM PhnsetGetHandwritingSpeed(void);
#endif


    /* MTK Terry : Multitap for Star and Pound */
    extern void EntryQuickSearchInputMethodScreen(void);
    extern void ExitQuickSearchInputMethodScreen(void);

    extern void EntryInputMethodScreen(void);
	extern void EntryInputModeScreen(void);
    extern void EntryInputModeScreen_with_sg(mmi_id g_id);
    extern void ExitInputMethodScreen(void);
	extern void ExitInputModeScreen(void);
    extern void EntryAPRequiredInputMethodScreen(void);
    extern void mmi_ime_entry_input_method_screen_with_sg(mmi_id g_id);
    extern void ExitAPRequiredInputMethodScreen(void);

    extern void EntryInLineMultilineEditorOption(void);
    extern void ExitInLineMultilineEditorOption(void);
    extern void RegisterInputMethodScreenCloseFunction(void (*f) (void));
    extern void RegisterInputMethodScreenEntryCallback(void (*f) (void));
    extern void RegisterInputMethodScreenExitCallback(void (*f) (void));
    extern void RegisterSymbolTableScreenEntryCallback(void (*f) (void));
    extern void RegisterSymbolTableScreenExitCallback(void (*f) (void));
    extern void ResetInputMethodScreenEntryCallback(void);
    extern void ResetInputMethodScreenExitCallback(void);
    extern void ResetSymbolTableScreenEntryCallback(void);
    extern void ResetSymbolTableScreenExitCallback(void);
    extern void ConfirmInlineFullScreenEdit(void);
    extern void CancelInlineFullScreenEdit(void);

    extern void EntrySymbolPickerScreen(void);
    extern void mmi_ime_entry_symbol_picker_screen_with_sg(mmi_id g_id);
    extern void ExitSymbolPickerScreen(void);
    extern void SymbolPickerHandleLSKFromMenuList(void);
    extern void SymbolPickerHandleRSKFromMenuList(void);
    extern void EntrySymbolPickerScreenFromMenuList(void);
    extern void EntrySymbolPickerScreenFromMenuList_with_sg(mmi_id g_id);
    extern void ExitSymbolPickerScreenFromMenuList(void);
    extern void SetInputMethodAndDoneCaptionIcon(U16 IconId);
    extern void EntryScrForInputMethodAndDone(void);
    extern void ExitScrForInputMethodAndDone(void);
    extern void PrepareSymbolTableAndShowCategory(U8 *guiBuffer, U8 *inputBuffer);
    extern void mmi_ime_register_symbol_table_callback(mmi_ime_symbol_table_callback funcptr);
    extern void mmi_ime_clear_symbol_table_callback(void);
    extern const U16 gIndexIconsImageList[];
    extern const U16 gTwoLineIndexIconsImageList[];

    extern MMI_BOOL mmi_ime_symbol_check(UI_character_type ch);
    extern void mmi_frm_go_back_2_history(void);

/*****************************************************************************
 * FUNCTION
 *  mmi_display_popup
 * DESCRIPTION
 *  1. Displays the common pop-up screen used across all applications.
 *  2. This pop-up screen will not be added into history.
 *  3. It will GoBackHistory when user press any key or timer expired.
 *  4. Get image, tone and duration based on event_id from table in custom_notify_event.c
 *  5. If the tone is over timer's duration, the popup duration time will the same as that of tone.
 * PARAMETERS
 *  string          : [IN](POPUP)    Char array of string
 *  event_id        : [IN](N/A)		   Display popup event type
 * RETURNS
 *  void
 *****************************************************************************/
    extern void mmi_display_popup(UI_string_type string, mmi_event_notify_enum event_id);
    
/*****************************************************************************
 * FUNCTION
 *  mmi_display_popup_with_tone
 * DESCRIPTION
 *  1. Displays the pop-up screen used across all applications.
 *  2. This pop-up screen will not be added into history.
 *  3. It will GoBackHistory when user press any key or timer expired.
 *  4. Get image and duration based on event_id from table in custom_notify_event.c
 *  5. If the tone is over timer's duration, the popup duration time will the same as that of tone.
 *  6. The tone use the input.
 * PARAMETERS
 *  string          : [IN](POPUP)    	Char array of string
 *  event_id        : [IN](N/A)    		Display popup type
 *  tone            : [IN](N/A)	    	Tone defined by app
 * RETURNS
 *  void
 *****************************************************************************/
    extern void mmi_display_popup_with_tone(UI_string_type string, mmi_event_notify_enum event_id, srv_prof_tone_enum tone);

/*****************************************************************************
 * FUNCTION
 *  mmi_display_popup_with_flag
 * DESCRIPTION
 *  1. Displays the pop-up screen used across all applications.
 *  2. This pop-up screen will not be added into history.
 *  3. It will GoBackHistory when user press any key or timer expired.
 *  4. Get image, tone and duration based on event_id from table in custom_notify_event.c
 *  5. If the tone is over timer's duration, the popup duration time will the same as that of tone.
 *  6. Set popup behaviour by flag. It can be MMI_POPUP_DISABLE_SLIDING_EFFECT ,MMI_POPUP_DISABLE_SHOW_ICON. 
 * PARAMETERS
 *  string          : [IN](POPUP)    Char array of string
 *  event_id        : [IN](N/A)		   Display popup type
 *  flag            : [IN](N/A)    	 Popup behaviour flag
 * RETURNS
 *  void
 *****************************************************************************/
    extern void mmi_display_popup_with_flag(UI_string_type string, mmi_event_notify_enum event_id, U32 flag);

/*****************************************************************************
 * FUNCTION
 *  mmi_display_popupcallback
 * DESCRIPTION
 * 1. This pop-up screen will not be added into history.
 * 2. This pop-up will not GoBackHistory, and applications have to handle the next screen by callback function f.
 * 3. It will call callback f when timer expired or pressing any key or pen down.
 * 4. If there any incoming event that need show new screen, we will not call f.
 * 5. Get image, tone and duration based on event_id from table in custom_notify_event.c
 * PARAMETERS
 *  string              : [IN](POPUP)   Char array of string
 *  event_id            : [IN](N/A)    	Display popup type
 *  f                   : [IN](N/A)    	Callback function pointer
 * RETURNS
 *  void
 *****************************************************************************/
    extern void mmi_display_popupcallback(UI_string_type string, mmi_event_notify_enum event_id, FuncPtr f);

/*****************************************************************************
 * FUNCTION
 *  mmi_display_popupcallback_ext
 * DESCRIPTION
 * 1. This pop-up screen will not be added into history.
 * 2. This pop-up will not GoBackHistory, and applications have to handle the next screen by callback function f.
 * 3. It will call callback f only when timer expired or pressing any key or pen down.
 * 4. If there any new incoming event that need show new screen, we will not call f.
 * 5. interr_callback function will be called only when condition 4.
 * 6. It's a strict rule that interr_callback can't handle screen ;interr_callback  only handle low_cost event for App.
 * PARAMETERS
 *  string                  : [IN](POPUP)    	Char array of string
 *  mmi_event_notify_enum   : [IN](N/A)    		Popup event type
 *  f                       : [IN](N/A)    		Callback function pointer when timer expired
 *  interr_callback         : [IN](N/A)    		Callback function pointer when exit the popup screen only by interrupt.
 * RETURNS
 *  void
 *****************************************************************************/
    extern void mmi_display_popupcallback_ext(UI_string_type string, mmi_event_notify_enum event_id, FuncPtr f, FuncPtr interr_callback);

/*****************************************************************************
 * FUNCTION
 *  mmi_display_popup_confirm
 * DESCRIPTION
 *  1. Display common popup confirm screen.
 *  2. This popup confirm screen will not be add into history.
 *  3. Get image and tone based on event_id from table in custom_notify_event.c.
 * PARAMETERS
 *  left_softkey            : [IN](LSK)        			Left softkey label
 *  left_softkey_icon       : [IN](N/A)        			Icon for the Left softkey
 *  right_softkey           : [IN](RSK)        			Right softkey label
 *  right_softkey_icon      : [IN](N/A)        			Icon for the right softkey
 *  message                 : [IN](POPUPCONFIRM)    message string
 *  even_id                 : [IN](N/A)        			Popup event type
 * RETURNS
 *  void
 *****************************************************************************/    
    extern void mmi_display_popup_confirm(UI_string_type left_softkey, PU8 left_softkey_icon, UI_string_type right_softkey, PU8 right_softkey_icon, UI_string_type message,
                    mmi_event_notify_enum event_id);
                    
/*****************************************************************************
 * FUNCTION
 *  mmi_display_popup_confirmext
 * DESCRIPTION
 *  1. Display common popup confirm screen with center softkey.
 *  2. This popup confirm screen will not be add into history.
 *  3. Get image and tone based on event_id from table in custom_notify_event.c.
 * PARAMETERS
 *  left_softkey            : [IN](LSK)        			Left softkey label
 *  left_softkey_icon       : [IN](N/A)        			Icon for the Left softkey
 *  right_softkey           : [IN](RSK)        			Right softkey label
 *  right_softkey_icon      : [IN](N/A)        			Icon for the right softkey
 *	CSK_str									:	[IN](N/A)							Center softkey label
 *	CSK_img									:	[IN](N/A)							Center softkey icon
 *  message                 : [IN](POPUPCONFIRM)    message string
 *  even_id                 : [IN](N/A)        			Popup event type
 * RETURNS
 *  void
 *****************************************************************************/     
    extern void mmi_display_popup_confirmext(UI_string_type left_softkey, PU8 left_softkey_icon, UI_string_type right_softkey, PU8 right_softkey_icon, U16 CSK_str, U16 CSK_img, UI_string_type message,
                    mmi_event_notify_enum event_id);
    
/*****************************************************************************
 * FUNCTION
 *  mmi_display_popup_confirm_with_flag
 * DESCRIPTION
 *  1. Display common popup confirm screen.
 *  2. This popup confirm screen will not be add into history.
 *  3. Get image and tone based on event_id from table in custom_notify_event.c.
 *	4. Set popup behaviour by flag. It can be MMI_POPUP_DISABLE_SLIDING_EFFECT ,MMI_POPUP_DISABLE_SHOW_ICON.
 * PARAMETERS
 *  left_softkey            : [IN](LSK)        			Left softkey label
 *  left_softkey_icon       : [IN](N/A)        			Icon for the Left softkey
 *  right_softkey           : [IN](RSK)        			Right softkey label
 *  right_softkey_icon      : [IN](N/A)        			Icon for the right softkey
 *  message                 : [IN](POPUPCONFIRM)    message string
 *  even_id                 : [IN](N/A)        			Popup event type
 *  flag										:	[IN](N/A)							Popup screen behavior.
 * RETURNS
 *  void
 *****************************************************************************/     
    extern void mmi_display_popup_confirm_with_flag(UI_string_type left_softkey, PU8 left_softkey_icon, UI_string_type right_softkey, PU8 right_softkey_icon, UI_string_type message,
                    mmi_event_notify_enum event_id, U32 flag);
                    
#ifdef __MMI_SCREEN_ROTATE__
/*****************************************************************************
 * FUNCTION
 *  mmi_display_popup_rotated
 * DESCRIPTION
 *  1. Displays the common rotated pop-up screen used across all applications.
 *  2. This pop-up screen will not be added into history.
 *  3. It will GoBackHistory when user press any key or timer expired.
 *  4. Get image, tone and duration based on event_id from table in custom_notify_event.c
 *  5. For tones over timer duration, the popup duration time will same as that of tone.
 * PARAMETERS
 *  string          : [IN]    Char array of string
 *  event_id        : [IN]    Display popup type
 *  rotation        : [IN]    Rotation
 * RETURNS
 *  void
 *****************************************************************************/
    extern void mmi_display_popup_rotated(UI_string_type string, mmi_event_notify_enum event_id,
                         mmi_frm_screen_rotate_enum rotation);
                         
/*****************************************************************************
 * FUNCTION
 *  mmi_display_popupcallback_rotated
 * DESCRIPTION
 * 1. This pop-up screen will not be added into history.
 * 2. This pop-up will not GoBackHistory, and applications have to handle the next screen by callback function f.
 * 3. It will call callback f when timer expired or pressing any key or pen down.
 * 4. If there any new incoming event that need show new screen,  we will not call f.
 * 5. Get image, tone and duration based on event_id from table in custom_notify_event.c
 * PARAMETERS
 *  string              : [IN]    Char array of string
 *  event_id            : [IN]    Display popup type
 *  f                   : [IN]    Callback function pointer
 *  rotation            : [IN]    Popup rotated degree
 * RETURNS
 *  void
 *****************************************************************************/    
    extern void mmi_display_popupcallback_rotated(UI_string_type string, mmi_event_notify_enum event_id, FuncPtr f,
                         mmi_frm_screen_rotate_enum rotation);
    
/*****************************************************************************
 * FUNCTION
 *  mmi_display_popup_confirm_rotated
 * DESCRIPTION
 *  1. Display common popup confirm rotated screen.
 *  2. This popup confirm screen will not be add into history.
 *  3. Get image and tone based on event_id from table in custom_notify_event.c.
 * PARAMETERS
 *  left_softkey            : [IN](LSK)        			Left softkey label
 *  left_softkey_icon       : [IN](N/A)        			Icon for the Left softkey
 *  right_softkey           : [IN](RSK)        			Right softkey label
 *  right_softkey_icon      : [IN](N/A)        			Icon for the right softkey
 *  message                 : [IN](POPUPCONFIRM)    message string
 *  even_id                 : [IN](N/A)        			Popup event type
 *  rotation								: [IN](N/A)							Popup rotation degree.
 * RETURNS
 *  void
 *****************************************************************************/     
    extern void mmi_display_popup_confirm_rotated(UI_string_type left_softkey, PU8 left_softkey_icon, UI_string_type right_softkey, PU8 right_softkey_icon, UI_string_type message,
                           mmi_event_notify_enum event_id, mmi_frm_screen_rotate_enum rotation);
    
/*****************************************************************************
 * FUNCTION
 *  mmi_display_popup_confirmext
 * DESCRIPTION
 *  1. Display common popup confirm rotated screen with center softkey.
 *  2. This popup confirm screen will not be add into history.
 *  3. Get image and tone based on event_id from table in custom_notify_event.c.
 * PARAMETERS
 *  left_softkey            : [IN](LSK)        			Left softkey label
 *  left_softkey_icon       : [IN](N/A)        			Icon for the Left softkey
 *  right_softkey           : [IN](RSK)        			Right softkey label
 *  right_softkey_icon      : [IN](N/A)        			Icon for the right softkey
 *	CSK_str									:	[IN](N/A)							Center softkey label
 *	CSK_img									:	[IN](N/A)							Center softkey icon
 *  message                 : [IN](POPUPCONFIRM)    message string
 *  even_id                 : [IN](N/A)        			Popup event type
 *	rotation								:	[IN](N/A)							Popup rotation degree.
 * RETURNS
 *  void
 *****************************************************************************/    
    extern void mmi_display_popup_confirmext_rotated(UI_string_type left_softkey, PU8 left_softkey_icon, UI_string_type right_softkey, PU8 right_softkey_icon, U16 CSK_str, U16 CSK_img, UI_string_type message,
                           mmi_event_notify_enum event_id, mmi_frm_screen_rotate_enum rotation);
#endif /* __MMI_SCREEN_ROTATE__ */
/* end  new popup function from 09A */

/* DOM-NOT_FOR_SDK-BEGIN */ 
#if 0
/* under construction !*/
/* under construction !*/
/* under construction !*/
/* under construction !*/
#ifdef __MMI_SCREEN_ROTATE__
/* under construction !*/
/* under construction !*/
/* under construction !*/
#endif
#endif
/* end  new popup function from 08B */
/* DOM-NOT_FOR_SDK-END */
#ifdef __ATV_SMS_SUPPORT__
extern MMI_BOOL mmi_sms_matv_popup_show(
				 UI_string_type string,
				 mmi_event_notify_enum event_id,
				 MMI_ID parent_id,
				 U16 screen_id,
				 FuncPtr exit_callback);

/*****************************************************************************
 * FUNCTION
 *  mmi_mtv_ime_display_popup
 * DESCRIPTION
 *  display ime common screen in mATV
 * PARAMETERS
 *  string          [in] : string to display
 *  event_id        [in] : nofity type
 * RETURNS
 *  void
 *****************************************************************************/
extern void mmi_mtv_ime_display_popup(MMI_ID string, mmi_event_notify_enum event_id);

#endif
/* popup callback screen exit state (only keep for backward compatible, 
   please use mmi_alert_result_enum after 10A) */
typedef mmi_alert_result_enum   mmi_popupcallback_result_enum;
    

/* popupcallback result event struct (only keep for backward compatible, please use mmi_alert_result_evt_struct after 10A) */
typedef mmi_alert_result_evt_struct     mmi_event_popoupcallback_result_struct;

 
/* temp define to avoid build error, pls use prefix "MMI_" */
#define POPUP_NORMAL_EXIT MMI_POPUP_NORMAL_EXIT
#define POPUP_INTERRUPT_EXIT MMI_POPUP_INTERRUPT_EXIT

 /*****************************************************************************
  * FUNCTION
  *  mmi_display_popup_with_sg
  * DESCRIPTION
  *  1. [NOTICE!] If caller group is not active, The API will return directly and do not show popup.
  *  2. [NOTICE!] If caller call the function in a entry proc, the function will be posted after the entry proc\
  *               When Gobackhistory. So caller must use global buffer to save the string in the case.
  *  3. This pop-up screen will not be added into history.
  *  4. It will close popup screen when user press any key or timer expired.
  *  5. Don't send quit event to caller.
  *  6. EntryIdle screen if Pressing END KEY.
  * PARAMETERS
  *  parent_id       : [IN](N/A)     Caller group ID.
  *  string          : [IN](POPUP)   Char array of string
  *  event_id        : [IN](N/A)     Display popup event type
  *  flags           : [IN](N/A)     Popup behaviors customize.(please set 0 in default)
  * RETURNS
  *  MMI_BOOL        :  [OUT]        Show popup screen or not.
  *****************************************************************************/
 extern MMI_BOOL mmi_display_popup_with_sg(mmi_id parent_id, UI_string_type string, mmi_event_notify_enum event_id, U32 flags);


/*****************************************************************************
 * FUNCTION
 *  mmi_display_popupcallback_with_sg
 * DESCRIPTION
 *  1. [NOTICE!] Popupcallback screen will close itself after send event to caller.
 *  2. [NOTICE!] If caller group is not active, The API will return directly and do not show popup.
 *  3. [NOTICE!] If caller call the function in a entry proc, the function will be posted after the entry proc\
 *               When Gobackhistory. So caller must use global buffer to save the string in the case.
 *  4. It will sent EVT_ID_POPUP_QUIT to the receiver proc or parent proc when popupcallback screen disappeared.
 *  5. It will sent mmi_popupcallback_result_enum as extra info in the event if caller want to know the exit state.
 *  6. This pop-up screen will not be added into history.
 *  7. EntryIdle screen if Pressing END KEY.
 * PARAMETERS
 *  parent_id       : [IN](N/A)     Caller group ID.
 *  string          : [IN](POPUP)   Char array of string
 *  event_id        : [IN](N/A)		Display popup event type
 *  receiver_proc   :  [IN](N/A)    popupcallback recevier proc.(If NULL, use parent's proc & parent's user data)
 *  user_data       : [IN](N/A)     receiver proc user data.
 *  flags           : [IN](N/A)     Popup behaviors customize.(please set 0 in default)
 * RETURNS
 *  MMI_BOOL        : [OUT]         Show popup screen or not;
 *****************************************************************************/
extern MMI_BOOL mmi_display_popupcallback_with_sg(mmi_id parent_id, UI_string_type string, 
                mmi_event_notify_enum event_id, mmi_proc_func receiver_proc, void *user_data, U32 flags);

#ifdef __MMI_SCREEN_ROTATE__

/*****************************************************************************
 * FUNCTION
 *  mmi_display_popupcallback_rotated_with_sg
 * DESCRIPTION
 *  1. [NOTICE!] Popupcallback screen will close itself after send event to caller.
 *  2. [NOTICE!] If caller group is not active, The API will return directly and do not show popup.
 *  3. [NOTICE!] If caller call the function in a entry proc, the function will be posted after the entry proc\
 *               When Gobackhistory. So caller must use global buffer to save the string in the case.
 *  4. It will sent EVT_ID_POPUP_QUIT to the receiver proc or parent proc when popupcallback screen disappeared.
 *  5. It will sent mmi_popupcallback_result_enum as extra info in the event if caller want to know the exit state.
 *  6. This pop-up screen will not be added into history.
 *  7. EntryIdle screen if Pressing END KEY.
 * PARAMETERS
 *  parent_id       : [IN](N/A)     Caller group ID.
 *  string          : [IN](POPUP)   Char array of string
 *  event_id        : [IN](N/A)		  Display popup event type
 *  rotation        : [IN](N/A)     Rotation degree
 *  receiver_proc   : [IN](N/A)     popupcallback recevier proc.(If NULL, use parent's proc & parent's user data)
 *  user_data       : [IN](N/A)     receiver proc user data.
 *  flags           : [IN](N/A)     Popup behaviors customize.(please set 0 in default)
 * RETURNS
 *  MMI_BOOL        : [OUT]         Show popup screen or not;
 *****************************************************************************/
extern MMI_BOOL mmi_display_popupcallback_rotated_with_sg(mmi_id parent_id, UI_string_type string,
                mmi_event_notify_enum event_id, mmi_frm_screen_rotate_enum rotation, mmi_proc_func receiver_proc, void *user_data, U32 flags);

/*****************************************************************************
 * FUNCTION
 *  mmi_display_popupcallback_rotated_with_sg_ext
 * DESCRIPTION
 *  1. [NOTICE!] Popupcallback screen will close itself after send event to caller.
 *  2. [NOTICE!] If caller group is not active, The API will return directly and do not show popup.
 *  3. [NOTICE!] If caller call the function in a entry proc, the function will be posted after the entry proc\
 *               When Gobackhistory. So caller must use global buffer to save the string in the case.
 *  4. It will sent EVT_ID_POPUP_QUIT to the parent_id's proc when popupcallback screen disappeared.
 *  5. It will sent mmi_popupcallback_result_enum as extra info in the event if caller want to know the exit state.
 *  6. This pop-up screen will not be added into history.
 *  7. EntryIdle screen if Pressing END KEY.
 * PARAMETERS
 *  parent_id       : [IN](N/A)     Caller group ID.
 *  string          : [IN](POPUP)   Char array of string
 *  event_id        : [IN](N/A)		  Display popup event type
 *  rotation        : [IN](N/A)     Rotated degree
 *  user_tag        : [IN](N/A)     caller tag for multi instance by parent group 
 *  flags           : [IN](N/A)     Popup behaviors customize.(please set 0 in default)
 * RETURNS
 *  MMI_BOOL        : [OUT]         Show popup screen or not;
 *****************************************************************************/
extern MMI_BOOL mmi_display_popupcallback_rotated_with_sg_ext(mmi_id parent_id, UI_string_type string, mmi_event_notify_enum event_id, mmi_frm_screen_rotate_enum rotation, void *user_tag, U32 flags);
#endif /* __MMI_SCREEN_ROTATE__ */

/*****************************************************************************
 * FUNCTION
 *  mmi_display_popupcallback_with_sg_ext
 * DESCRIPTION
 *  1. [NOTICE!] Popupcallback screen will close itself after send event to caller.
 *  2. [NOTICE!] If caller group is not active, The API will return directly and do not show popup.
 *  3. [NOTICE!] If caller call the function in a entry proc, the function will be posted after the entry proc\
 *               When Gobackhistory. So caller must use global buffer to save the string in the case.
 *  4. It will sent EVT_ID_POPUP_QUIT to the parent_id's proc when popupcallback screen disappeared.
 *  5. It will sent mmi_popupcallback_result_enum as extra info in the event if caller want to know the exit state.
 *  6. This pop-up screen will not be added into history.
 *  7. EntryIdle screen if Pressing END KEY.
 * PARAMETERS
 *  parent_id       : [IN](N/A)     Caller group ID.
 *  string          : [IN](POPUP)   Char array of string
 *  event_id        : [IN](N/A)		  Display popup event type
 *  user_tag        : [IN](N/A)     caller tag for multi instance by parent group 
 *  flags           : [IN](N/A)     Popup behaviors customize.(please set 0 in default)
 * RETURNS
 *  MMI_BOOL        : [OUT]         Show popup screen or not;
 *****************************************************************************/
extern MMI_BOOL mmi_display_popupcallback_with_sg_ext(mmi_id parent_id, UI_string_type string, mmi_event_notify_enum event_id, void *user_tag, U32 flags);


/*****************************************************************************
 * FUNCTION
 *  mmi_display_popup_confirm_with_sg
 * DESCRIPTION
 *  1. [NOTICE!] Display common confirm screen with screen group.
 *  2. [NOTICE!] If caller group is not active, The API will return FALSE and do not show confirm screen.
 *  3. [NOTICE!] If caller call the function in a entry proc, the function will return FALSE and do not show confirm screen.
 *                 Caller need use showcategory163screen to handle the case by themself.
 *  4. This pop confirm screen will not be added into history.
 * PARAMETERS
 *  parent_id               : [IN](N/A)                 Caller group ID
 *  left_softkey            : [IN](LSK)        			Left softkey label
 *  left_softkey_icon       : [IN](N/A)        			Icon for the Left softkey
 *  right_softkey           : [IN](RSK)        			Right softkey label
 *  right_softkey_icon      : [IN](N/A)        			Icon for the right softkey
 *  message                 : [IN](POPUPCONFIRM)        message string
 *  even_id                 : [IN](N/A)        			Popup event type
 *  flags                   : [IN](N/A)                 reserved(please set 0 in default).
 * RETURNS
 *  MMI_BOOL                : [OUT]                     show screen or not
 *****************************************************************************/
extern MMI_BOOL mmi_display_popup_confirm_with_sg(mmi_id parent_id, UI_string_type left_softkey, PU8 left_softkey_icon, UI_string_type right_softkey, PU8 right_softkey_icon, UI_string_type message,
                    mmi_event_notify_enum event_id, U32 flags);

/*****************************************************************************
 * FUNCTION
 *  mmi_display_popup_confirmext_with_sg
 * DESCRIPTION
 *  1. [NOTICE!] Display common confirm screen with screen group.
 *  2. [NOTICE!] If caller group is not active, The API will return FALSE and do not show confirm screen.
 *  3. [NOTICE!] If caller call the function in a entry proc, the function will return FALSE and do not show confirm screen.
 *                 Caller need use showcategory163screen to handle the case by themself.
 *  4. This pop confirm screen will not be added into history.
 * PARAMETERS
 *  parent_id               : [IN](N/A)                 Caller group ID
 *  left_softkey            : [IN](LSK)        			Left softkey label
 *  left_softkey_icon       : [IN](N/A)        			Icon for the Left softkey
 *  right_softkey           : [IN](RSK)        			Right softkey label
 *  right_softkey_icon      : [IN](N/A)        			Icon for the right softkey
 *	CSK_str				    : [IN](CSK)				    Center softkey label
 *	CSK_img					: [IN](N/A)				    Center sofktey icon  
 *  message                 : [IN](POPUPCONFIRM)        message string
 *  even_id                 : [IN](N/A)        			Popup event type
 *  flags                   : [IN](N/A)                 reserved(please set 0 in default).
 * RETURNS
 *  MMI_BOOL                : [OUT]                     show screen or not
 *****************************************************************************/
extern MMI_BOOL mmi_display_popup_confirmext_with_sg(mmi_id parent_id, UI_string_type left_softkey, PU8 left_softkey_icon, UI_string_type right_softkey, PU8 right_softkey_icon, 
    U16 CSK_str, U16 CSK_img, UI_string_type message, mmi_event_notify_enum event_id, U32 flags);
    
#ifdef __MMI_SCREEN_ROTATE__

/*****************************************************************************
 * FUNCTION
 *  mmi_display_popup_rotated_with_sg
 * DESCRIPTION
 *  1. [NOTICE!] If caller group is not active, The API will return directly and do not show popup.
 *  2. [NOTICE!] If caller call the function in a entry proc, the function will be posted after the entry proc\
 *               When Gobackhistory. So caller must use global buffer to save the string in the case.
 *  3. This pop-up screen will not be added into history.
 *  4. It will close popup screen when user press any key or timer expired.
 *  5. Don't send quit event to caller.
 *  6. EntryIdle screen if Pressing END KEY.
 * PARAMETERS
 *  parent_id       : [IN](N/A)     caller group ID.
 *  string          : [IN](POPUP)    Char array of string
 *  event_id        : [IN](N/A)		   Display popup event type
 * RETURNS
 *  MMI_BOOL        : [OUT](N/A)       show screen or not
 *****************************************************************************/
extern MMI_BOOL mmi_display_popup_rotated_with_sg(mmi_id parent_id, UI_string_type string, mmi_event_notify_enum event_id, mmi_frm_screen_rotate_enum rotation, U32 flags);


/*****************************************************************************
 * FUNCTION
 *  mmi_display_popup_confirm_rotated_with_sg
 * DESCRIPTION
 *  1. [NOTICE!] Display common rotated confirm screen with screen group.
 *  2. [NOTICE!] If caller group is not active, The API will return directly and do not show confirm screen.
 *  3. [NOTICE!] If caller call the function in a entry proc, the function will return directly and do not show confirm screen.
 *                Caller need use showcategory163screen to handle the case by themself.
 *  4. This pop confirm screen will not be added into history.
 * PARAMETERS
 *  parent_id               : [IN](N/A)                 Caller group ID
 *  left_softkey            : [IN](LSK)        			Left softkey label
 *  left_softkey_icon       : [IN](N/A)        			Icon for the Left softkey
 *  right_softkey           : [IN](RSK)        			Right softkey label
 *  right_softkey_icon      : [IN](N/A)        			Icon for the right softkey
 *  message                 : [IN](POPUPCONFIRM)        message string
 *  even_id                 : [IN](N/A)        			Popup event type
 *  rotation                : [IN](N/A)                 Screen rotation degree
 *  flags                   : [IN](N/A)                 reserved(please set 0 in default).
 * RETURNS
 *  MMI_BOOL                : [OUT](N/A)                show screen or not
 *****************************************************************************/
extern MMI_BOOL mmi_display_popup_confirm_rotated_with_sg(mmi_id parent_id, UI_string_type left_softkey, PU8 left_softkey_icon, UI_string_type right_softkey, PU8 right_softkey_icon, UI_string_type message,
                    mmi_event_notify_enum event_id,mmi_frm_screen_rotate_enum rotation, U32 flags);
                    
/*****************************************************************************
 * FUNCTION
 *  mmi_display_popup_confirmext_rotated_with_sg
 * DESCRIPTION
 *  1. [NOTICE!] Display common rotated confirm screen with screen group.
 *  2. [NOTICE!] If caller group is not active, The API will return directly and do not show confirm screen.
 *  3. [NOTICE!] If caller call the function in a entry proc, the function will return directly and do not show confirm screen.
 *                Caller need use showcategory163screen to handle the case by themself.
 *  4. This pop confirm screen will not be added into history.
 * PARAMETERS
 *  parent_id               : [IN](N/A)                 Caller group ID
 *  left_softkey            : [IN](LSK)        			Left softkey label
 *  left_softkey_icon       : [IN](N/A)        			Icon for the Left softkey
 *  right_softkey           : [IN](RSK)        			Right softkey label
 *  right_softkey_icon      : [IN](N/A)        			Icon for the right softkey
 *	CSK_str				    : [IN](CSK)				    Center softkey label
 *	CSK_img					: [IN](N/A)				    Center sofktey icon  
 *  message                 : [IN](POPUPCONFIRM)        message string
 *  even_id                 : [IN](N/A)        			Popup event type
 *  rotation                : [IN](N/A)                 Screen rotation degree
 *  flags                   : [IN](N/A)                 reserved(please set 0 in default).
 * RETURNS
 *  MMI_BOOL                : [OUT](N/A)                show screen or not
 *****************************************************************************/
extern MMI_BOOL mmi_display_popup_confirmext_rotated_with_sg(mmi_id parent_id, UI_string_type left_softkey, PU8 left_softkey_icon, UI_string_type right_softkey, PU8 right_softkey_icon, U16 CSK_str, U16 CSK_img, UI_string_type message,
                           mmi_event_notify_enum event_id, mmi_frm_screen_rotate_enum rotation, U32 flags);                
#endif /* __MMI_SCREEN_ROTATE__ */

/******************************** End - Common Popup with SG ******************************************/


/*****************************************************************************
 * FUNCTION
 *  DisplayPopup
 * DESCRIPTION
 *  Displays the common pop-up screen used across all applications.
 *  This pop-up screen will not be added into history.
 *  It will GoBackHistory only when user press any key or timer expired.
 *  The function is suggested to be replaced by mmi_display_popup.
 * PARAMETERS
 *  string          : [IN](POPUP)    	Char array of string
 *  imageId         : [IN](N/A)    		Image ID
 *  imageOnBottom   : [IN](N/A)    		Reserved
 *  popupDuration   : [IN](N/A)    		Duration of the pop-up
 *  toneId          : [IN](N/A)    		Tone ID
 * RETURNS
 *  void
 *****************************************************************************/
    extern void DisplayPopup(U8 *string, U16 imageId, U8 imageOnBottom, U32 popupDuration, U8 toneId);

#ifdef __MMI_SCREEN_ROTATE__
/*****************************************************************************
 * FUNCTION
 *  DisplayPopupRotated
 * DESCRIPTION
 *  Displays the common pop-up rotated screen used across all applications.
 *  This pop-up screen will not be added into history.
 *  It will GoBackHistory only when user press any key or timer expired.
 *  The function is suggested to be replaced by mmi_display_popup_rotated.
 * PARAMETERS
 *  string          : [IN](POPUP)    	Char array of string
 *  imageId         : [IN](N/A)    		Image ID
 *  imageOnBottom   : [IN](N/A)    		Reserved
 *  popupDuration   : [IN](N/A)    		Duration of the pop-up
 *  toneId          : [IN](N/A)    		Tone ID
 *  rotation        :	[IN](N/A)		    Rotation
 * RETURNS
 *  void
 *****************************************************************************/
    extern void DisplayPopupRotated(
                    U8 *string,
                    U16 imageId,
                    U8 imageOnBottom,
                    U32 popupDuration,
                    U8 toneId,
                    mmi_frm_screen_rotate_enum rotation);
#endif /* __MMI_SCREEN_ROTATE__ */ 

/* DOM-NOT_FOR_SDK-BEGIN */ 
    extern void ExitDisplayPopup(void);
/* DOM-NOT_FOR_SDK-END */
/*****************************************************************************
 * FUNCTION
 *  DisplayPopupCallBack
 * DESCRIPTION
 *  Displays the comon pop-up screen used across all applications.
 *  This pop-up screen will not be added into history.
 *  It will call callback only when timer expired.
 *  This pop-up will not GoBackHistory, and applications have to handle the screen by themselves
 *	The function is suggested to be replaced by mmi_display_popupcallback.
 * PARAMETERS
 *  string          : [IN](POPUP)    	Char array of string
 *  imageId         : [IN](N/A)    		Image ID
 *  imageOnBottom   : [IN](N/A)    		Reserved
 *  popupDuration   : [IN](N/A)    		Duration of the pop-up
 *  toneId          : [IN](N/A)    		Tone ID
 *  f               : [IN](N/A)		    Callback function pointer
 * RETURNS
 *  void
 *****************************************************************************/
    extern void DisplayPopupCallBack(
                    U8 *string,
                    U16 imageId,
                    U8 imageOnBottom,
                    U32 popupDuration,
                    U8 toneId,
                    FuncPtr f);

/*****************************************************************************
 * FUNCTION
 *  DisplayPopupCallBackExt
 * DESCRIPTION
 * This pop-up screen will not be added into history.
 * This pop-up will not GoBackHistory, and applications have to handle the next screen by themselves using callback f.
 * It will call callback f only when timer expired.
 * If there any new incoming event, we will not call f.
 * InterrCallBack function will be call when exit the popup screen only by interrupt.
 * It's a strict rule that exitcallback can't handle screen ;InterrCallBack  only handle low_cost event for App.
 * The function is suggested to be replaced by mmi_display_popupcallback_ext.
 * PARAMETERS
 *  string          : [IN](POPUP)    	Char array of string
 *  imageId         : [IN](N/A)    		Image ID
 *  imageOnBottom   : [IN](N/A)    		Reserved
 *  popupDuration   : [IN](N/A)    		Duration of the pop-up
 *  toneId          : [IN](N/A)    		Tone ID
 *  f               : [IN](N/A)    		Callback function pointer when timer expired
 *  InterrCallBack  : [IN](N/A)   		Callback function pointer when interrupted.
 * RETURNS
 *  void
 *****************************************************************************/
    extern void DisplayPopupCallBackExt(
                    U8 *string,
                    U16 imageId,
                    U8 imageOnBottom,
                    U32 popupDuration,
                    U8 toneId, 
                    FuncPtr f, 
                    FuncPtr InterrCallBack);
#ifdef __MMI_SCREEN_ROTATE__
/*****************************************************************************
 * FUNCTION
 *  DisplayPopupCallBackRotated
 * DESCRIPTION
 *  Displays the common pop-up rotated screen used across all applications.
 *  This pop-up screen will not be added into history.
 *  It will call callback only when timer expired.
 *  This pop-up will not GoBackHistory, and applications have to handle the screen by themselves
 *	The function is suggested to be replaced by mmi_display_popupcallback_rotated.
 * PARAMETERS
 *  string          : [IN](POPUP)    	Char array of string
 *  imageId         : [IN](N/A)    		Image ID
 *  imageOnBottom   : [IN](N/A)    		Reserved
 *  popupDuration   : [IN](N/A)    		Duration of the pop-up
 *  toneId          : [IN](N/A)    		Tone ID
 *  f               : [IN](N/A)		    Callback function pointer
 *  rotation				:	[IN](N/A)				Popup rotated degree.
 * RETURNS
 *  void
 *****************************************************************************/
    extern void DisplayPopupCallBackRotated(
                    U8 *string, 
                    U16 imageId, 
                    U8 imageOnBottom, 
                    U32 popupDuration, 
                    U8 toneId, 
                    FuncPtr f,
                    mmi_frm_screen_rotate_enum rotation);
#endif /*__MMI_SCREEN_ROTATE__*/

/* DOM-NOT_FOR_SDK-BEGIN */ 

#if !defined(__MTK_TARGET__)
    extern void PopupNoSupport(void);
#endif 
/* DOM-NOT_FOR_SDK-END */

/*****************************************************************************
 * FUNCTION
 *  DisplayConfirm
 * DESCRIPTION
 *  Display Popup Confirm Screen
 *	The function is suggested to be replaced by mmi_display_popup_confirm.
 * PARAMETERS
 *  LSK_str             : [IN](LSK)  					Left softkey label      
 *  LSK_img             : [IN](N/A)        		Icon for the Left softkey
 *  RSK_str             : [IN](RSK)       		Right softkey label 
 *  RSK_img             : [IN](N/A)						Icon for the right softkey        
 *  message             : [IN](POPUPCONFIRM)  Message string     
 *  message_image       : [IN](N/A)  					Popup icon      
 *  toneId              : [IN](N/A)     			Tone Id.	         
 * RETURNS
 *  void
 *****************************************************************************/
    extern void DisplayConfirm(
                    U16 LSK_str,
                    U16 LSK_img,
                    U16 RSK_str,
                    U16 RSK_img,
                    UI_string_type message,
                    MMI_ID_TYPE message_image,
                    U8 toneId);

/*****************************************************************************
 * FUNCTION
 *  DisplayConfirmExt
 * DESCRIPTION
 *  Display Popup Confirm Screen with center softkey.
 *	The function is suggested to be replaced by mmi_display_popup_confirmext.
 * PARAMETERS
 *  LSK_str             : [IN](LSK)  					Left softkey label      
 *  LSK_img             : [IN](N/A)        		Icon for the Left softkey
 *  RSK_str             : [IN](RSK)       		Right softkey label 
 *  RSK_img             : [IN](N/A)						Icon for the right softkey
 *	CSK_str							:	[IN](N/A)						Center softkey label
 *	CSK_img							:	[IN](N/A)						Center sofktey icon    
 *  message             : [IN](POPUPCONFIRM)  Message string     
 *  message_image       : [IN](N/A)  					Popup icon      
 *  toneId              : [IN](N/A)     			Tone Id.	         
 * RETURNS
 *  void
 *****************************************************************************/
    extern void DisplayConfirmExt(
                    U16 LSK_str,
                    U16 LSK_img,
                    U16 RSK_str,
                    U16 RSK_img,
                    U16 CSK_str,
                    U16 CSK_img,
                    UI_string_type message,
                    MMI_ID_TYPE message_image,
                    U8 toneId);
#ifdef __MMI_SCREEN_ROTATE__
/*****************************************************************************
 * FUNCTION
 *  DisplayConfirmRotated
 * DESCRIPTION
 *  Display popup confirm rotated screen.
 *	The function is suggested to be replaced by mmi_display_popup_confirm_rotated.
 * PARAMETERS
 *  LSK_str             : [IN](LSK)  					Left softkey label      
 *  LSK_img             : [IN](N/A)        		Icon for the Left softkey
 *  RSK_str             : [IN](RSK)       		Right softkey label 
 *  RSK_img             : [IN](N/A)						Icon for the right softkey  
 *  message             : [IN](POPUPCONFIRM)  Message string     
 *  message_image       : [IN](N/A)  					Popup icon      
 *  toneId              : [IN](N/A)     			Tone Id.
 *	rotation						:	[IN](N/A)						rotated degree        
 * RETURNS
 *  void
 *****************************************************************************/
    extern void DisplayConfirmRotated(
                    U16 LSK_str,
                    U16 LSK_img,
                    U16 RSK_str,
                    U16 RSK_img,
                    UI_string_type message,
                    MMI_ID_TYPE message_image,
                    U8 toneId,
                    mmi_frm_screen_rotate_enum rotation);
                    
/*****************************************************************************
 * FUNCTION
 *  DisplayConfirmRotatedExt
 * DESCRIPTION
 *  Display Popup Confirm rotated Screen with center softkey.
 *	The function is suggested to be replaced by mmi_display_popup_confirmext_rotated.
 * PARAMETERS
 *  LSK_str             : [IN](LSK)  					Left softkey label      
 *  LSK_img             : [IN](N/A)        		Icon for the Left softkey
 *  RSK_str             : [IN](RSK)       		Right softkey label 
 *  RSK_img             : [IN](N/A)						Icon for the right softkey
 *	CSK_str							:	[IN](N/A)						Center softkey label
 *	CSK_img							:	[IN](N/A)						Center sofktey icon    
 *  message             : [IN](POPUPCONFIRM)  Message string     
 *  message_image       : [IN](N/A)  					Popup icon      
 *  toneId              : [IN](N/A)     			Tone Id.
 *	rotation						:	[IN](N/A)						Rotated degree.       
 * RETURNS
 *  void
 *****************************************************************************/
    extern void DisplayConfirmRotatedExt(
                    U16 LSK_str,
                    U16 LSK_img,
                    U16 RSK_str,
                    U16 RSK_img,
                    U16 CSK_str,
                    U16 CSK_img,
                    UI_string_type message,
                    MMI_ID_TYPE message_image,
                    U8 toneId,
                    mmi_frm_screen_rotate_enum rotation);
#endif /* __MMI_SCREEN_ROTATE__ */ 
 
/*****************************************************************************
 * FUNCTION
 *  DisplayConfirmCountDown
 * DESCRIPTION
 *  Display Popup Confirm count down screen.
 * PARAMETERS
 *  LSK_str             : [IN](LSK)  					Left softkey label      
 *  LSK_img             : [IN](N/A)        		Icon for the Left softkey
 *  RSK_str             : [IN](RSK)       		Right softkey label 
 *  RSK_img             : [IN](N/A)						Icon for the right softkey  
 *  message             : [IN](POPUPCONFIRM)  Message string     
 *  message_image       : [IN](N/A)  					Popup icon      
 *  toneId              : [IN](N/A)     			Tone Id
 *	duration						:	[IN](N/A)						Duration number
 *	callback						:	[IN](N/A)						Count down callback.     
 * RETURNS
 *  void
 *****************************************************************************/
    extern void DisplayConfirmCountDown(
                    U16 LSK_str,
                    U16 LSK_img,
                    U16 RSK_str,
                    U16 RSK_img,
                    UI_string_type message,
                    MMI_ID_TYPE message_image,
                    U8 toneId,
                    U32 duration,
                    FuncPtr callback);
/* DOM-NOT_FOR_SDK-BEGIN */ 
    extern void ExitDisplayPopupConfirm(void);
/* DOM-NOT_FOR_SDK-END */ 
    extern void mmi_frm_set_highlight_handler(void);

/*****************************************************************************
 * FUNCTION
 *  DisplaySubLcdPopup
 * DESCRIPTION
 *  Display SubLcd Popup screen
 * PARAMETERS
 *  imageId     : [IN](N/A)   popup image     
 * RETURNS
 *  void
 *****************************************************************************/
    extern void DisplaySubLcdPopup(U16 imageId);

/*****************************************************************************
 * FUNCTION
 *  SetInterruptPopupDisplay
 * DESCRIPTION
 *  Set Interrupt popup screen is allowed to display or not.
 * PARAMETERS
 *  flag        [IN]        can be POPUP_ALL_OFF, POPUP_DSPL_ON, POPUP_TONE_ON
 * RETURNS
 *  void
 *****************************************************************************/
    extern void SetInterruptPopupDisplay(U8 flag);
    
/*****************************************************************************
 * FUNCTION
 *  GetInterruptPopupDisplay
 * DESCRIPTION
 *  Get if the interrupt popup screen is allowed to display or not.
 * PARAMETERS
 *  void
 * RETURNS
 *  U8 : can be POPUP_ALL_OFF, POPUP_DSPL_ON, POPUP_TONE_ON
 *****************************************************************************/
    extern U8 GetInterruptPopupDisplay(void);

    typedef struct cascading_menu_item
    {
        U8  flag;
        U8* list_text;
        U8* list_icon;
        U32 menu_id;
        U32 no_of_submenus;
        struct cascading_menu_item *psub;
    }cascading_menu_item_struct;
    /* Cascading Menu */    
    typedef MMI_BOOL (*CascadingMenuCmdHdlrFuncPtr)(U16 menu_id);
    typedef MMI_BOOL (*CascadingMenubydataCmdHdlrFuncPtr)(U32 menu_id);
    typedef void (*CascadingMenubydataHLHdlrFuncPtr)(U32 menu_id);
	#if defined(__MMI_CASCADED_OPTION_MENU__)
    extern void DisplayCascadingMenu(U16 cascading_menu_id, CascadingMenuCmdHdlrFuncPtr command_handler);
	#else
	#define DisplayCascadingMenu(cascading_menu_id, command_handler)
	#endif
    extern void DisplayCascadingMenuByData(S32 n_items, cascading_menu_item_struct *list_of_item,
                                CascadingMenubydataCmdHdlrFuncPtr command_handler,
                                CascadingMenubydataHLHdlrFuncPtr highlight_handler);
    extern void ChangeCascadingMenuByDataIcon(U32 menu_id, PU8 img);
    extern void ChangeCascadingMenuByDataNIcon(U32 n, U32* menu_id, PU8 *img);
    extern void CloseCascadingMenu(void);

    extern void mmi_cascading_register_rsk_handler(FuncPtr handler);

#ifdef __MMI_CASCADE_MENU__    
    extern void mmi_cascade_menu_test(void);
#endif /* __MMI_CASCADE_MENU__ */

#ifdef __MMI_CLIPBOARD__
    extern void EntryClipboardOptionScreen(void);
    extern void ExitClipboardOptionScreen(void);
    extern void EntryClipboardLocateCursorScreen(void);
    extern void EntryClipboardCopy(void);
    extern void EntryClipboardCut(void);
    extern void EntryClipboardCopyAll(void);
    extern void EntryClipboardCutAll(void);
    extern void EntryClipboardPaste(void);

/*****************************************************************************
 * FUNCTION
 *  mmi_ime_clipboard_entry_option_screen_with_sg
 * DESCRIPTION
 *  Entry fn for clipboard option menu with group ID
 * PARAMETERS
 *  g_id            [IN]        group ID
 * RETURNS
 *  void
 *****************************************************************************/
extern void mmi_ime_clipboard_entry_option_screen_with_sg(mmi_id g_id);

#endif /* __MMI_CLIPBOARD__ */

    extern U16 mmi_ime_gen_editor_common_scr_id(U16 scr_id);
    extern void mmi_ime_delete_editor_common_scr(U16 scr_id);
    extern void mmi_ime_delete_editor_common_scr_with_sg(U16 g_id, U16 scr_id);
    extern MMI_BOOL mmi_ime_is_editor_common_scr(U16 scr_id);

    typedef void (*mmi_ime_common_scr_entry_exit_callback)(U16 old_scr_id,U16 new_scr_id);
    
    extern void mmi_ime_register_editor_common_scr_entry_callback(mmi_ime_common_scr_entry_exit_callback entery_functpr);
    
    extern void mmi_ime_register_editor_common_scr_exit_callback(mmi_ime_common_scr_entry_exit_callback exit_functpr);


#ifdef __MMI_PREFER_INPUT_METHOD__

extern void mmi_imesettings_init_prefered_inputmethod(void);
extern void mmi_imesettings_highlight_inputmethodsettings(void);
extern void mmi_imesettings_enter_screen_prefered_inputmethod(void);
extern void mmi_imesettings_highlight_current_inputmethod(S32 index);
extern void mmi_imesettings_select_inputmethod_handler(void);
extern void mmi_imesettings_exit_inputmethod_screen(void);
extern void mmi_imesettings_set_inputmethod_type(U16 inputType);

#endif /* __MMI_PREFER_INPUT_METHOD__ */ 

#if defined (__MMI_MIXED_LANG_SUPPORT__) || defined (__MMI_PREFER_WRITING_LANG__) || defined  (__MMI_PREFER_INPUT_METHOD__) || defined (__MMI_IME_PLUG_IN_SETTING__)
/*****************************************************************************
 * FUNCTION
 *  mmi_imesettings_menu_handler
 * DESCRIPTION
 *  Phonesettings event handler for Mixed,prefered langauge and prefered input mode
 * PARAMETERS
 *  cui_menu_event_struct       [IN]    event structure        
 *  MMI_ID        [IN]       parent id 
 * RETURNS
 *  mmi_ret
 *****************************************************************************/
extern mmi_ret mmi_imesettings_menu_handler(cui_menu_event_struct *evt, MMI_ID parent_gid);
#endif

#ifdef __TOPWELL_MMI_LANGUAGE_METHOD_FIX__
mmi_ret mmi_phnset_language_and_method_fix_menu_handler(cui_menu_event_struct *param, MMI_ID parent_gid);
#endif

#if defined (__MMI_IME_V3__)
extern mmi_ret mmi_imesettings_menu_handler_ext(cui_menu_event_struct *evt, MMI_ID parent_gid);
#endif



#ifdef __cplusplus
}
#endif 

#endif /* __COMMONSCREENS_H__ */