aboutsummaryrefslogtreecommitdiffstats
path: root/src/lib/ecore_imf/Ecore_IMF.h
blob: 16153748728380925efc9deb38abea0c2302a66b (plain) (blame)
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
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
#ifndef _ECORE_IMF_H
#define _ECORE_IMF_H

#include <Eina.h>

#ifdef EAPI
# undef EAPI
#endif

#ifdef _WIN32
# ifdef EFL_ECORE_IMF_BUILD
#  ifdef DLL_EXPORT
#   define EAPI __declspec(dllexport)
#  else
#   define EAPI
#  endif /* ! DLL_EXPORT */
# else
#  define EAPI __declspec(dllimport)
# endif /* ! EFL_ECORE_IMF_BUILD */
#else
# ifdef __GNUC__
#  if __GNUC__ >= 4
#   define EAPI __attribute__ ((visibility("default")))
#  else
#   define EAPI
#  endif
# else
#  define EAPI
# endif
#endif /* ! _WIN32 */

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @internal
 * @defgroup Ecore_IMF_Group Ecore_IMF - Ecore Input Method Library Functions
 * @ingroup Ecore_Group
 *
 * Utility functions that set up and shut down the Ecore Input Method
 * library.
 *
 * @{
 */

/**
 * @internal
 * @defgroup Ecore_IMF_Context_Group Ecore Input Method Context Functions
 * @ingroup Ecore_IMF_Group
 *
 * @brief This group discusses the functions that operate on Ecore Input Method Context objects.

 * @remarks Ecore Input Method Context Function defines the interface for EFL input methods.
 *          An input method is used by EFL text input widgets like elm_entry
 *          (based on edje_entry) to map from key events to Unicode character strings.
 *
 * @remarks The default input method can be set through setting the ECORE_IMF_MODULE environment variable.
 *          eg: export ECORE_IMF_MODULE=xim (or scim or ibus)
 *
 * @remarks An input method may consume multiple key events in sequence and finally give the composed result as output.
 *          This is called preediting, and an input method may provide feedback about
 *          this process by displaying the intermediate composition states as preedit text.
 *
 * @remarks Immodule is a plugin to connect your application and input method framework such as SCIM, ibus, and so on. \n
 *          ecore_imf_init() should be called to initialize and load immodule. \n
 *          ecore_imf_shutdown() is used to shutdown and unload immodule.
 *
 * @{
 */

/**
 * @brief Enumeration of Ecore IMF Input Panel State type
 * @see ecore_imf_context_input_panel_event_callback_add
 */
typedef enum
{
   ECORE_IMF_INPUT_PANEL_STATE_EVENT,              /**< Called when the state of the input panel is changed @since 1.7 */
   ECORE_IMF_INPUT_PANEL_LANGUAGE_EVENT,           /**< Called when the language of the input panel is changed @since 1.7 */
   ECORE_IMF_INPUT_PANEL_SHIFT_MODE_EVENT,         /**< Called when the shift key state of the input panel is changed @since 1.7 */
   ECORE_IMF_INPUT_PANEL_GEOMETRY_EVENT,           /**< Called when the size of the input panel is changed @since 1.7 */
   ECORE_IMF_CANDIDATE_PANEL_STATE_EVENT,          /**< Called when the state of the candidate word panel is changed @since 1.7 */
   ECORE_IMF_CANDIDATE_PANEL_GEOMETRY_EVENT        /**< Called when the size of the candidate word panel is changed @since 1.7 */
} Ecore_IMF_Input_Panel_Event;

/**
 * @brief Enumeration of Ecore IMF Input Panel State type
 */
typedef enum
{
   ECORE_IMF_INPUT_PANEL_STATE_SHOW,        /**< Notification after the display of the input panel @since 1.7 */
   ECORE_IMF_INPUT_PANEL_STATE_HIDE,        /**< Notification prior to the dismissal of the input panel @since 1.7 */
   ECORE_IMF_INPUT_PANEL_STATE_WILL_SHOW    /**< Notification prior to the display of the input panel @since 1.7 */
} Ecore_IMF_Input_Panel_State;

/**
 * @brief Enumeration of Ecore IMF Input Panel Shift Mode type
 */
typedef enum
{
    ECORE_IMF_INPUT_PANEL_SHIFT_MODE_OFF, /**< @since 1.7 */
    ECORE_IMF_INPUT_PANEL_SHIFT_MODE_ON   /**< @since 1.7 */
} Ecore_IMF_Input_Panel_Shift_Mode;

/**
 * @brief Enumeration of Ecore IMF Candidate Panel type
 */
typedef enum
{
   ECORE_IMF_CANDIDATE_PANEL_SHOW,        /**< Notification after the display of the candidate word panel @since 1.7 */
   ECORE_IMF_CANDIDATE_PANEL_HIDE         /**< Notification prior to the dismissal of the candidate word panel @since 1.7 */
} Ecore_IMF_Candidate_Panel_State;

/* Events sent by the Input Method */
typedef struct _Ecore_IMF_Event_Preedit_Start      Ecore_IMF_Event_Preedit_Start;
typedef struct _Ecore_IMF_Event_Preedit_End        Ecore_IMF_Event_Preedit_End;
typedef struct _Ecore_IMF_Event_Preedit_Changed    Ecore_IMF_Event_Preedit_Changed;
typedef struct _Ecore_IMF_Event_Commit             Ecore_IMF_Event_Commit;
typedef struct _Ecore_IMF_Event_Delete_Surrounding Ecore_IMF_Event_Delete_Surrounding;
typedef struct _Ecore_IMF_Event_Selection          Ecore_IMF_Event_Selection;

/* Events to the filter */
typedef struct _Ecore_IMF_Event_Mouse_Down         Ecore_IMF_Event_Mouse_Down;
typedef struct _Ecore_IMF_Event_Mouse_Up           Ecore_IMF_Event_Mouse_Up;
typedef struct _Ecore_IMF_Event_Mouse_In           Ecore_IMF_Event_Mouse_In;
typedef struct _Ecore_IMF_Event_Mouse_Out          Ecore_IMF_Event_Mouse_Out;
typedef struct _Ecore_IMF_Event_Mouse_Move         Ecore_IMF_Event_Mouse_Move;
typedef struct _Ecore_IMF_Event_Mouse_Wheel        Ecore_IMF_Event_Mouse_Wheel;
typedef struct _Ecore_IMF_Event_Key_Down           Ecore_IMF_Event_Key_Down;
typedef struct _Ecore_IMF_Event_Key_Up             Ecore_IMF_Event_Key_Up;
typedef union  _Ecore_IMF_Event                    Ecore_IMF_Event;

typedef struct _Ecore_IMF_Context                  Ecore_IMF_Context;                  /**< An Input Method Context */
typedef struct _Ecore_IMF_Context_Class            Ecore_IMF_Context_Class;            /**< An Input Method Context class */
typedef struct _Ecore_IMF_Context_Info             Ecore_IMF_Context_Info;             /**< Input Method Context info */

/* Preedit attribute info */
typedef struct _Ecore_IMF_Preedit_Attr             Ecore_IMF_Preedit_Attr;

EAPI extern int ECORE_IMF_EVENT_PREEDIT_START;
EAPI extern int ECORE_IMF_EVENT_PREEDIT_END;
EAPI extern int ECORE_IMF_EVENT_PREEDIT_CHANGED;
EAPI extern int ECORE_IMF_EVENT_COMMIT;
EAPI extern int ECORE_IMF_EVENT_DELETE_SURROUNDING;

typedef void (*Ecore_IMF_Event_Cb) (void *data, Ecore_IMF_Context *ctx, void *event_info);

/**
 * @typedef Ecore_IMF_Callback_Type
 *
 * @brief Enumeration that defines the Ecore IMF Event callback types.
 *
 * @see ecore_imf_context_event_callback_add()
 */
typedef enum
{
   ECORE_IMF_CALLBACK_PREEDIT_START,      /**< "PREEDIT_START" is called when a new preediting sequence starts @since 1.2 */
   ECORE_IMF_CALLBACK_PREEDIT_END,        /**< "PREEDIT_END" is called when a preediting sequence has been completed or cancelled @since 1.2 */
   ECORE_IMF_CALLBACK_PREEDIT_CHANGED,    /**< "PREEDIT_CHANGED" is called whenever the preedit sequence currently being entered has changed @since 1.2 */
   ECORE_IMF_CALLBACK_COMMIT,             /**< "COMMIT" is called when a complete input sequence has been entered by the user @since 1.2 */
   ECORE_IMF_CALLBACK_DELETE_SURROUNDING, /**< "DELETE_SURROUNDING" is called when the input method needs to delete all or part of the context surrounding the cursor @since 1.2 */
   ECORE_IMF_CALLBACK_SELECTION_SET,      /**< "SELECTION_SET" is called when the input method needs to set the selection @since 1.9 */
   ECORE_IMF_CALLBACK_PRIVATE_COMMAND_SEND /**< "PRIVATE_COMMAND_SEND" is called when the input method sends a private command @since 1.12 */
} Ecore_IMF_Callback_Type;

/**
 * @typedef Ecore_IMF_Event_Type
 *
 * @brief Enumeration that defines the Ecore IMF event types.
 *
 * @see ecore_imf_context_filter_event()
 */
typedef enum
{
   ECORE_IMF_EVENT_MOUSE_DOWN,  /**< Mouse Down event */
   ECORE_IMF_EVENT_MOUSE_UP,    /**< Mouse Up event */
   ECORE_IMF_EVENT_MOUSE_IN,    /**< Mouse In event */
   ECORE_IMF_EVENT_MOUSE_OUT,   /**< Mouse Out event */
   ECORE_IMF_EVENT_MOUSE_MOVE,  /**< Mouse Move event */
   ECORE_IMF_EVENT_MOUSE_WHEEL, /**< Mouse Wheel event */
   ECORE_IMF_EVENT_KEY_DOWN,    /**< Key Down event */
   ECORE_IMF_EVENT_KEY_UP       /**< Key Up event */
} Ecore_IMF_Event_Type;
/**
 * @typedef Ecore_IMF_Keyboard_Modifiers
 * @brief Enumeration that defines the types of Ecore_IMF keyboard modifiers.
 */
typedef enum
{
   ECORE_IMF_KEYBOARD_MODIFIER_NONE  = 0,      /**< No active modifiers */
   ECORE_IMF_KEYBOARD_MODIFIER_CTRL  = 1 << 0, /**< "Control" is pressed */
   ECORE_IMF_KEYBOARD_MODIFIER_ALT   = 1 << 1, /**< "Alt" is pressed */
   ECORE_IMF_KEYBOARD_MODIFIER_SHIFT = 1 << 2, /**< "Shift" is pressed */
   ECORE_IMF_KEYBOARD_MODIFIER_WIN   = 1 << 3, /**< "Win" (between "Ctrl" and "Alt") is pressed */
   ECORE_IMF_KEYBOARD_MODIFIER_ALTGR = 1 << 4  /**< "AltGr" is pressed @since 1.7 */
} Ecore_IMF_Keyboard_Modifiers;

/**
 * @typedef Ecore_IMF_Keyboard_Locks
 * @brief Enumeration that defines the types of Ecore_IMF keyboard locks.
 */
typedef enum
{
   ECORE_IMF_KEYBOARD_LOCK_NONE      = 0,      /**< No locks are active */
   ECORE_IMF_KEYBOARD_LOCK_NUM       = 1 << 0, /**< "Num" lock is active */
   ECORE_IMF_KEYBOARD_LOCK_CAPS      = 1 << 1, /**< "Caps" lock is active */
   ECORE_IMF_KEYBOARD_LOCK_SCROLL    = 1 << 2  /**< "Scroll" lock is active */
} Ecore_IMF_Keyboard_Locks;

/**
 * @typedef Ecore_IMF_Mouse_Flags
 * @brief Enumeration that defines the types of Ecore_IMF mouse flags.
 */
typedef enum
{
   ECORE_IMF_MOUSE_NONE              = 0,      /**< A single click */
   ECORE_IMF_MOUSE_DOUBLE_CLICK      = 1 << 0, /**< A double click */
   ECORE_IMF_MOUSE_TRIPLE_CLICK      = 1 << 1  /**< A triple click */
} Ecore_IMF_Mouse_Flags;

typedef enum
{
   ECORE_IMF_INPUT_MODE_ALPHA        = 1 << 0,
   ECORE_IMF_INPUT_MODE_NUMERIC      = 1 << 1,
   ECORE_IMF_INPUT_MODE_SPECIAL      = 1 << 2,
   ECORE_IMF_INPUT_MODE_HEXA         = 1 << 3,
   ECORE_IMF_INPUT_MODE_TELE         = 1 << 4,
   ECORE_IMF_INPUT_MODE_FULL         = (ECORE_IMF_INPUT_MODE_ALPHA | ECORE_IMF_INPUT_MODE_NUMERIC | ECORE_IMF_INPUT_MODE_SPECIAL),
   ECORE_IMF_INPUT_MODE_INVISIBLE    = 1 << 29,
   ECORE_IMF_INPUT_MODE_AUTOCAP      = 1 << 30
} Ecore_IMF_Input_Mode;

/**
 * @typedef Ecore_IMF_Preedit_Type
 *
 * @brief Enumeration that defines the Ecore IMF Preedit style types.
 *
 * @see ecore_imf_context_preedit_string_with_attributes_get()
 */
typedef enum
{
   ECORE_IMF_PREEDIT_TYPE_NONE, /**< None style @since 1.1 */
   ECORE_IMF_PREEDIT_TYPE_SUB1, /**< Substring style 1 @since 1.1 */
   ECORE_IMF_PREEDIT_TYPE_SUB2, /**< Substring style 2 @since 1.1 */
   ECORE_IMF_PREEDIT_TYPE_SUB3, /**< Substring style 3 @since 1.1 */
   ECORE_IMF_PREEDIT_TYPE_SUB4, /**< Substring style 4 @since 1.8 */
   ECORE_IMF_PREEDIT_TYPE_SUB5, /**< Substring style 5 @since 1.8 */
   ECORE_IMF_PREEDIT_TYPE_SUB6, /**< Substring style 6 @since 1.8 */
   ECORE_IMF_PREEDIT_TYPE_SUB7  /**< Substring style 7 @since 1.8 */
} Ecore_IMF_Preedit_Type;

/**
 * @typedef Ecore_IMF_Autocapital_Type
 *
 * @brief Enumeration that defines the auto-capitalization types.
 *
 * @see ecore_imf_context_autocapital_type_set()
 */
typedef enum
{
   ECORE_IMF_AUTOCAPITAL_TYPE_NONE,         /**< No auto-capitalization when typing @since 1.1 */
   ECORE_IMF_AUTOCAPITAL_TYPE_WORD,         /**< Auto-capitalize each type word @since 1.1 */
   ECORE_IMF_AUTOCAPITAL_TYPE_SENTENCE,     /**< Auto-capitalize the start of each sentence @since 1.1 */
   ECORE_IMF_AUTOCAPITAL_TYPE_ALLCHARACTER, /**< Auto-capitalize all letters @since 1.1 */
} Ecore_IMF_Autocapital_Type;

/**
 * @typedef Ecore_IMF_Input_Panel_Layout
 *
 * @brief Enumeration that defines the input panel (virtual keyboard) layout types.
 *
 * @see ecore_imf_context_input_panel_layout_set()
 */
typedef enum
{
   ECORE_IMF_INPUT_PANEL_LAYOUT_NORMAL,          /**< Default layout */
   ECORE_IMF_INPUT_PANEL_LAYOUT_NUMBER,          /**< Number layout */
   ECORE_IMF_INPUT_PANEL_LAYOUT_EMAIL,           /**< Email layout */
   ECORE_IMF_INPUT_PANEL_LAYOUT_URL,             /**< URL layout */
   ECORE_IMF_INPUT_PANEL_LAYOUT_PHONENUMBER,     /**< Phone Number layout */
   ECORE_IMF_INPUT_PANEL_LAYOUT_IP,              /**< IP layout */
   ECORE_IMF_INPUT_PANEL_LAYOUT_MONTH,           /**< Month layout */
   ECORE_IMF_INPUT_PANEL_LAYOUT_NUMBERONLY,      /**< Number Only layout */
   ECORE_IMF_INPUT_PANEL_LAYOUT_INVALID,         /**< Never use this */
   ECORE_IMF_INPUT_PANEL_LAYOUT_HEX,             /**< Hexadecimal layout @since 1.2 */
   ECORE_IMF_INPUT_PANEL_LAYOUT_TERMINAL,        /**< Command-line terminal layout including the ESC, Alt, Ctrl key, and so on (no auto-correct, no auto-capitalization) @since 1.2 */
   ECORE_IMF_INPUT_PANEL_LAYOUT_PASSWORD,        /**< Like normal, but no auto-correct, no auto-capitalization, and so on @since 1.2 */
   ECORE_IMF_INPUT_PANEL_LAYOUT_DATETIME,        /**< Date and time layout @since 1.8 */
   ECORE_IMF_INPUT_PANEL_LAYOUT_EMOTICON         /**< Emoticon layout @since 1.10 */
} Ecore_IMF_Input_Panel_Layout;

/**
 * @typedef Ecore_IMF_Input_Panel_Lang
 *
 * @brief Enumeration that defines the input panel (virtual keyboard) language modes.
 *
 * @see ecore_imf_context_input_panel_language_set()
 */
typedef enum
{
   ECORE_IMF_INPUT_PANEL_LANG_AUTOMATIC,    /**< Automatic @since 1.2 */
   ECORE_IMF_INPUT_PANEL_LANG_ALPHABET      /**< Alphabet @since 1.2 */
} Ecore_IMF_Input_Panel_Lang;

/**
 * @typedef Ecore_IMF_Input_Panel_Return_Key_Type
 *
 * @brief Enumeration that defines the "Return" key types on the input panel (virtual keyboard).
 *
 * @see ecore_imf_context_input_panel_return_key_type_set()
 */
typedef enum
{
   ECORE_IMF_INPUT_PANEL_RETURN_KEY_TYPE_DEFAULT, /**< Default @since 1.2 */
   ECORE_IMF_INPUT_PANEL_RETURN_KEY_TYPE_DONE,    /**< Done @since 1.2 */
   ECORE_IMF_INPUT_PANEL_RETURN_KEY_TYPE_GO,      /**< Go @since 1.2 */
   ECORE_IMF_INPUT_PANEL_RETURN_KEY_TYPE_JOIN,    /**< Join @since 1.2 */
   ECORE_IMF_INPUT_PANEL_RETURN_KEY_TYPE_LOGIN,   /**< Login @since 1.2 */
   ECORE_IMF_INPUT_PANEL_RETURN_KEY_TYPE_NEXT,    /**< Next @since 1.2 */
   ECORE_IMF_INPUT_PANEL_RETURN_KEY_TYPE_SEARCH,  /**< Search or magnifier icon @since 1.2 */
   ECORE_IMF_INPUT_PANEL_RETURN_KEY_TYPE_SEND,    /**< Send @since 1.2 */
   ECORE_IMF_INPUT_PANEL_RETURN_KEY_TYPE_SIGNIN   /**< Sign-in @since 1.8 */
} Ecore_IMF_Input_Panel_Return_Key_Type;

/**
 * @typedef Ecore_IMF_Input_Hints
 * @brief Enumeration that defines the types of Ecore_IMF Input Hints.
 * @since 1.12
 */
typedef enum
{
   ECORE_IMF_INPUT_HINT_NONE                = 0,        /**< No active hints @since 1.12 */
   ECORE_IMF_INPUT_HINT_AUTO_COMPLETE       = 1 << 0,   /**< Suggest word auto completion @since 1.12 */
   ECORE_IMF_INPUT_HINT_SENSITIVE_DATA      = 1 << 1,   /**< Typed text should not be stored. @since 1.12 */
} Ecore_IMF_Input_Hints;

enum
{
   ECORE_IMF_INPUT_PANEL_LAYOUT_NORMAL_VARIATION_NORMAL,            /**< The plain normal layout @since 1.12 */
   ECORE_IMF_INPUT_PANEL_LAYOUT_NORMAL_VARIATION_FILENAME,          /**< Filename layout. Symbols such as '/' should be disabled. @since 1.12 */
   ECORE_IMF_INPUT_PANEL_LAYOUT_NORMAL_VARIATION_PERSON_NAME        /**< The name of a person. @since 1.12 */
};

enum
{
   ECORE_IMF_INPUT_PANEL_LAYOUT_NUMBERONLY_VARIATION_NORMAL,            /**< The plain normal number layout @since 1.8 */
   ECORE_IMF_INPUT_PANEL_LAYOUT_NUMBERONLY_VARIATION_SIGNED,            /**< The number layout to allow a positive or negative sign at the start @since 1.8 */
   ECORE_IMF_INPUT_PANEL_LAYOUT_NUMBERONLY_VARIATION_DECIMAL,           /**< The number layout to allow decimal point to provide fractional value @since 1.8 */
   ECORE_IMF_INPUT_PANEL_LAYOUT_NUMBERONLY_VARIATION_SIGNED_AND_DECIMAL /**< The number layout to allow decimal point and negative sign @since 1.8 */
};

enum
{
   ECORE_IMF_INPUT_PANEL_LAYOUT_PASSWORD_VARIATION_NORMAL,          /**< The normal password layout @since 1.12 */
   ECORE_IMF_INPUT_PANEL_LAYOUT_PASSWORD_VARIATION_NUMBERONLY       /**< The password layout to allow only number @since 1.12 */
};

/**
 * @typedef Ecore_IMF_BiDi_Direction
 * @brief Enumeration that defines the types of Ecore_IMF bidirectionality
 * @since 1.12
 */
typedef enum
{
   ECORE_IMF_BIDI_DIRECTION_NEUTRAL,    /**< The neutral mode @since 1.12 */
   ECORE_IMF_BIDI_DIRECTION_LTR,        /**< The Left to Right mode @since 1.12 */
   ECORE_IMF_BIDI_DIRECTION_RTL         /**< The Right to Left mode @since 1.12 */
} Ecore_IMF_BiDi_Direction;

struct _Ecore_IMF_Event_Preedit_Start
{
   Ecore_IMF_Context *ctx;
};

struct _Ecore_IMF_Event_Preedit_End
{
   Ecore_IMF_Context *ctx;
};

struct _Ecore_IMF_Event_Preedit_Changed
{
   Ecore_IMF_Context *ctx;
};

struct _Ecore_IMF_Event_Commit
{
   Ecore_IMF_Context *ctx;
   char              *str;
};

struct _Ecore_IMF_Event_Delete_Surrounding
{
   Ecore_IMF_Context *ctx;
   int                offset;
   int                n_chars;
};

struct _Ecore_IMF_Event_Selection
{
   Ecore_IMF_Context *ctx;
   int                start;
   int                end;
};

struct _Ecore_IMF_Event_Mouse_Down
{
   int button;                             /**< The button that has been pressed */
   struct {
      int x, y;
   } output;
   struct {
      int x, y;
   } canvas;
   Ecore_IMF_Keyboard_Modifiers modifiers; /**< The active keyboard modifiers when the event has been emitted */
   Ecore_IMF_Keyboard_Locks     locks;     /**< The active keyboard locks when the event has been emitted */
   Ecore_IMF_Mouse_Flags        flags;     /**< The flags corresponding to a mouse click (single, double, or triple click) */
   unsigned int                 timestamp; /**< The timestamp when the event occurred */
};

struct _Ecore_IMF_Event_Mouse_Up
{
   int button;                             /**< The button that has been pressed */
   struct {
      int x, y;
   } output;
   struct {
      int x, y;
   } canvas;
   Ecore_IMF_Keyboard_Modifiers modifiers; /**< The active keyboard modifiers when the event has been emitted */
   Ecore_IMF_Keyboard_Locks     locks;     /**< The active keyboard locks when the event has been emitted */
   Ecore_IMF_Mouse_Flags        flags;     /**< The flags corresponding to a mouse click (single, double, or triple click) */
   unsigned int                 timestamp; /**< The timestamp when the event occurred */
};

struct _Ecore_IMF_Event_Mouse_In
{
   int buttons;
   struct {
      int x, y;
   } output;
   struct {
      int x, y;
   } canvas;
   Ecore_IMF_Keyboard_Modifiers modifiers; /**< The active keyboard modifiers when the event has been emitted */
   Ecore_IMF_Keyboard_Locks     locks;     /**< The active keyboard locks when the event has been emitted */
   unsigned int                 timestamp; /**< The timestamp when the event occurred */
};

struct _Ecore_IMF_Event_Mouse_Out
{
   int buttons;
   struct {
      int x, y;
   } output;
   struct {
      int x, y;
   } canvas;
   Ecore_IMF_Keyboard_Modifiers modifiers; /**< The active keyboard modifiers when the event has been emitted */
   Ecore_IMF_Keyboard_Locks     locks;     /**< The active keyboard locks when the event has been emitted */
   unsigned int                 timestamp; /**< The timestamp when the event occurred */
};

struct _Ecore_IMF_Event_Mouse_Move
{
   int buttons;
   struct {
      struct {
         int x, y;
      } output;
      struct {
         int x, y;
      } canvas;
   } cur, prev;
   Ecore_IMF_Keyboard_Modifiers modifiers; /**< The active keyboard modifiers when the event has been emitted */
   Ecore_IMF_Keyboard_Locks     locks;     /**< The active keyboard locks when the event has been emitted */
   unsigned int                 timestamp; /**< The timestamp when the event occurred */
};

struct _Ecore_IMF_Event_Mouse_Wheel
{
   int direction;                         /* 0 = default up/down wheel */
   int z;                                 /* ...,-2,-1 = down, 1,2,... = up */
   struct {
      int x, y;
   } output;
   struct {
      int x, y;
   } canvas;
   Ecore_IMF_Keyboard_Modifiers modifiers; /**< The active keyboard modifiers when the event has been emitted */
   Ecore_IMF_Keyboard_Locks     locks;     /**< The active keyboard locks when the event has been emitted */
   unsigned int                 timestamp; /**< The timestamp when the event occurred */
};

struct _Ecore_IMF_Event_Key_Down
{
   const char                   *keyname;   /**< The string name of the key that has been pressed */
   Ecore_IMF_Keyboard_Modifiers  modifiers; /**< The active keyboard modifiers when the event has been emitted */
   Ecore_IMF_Keyboard_Locks      locks;     /**< The active keyboard locks when the event has been emitted */
   const char                   *key;       /**< The logical key : (eg shift+1 == exclamation) */
   const char                   *string;    /**< A UTF8 string if this keystroke has produced a visible string to be ADDED */
   const char                   *compose;   /**< A UTF8 string if this keystroke has modified a string in the middle of being composed - this string replaces the previous one */
   unsigned int                  timestamp; /**< The timestamp when the event occurred */
};

struct _Ecore_IMF_Event_Key_Up
{
   const char                   *keyname;   /**< The string name of the key that has been pressed */
   Ecore_IMF_Keyboard_Modifiers  modifiers; /**< The active keyboard modifiers when the event has been emitted */
   Ecore_IMF_Keyboard_Locks      locks;     /**< The active keyboard locks when the event has been emitted */
   const char                   *key;       /**< The logical key : (eg shift+1 == exclamation) */
   const char                   *string;    /**< A UTF8 string if this keystroke has produced a visible string to be ADDED */
   const char                   *compose;   /**< A UTF8 string if this keystroke has modified a string in the middle of being composed - this string replaces the previous one */
   unsigned int                  timestamp; /**< The timestamp when the event occurred */
};

union _Ecore_IMF_Event
{
   Ecore_IMF_Event_Mouse_Down  mouse_down;
   Ecore_IMF_Event_Mouse_Up    mouse_up;
   Ecore_IMF_Event_Mouse_In    mouse_in;
   Ecore_IMF_Event_Mouse_Out   mouse_out;
   Ecore_IMF_Event_Mouse_Move  mouse_move;
   Ecore_IMF_Event_Mouse_Wheel mouse_wheel;
   Ecore_IMF_Event_Key_Down    key_down;
   Ecore_IMF_Event_Key_Up      key_up;
};

struct _Ecore_IMF_Preedit_Attr
{
   Ecore_IMF_Preedit_Type preedit_type; /**< The preedit style type */
   unsigned int start_index;            /**< The start index of the range (in bytes) */
   unsigned int end_index;              /**< The end index of the range (in bytes) */
};

struct _Ecore_IMF_Context_Class
{
   void (*add)                 (Ecore_IMF_Context *ctx);
   void (*del)                 (Ecore_IMF_Context *ctx);
   void (*client_window_set)   (Ecore_IMF_Context *ctx, void *window);
   void (*client_canvas_set)   (Ecore_IMF_Context *ctx, void *canvas);
   void (*show)                (Ecore_IMF_Context *ctx);
   void (*hide)                (Ecore_IMF_Context *ctx);
   void (*preedit_string_get)  (Ecore_IMF_Context *ctx, char **str, int *cursor_pos);
   void (*focus_in)            (Ecore_IMF_Context *ctx);
   void (*focus_out)           (Ecore_IMF_Context *ctx);
   void (*reset)               (Ecore_IMF_Context *ctx);
   void (*cursor_position_set) (Ecore_IMF_Context *ctx, int cursor_pos);
   void (*use_preedit_set)     (Ecore_IMF_Context *ctx, Eina_Bool use_preedit);
   void (*input_mode_set)      (Ecore_IMF_Context *ctx, Ecore_IMF_Input_Mode input_mode);
   Eina_Bool (*filter_event)   (Ecore_IMF_Context *ctx, Ecore_IMF_Event_Type type, Ecore_IMF_Event *event);
   void (*preedit_string_with_attributes_get) (Ecore_IMF_Context *ctx, char **str, Eina_List **attrs, int *cursor_pos);
   void (*prediction_allow_set)(Ecore_IMF_Context *ctx, Eina_Bool prediction);
   void (*autocapital_type_set)(Ecore_IMF_Context *ctx, Ecore_IMF_Autocapital_Type autocapital_type);
   void (*control_panel_show)   (Ecore_IMF_Context *ctx);
   void (*control_panel_hide)   (Ecore_IMF_Context *ctx);
   void (*input_panel_layout_set) (Ecore_IMF_Context *ctx, Ecore_IMF_Input_Panel_Layout layout);
   Ecore_IMF_Input_Panel_Layout (*input_panel_layout_get) (Ecore_IMF_Context *ctx);
   void (*input_panel_language_set) (Ecore_IMF_Context *ctx, Ecore_IMF_Input_Panel_Lang lang);
   Ecore_IMF_Input_Panel_Lang (*input_panel_language_get) (Ecore_IMF_Context *ctx);
   void (*cursor_location_set) (Ecore_IMF_Context *ctx, int x, int y, int w, int h);
   void (*input_panel_imdata_set)(Ecore_IMF_Context *ctx, const void* data, int len);
   void (*input_panel_imdata_get)(Ecore_IMF_Context *ctx, void* data, int *len);
   void (*input_panel_return_key_type_set) (Ecore_IMF_Context *ctx, Ecore_IMF_Input_Panel_Return_Key_Type return_key_type);
   void (*input_panel_return_key_disabled_set) (Ecore_IMF_Context *ctx, Eina_Bool disabled);
   void (*input_panel_caps_lock_mode_set) (Ecore_IMF_Context *ctx, Eina_Bool mode);
   void (*input_panel_geometry_get)(Ecore_IMF_Context *ctx, int *x, int *y, int *w, int *h);
   Ecore_IMF_Input_Panel_State (*input_panel_state_get) (Ecore_IMF_Context *ctx);
   void (*input_panel_event_callback_add) (Ecore_IMF_Context *ctx, Ecore_IMF_Input_Panel_Event type, void (*func) (void *data, Ecore_IMF_Context *ctx, int value), void *data);
   void (*input_panel_event_callback_del) (Ecore_IMF_Context *ctx, Ecore_IMF_Input_Panel_Event type, void (*func) (void *data, Ecore_IMF_Context *ctx, int value));
   void (*input_panel_language_locale_get) (Ecore_IMF_Context *ctx, char **lang);
   void (*candidate_panel_geometry_get)(Ecore_IMF_Context *ctx, int *x, int *y, int *w, int *h);
   void (*input_hint_set) (Ecore_IMF_Context *ctx, Ecore_IMF_Input_Hints input_hints);
   void (*bidi_direction_set) (Ecore_IMF_Context *ctx, Ecore_IMF_BiDi_Direction direction);
};

struct _Ecore_IMF_Context_Info
{
   const char *id;              /**< ID */
   const char *description;     /**< Human readable description */
   const char *default_locales; /**< Languages for which this context is the default, separated by : */
   const char *canvas_type;     /**< The canvas type used by the input method. Eg.: evas */
   int         canvas_required; /**< Whether canvas usage is required for this input method */
};

/**
 * @brief Initialises the Ecore_IMF library.
 *
 * @return  The number of times the library has been initialised without being
 *          shut down
 * @ingroup Ecore_IMF_Group
 */
EAPI int                           ecore_imf_init(void);

/**
 * @brief Shuts down the Ecore_IMF library.
 *
 * @return  The number of times the library has been initialised without being
 *          shut down
 * @ingroup Ecore_IMF_Group
 */
EAPI int                           ecore_imf_shutdown(void);

EAPI void                          ecore_imf_module_register(const Ecore_IMF_Context_Info *info, Ecore_IMF_Context *(*imf_module_create)(void), Ecore_IMF_Context *(*imf_module_exit)(void));

/**
 * @brief Hides the input panel.
 *
 * @since 1.8.0
 *
 * @return  @c EINA_TRUE if the input panel is hidden,
 *          otherwise @c EINA_FALSE if the input panel is already in the hidden state
 * @ingroup Ecore_IMF_Group
 */
EAPI Eina_Bool                     ecore_imf_input_panel_hide(void);

/**
 * @brief Gets the list of available Input Method Context IDs.
 *
 * @remarks Note that the caller is responsible for freeing the Eina_List
 *          when he is finished with it. There is no need to finish the list strings.
 *
 * @return An Eina_List of strings,
 *         otherwise @c NULL on failure
 */
EAPI Eina_List                    *ecore_imf_context_available_ids_get(void);

EAPI Eina_List                    *ecore_imf_context_available_ids_by_canvas_type_get(const char *canvas_type);

/**
 * @brief Gets the ID of the default Input Method Context.
 *
 * @remarks The ID may be used to create a new instance of an Input Method
 *          Context object.
 *
 * @return A string containing the ID of the default Input Method Context,
 *         otherwise @c NULL on failure
 */
EAPI const char                   *ecore_imf_context_default_id_get(void);

EAPI const char                   *ecore_imf_context_default_id_by_canvas_type_get(const char *canvas_type);

/**
 * Retrieve the info for the Input Method Context with @p id.
 *
 * @param[in] id The Input Method Context id to query for.
 * @return Return a #Ecore_IMF_Context_Info for the Input Method Context with @p id;
 *         on failure it returns NULL.
 * @ingroup Ecore_IMF_Context_Group
 *
 * Example
 * @code
 *
 * const char *ctx_id;
 * const Ecore_IMF_Context_Info *ctx_info;
 * Ecore_IMF_Context *imf_context;
 * ctx_id = ecore_imf_context_default_id_get();
 * if (ctx_id)
 *   {
 *      ctx_info = ecore_imf_context_info_by_id_get(ctx_id);
 *      if (!ctx_info->canvas_type ||
 *          strcmp(ctx_info->canvas_type, "evas") == 0)
 *        {
 *           imf_context = ecore_imf_context_add(ctx_id);
 *        }
 *      else
 *        {
 *           ctx_id = ecore_imf_context_default_id_by_canvas_type_get("evas");
 *           if (ctx_id)
 *             {
 *                imf_context = ecore_imf_context_add(ctx_id);
 *             }
 *        }
 *   }
 * @endcode
 */
EAPI const Ecore_IMF_Context_Info *ecore_imf_context_info_by_id_get(const char *id);

/**
 * @brief Gets the info for the Input Method Context with ID @a id.
 *
 * @param[in] id The Input Method Context ID to query for
 * @return An #Ecore_IMF_Context_Info for the Input Method Context with ID @a id,
 *         otherwise @c NULL on failure
 */
EAPI Ecore_IMF_Context            *ecore_imf_context_add(const char *id);

/**
 * @brief Gets the info for the given Input Method Context.
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @return An #Ecore_IMF_Context_Info for the given Input Method Context,
 *         otherwise @c NULL on failure
 */
EAPI const Ecore_IMF_Context_Info *ecore_imf_context_info_get(Ecore_IMF_Context *ctx);

/**
 * @brief Deletes the given Input Method Context and frees its memory.
 *
 * @param[in] ctx An #Ecore_IMF_Context
 */
EAPI void                          ecore_imf_context_del(Ecore_IMF_Context *ctx);

/**
 * @brief Sets the client window for the Input Method Context. This is the
 *        Ecore_X_Window when using X11, Ecore_Win32_Window when using Win32, and so on.
 *
 * @remarks This window is used in order to correctly position status windows and may
 *          also be used for purposes that are internal to the Input Method Context.
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @param[in] window The client windowc\n
 *               This may be @c NULL to indicate
 *               that the previous client window no longer exists.
 */
EAPI void                          ecore_imf_context_client_window_set(Ecore_IMF_Context *ctx, void *window);

/**
 * @brief Gets the client window of the Input Method Context.
 *
 * @since 1.1.0
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @return The client window
 *
 * @see ecore_imf_context_client_window_set()
 */
EAPI void                         *ecore_imf_context_client_window_get(Ecore_IMF_Context *ctx);

/**
 * @brief Sets the client canvas for the Input Method Context. This is the
 *        canvas in which the input appears.
 *
 * @remarks The canvas type can be determined by using the context canvas type.
 *          Actually only a canvas with type "evas" (Evas *) is supported.
 * 
 * @remarks This canvas may be used in order to correctly position status windows, and may
 *          also be used for purposes that are internal to the Input Method Context.
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @param[in] canvas The client canvas \n
 *               This may be @c NULL to indicate
 *               that the previous client canvas no longer exists.
 */
EAPI void                          ecore_imf_context_client_canvas_set(Ecore_IMF_Context *ctx, void *canvas);

/**
 * @brief Gets the client canvas of the Input Method Context.
 *
 * @since 1.1.0
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @return The client canvas
 *
 * @see ecore_imf_context_client_canvas_set()
 */
EAPI void                         *ecore_imf_context_client_canvas_get(Ecore_IMF_Context *ctx);

/**
 * @brief Asks the Input Method Context to show itself.
 *
 * @param[in] ctx An #Ecore_IMF_Context
 */
EAPI void                          ecore_imf_context_show(Ecore_IMF_Context *ctx);

/**
 * @brief Asks the Input Method Context to hide itself.
 *
 * @param[in] ctx An #Ecore_IMF_Context
 */
EAPI void                          ecore_imf_context_hide(Ecore_IMF_Context *ctx);

/**
 * @brief Gets the current preedit string and cursor position
 *        for the Input Method Context.
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @param[out] str The location to store the retrieved string \n
 *            The string retrieved must be freed with free().
 * @param[out] cursor_pos The location to store the position of the cursor (in characters)
 *                   within the preedit string
 */
EAPI void                          ecore_imf_context_preedit_string_get(Ecore_IMF_Context *ctx, char **str, int *cursor_pos);

/**
 * @brief Gets the current preedit string, attributes, and
 *        cursor position for the Input Method Context.
 *
 * @since 1.1.0
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @param[out] str The location to store the retrieved string \n
 *            The string retrieved must be freed with free().
 * @param[in] attrs An Eina_List of attributes
 * @param[out] cursor_pos The location to store the position of the cursor (in characters)
 *                   within the preedit string
 *
 * Example:
 * @code
 * char *preedit_string;
 * int cursor_pos;
 * Eina_List *attrs = NULL, *l = NULL;
 * Ecore_IMF_Preedit_Attr *attr;
 *
 * ecore_imf_context_preedit_string_with_attributes_get(imf_context,
 *                                                      &preedit_string,
 *                                                      &attrs, &cursor_pos);
 * if (!preedit_string) return;
 *
 *  if (strlen(preedit_string) > 0)
 *    {
 *       if (attrs)
 *         {
 *            EINA_LIST_FOREACH(attrs, l, attr)
 *              {
 *                 if (attr->preedit_type == ECORE_IMF_PREEDIT_TYPE_SUB1)
 *                   {
 *                      // Something to do
 *                   }
 *                 else if (attr->preedit_type == ECORE_IMF_PREEDIT_TYPE_SUB2)
 *                   {
 *                      // Something to do
 *                   }
 *                 else if (attr->preedit_type == ECORE_IMF_PREEDIT_TYPE_SUB3)
 *                   {
 *                      // Something to do
 *                   }
 *              }
 *         }
 *    }
 *
 * // delete attribute list
 * EINA_LIST_FREE(attrs, attr) free(attr);
 *
 * free(preedit_string);
 * @endcode
 */
EAPI void                          ecore_imf_context_preedit_string_with_attributes_get(Ecore_IMF_Context *ctx, char **str, Eina_List **attrs, int *cursor_pos);

/**
 * @brief Notifies the Input Method Context that the widget to which it
 *        corresponds has gained focus.
 *
 * @param[in] ctx An #Ecore_IMF_Context
 *
 * Example:
 * @code
 * static void
 * _focus_in_cb(void *data, Evas_Object *o, const char *emission, const char *source)
 * {
 *    Ecore_IMF_Context *imf_context = data;
 *    ecore_imf_context_focus_in(imf_context);
 * }
 *
 * evas_object_event_callback_add(obj, EVAS_CALLBACK_FOCUS_IN, _focus_in_cb, imf_context);
 * @endcode
 */
EAPI void                          ecore_imf_context_focus_in(Ecore_IMF_Context *ctx);

/**
 * @brief Notifies the Input Method Context that the widget to which it
 *        corresponds has lost focus.
 *
 * @param[in] ctx An #Ecore_IMF_Context
 *
 * Example:
 * @code
 * static void
 * _focus_out_cb(void *data, Evas_Object *o, const char *emission, const char *source)
 * {
 *    Ecore_IMF_Context *imf_context = data;
 *    ecore_imf_context_reset(imf_context);
 *    ecore_imf_context_focus_out(imf_context);
 * }
 *
 * evas_object_event_callback_add(obj, EVAS_CALLBACK_FOCUS_OUT, _focus_out_cb, ed);
 * @endcode
 */
EAPI void                          ecore_imf_context_focus_out(Ecore_IMF_Context *ctx);

/**
 * @brief Notifies the Input Method Context that a change, such as a
 *        change in the cursor position, has been made. This typically
 *        causes the Input Method Context to clear the preedit state or commit the preedit string.
 *
 * @remarks The operation of ecore_imf_context_reset() depends on the specific characteristics of
 *          each language. For example, the preedit string is cleared in the Chinese and Japanese Input Method Engine.
 *          However, The preedit string is committed and then cleared in the Korean Input Method Engine.
 *
 * @remarks This function should be called for the focus-out and mouse down event callback function.
 *          In addition, it should be called before inserting some text.
 *
 * @param[in] ctx An #Ecore_IMF_Context
 *
 * Example:
 * @code
 * static void
 * _focus_out_cb(void *data, Evas_Object *o, const char *emission, const char *source)
 * {
 *    Ecore_IMF_Context *imf_context = data;
 *    ecore_imf_context_reset(imf_context);
 *    ecore_imf_context_focus_out(imf_context);
 * }
 *
 * evas_object_event_callback_add(obj, EVAS_CALLBACK_FOCUS_OUT, _focus_out_cb, imf_context);
 * @endcode
 */
EAPI void                          ecore_imf_context_reset(Ecore_IMF_Context *ctx);

/**
 * @brief Notifies the Input Method Context that a change in the cursor
 *        position has been made.
 *
 * @remarks This function should be called when the cursor position is changed or a mouse up event is generated.
 *          Some input methods that do a heavy job using this event can give a critical performance latency problem.
 *          For better typing performance, we suggest that the cursor position change events need to occur
 *          only if the cursor position is on a confirmed status, not on a moving status.
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @param[in] cursor_pos The new cursor position in characters
 */
EAPI void                          ecore_imf_context_cursor_position_set(Ecore_IMF_Context *ctx, int cursor_pos);

/**
 * @brief Notifies the Input Method Context that a change in the cursor
 *        location has been made. The location is relative to the canvas.
 *
 * @since 1.1.0
 *
 * @remarks The cursor location can be used to determine the position of
 *          the candidate word window in the immodule.
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @param[in] x The cursor's x position
 * @param[in] y The cursor's y position
 * @param[in] w The cursor width
 * @param[in] h The cursor height
 */
EAPI void                          ecore_imf_context_cursor_location_set(Ecore_IMF_Context *ctx, int x, int y, int w, int h);

/**
 * @brief Sets whether the IM context should use the preedit string
 *        to display feedback. 
 *
 * @remarks If @a use_preedit is @c EINA_FALSE (default
 *          is @c EINA_TRUE), then the IM context may use some other method to display
 *          feedback, such as displaying it in a child of the root window.
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @param[in] use_preedit The boolean value that indicates whether the IM context should use the preedit string
 */
EAPI void                          ecore_imf_context_use_preedit_set(Ecore_IMF_Context *ctx, Eina_Bool use_preedit);

/**
 * @brief Sets the callback to be used on the surrounding_get request.
 *
 * @remarks This callback is called when the Input Method Context
 *          module requests the surrounding context.
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @param[in] func The callback to be called
 * @param[in] data The data pointer to be passed to @a func
 */
EAPI void                          ecore_imf_context_retrieve_surrounding_callback_set(Ecore_IMF_Context *ctx, Eina_Bool (*func)(void *data, Ecore_IMF_Context *ctx, char **text, int *cursor_pos), const void *data);

/**
 * @brief Sets the callback to be used on the selection_get request.
 *
 * @since 1.9.0
 *
 * @remarks This callback is called when the Input Method Context
 *          module requests the selection context.
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @param[in] func The callback to be called
 * @param[in] data The data pointer to be passed to @a func
 */
EAPI void                          ecore_imf_context_retrieve_selection_callback_set(Ecore_IMF_Context *ctx, Eina_Bool (*func)(void *data, Ecore_IMF_Context *ctx, char **text), const void *data);

/**
 * @brief Sets the callback to be used on the surrounding_get request.
 *
 * @remarks The input mode can be one of the input modes defined in
 *          Ecore_IMF_Input_Mode. The default input mode is
 *          @c ECORE_IMF_INPUT_MODE_FULL.
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @param[in] input_mode The input mode to be used by @a ctx
 */
EAPI void                          ecore_imf_context_input_mode_set(Ecore_IMF_Context *ctx, Ecore_IMF_Input_Mode input_mode);

/**
 * @brief Gets the input mode being used by the Ecore Input Context.
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @return The input mode being used by @a ctx
 *
 * @see ecore_imf_context_input_mode_set
 */
EAPI Ecore_IMF_Input_Mode          ecore_imf_context_input_mode_get(Ecore_IMF_Context *ctx);

/**
 * @brief Allows an Ecore Input Context to internally handle an event.
 *
 * @remarks If this function returns @c EINA_TRUE, then no further processing
 *          should be done for this event.
 *
 * @remarks Input methods must be able to accept all types of events (simply
 *          returning @c EINA_FALSE if the event is not handled), but there is no
 *          obligation of any events to be submitted to this function.
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @param[in] type The type of event defined by #Ecore_IMF_Event_Type
 * @param[in] event The event itself
 * @return @c EINA_TRUE if the event is handled,
 *         otherwise @c EINA_FALSE
 *
 * Example:
 * @code
 * static void
 * _key_down_cb(void *data, Evas *e, Evas_Object *obj, void *event_info)
 * {
 *    Evas_Event_Key_Down *ev = event_info;
 *    if (!ev->key) return;
 *
 *    if (imf_context)
 *      {
 *         Ecore_IMF_Event_Key_Down ecore_ev;
 *         ecore_imf_evas_event_key_down_wrap(ev, &ecore_ev);
 *         if (ecore_imf_context_filter_event(imf_context,
 *                                            ECORE_IMF_EVENT_KEY_DOWN,
 *                                            (Ecore_IMF_Event *)&ecore_ev))
 *           return;
 *      }
 * }
 *
 * evas_object_event_callback_add(obj, EVAS_CALLBACK_KEY_DOWN, _key_down_cb, data);
 * @endcode
 */
EAPI Eina_Bool                     ecore_imf_context_filter_event(Ecore_IMF_Context *ctx, Ecore_IMF_Event_Type type, Ecore_IMF_Event *event);

/* Plugin specific functions */

/**
 * @brief Creates a new Input Method Context with the class specified by @a ctxc.
 *
 * @remarks This method should be used by modules implementing the Input
 *          Method Context interface.
 *
 * @param[in] ctxc An #Ecore_IMF_Context_Class
 * @return A new #Ecore_IMF_Context,
 *         otherwise @c NULL on failure
 */
EAPI Ecore_IMF_Context            *ecore_imf_context_new(const Ecore_IMF_Context_Class *ctxc);

/**
 * @brief Sets the Input Method Context specific data.
 *
 * @remarks Note that this method should be used by modules to set
 *          the Input Method Context specific data and it's not meant to
 *          be used by applications to store application specific data.
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @param[in] data The Input Method Context specific data
 * @return A new #Ecore_IMF_Context,
 *         otherwise @c NULL on failure
 */
EAPI void                          ecore_imf_context_data_set(Ecore_IMF_Context *ctx, void *data);

/**
 * @brief Gets the Input Method Context specific data.
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @return The Input Method Context specific data
 *
 * @see ecore_imf_context_data_set()
 */
EAPI void                         *ecore_imf_context_data_get(Ecore_IMF_Context *ctx);

/**
 * @brief Gets the context around the insertion point.
 *
 * @remarks Input methods typically want context in order to constrain the input text based on existing text.
 *          This is important for languages such as Thai where only some sequences of characters are allowed.
 *          In addition, the text around the insertion point can be used for supporting the auto-capital feature.
 *
 * @remarks This function is implemented by calling the
 *          Ecore_IMF_Context::retrieve_surrounding_func
 *          (set using #ecore_imf_context_retrieve_surrounding_callback_set).
 *
 * @remarks There is no obligation for a widget to respond to
 *          retrieve_surrounding_func, so input methods must be prepared
 *          to function without context.
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @param[out] text The location to store a UTF-8 encoded string of text
 *             holding context around the insertion point \n
 *             If the function returns @c EINA_TRUE, then you must free
 *             the result stored in this location using free().
 * @param[out] cursor_pos The location to store the position in characters of
 *                   the insertion cursor within @a text
 * @return @c EINA_TRUE if the surrounding text is provided,
 * 		   otherwise @c EINA_FALSE
 */
EAPI Eina_Bool                     ecore_imf_context_surrounding_get(Ecore_IMF_Context *ctx, char **text, int *cursor_pos);

/**
 * @brief Gets the selected text.
 *
 * @since 1.9.0
 *
 * @remarks This function is implemented by calling
 *          Ecore_IMF_Context::retrieve_selection_func
 *          (set using #ecore_imf_context_retrieve_selection_callback_set).
 *
 * @remarks There is no obligation for a widget to respond to
 *          retrieve_surrounding_func, so input methods must be prepared
 *          to function without context.
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @param[out] text The location to store a UTF-8 encoded string of the selected text \n
 *             If the function returns @c EINA_TRUE, then you must free
 *             the result stored in this location using free().
 * @return @c EINA_TRUE if the selected text is provided,
 *         otherwise @c EINA_FALSE
 */
EAPI Eina_Bool                     ecore_imf_context_selection_get(Ecore_IMF_Context *ctx, char **text);

/**
 * @brief Adds @c ECORE_IMF_EVENT_PREEDIT_START to the event queue.
 *
 * @remarks @c ECORE_IMF_EVENT_PREEDIT_START should be added when a new preedit sequence starts.
 *          It's an asynchronous method to put an event to the event queue.
 *          ecore_imf_context_event_callback_call() can be used as a synchronous method.
 *
 * @param[in] ctx An #Ecore_IMF_Context
 */
EAPI void                          ecore_imf_context_preedit_start_event_add(Ecore_IMF_Context *ctx);

/**
 * @brief Adds @c ECORE_IMF_EVENT_PREEDIT_END to the event queue.
 *
 * @remarks @c ECORE_IMF_EVENT_PREEDIT_END should be added when a new preedit sequence has been completed or cancelled.
 *          It's an asynchronous method to put an event to the event queue.
 *          ecore_imf_context_event_callback_call() can be used as a synchronous method.
 *
 * @param[in] ctx An #Ecore_IMF_Context
 */
EAPI void                          ecore_imf_context_preedit_end_event_add(Ecore_IMF_Context *ctx);

/**
 * @brief Adds @c ECORE_IMF_EVENT_PREEDIT_CHANGED to the event queue.
 *
 * @remarks It's an asynchronous method to put an event to the event queue.
 *          ecore_imf_context_event_callback_call() can be used as a synchronous method.
 *
 * @param[in] ctx An #Ecore_IMF_Context
 */
EAPI void                          ecore_imf_context_preedit_changed_event_add(Ecore_IMF_Context *ctx);

/**
 * @brief Adds @c ECORE_IMF_EVENT_COMMIT to the event queue.
 *
 * @remarks It's an asynchronous method to put an event to the event queue.
 *          ecore_imf_context_event_callback_call() can be used as a synchronous method.
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @param[in] str The committed string
 */
EAPI void                          ecore_imf_context_commit_event_add(Ecore_IMF_Context *ctx, const char *str);

/**
 * @brief Adds @c ECORE_IMF_EVENT_DELETE_SURROUNDING to the event queue.
 *
 * @remarks This asks the widget that the input context is attached to delete characters around the cursor position
 *          by adding @c ECORE_IMF_EVENT_DELETE_SURROUNDING to the event queue.
 *          Note that @a offset and @a n_chars are in characters and not in bytes.
 *
 * @remarks It's an asynchronous method to put the @c ECORE_IMF_EVENT_DELETE_SURROUNDING event to the event queue.
 *          ecore_imf_context_event_callback_call() can be used as a synchronous method.
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @param[in] offset The start offset of the surrounding to be deleted
 * @param[in] n_chars The number of characters to be deleted
 */
EAPI void                          ecore_imf_context_delete_surrounding_event_add(Ecore_IMF_Context *ctx, int offset, int n_chars);

/**
 * @}
 */

/**
 * @brief Adds (registers) a callback function to a given context event.
 *
 * @details This function adds a function callback to the context @a ctx when the
 *          event of type @a type occurs on it. The function pointer is
 *          @a func.
 *
 * @since 1.2.0
 *
 * @remarks The event type @a type to trigger the function may be one of
 *          #ECORE_IMF_CALLBACK_PREEDIT_START, #ECORE_IMF_CALLBACK_PREEDIT_END,
 *          #ECORE_IMF_CALLBACK_PREEDIT_CHANGED, #ECORE_IMF_CALLBACK_COMMIT, or
 *          #ECORE_IMF_CALLBACK_DELETE_SURROUNDING.
 *
 * @param[in] ctx The Ecore_IMF_Context to attach a callback to
 * @param[in] type The type of event that triggers the callback
 * @param[in] func The (callback) function to be called when the event is
 *             triggered
 * @param[in] data The data pointer to be passed to @a func
 *
 * Example:
 * @code
 * static void
 * _imf_event_commit_cb(void *data, Ecore_IMF_Context *ctx, void *event_info)
 * {
 *    char *commit_str = event_info;
 *    // something to do
 * }
 *
 * ecore_imf_context_event_callback_add(en->imf_context, ECORE_IMF_CALLBACK_COMMIT, _imf_event_commit_cb, data);
 * @endcode
 */
EAPI void                          ecore_imf_context_event_callback_add(Ecore_IMF_Context *ctx, Ecore_IMF_Callback_Type type, Ecore_IMF_Event_Cb func, const void *data);

/**
 * @brief Deletes (unregisters) a callback function registered to a given
 *        context event.
 *
 * @details This function removes a function callback from the context @a ctx when the
 *          event of type @a type occurs on it. The function pointer is
 *          @a func.
 *
 * @since 1.2.0
 *
 * @param[in] ctx The Ecore_IMF_Context to remove a callback from
 * @param[in] type The type of event that triggers the callback
 * @param[in] func The (callback) function to be called when the event is triggered
 * @return The data pointer
 *
 * @see ecore_imf_context_event_callback_add()
 */
EAPI void                         *ecore_imf_context_event_callback_del(Ecore_IMF_Context *ctx, Ecore_IMF_Callback_Type type, Ecore_IMF_Event_Cb func);

/**
 * @brief Calls a given callback on the context @a ctx.
 *
 * @since 1.2.0
 *
 * @remarks The ecore_imf_context_preedit_start_event_add(), ecore_imf_context_preedit_end_event_add(),
 *          ecore_imf_context_preedit_changed_event_add(), ecore_imf_context_commit_event_add(), and
 *          ecore_imf_context_delete_surrounding_event_add() APIs are asynchronous
 *          because those APIs add each event to the event queue.
 *
 * @remarks This API provides a way to call each callback function immediately.
 *
 * @param[in] ctx An Ecore_IMF_Context
 * @param[in] type The type of event that triggers the callback
 * @param[in] event_info A pointer to an event specific struct or information to
 *                   pass to the callback functions registered on this event
 */
EAPI void                          ecore_imf_context_event_callback_call(Ecore_IMF_Context *ctx, Ecore_IMF_Callback_Type type, void *event_info);

/**
 * @brief Sets whether the IM context should allow text prediction.
 *
 * @since 1.1.0
 *
 * @remarks If @a prediction is @c EINA_FALSE (default is @c EINA_TRUE), then the IM
 *          context does not display the text prediction window.
 *          Default value is @c EINA_TRUE.
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @param[in] prediction The boolean value that indicates whether the IM context should allow text prediction
 */
EAPI void                          ecore_imf_context_prediction_allow_set(Ecore_IMF_Context *ctx, Eina_Bool prediction);

/**
 * @brief Gets whether the IM context should allow text prediction.
 *
 * @since 1.1.0
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @return @c EINA_TRUE if it allows text prediction,
 *         otherwise @c EINA_FALSE
 */
EAPI Eina_Bool                     ecore_imf_context_prediction_allow_get(Ecore_IMF_Context *ctx);

/**
 * @brief Sets the auto-capitalization type on the immodule.
 *
 * @since 1.1.0
 *
 * @remarks Default type is @c ECORE_IMF_AUTOCAPITAL_TYPE_SENTENCE.
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @param[in] autocapital_type The auto-capitalization type
 */
EAPI void                          ecore_imf_context_autocapital_type_set(Ecore_IMF_Context *ctx, Ecore_IMF_Autocapital_Type autocapital_type);

/**
 * @brief Gets the auto-capitalization type.
 *
 * @since 1.1.0
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @return The autocapital type being used by @a ctx
 */
EAPI Ecore_IMF_Autocapital_Type    ecore_imf_context_autocapital_type_get(Ecore_IMF_Context *ctx);

/**
 * @brief Sets the input hint which allows input methods to fine-tune their behavior.
 *
 * @since 1.12
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @param[in] hints input hint
 * @note The default input hint is ECORE_IMF_INPUT_HINT_AUTO_COMPLETE.
 */
EAPI void                          ecore_imf_context_input_hint_set(Ecore_IMF_Context *ctx, Ecore_IMF_Input_Hints hints);

/**
 * @brief Gets the value of input hint.
 *
 * @since 1.12
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @return The value of input hint
 */
EAPI Ecore_IMF_Input_Hints         ecore_imf_context_input_hint_get(Ecore_IMF_Context *ctx);

/**
 * @brief Asks the Input Method Context to show the control panel for using the Input Method.
 *
 * @since 1.1.0
 *
 * @param[in] ctx An #Ecore_IMF_Context
 */
EAPI void                          ecore_imf_context_control_panel_show(Ecore_IMF_Context *ctx);

/**
 * @brief Asks the Input Method Context to hide the control panel for using the Input Method.
 *
 * @since 1.1.0
 *
 * @param[in] ctx An #Ecore_IMF_Context
 */
EAPI void                          ecore_imf_context_control_panel_hide(Ecore_IMF_Context *ctx);

/**
 * @brief Asks the Input Method Context to show the input panel (virtual keyboard).
 *
 * @since 1.1.0
 *
 * @param[in] ctx An #Ecore_IMF_Context
 */
EAPI void                          ecore_imf_context_input_panel_show(Ecore_IMF_Context *ctx);

/**
 * @brief Asks the Input Method Context to hide the input panel.
 *
 * @since 1.1.0
 *
 * @param[in] ctx An #Ecore_IMF_Context
 */
EAPI void                          ecore_imf_context_input_panel_hide(Ecore_IMF_Context *ctx);

/**
 * @brief Sets the layout of the input panel.
 *
 * @since 1.1.0
 *
 * @remarks Default layout type is @c ECORE_IMF_INPUT_PANEL_LAYOUT_NORMAL.
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @param[in] layout The #Ecore_IMF_Input_Panel_Layout
 */
EAPI void                          ecore_imf_context_input_panel_layout_set(Ecore_IMF_Context *ctx, Ecore_IMF_Input_Panel_Layout layout);

/**
 * @brief Gets the layout of the current active input panel.
 *
 * @since 1.1.0
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @return layout The #Ecore_IMF_Input_Panel_Layout
 */
EAPI Ecore_IMF_Input_Panel_Layout  ecore_imf_context_input_panel_layout_get(Ecore_IMF_Context *ctx);

/**
 * @brief Sets the layout variation of the current active input panel.
 *
 * @since 1.8.0
 *
 * @remarks Default layout variation type is @c NORMAL.
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @param[in] variation The layout variation
 */
EAPI void                          ecore_imf_context_input_panel_layout_variation_set(Ecore_IMF_Context *ctx, int variation);

/**
 * @brief Gets the layout variation of the current active input panel.
 *
 * @since 1.8.0
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @return The layout variation
 */
EAPI int                           ecore_imf_context_input_panel_layout_variation_get(Ecore_IMF_Context *ctx);

/**
 * @brief Sets the language of the input panel.
 *
 * @since 1.1.0
 *
 * @remarks This API can be used when you want to show the English keyboard.
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @param[in] lang The language to be set for the input panel
 */
EAPI void                          ecore_imf_context_input_panel_language_set(Ecore_IMF_Context *ctx, Ecore_IMF_Input_Panel_Lang lang);

/**
 * @brief Gets the language of the input panel.
 *
 * @since 1.1.0
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @return The Ecore_IMF_Input_Panel_Lang
 *
 * @see ecore_imf_context_input_panel_language_set()
 */
EAPI Ecore_IMF_Input_Panel_Lang    ecore_imf_context_input_panel_language_get(Ecore_IMF_Context *ctx);

/**
 * @brief Sets whether the Input Method Context should request to show the input panel automatically
 * 		  when the widget has focus.
 *
 * @since 1.1.0
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @param[in] enabled If @c true the input panel is shown when the widget is clicked or has focus,
 *                otherwise @c false
 */
EAPI void                          ecore_imf_context_input_panel_enabled_set(Ecore_IMF_Context *ctx, Eina_Bool enabled);

/**
 * @brief Gets whether the Input Method Context requests to show the input panel automatically.
 *
 * @since 1.1.0
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @return The attribute to show the input panel automatically
 */
EAPI Eina_Bool                     ecore_imf_context_input_panel_enabled_get(Ecore_IMF_Context *ctx);

/**
 * @brief Sets the input panel-specific data to deliver to the input panel.
 * 
 * @since 1.2.0
 *
 * @remarks This API is used by applications to deliver specific data to the input panel.
 *          The data format MUST be negotiated by both the application and the input panel.
 *          The size and format of data is defined by the input panel.
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @param[in] data The specific data to be set to the input panel
 * @param[in] len The length of data, in bytes, to send to the input panel
 */
EAPI void                          ecore_imf_context_input_panel_imdata_set(Ecore_IMF_Context *ctx, const void *data, int len);

/**
 * @brief Gets the specific data of the current active input panel.
 *
 * @since 1.2.0
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @param[out] data The specific data to be obtained from the input panel
 * @param[out] len The length of the data
 */
EAPI void                          ecore_imf_context_input_panel_imdata_get(Ecore_IMF_Context *ctx, void *data, int *len);

/**
 * @brief Sets the "return" key type. This type is used to set a string or icon on the "return" key of the input panel.
 *
 * @since 1.2.0
 *
 * @remarks An input panel displays the string or icon associated to this type.
 *
 * @remarks Default type is @c ECORE_IMF_INPUT_PANEL_RETURN_KEY_TYPE_DEFAULT.
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @param[in] return_key_type The type of "return" key on the input panel
 */
EAPI void                          ecore_imf_context_input_panel_return_key_type_set(Ecore_IMF_Context *ctx, Ecore_IMF_Input_Panel_Return_Key_Type return_key_type);

/**
 * @brief Gets the "return" key type.
 *
 * @since 1.2.0
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @return The type of "return" key on the input panel
 *
 * @see ecore_imf_context_input_panel_return_key_type_set()
 */
EAPI Ecore_IMF_Input_Panel_Return_Key_Type ecore_imf_context_input_panel_return_key_type_get(Ecore_IMF_Context *ctx);

/**
 * @brief Sets the return key on the input panel to be disabled.
 *
 * @since 1.2.0
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @param[in] disabled The return key state
 */
EAPI void                          ecore_imf_context_input_panel_return_key_disabled_set(Ecore_IMF_Context *ctx, Eina_Bool disabled);

/**
 * @brief Gets whether the return key on the input panel should be disabled.
 *
 * @since 1.2.0
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @return @c EINA_TRUE if it should be disabled,
 *         otherwise @c EINA_FALSE
 */
EAPI Eina_Bool                     ecore_imf_context_input_panel_return_key_disabled_get(Ecore_IMF_Context *ctx);

/**
 * @brief Sets the caps lock mode on the input panel.
 *
 * @since 1.2.0
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @param[in] mode If @c EINA_TRUE caps lock on the input panel is turned on,
 *             otherwise @c EINA_FALSE
 */
EAPI void                          ecore_imf_context_input_panel_caps_lock_mode_set(Ecore_IMF_Context *ctx, Eina_Bool mode);

/**
 * @brief Gets the caps lock mode on the input panel.
 *
 * @since 1.2.0
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @return @c EINA_TRUE if caps lock is turned on,
 *         otherwise @c EINA_FALSE
 */
EAPI Eina_Bool                     ecore_imf_context_input_panel_caps_lock_mode_get(Ecore_IMF_Context *ctx);

/**
 * @brief Gets the position of the current active input panel.
 *
 * @since 1.30
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @param[out] x The top-left x co-ordinate of the input panel
 * @param[out] y The top-left y co-ordinate of the input panel
 * @param[out] w The width of the input panel
 * @param[out] h The height of the input panel
 */
EAPI void                          ecore_imf_context_input_panel_geometry_get(Ecore_IMF_Context *ctx, int *x, int *y, int *w, int *h);

/**
 * @brief Gets the state of the current active input panel.
 *
 * @since 1.3
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @return The state of the input panel
 */
EAPI Ecore_IMF_Input_Panel_State   ecore_imf_context_input_panel_state_get(Ecore_IMF_Context *ctx);

/**
 * @brief Registers a callback function which is called if there is a change in the input panel state, language, mode, and so on.
 * 
 * @since 1.3
 *
 * @remarks In order to unregister the callback function
 *          use @ref ecore_imf_context_input_panel_event_callback_del.
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @param[in] type The event type
 * @param[in] func The callback function
 * @param[in] data The application-input panel specific data
 */
EAPI void                          ecore_imf_context_input_panel_event_callback_add(Ecore_IMF_Context *ctx, Ecore_IMF_Input_Panel_Event type, void (*func) (void *data, Ecore_IMF_Context *ctx, int value), const void *data);

/**
 * @brief Unregisters a callback function which is called if there is a change in the input panel state, language, mode, and so on.
 *
 * @since 1.3
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @param[in] type An #Ecore_IMF_Input_Panel_Event
 * @param[in] func The callback function
 */
EAPI void                          ecore_imf_context_input_panel_event_callback_del(Ecore_IMF_Context *ctx, Ecore_IMF_Input_Panel_Event type, void (*func) (void *data, Ecore_IMF_Context *ctx, int value));

/**
 * @brief Calls a given input panel callback on the context @a ctx.
 *
 * @since 1.8.0
 *
 * @param[in] ctx An Ecore_IMF_Context
 * @param[in] type The type of event that triggers the callback
 * @param[in] value The event value
 */
EAPI void                          ecore_imf_context_input_panel_event_callback_call(Ecore_IMF_Context *ctx, Ecore_IMF_Input_Panel_Event type, int value);

/**
 * @brief Deletes all input panel callbacks on the context @a ctx.
 *
 * @details This deletes all input panel callbacks to be registered by ecore_imf_context_input_panel_event_callback_add().
 *
 * @since 1.8.0
 *
 * @param[in] ctx An Ecore_IMF_Context
 */
EAPI void                          ecore_imf_context_input_panel_event_callback_clear(Ecore_IMF_Context *ctx);

/**
 * @brief Gets the current language locale of the input panel, eg: fr_FR.
 *
 * @since 1.3
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @param[out] lang The location to store the retrieved language string \n
 *             The string retrieved must be freed with free().
 */
EAPI void                          ecore_imf_context_input_panel_language_locale_get(Ecore_IMF_Context *ctx, char **lang);

/**
 * @brief Gets the geometry information of the candidate panel.
 *
 * @since 1.3
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @param[out] x The top-left x co-ordinate of the candidate panel
 * @param[out] y The top-left y co-ordinate of the candidate panel
 * @param[out] w The width of the candidate panel
 * @param[out] h The height of the candidate panel
 */
EAPI void                          ecore_imf_context_candidate_panel_geometry_get(Ecore_IMF_Context *ctx, int *x, int *y, int *w, int *h);

/**
 * @brief Sets whether the Input Method Context should request to show the input panel if only one user's explicit Mouse Up event has occurred.
 *		  It doesn't request to show the input panel even though the Input Method Context has focus.
 *
 * @since 1.8.0
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @param[in] ondemand If @c true the input panel is shown when only one user's Mouse up event occurs, (Focus event is ignored)
 *                 otherwise @c false
 */
EAPI void                          ecore_imf_context_input_panel_show_on_demand_set(Ecore_IMF_Context *ctx, Eina_Bool ondemand);

/**
 * @brief Gets whether the Input Method Context should request to show the input panel if only one user's explicit Mouse Up event has occurred.
 *
 * @since 1.8.0
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @return @c EINA_TRUE if the input panel is shown when only one user's Mouse up event occurs,
 *         otherwise @c EINA_FALSE
 */
EAPI Eina_Bool                     ecore_imf_context_input_panel_show_on_demand_get(Ecore_IMF_Context *ctx);

/**
 * @brief Sets the bidirectionality at the current cursor position.
 *
 * @since 1.12.0
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @param[in] direction the direction mode
 */
EAPI void                          ecore_imf_context_bidi_direction_set(Ecore_IMF_Context *ctx, Ecore_IMF_BiDi_Direction direction);

/**
 * @brief Gets the bidirectionality at the current cursor position.
 *
 * @since 1.12.0
 *
 * @param[in] ctx An #Ecore_IMF_Context
 * @return the direction mode
 */
EAPI Ecore_IMF_BiDi_Direction      ecore_imf_context_bidi_direction_get(Ecore_IMF_Context *ctx);

/* The following entry points must be exported by each input method module.
 */

/*
 * int                imf_module_init   (const Ecore_IMF_Context_Info **info);
 * void               imf_module_exit   (void);
 * Ecore_IMF_Context *imf_module_create (void);
 */

/**
 * @}
 */

/**
 * @}
 */

#ifdef __cplusplus
}
#endif

#endif