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
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>The m17n Library: Input Method (basic)</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">The m17n Library
 <span id="projectnumber">1.8.4</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">Input Method (basic)<div class="ingroups"><a class="el" href="group__m17nShell.html">SHELL API</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>API for Input method.
<a href="#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for Input Method (basic):</div>
<div class="dyncontent">
<div class="center"><img src="group__m17nInputMethod.png" border="0" usemap="#agroup____m17nInputMethod" alt=""/></div>
<map name="agroup____m17nInputMethod" id="agroup____m17nInputMethod">
<area shape="rect" title="API for Input method." alt="" coords="140,5,296,31"/>
<area shape="rect" href="group__m17nShell.html" title="API provided by libm17n.so" alt="" coords="5,5,92,31"/>
</map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structMInputDriver.html">MInputDriver</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Structure of input method driver. <a href="structMInputDriver.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structMInputMethod.html">MInputMethod</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Structure of input method. <a href="structMInputMethod.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structMInputContext.html">MInputContext</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Structure of input context. <a href="structMInputContext.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga2b9c7eab6cc379f1b21935640797dc83"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#ga2b9c7eab6cc379f1b21935640797dc83">MInputCallbackFunc</a>) (<a class="el" href="structMInputContext.html">MInputContext</a> *ic, MSymbol command)</td></tr>
<tr class="memdesc:ga2b9c7eab6cc379f1b21935640797dc83"><td class="mdescLeft"> </td><td class="mdescRight">Type of input method callback functions. <a href="group__m17nInputMethod.html#ga2b9c7eab6cc379f1b21935640797dc83">More...</a><br /></td></tr>
<tr class="separator:ga2b9c7eab6cc379f1b21935640797dc83"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga55fdd3ec1e7a1ebcf84468c0637f4e42"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#ga55fdd3ec1e7a1ebcf84468c0637f4e42">MInputCandidatesChanged</a> { <br />
  <a class="el" href="group__m17nInputMethod.html#gga55fdd3ec1e7a1ebcf84468c0637f4e42a175a5183c1e25d8c885f0896200738fa">MINPUT_CANDIDATES_LIST_CHANGED</a> = 1
, <br />
  <a class="el" href="group__m17nInputMethod.html#gga55fdd3ec1e7a1ebcf84468c0637f4e42a59599bf8a86a08077f83d2451493d1ab">MINPUT_CANDIDATES_INDEX_CHANGED</a> = 2
, <br />
  <a class="el" href="group__m17nInputMethod.html#gga55fdd3ec1e7a1ebcf84468c0637f4e42a3bb5a55a5ccf58331afe4ef07f18dd58">MINPUT_CANDIDATES_SHOW_CHANGED</a> = 4
, <br />
  <a class="el" href="group__m17nInputMethod.html#gga55fdd3ec1e7a1ebcf84468c0637f4e42a7a525f8a61edaae9febe3884e496ab27">MINPUT_CANDIDATES_CHANGED_MAX</a>
<br />
}</td></tr>
<tr class="memdesc:ga55fdd3ec1e7a1ebcf84468c0637f4e42"><td class="mdescLeft"> </td><td class="mdescRight">Bit-masks to specify how candidates of input method is changed. <br />
<a href="group__m17nInputMethod.html#ga55fdd3ec1e7a1ebcf84468c0637f4e42">More...</a><br /></td></tr>
<tr class="separator:ga55fdd3ec1e7a1ebcf84468c0637f4e42"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:ga4f2d5dc3e6c637d18e2ecf24edfff456"><td class="memItemLeft" align="right" valign="top">MSymbol </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#ga4f2d5dc3e6c637d18e2ecf24edfff456">Minput_method</a></td></tr>
<tr class="memdesc:ga4f2d5dc3e6c637d18e2ecf24edfff456"><td class="mdescLeft"> </td><td class="mdescRight">Symbol whose name is "input-method". <a href="group__m17nInputMethod.html#ga4f2d5dc3e6c637d18e2ecf24edfff456">More...</a><br /></td></tr>
<tr class="separator:ga4f2d5dc3e6c637d18e2ecf24edfff456"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadb0ff8e5e616a810ed27113b17ad363b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structMInputDriver.html">MInputDriver</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#gadb0ff8e5e616a810ed27113b17ad363b">minput_default_driver</a></td></tr>
<tr class="memdesc:gadb0ff8e5e616a810ed27113b17ad363b"><td class="mdescLeft"> </td><td class="mdescRight">The default driver for internal input methods. <a href="group__m17nInputMethod.html#gadb0ff8e5e616a810ed27113b17ad363b">More...</a><br /></td></tr>
<tr class="separator:gadb0ff8e5e616a810ed27113b17ad363b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0e4d7a69ac0861d4b9b58990a0f03702"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structMInputDriver.html">MInputDriver</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#ga0e4d7a69ac0861d4b9b58990a0f03702">minput_driver</a></td></tr>
<tr class="memdesc:ga0e4d7a69ac0861d4b9b58990a0f03702"><td class="mdescLeft"> </td><td class="mdescRight">The driver for internal input methods. <a href="group__m17nInputMethod.html#ga0e4d7a69ac0861d4b9b58990a0f03702">More...</a><br /></td></tr>
<tr class="separator:ga0e4d7a69ac0861d4b9b58990a0f03702"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf03ec92f0d20d9bff8b9031461270d41"><td class="memItemLeft" align="right" valign="top">MSymbol </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#gaf03ec92f0d20d9bff8b9031461270d41">Minput_driver</a></td></tr>
<tr class="separator:gaf03ec92f0d20d9bff8b9031461270d41"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader">Variables: Predefined symbols for callback commands. <br></h2></td></tr>
<tr><td class="ititle" colspan="2"><p><a class="anchor" id="amgrp25052c81063b85d9ae708eee3cec638d"></a> These are the predefined symbols that are used as the <code>COMMAND</code> argument of callback functions of an input method driver (see <a class="el" href="structMInputDriver.html#a159fe7401cd0913dc8c480a18efeff64" title="List of callback functions.">MInputDriver::callback_list</a>). <br />
</p>
<p>Most of them do not require extra argument nor return any value; exceptions are these:</p>
<p><b>Minput_get_surrounding_text:</b> When a callback function assigned for this command is called, the first element of <a class="el" href="structMInputContext.html#a12f494b6550e5ec675c187766fb9e461">MInputContext::plist</a> has key <a class="el" href="group__m17nPlist.html#ga0ce08eb57aa339db4d4745e75e80fdd8" title="Symbol whose name is "integer".">Minteger</a> and the value specifies which portion of the surrounding text should be retrieved. If the value is positive, it specifies the number of characters following the current cursor position. If the value is negative, the absolute value specifies the number of characters preceding the current cursor position. If the value is zero, it means that the caller just wants to know if the surrounding text is currently supported or not.</p>
<p>If the surrounding text is currently supported, the callback function must set the key of this element to <a class="el" href="group__m17nPlist.html#ga1a22859374071a0ca66f12452afee8bd" title="Symbol whose name is "mtext".">Mtext</a> and the value to the retrieved M-text. The length of the M-text may be shorter than the requested number of characters, if the available text is not that long. The length can be zero in the worst case. Or, the length may be longer if an application thinks it is more efficient to return that length.</p>
<p>If the surrounding text is not currently supported, the callback function should return without changing the first element of <a class="el" href="structMInputContext.html#a12f494b6550e5ec675c187766fb9e461">MInputContext::plist</a>.</p>
<p><b>Minput_delete_surrounding_text:</b> When a callback function assigned for this command is called, the first element of <a class="el" href="structMInputContext.html#a12f494b6550e5ec675c187766fb9e461">MInputContext::plist</a> has key <a class="el" href="group__m17nPlist.html#ga0ce08eb57aa339db4d4745e75e80fdd8" title="Symbol whose name is "integer".">Minteger</a> and the value specifies which portion of the surrounding text should be deleted in the same way as the case of Minput_get_surrounding_text. The callback function must delete the specified text. It should not alter <a class="el" href="structMInputContext.html#a12f494b6550e5ec675c187766fb9e461">MInputContext::plist</a>. <br />
</p>
</td></tr>
<tr class="memitem:ga5516535b28981c4b02b33368f3d56d56"><td class="memItemLeft" align="right" valign="top">MSymbol </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#ga5516535b28981c4b02b33368f3d56d56">Minput_preedit_start</a></td></tr>
<tr class="separator:ga5516535b28981c4b02b33368f3d56d56"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3f96ecb6d7f7f82bc1ba5e47f8da0b92"><td class="memItemLeft" align="right" valign="top">MSymbol </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#ga3f96ecb6d7f7f82bc1ba5e47f8da0b92">Minput_preedit_done</a></td></tr>
<tr class="separator:ga3f96ecb6d7f7f82bc1ba5e47f8da0b92"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gacb0619c67c071d453dd2920ffc26d0ed"><td class="memItemLeft" align="right" valign="top">MSymbol </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#gacb0619c67c071d453dd2920ffc26d0ed">Minput_preedit_draw</a></td></tr>
<tr class="separator:gacb0619c67c071d453dd2920ffc26d0ed"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad3739f8097f1c52f10a8581828b7bb95"><td class="memItemLeft" align="right" valign="top">MSymbol </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#gad3739f8097f1c52f10a8581828b7bb95">Minput_status_start</a></td></tr>
<tr class="separator:gad3739f8097f1c52f10a8581828b7bb95"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga49febb92bb4320bc27f20043517f3169"><td class="memItemLeft" align="right" valign="top">MSymbol </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#ga49febb92bb4320bc27f20043517f3169">Minput_status_done</a></td></tr>
<tr class="separator:ga49febb92bb4320bc27f20043517f3169"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae75d45c1dbe0483768e9364af4d282f9"><td class="memItemLeft" align="right" valign="top">MSymbol </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#gae75d45c1dbe0483768e9364af4d282f9">Minput_status_draw</a></td></tr>
<tr class="separator:gae75d45c1dbe0483768e9364af4d282f9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6bb355b1b5521571056b96a854f3c6c8"><td class="memItemLeft" align="right" valign="top">MSymbol </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#ga6bb355b1b5521571056b96a854f3c6c8">Minput_candidates_start</a></td></tr>
<tr class="separator:ga6bb355b1b5521571056b96a854f3c6c8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6ff3deabad4489cef99fff428b2628e2"><td class="memItemLeft" align="right" valign="top">MSymbol </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#ga6ff3deabad4489cef99fff428b2628e2">Minput_candidates_done</a></td></tr>
<tr class="separator:ga6ff3deabad4489cef99fff428b2628e2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6bf782d7824557ec10e3988f6fcf4834"><td class="memItemLeft" align="right" valign="top">MSymbol </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#ga6bf782d7824557ec10e3988f6fcf4834">Minput_candidates_draw</a></td></tr>
<tr class="separator:ga6bf782d7824557ec10e3988f6fcf4834"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf19d77434bb1a12bdcb50f46448f1402"><td class="memItemLeft" align="right" valign="top">MSymbol </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#gaf19d77434bb1a12bdcb50f46448f1402">Minput_set_spot</a></td></tr>
<tr class="separator:gaf19d77434bb1a12bdcb50f46448f1402"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafa306a028998a972bf3a05c8609fe65e"><td class="memItemLeft" align="right" valign="top">MSymbol </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#gafa306a028998a972bf3a05c8609fe65e">Minput_toggle</a></td></tr>
<tr class="separator:gafa306a028998a972bf3a05c8609fe65e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5f07520efe1e533af2b2322fca2bc9a2"><td class="memItemLeft" align="right" valign="top">MSymbol </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#ga5f07520efe1e533af2b2322fca2bc9a2">Minput_reset</a></td></tr>
<tr class="separator:ga5f07520efe1e533af2b2322fca2bc9a2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1ca3d6e04f44fada82ed3c81069be23c"><td class="memItemLeft" align="right" valign="top">MSymbol </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#ga1ca3d6e04f44fada82ed3c81069be23c">Minput_get_surrounding_text</a></td></tr>
<tr class="separator:ga1ca3d6e04f44fada82ed3c81069be23c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab1bfef46ab8e9daa6f3cf53b912b7da8"><td class="memItemLeft" align="right" valign="top">MSymbol </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#gab1bfef46ab8e9daa6f3cf53b912b7da8">Minput_delete_surrounding_text</a></td></tr>
<tr class="separator:gab1bfef46ab8e9daa6f3cf53b912b7da8"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader">Variables: Predefined symbols for special input events.</h2></td></tr>
<tr><td class="ititle" colspan="2"><p><a class="anchor" id="amgrpc0c39849c0524dad7976cd7838b37822"></a> These are the predefined symbols that are used as the <code>KEY</code> argument of <a class="el" href="group__m17nInputMethod.html#ga6d9c3c97524114496fd8b7f70af92457" title="Filter an input key.">minput_filter()</a>. <br />
</p>
</td></tr>
<tr class="memitem:ga3edb37986f3bcdd15d73884c0d9b239b"><td class="memItemLeft" align="right" valign="top">MSymbol </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#ga3edb37986f3bcdd15d73884c0d9b239b">Minput_focus_out</a></td></tr>
<tr class="separator:ga3edb37986f3bcdd15d73884c0d9b239b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0d721c64e73c1e362f3cc44716b6c6ab"><td class="memItemLeft" align="right" valign="top">MSymbol </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#ga0d721c64e73c1e362f3cc44716b6c6ab">Minput_focus_in</a></td></tr>
<tr class="separator:ga0d721c64e73c1e362f3cc44716b6c6ab"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2b2dd61bcb633e89865ebeda1cd9f466"><td class="memItemLeft" align="right" valign="top">MSymbol </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#ga2b2dd61bcb633e89865ebeda1cd9f466">Minput_focus_move</a></td></tr>
<tr class="separator:ga2b2dd61bcb633e89865ebeda1cd9f466"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader">Variables: Predefined symbols used in input method information. <br></h2></td></tr>
<tr class="memitem:gaf84d56e3015c4b26802debcbd9352806"><td class="memItemLeft" align="right" valign="top">MSymbol </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#gaf84d56e3015c4b26802debcbd9352806">Minherited</a></td></tr>
<tr class="separator:gaf84d56e3015c4b26802debcbd9352806"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga07679cd0d5bf8e137d5dc554a30aa106"><td class="memItemLeft" align="right" valign="top">MSymbol </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#ga07679cd0d5bf8e137d5dc554a30aa106">Mcustomized</a></td></tr>
<tr class="separator:ga07679cd0d5bf8e137d5dc554a30aa106"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae01597fe66dfef937b4c5c47e54abbd0"><td class="memItemLeft" align="right" valign="top">MSymbol </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#gae01597fe66dfef937b4c5c47e54abbd0">Mconfigured</a></td></tr>
<tr class="separator:gae01597fe66dfef937b4c5c47e54abbd0"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader">Functions</h2></td></tr>
<tr class="memitem:ga34d3e527bfd705d2b7f2b749199c1e11"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structMInputMethod.html">MInputMethod</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#ga34d3e527bfd705d2b7f2b749199c1e11">minput_open_im</a> (MSymbol language, MSymbol name, void *arg)</td></tr>
<tr class="memdesc:ga34d3e527bfd705d2b7f2b749199c1e11"><td class="mdescLeft"> </td><td class="mdescRight">Open an input method. <a href="group__m17nInputMethod.html#ga34d3e527bfd705d2b7f2b749199c1e11">More...</a><br /></td></tr>
<tr class="separator:ga34d3e527bfd705d2b7f2b749199c1e11"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga373b415d157c2507f4ca4a864836e905"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#ga373b415d157c2507f4ca4a864836e905">minput_close_im</a> (<a class="el" href="structMInputMethod.html">MInputMethod</a> *im)</td></tr>
<tr class="memdesc:ga373b415d157c2507f4ca4a864836e905"><td class="mdescLeft"> </td><td class="mdescRight">Close an input method. <a href="group__m17nInputMethod.html#ga373b415d157c2507f4ca4a864836e905">More...</a><br /></td></tr>
<tr class="separator:ga373b415d157c2507f4ca4a864836e905"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8b32df84c645f73ed65e20a1d51c1859"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structMInputContext.html">MInputContext</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#ga8b32df84c645f73ed65e20a1d51c1859">minput_create_ic</a> (<a class="el" href="structMInputMethod.html">MInputMethod</a> *im, void *arg)</td></tr>
<tr class="memdesc:ga8b32df84c645f73ed65e20a1d51c1859"><td class="mdescLeft"> </td><td class="mdescRight">Create an input context. <a href="group__m17nInputMethod.html#ga8b32df84c645f73ed65e20a1d51c1859">More...</a><br /></td></tr>
<tr class="separator:ga8b32df84c645f73ed65e20a1d51c1859"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga80e4b330fb112883f2183d54b4e9c5bb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#ga80e4b330fb112883f2183d54b4e9c5bb">minput_destroy_ic</a> (<a class="el" href="structMInputContext.html">MInputContext</a> *ic)</td></tr>
<tr class="memdesc:ga80e4b330fb112883f2183d54b4e9c5bb"><td class="mdescLeft"> </td><td class="mdescRight">Destroy an input context. <a href="group__m17nInputMethod.html#ga80e4b330fb112883f2183d54b4e9c5bb">More...</a><br /></td></tr>
<tr class="separator:ga80e4b330fb112883f2183d54b4e9c5bb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6d9c3c97524114496fd8b7f70af92457"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#ga6d9c3c97524114496fd8b7f70af92457">minput_filter</a> (<a class="el" href="structMInputContext.html">MInputContext</a> *ic, MSymbol key, void *arg)</td></tr>
<tr class="memdesc:ga6d9c3c97524114496fd8b7f70af92457"><td class="mdescLeft"> </td><td class="mdescRight">Filter an input key. <a href="group__m17nInputMethod.html#ga6d9c3c97524114496fd8b7f70af92457">More...</a><br /></td></tr>
<tr class="separator:ga6d9c3c97524114496fd8b7f70af92457"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafe533480c705b877189938a0eecb1b57"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#gafe533480c705b877189938a0eecb1b57">minput_lookup</a> (<a class="el" href="structMInputContext.html">MInputContext</a> *ic, MSymbol key, void *arg, <a class="el" href="structMText.html">MText</a> *mt)</td></tr>
<tr class="memdesc:gafe533480c705b877189938a0eecb1b57"><td class="mdescLeft"> </td><td class="mdescRight">Look up a text produced in the input context. <a href="group__m17nInputMethod.html#gafe533480c705b877189938a0eecb1b57">More...</a><br /></td></tr>
<tr class="separator:gafe533480c705b877189938a0eecb1b57"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac12030bd2d5c265a7327a9487f9c1376"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#gac12030bd2d5c265a7327a9487f9c1376">minput_set_spot</a> (<a class="el" href="structMInputContext.html">MInputContext</a> *ic, int x, int y, int ascent, int descent, int fontsize, <a class="el" href="structMText.html">MText</a> *mt, int pos)</td></tr>
<tr class="memdesc:gac12030bd2d5c265a7327a9487f9c1376"><td class="mdescLeft"> </td><td class="mdescRight">Set the spot of the input context. <a href="group__m17nInputMethod.html#gac12030bd2d5c265a7327a9487f9c1376">More...</a><br /></td></tr>
<tr class="separator:gac12030bd2d5c265a7327a9487f9c1376"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga065a8f8e5a28180fd0fa6d160e07481b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#ga065a8f8e5a28180fd0fa6d160e07481b">minput_toggle</a> (<a class="el" href="structMInputContext.html">MInputContext</a> *ic)</td></tr>
<tr class="memdesc:ga065a8f8e5a28180fd0fa6d160e07481b"><td class="mdescLeft"> </td><td class="mdescRight">Toggle input method. <a href="group__m17nInputMethod.html#ga065a8f8e5a28180fd0fa6d160e07481b">More...</a><br /></td></tr>
<tr class="separator:ga065a8f8e5a28180fd0fa6d160e07481b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1c3c2263d2bb2d250b1f926f4b4c1db5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#ga1c3c2263d2bb2d250b1f926f4b4c1db5">minput_reset_ic</a> (<a class="el" href="structMInputContext.html">MInputContext</a> *ic)</td></tr>
<tr class="memdesc:ga1c3c2263d2bb2d250b1f926f4b4c1db5"><td class="mdescLeft"> </td><td class="mdescRight">Reset an input context. <a href="group__m17nInputMethod.html#ga1c3c2263d2bb2d250b1f926f4b4c1db5">More...</a><br /></td></tr>
<tr class="separator:ga1c3c2263d2bb2d250b1f926f4b4c1db5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa6ca1639d1d2cc56908cc6972d237f3a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structMPlist.html">MPlist</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#gaa6ca1639d1d2cc56908cc6972d237f3a">minput_get_title_icon</a> (MSymbol language, MSymbol name)</td></tr>
<tr class="memdesc:gaa6ca1639d1d2cc56908cc6972d237f3a"><td class="mdescLeft"> </td><td class="mdescRight">Get title and icon filename of an input method. <a href="group__m17nInputMethod.html#gaa6ca1639d1d2cc56908cc6972d237f3a">More...</a><br /></td></tr>
<tr class="separator:gaa6ca1639d1d2cc56908cc6972d237f3a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4a80b81791850c2445992e6e4fd7fa1b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structMText.html">MText</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#ga4a80b81791850c2445992e6e4fd7fa1b">minput_get_description</a> (MSymbol language, MSymbol name)</td></tr>
<tr class="memdesc:ga4a80b81791850c2445992e6e4fd7fa1b"><td class="mdescLeft"> </td><td class="mdescRight">Get description text of an input method. <a href="group__m17nInputMethod.html#ga4a80b81791850c2445992e6e4fd7fa1b">More...</a><br /></td></tr>
<tr class="separator:ga4a80b81791850c2445992e6e4fd7fa1b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4472e21e6a1e65056f5815c3ce36e41b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structMPlist.html">MPlist</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#ga4472e21e6a1e65056f5815c3ce36e41b">minput_get_command</a> (MSymbol language, MSymbol name, MSymbol command)</td></tr>
<tr class="separator:ga4472e21e6a1e65056f5815c3ce36e41b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa5de29f63f6eb770059c2f55ce8237ed"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#gaa5de29f63f6eb770059c2f55ce8237ed">minput_config_command</a> (MSymbol language, MSymbol name, MSymbol command, <a class="el" href="structMPlist.html">MPlist</a> *keyseqlist)</td></tr>
<tr class="separator:gaa5de29f63f6eb770059c2f55ce8237ed"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga09c8aea172323731cd3e946b3ef43a50"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structMPlist.html">MPlist</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#ga09c8aea172323731cd3e946b3ef43a50">minput_get_variable</a> (MSymbol language, MSymbol name, MSymbol variable)</td></tr>
<tr class="separator:ga09c8aea172323731cd3e946b3ef43a50"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga15f7939874de15330d3d9aa0c450e424"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#ga15f7939874de15330d3d9aa0c450e424">minput_config_variable</a> (MSymbol language, MSymbol name, MSymbol variable, <a class="el" href="structMPlist.html">MPlist</a> *value)</td></tr>
<tr class="memdesc:ga15f7939874de15330d3d9aa0c450e424"><td class="mdescLeft"> </td><td class="mdescRight">Configure the value of an input method variable. <a href="group__m17nInputMethod.html#ga15f7939874de15330d3d9aa0c450e424">More...</a><br /></td></tr>
<tr class="separator:ga15f7939874de15330d3d9aa0c450e424"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5bf6821ca0d9bb5a738aba60225e247d"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#ga5bf6821ca0d9bb5a738aba60225e247d">minput_config_file</a> ()</td></tr>
<tr class="memdesc:ga5bf6821ca0d9bb5a738aba60225e247d"><td class="mdescLeft"> </td><td class="mdescRight">Get the name of per-user customization file. <a href="group__m17nInputMethod.html#ga5bf6821ca0d9bb5a738aba60225e247d">More...</a><br /></td></tr>
<tr class="separator:ga5bf6821ca0d9bb5a738aba60225e247d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga08b59a97ca5194abfb04dc4cc96919d6"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#ga08b59a97ca5194abfb04dc4cc96919d6">minput_save_config</a> (void)</td></tr>
<tr class="memdesc:ga08b59a97ca5194abfb04dc4cc96919d6"><td class="mdescLeft"> </td><td class="mdescRight">Save configurations in per-user customization file. <a href="group__m17nInputMethod.html#ga08b59a97ca5194abfb04dc4cc96919d6">More...</a><br /></td></tr>
<tr class="separator:ga08b59a97ca5194abfb04dc4cc96919d6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf3a27feb1cab27ce0bdf7768d6bebe38"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structMPlist.html">MPlist</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#gaf3a27feb1cab27ce0bdf7768d6bebe38">minput_list</a> (MSymbol language)</td></tr>
<tr class="separator:gaf3a27feb1cab27ce0bdf7768d6bebe38"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader">Obsolete functions</h2></td></tr>
<tr class="memitem:gab6d3ebaf43705f994aebb990feada7aa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structMPlist.html">MPlist</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#gab6d3ebaf43705f994aebb990feada7aa">minput_get_variables</a> (MSymbol language, MSymbol name)</td></tr>
<tr class="separator:gab6d3ebaf43705f994aebb990feada7aa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaec5679f07f92df8aba39e49fc90341bd"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#gaec5679f07f92df8aba39e49fc90341bd">minput_set_variable</a> (MSymbol language, MSymbol name, MSymbol variable, void *value)</td></tr>
<tr class="memdesc:gaec5679f07f92df8aba39e49fc90341bd"><td class="mdescLeft"> </td><td class="mdescRight">Set the initial value of an input method variable. <a href="group__m17nInputMethod.html#gaec5679f07f92df8aba39e49fc90341bd">More...</a><br /></td></tr>
<tr class="separator:gaec5679f07f92df8aba39e49fc90341bd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga63f6d2d105b01b7721f732b2433ea78e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structMPlist.html">MPlist</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#ga63f6d2d105b01b7721f732b2433ea78e">minput_get_commands</a> (MSymbol language, MSymbol name)</td></tr>
<tr class="memdesc:ga63f6d2d105b01b7721f732b2433ea78e"><td class="mdescLeft"> </td><td class="mdescRight">Get information about input method commands. <a href="group__m17nInputMethod.html#ga63f6d2d105b01b7721f732b2433ea78e">More...</a><br /></td></tr>
<tr class="separator:ga63f6d2d105b01b7721f732b2433ea78e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga617c6a8028c05381f4f8a0ec781f1855"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#ga617c6a8028c05381f4f8a0ec781f1855">minput_assign_command_keys</a> (MSymbol language, MSymbol name, MSymbol command, <a class="el" href="structMPlist.html">MPlist</a> *keyseq)</td></tr>
<tr class="memdesc:ga617c6a8028c05381f4f8a0ec781f1855"><td class="mdescLeft"> </td><td class="mdescRight">Assign a key sequence to an input method command (obsolete). <a href="group__m17nInputMethod.html#ga617c6a8028c05381f4f8a0ec781f1855">More...</a><br /></td></tr>
<tr class="separator:ga617c6a8028c05381f4f8a0ec781f1855"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7d429265a08a1ca8fa55c7ebfcfad6f7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structMPlist.html">MPlist</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#ga7d429265a08a1ca8fa55c7ebfcfad6f7">minput_parse_im_names</a> (<a class="el" href="structMText.html">MText</a> *mt)</td></tr>
<tr class="memdesc:ga7d429265a08a1ca8fa55c7ebfcfad6f7"><td class="mdescLeft"> </td><td class="mdescRight">Parse input method names. <a href="group__m17nInputMethod.html#ga7d429265a08a1ca8fa55c7ebfcfad6f7">More...</a><br /></td></tr>
<tr class="separator:ga7d429265a08a1ca8fa55c7ebfcfad6f7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga955cd9e0b9fd8cf426aed3f3584337ff"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethod.html#ga955cd9e0b9fd8cf426aed3f3584337ff">minput_callback</a> (<a class="el" href="structMInputContext.html">MInputContext</a> *ic, MSymbol command)</td></tr>
<tr class="memdesc:ga955cd9e0b9fd8cf426aed3f3584337ff"><td class="mdescLeft"> </td><td class="mdescRight">Call a callback function. <a href="group__m17nInputMethod.html#ga955cd9e0b9fd8cf426aed3f3584337ff">More...</a><br /></td></tr>
<tr class="separator:ga955cd9e0b9fd8cf426aed3f3584337ff"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>API for Input method. </p>
<p><br />
</p>
<p>An input method is an object to enable inputting various characters. An input method is identified by a pair of symbols, LANGUAGE and NAME. This pair decides an input method driver of the input method. An input method driver is a set of functions for handling the input method. There are two kinds of input methods; internal one and foreign one.</p>
<ul>
<li>
<p class="startli">Internal Input Method</p>
<p class="interli">An internal input method has non <code>Mnil</code> LANGUAGE, and its body is defined in the m17n database by the tag <Minput_method, LANGUAGE, NAME>. For this kind of input methods, the m17n library uses two predefined input method drivers, one for CUI use and the other for GUI use. Those drivers utilize the input processing engine provided by the m17n library itself. The m17n database may provide input methods that are not limited to a specific language. The database uses <code>Mt</code> as LANGUAGE of those input methods.</p>
<p class="interli">An internal input method accepts an input key which is a symbol associated with an input event. As there is no way for the <code>m17n</code> <code>library</code> to know how input events are represented in an application program, an application programmer has to convert an input event to an input key by himself. See the documentation of the function <a class="el" href="group__m17nInputMethodWin.html#ga58715c630a04fd33f12394e9c93f1bad" title="Convert an event to an input key.">minput_event_to_key()</a> for the detail.</p>
<p class="endli"></p>
</li>
<li>
<p class="startli">Foreign Input Method<a class="anchor" id="foreign-input-method"></a> A foreign input method has <code>Mnil</code> LANGUAGE, and its body is defined in an external resource (e.g. XIM of X Window System). For this kind of input methods, the symbol NAME must have a property of key <a class="el" href="group__m17nInputMethod.html#gaf03ec92f0d20d9bff8b9031461270d41">Minput_driver</a>, and the value must be a pointer to an input method driver. Therefore, by preparing a proper driver, any kind of input method can be treated in the framework of the <code>m17n</code> <code>library</code>.</p>
<p class="interli">For convenience, the m17n-X library provides an input method driver that enables the input style of OverTheSpot for XIM, and stores <a class="el" href="group__m17nInputMethod.html#gaf03ec92f0d20d9bff8b9031461270d41">Minput_driver</a> property of the symbol <code>Mxim</code> with a pointer to the driver. See the documentation of m17n GUI API for the detail.</p>
<p class="endli"></p>
</li>
</ul>
<p>PROCESSING FLOW</p>
<p>The typical processing flow of handling an input method is:</p>
<ul>
<li>open an input method </li>
<li>create an input context for the input method </li>
<li>filter an input key </li>
<li>look up a produced text in the input context <br />
</li>
</ul>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ga2b9c7eab6cc379f1b21935640797dc83"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2b9c7eab6cc379f1b21935640797dc83">◆ </a></span>MInputCallbackFunc</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* MInputCallbackFunc) (<a class="el" href="structMInputContext.html">MInputContext</a> *ic, MSymbol command)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Type of input method callback functions. </p>
<p>This is the type of callback functions called from input method drivers. <b>ic</b> is a pointer to an input context, <b>command</b> is a name of callback for which the function is called. <br />
</p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="ga55fdd3ec1e7a1ebcf84468c0637f4e42"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga55fdd3ec1e7a1ebcf84468c0637f4e42">◆ </a></span>MInputCandidatesChanged</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__m17nInputMethod.html#ga55fdd3ec1e7a1ebcf84468c0637f4e42">MInputCandidatesChanged</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Bit-masks to specify how candidates of input method is changed. <br />
</p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga55fdd3ec1e7a1ebcf84468c0637f4e42a175a5183c1e25d8c885f0896200738fa"></a>MINPUT_CANDIDATES_LIST_CHANGED </td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="gga55fdd3ec1e7a1ebcf84468c0637f4e42a59599bf8a86a08077f83d2451493d1ab"></a>MINPUT_CANDIDATES_INDEX_CHANGED </td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="gga55fdd3ec1e7a1ebcf84468c0637f4e42a3bb5a55a5ccf58331afe4ef07f18dd58"></a>MINPUT_CANDIDATES_SHOW_CHANGED </td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="gga55fdd3ec1e7a1ebcf84468c0637f4e42a7a525f8a61edaae9febe3884e496ab27"></a>MINPUT_CANDIDATES_CHANGED_MAX </td><td class="fielddoc"></td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga34d3e527bfd705d2b7f2b749199c1e11"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga34d3e527bfd705d2b7f2b749199c1e11">◆ </a></span>minput_open_im()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structMInputMethod.html">MInputMethod</a>* minput_open_im </td>
<td>(</td>
<td class="paramtype">MSymbol </td>
<td class="paramname"><em>language</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">MSymbol </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>arg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Open an input method. </p>
<p>The <a class="el" href="group__m17nInputMethod.html#ga34d3e527bfd705d2b7f2b749199c1e11" title="Open an input method.">minput_open_im()</a> function opens an input method whose language and name match <b>language</b> and <b>name</b>, and returns a pointer to the input method object newly allocated.</p>
<p>This function at first decides a driver for the input method as described below.</p>
<p>If <b>language</b> is not <a class="el" href="group__m17nSymbol.html#ga0346fc05efcccc8f11271b51c0fe3eeb" title="Symbol whose name is "nil".">Mnil</a>, the driver pointed by the variable <a class="el" href="group__m17nInputMethod.html#ga0e4d7a69ac0861d4b9b58990a0f03702" title="The driver for internal input methods.">minput_driver</a> is used.</p>
<p>If <b>language</b> is <a class="el" href="group__m17nSymbol.html#ga0346fc05efcccc8f11271b51c0fe3eeb" title="Symbol whose name is "nil".">Mnil</a> and <b>name</b> has the property <a class="el" href="group__m17nInputMethod.html#gaf03ec92f0d20d9bff8b9031461270d41">Minput_driver</a>, the driver pointed to by the property value is used to open the input method. If <b>name</b> has no such a property, <code>NULL</code> is returned.</p>
<p>Then, the member <a class="el" href="structMInputDriver.html#adab132de1505f5945e55f5a4f00805e4" title="Open an input method.">MInputDriver::open_im()</a> of the driver is called. <br />
</p>
<p><b>arg</b> is set in the member <code>arg</code> of the structure <a class="el" href="structMInputMethod.html" title="Structure of input method.">MInputMethod</a> so that the driver can refer to it. <br />
</p>
</div>
</div>
<a id="ga373b415d157c2507f4ca4a864836e905"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga373b415d157c2507f4ca4a864836e905">◆ </a></span>minput_close_im()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void minput_close_im </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structMInputMethod.html">MInputMethod</a> * </td>
<td class="paramname"><em>im</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Close an input method. </p>
<p>The <a class="el" href="group__m17nInputMethod.html#ga373b415d157c2507f4ca4a864836e905" title="Close an input method.">minput_close_im()</a> function closes the input method <b>im</b>, which must have been created by <a class="el" href="group__m17nInputMethod.html#ga34d3e527bfd705d2b7f2b749199c1e11" title="Open an input method.">minput_open_im()</a>. <br />
</p>
</div>
</div>
<a id="ga8b32df84c645f73ed65e20a1d51c1859"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8b32df84c645f73ed65e20a1d51c1859">◆ </a></span>minput_create_ic()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structMInputContext.html">MInputContext</a>* minput_create_ic </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structMInputMethod.html">MInputMethod</a> * </td>
<td class="paramname"><em>im</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>arg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create an input context. </p>
<p>The <a class="el" href="group__m17nInputMethod.html#ga8b32df84c645f73ed65e20a1d51c1859" title="Create an input context.">minput_create_ic()</a> function creates an input context object associated with input method <b>im</b>, and calls callback functions corresponding to <b>Minput_preedit_start</b>, <b>Minput_status_start</b>, and <b>Minput_status_draw</b> in this order.</p>
<dl class="section user"><dt>Return value:</dt><dd>If an input context is successfully created, <a class="el" href="group__m17nInputMethod.html#ga8b32df84c645f73ed65e20a1d51c1859" title="Create an input context.">minput_create_ic()</a> returns a pointer to it. Otherwise it returns <code>NULL</code>. <br />
</dd></dl>
</div>
</div>
<a id="ga80e4b330fb112883f2183d54b4e9c5bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga80e4b330fb112883f2183d54b4e9c5bb">◆ </a></span>minput_destroy_ic()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void minput_destroy_ic </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structMInputContext.html">MInputContext</a> * </td>
<td class="paramname"><em>ic</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroy an input context. </p>
<p>The <a class="el" href="group__m17nInputMethod.html#ga80e4b330fb112883f2183d54b4e9c5bb" title="Destroy an input context.">minput_destroy_ic()</a> function destroys the input context <b>ic</b>, which must have been created by <a class="el" href="group__m17nInputMethod.html#ga8b32df84c645f73ed65e20a1d51c1859" title="Create an input context.">minput_create_ic()</a>. It calls callback functions corresponding to <b>Minput_preedit_done</b>, <b>Minput_status_done</b>, and <b>Minput_candidates_done</b> in this order. <br />
</p>
</div>
</div>
<a id="ga6d9c3c97524114496fd8b7f70af92457"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6d9c3c97524114496fd8b7f70af92457">◆ </a></span>minput_filter()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int minput_filter </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structMInputContext.html">MInputContext</a> * </td>
<td class="paramname"><em>ic</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">MSymbol </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>arg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Filter an input key. </p>
<p>The <a class="el" href="group__m17nInputMethod.html#ga6d9c3c97524114496fd8b7f70af92457" title="Filter an input key.">minput_filter()</a> function filters input key <b>key</b> according to input context <b>ic</b>, and calls callback functions corresponding to <b>Minput_preedit_draw</b>, <b>Minput_status_draw</b>, and <b>Minput_candidates_draw</b> if the preedit text, the status, and the current candidate are changed respectively.</p>
<p>To make the input method commit the current preedit text (if any) and shift to the initial state, call this function with <a class="el" href="group__m17nSymbol.html#ga0346fc05efcccc8f11271b51c0fe3eeb" title="Symbol whose name is "nil".">Mnil</a> as <b>key</b>.</p>
<p>To inform the input method about the focus-out event, call this function with <b>Minput_focus_out</b> as <b>key</b>.</p>
<p>To inform the input method about the focus-in event, call this function with <b>Minput_focus_in</b> as <b>key</b>.</p>
<p>To inform the input method about the focus-move event (i.e. input spot change within the same input context), call this function with <b>Minput_focus_move</b> as <b>key</b>.</p>
<dl class="section user"><dt>Return value:</dt><dd>If <b>key</b> is filtered out, this function returns 1. In that case, the caller should discard the key. Otherwise, it returns 0, and the caller should handle the key, for instance, by calling the function <a class="el" href="group__m17nInputMethod.html#gafe533480c705b877189938a0eecb1b57" title="Look up a text produced in the input context.">minput_lookup()</a> with the same key. <br />
</dd></dl>
</div>
</div>
<a id="gafe533480c705b877189938a0eecb1b57"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafe533480c705b877189938a0eecb1b57">◆ </a></span>minput_lookup()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int minput_lookup </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structMInputContext.html">MInputContext</a> * </td>
<td class="paramname"><em>ic</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">MSymbol </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>arg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structMText.html">MText</a> * </td>
<td class="paramname"><em>mt</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Look up a text produced in the input context. </p>
<p>The <a class="el" href="group__m17nInputMethod.html#gafe533480c705b877189938a0eecb1b57" title="Look up a text produced in the input context.">minput_lookup()</a> function looks up a text in the input context <b>ic</b>. <b>key</b> must be identical to the one that was used in the previous call of <a class="el" href="group__m17nInputMethod.html#ga6d9c3c97524114496fd8b7f70af92457" title="Filter an input key.">minput_filter()</a>.</p>
<p>If a text was produced by the input method, it is concatenated to M-text <b>mt</b>.</p>
<p>This function calls <a class="el" href="structMInputDriver.html#acf5fa6a15099d9d4f6888046ad634bb4" title="Lookup a produced text in an input context.">MInputDriver::lookup</a> .</p>
<dl class="section user"><dt>Return value:</dt><dd>If <b>key</b> was correctly handled by the input method, this function returns 0. Otherwise, it returns -1, even though some text might be produced in <b>mt</b>. <br />
</dd></dl>
</div>
</div>
<a id="gac12030bd2d5c265a7327a9487f9c1376"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac12030bd2d5c265a7327a9487f9c1376">◆ </a></span>minput_set_spot()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void minput_set_spot </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structMInputContext.html">MInputContext</a> * </td>
<td class="paramname"><em>ic</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>ascent</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>descent</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>fontsize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structMText.html">MText</a> * </td>
<td class="paramname"><em>mt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>pos</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the spot of the input context. </p>
<p>The <a class="el" href="group__m17nInputMethod.html#gac12030bd2d5c265a7327a9487f9c1376" title="Set the spot of the input context.">minput_set_spot()</a> function sets the spot of input context <b>ic</b> to coordinate (<b>x</b>, <b>y</b> ) with the height specified by <b>ascent</b> and <b>descent</b> . The semantics of these values depends on the input method driver.</p>
<p>For instance, a driver designed to work in a CUI environment may use <b>x</b> and <b>y</b> as the column- and row numbers, and may ignore <b>ascent</b> and <b>descent</b> . A driver designed to work in a window system may interpret <b>x</b> and <b>y</b> as the pixel offsets relative to the origin of the client window, and may interpret <b>ascent</b> and <b>descent</b> as the ascent- and descent pixels of the line at (<b>x</b> . <b>y</b> ).</p>
<p><b>fontsize</b> specifies the fontsize of preedit text in 1/10 point.</p>
<p><b>mt</b> and <b>pos</b> are the M-text and the character position at the spot. <b>mt</b> may be <code>NULL</code>, in which case, the input method cannot get information about the text around the spot. <br />
</p>
</div>
</div>
<a id="ga065a8f8e5a28180fd0fa6d160e07481b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga065a8f8e5a28180fd0fa6d160e07481b">◆ </a></span>minput_toggle()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void minput_toggle </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structMInputContext.html">MInputContext</a> * </td>
<td class="paramname"><em>ic</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Toggle input method. </p>
<p>The <a class="el" href="group__m17nInputMethod.html#ga065a8f8e5a28180fd0fa6d160e07481b" title="Toggle input method.">minput_toggle()</a> function toggles the input method associated with input context <b>ic</b>. <br />
</p>
</div>
</div>
<a id="ga1c3c2263d2bb2d250b1f926f4b4c1db5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1c3c2263d2bb2d250b1f926f4b4c1db5">◆ </a></span>minput_reset_ic()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void minput_reset_ic </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structMInputContext.html">MInputContext</a> * </td>
<td class="paramname"><em>ic</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reset an input context. </p>
<p>The <a class="el" href="group__m17nInputMethod.html#ga1c3c2263d2bb2d250b1f926f4b4c1db5" title="Reset an input context.">minput_reset_ic()</a> function resets input context <b>ic</b> by calling a callback function corresponding to <b>Minput_reset</b>. It resets the status of <b>ic</b> to its initial one. As the current preedit text is deleted without commitment, if necessary, call <a class="el" href="group__m17nInputMethod.html#ga6d9c3c97524114496fd8b7f70af92457" title="Filter an input key.">minput_filter()</a> with the arg <b>key</b> <a class="el" href="group__m17nSymbol.html#ga0346fc05efcccc8f11271b51c0fe3eeb" title="Symbol whose name is "nil".">Mnil</a> to force the input method to commit the preedit in advance. <br />
</p>
</div>
</div>
<a id="gaa6ca1639d1d2cc56908cc6972d237f3a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa6ca1639d1d2cc56908cc6972d237f3a">◆ </a></span>minput_get_title_icon()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structMPlist.html">MPlist</a>* minput_get_title_icon </td>
<td>(</td>
<td class="paramtype">MSymbol </td>
<td class="paramname"><em>language</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">MSymbol </td>
<td class="paramname"><em>name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get title and icon filename of an input method. </p>
<p>The <a class="el" href="group__m17nInputMethod.html#gaa6ca1639d1d2cc56908cc6972d237f3a" title="Get title and icon filename of an input method.">minput_get_title_icon()</a> function returns a plist containing a title and icon filename (if any) of an input method specified by <b>language</b> and <b>name</b>.</p>
<p>The first element of the plist has key <a class="el" href="group__m17nPlist.html#ga1a22859374071a0ca66f12452afee8bd" title="Symbol whose name is "mtext".">Mtext</a> and the value is an M-text of the title for identifying the input method. The second element (if any) has key <a class="el" href="group__m17nPlist.html#ga1a22859374071a0ca66f12452afee8bd" title="Symbol whose name is "mtext".">Mtext</a> and the value is an M-text of the icon image (absolute) filename for the same purpose.</p>
<dl class="section user"><dt>Return value:</dt><dd>If there exists a specified input method and it defines an title, a plist is returned. Otherwise, NULL is returned. The caller must free the plist by <a class="el" href="group__m17nObject.html#ga248ba287a615a2cf3cdb99c13275453b" title="Decrement the reference count of a managed object.">m17n_object_unref()</a>. <br />
</dd></dl>
</div>
</div>
<a id="ga4a80b81791850c2445992e6e4fd7fa1b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4a80b81791850c2445992e6e4fd7fa1b">◆ </a></span>minput_get_description()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structMText.html">MText</a>* minput_get_description </td>
<td>(</td>
<td class="paramtype">MSymbol </td>
<td class="paramname"><em>language</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">MSymbol </td>
<td class="paramname"><em>name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get description text of an input method. </p>
<p>The <a class="el" href="group__m17nInputMethod.html#ga4a80b81791850c2445992e6e4fd7fa1b" title="Get description text of an input method.">minput_get_description()</a> function returns an M-text that describes the input method specified by <b>language</b> and <b>name</b>.</p>
<dl class="section user"><dt>Return value:</dt><dd>If the specified input method has a description text, a pointer to <a class="el" href="structMText.html" title="Type of M-texts.">MText</a> is returned. The caller has to free it by <a class="el" href="group__m17nObject.html#ga248ba287a615a2cf3cdb99c13275453b" title="Decrement the reference count of a managed object.">m17n_object_unref()</a>. If the input method does not have a description text, <code>NULL</code> is returned. <br />
</dd></dl>
</div>
</div>
<a id="ga4472e21e6a1e65056f5815c3ce36e41b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4472e21e6a1e65056f5815c3ce36e41b">◆ </a></span>minput_get_command()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structMPlist.html">MPlist</a>* minput_get_command </td>
<td>(</td>
<td class="paramtype">MSymbol </td>
<td class="paramname"><em>language</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">MSymbol </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">MSymbol </td>
<td class="paramname"><em>command</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">@brief Get information about input method command(s).
The minput_get_command() function returns information about
the command @b command of the input method specified by @b language and
@b name. An input method command is a pseudo key event to which one
or more actual input key sequences are assigned.
There are two kinds of commands, global and local. A global
command has a global definition, and the description and the key
assignment may be inherited by a local command. Each input method
defines a local command which has a local key assignment. It may
also declare a local command that inherits the definition of a
global command of the same name.
If @b language is #Mt and @b name is #Mnil, this function returns
information about a global command. Otherwise information about a
local command is returned.
If @b command is #Mnil, information about all commands is returned.
The return value is a @e well-formed plist (@ref m17nPlist) of this
format:
</pre> <pre class="fragment"> ((NAME DESCRIPTION STATUS [KEYSEQ ...]) ...)
</pre><p> <code>NAME</code> is a symbol representing the command name.</p>
<p><code>DESCRIPTION</code> is an M-text describing the command, or <a class="el" href="group__m17nSymbol.html#ga0346fc05efcccc8f11271b51c0fe3eeb" title="Symbol whose name is "nil".">Mnil</a> if the command has no description.</p>
<p><code>STATUS</code> is a symbol representing how the key assignment is decided. The value is <a class="el" href="group__m17nSymbol.html#ga0346fc05efcccc8f11271b51c0fe3eeb" title="Symbol whose name is "nil".">Mnil</a> (the default key assignment), <b>Mcustomized</b> (the key assignment is customized by per-user customization file), or <b>Mconfigured</b> (the key assignment is set by the call of <a class="el" href="group__m17nInputMethod.html#gaa5de29f63f6eb770059c2f55ce8237ed">minput_config_command()</a>). For a local command only, it may also be <b>Minherited</b> (the key assignment is inherited from the corresponding global command).</p>
<p><code>KEYSEQ</code> is a plist of one or more symbols representing a key sequence assigned to the command. If there's no KEYSEQ, the command is currently disabled (i.e. no key sequence can trigger actions of the command).</p>
<p>If <b>command</b> is not <a class="el" href="group__m17nSymbol.html#ga0346fc05efcccc8f11271b51c0fe3eeb" title="Symbol whose name is "nil".">Mnil</a>, the first element of the returned plist contains the information about <b>command</b>.</p>
<dl class="section user"><dt>Return value:</dt><dd></dd></dl>
<p>If the requested information was found, a pointer to a non-empty plist is returned. As the plist is kept in the library, the caller must not modify nor free it.</p>
<p>Otherwise (the specified input method or the specified command does not exist), <code>NULL</code> is returned. <br />
</p>
<dl class="section user"><dt>Example:</dt><dd><div class="fragment"><div class="line"><a class="code" href="structMText.html">MText</a> *</div>
<div class="line">get_im_command_description (MSymbol language, MSymbol name, MSymbol command)</div>
<div class="line">{</div>
<div class="line"> <span class="comment">/* Return a description of the command COMMAND of the input method</span></div>
<div class="line"><span class="comment"> specified by LANGUAGE and NAME. */</span></div>
<div class="line"> <a class="code" href="structMPlist.html">MPlist</a> *cmd = <a class="code" href="group__m17nInputMethod.html#ga4472e21e6a1e65056f5815c3ce36e41b">minput_get_command</a> (language, name, command);</div>
<div class="line"> <a class="code" href="structMPlist.html">MPlist</a> *plist;</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (! cmds)</div>
<div class="line"> <span class="keywordflow">return</span> NULL;</div>
<div class="line"> plist = <a class="code" href="group__m17nPlist.html#ga855f3010b216bcf5f0914553fc034295">mplist_value</a> (cmds); <span class="comment">/* (NAME DESCRIPTION STATUS KEY-SEQ ...) */</span></div>
<div class="line"> plist = <a class="code" href="group__m17nPlist.html#ga5c7598c133f6a177a2ad5781fc712f6e">mplist_next</a> (plist); <span class="comment">/* (DESCRIPTION STATUS KEY-SEQ ...) */</span></div>
<div class="line"> <span class="keywordflow">return</span> (<a class="code" href="group__m17nPlist.html#ga79d757b26382412e7ea69e914bc06a07">mplist_key</a> (plist) == <a class="code" href="group__m17nPlist.html#ga1a22859374071a0ca66f12452afee8bd">Mtext</a></div>
<div class="line"> ? (<a class="code" href="structMText.html">MText</a> *) <a class="code" href="group__m17nPlist.html#ga855f3010b216bcf5f0914553fc034295">mplist_value</a> (plist)</div>
<div class="line"> : NULL);</div>
<div class="line">}</div>
<div class="ttc" id="agroup__m17nInputMethod_html_ga4472e21e6a1e65056f5815c3ce36e41b"><div class="ttname"><a href="group__m17nInputMethod.html#ga4472e21e6a1e65056f5815c3ce36e41b">minput_get_command</a></div><div class="ttdeci">MPlist * minput_get_command(MSymbol language, MSymbol name, MSymbol command)</div><div class="ttdef"><b>Definition:</b> input.c:4356</div></div>
<div class="ttc" id="agroup__m17nPlist_html_ga1a22859374071a0ca66f12452afee8bd"><div class="ttname"><a href="group__m17nPlist.html#ga1a22859374071a0ca66f12452afee8bd">Mtext</a></div><div class="ttdeci">MSymbol Mtext</div><div class="ttdoc">Symbol whose name is "mtext".</div><div class="ttdef"><b>Definition:</b> plist.c:734</div></div>
<div class="ttc" id="agroup__m17nPlist_html_ga5c7598c133f6a177a2ad5781fc712f6e"><div class="ttname"><a href="group__m17nPlist.html#ga5c7598c133f6a177a2ad5781fc712f6e">mplist_next</a></div><div class="ttdeci">MPlist * mplist_next(MPlist *plist)</div><div class="ttdoc">Return the next sublist of a property list.</div><div class="ttdef"><b>Definition:</b> plist.c:1012</div></div>
<div class="ttc" id="agroup__m17nPlist_html_ga79d757b26382412e7ea69e914bc06a07"><div class="ttname"><a href="group__m17nPlist.html#ga79d757b26382412e7ea69e914bc06a07">mplist_key</a></div><div class="ttdeci">MSymbol mplist_key(MPlist *plist)</div><div class="ttdoc">Return the key of the first property in a property list.</div><div class="ttdef"><b>Definition:</b> plist.c:1075</div></div>
<div class="ttc" id="agroup__m17nPlist_html_ga855f3010b216bcf5f0914553fc034295"><div class="ttname"><a href="group__m17nPlist.html#ga855f3010b216bcf5f0914553fc034295">mplist_value</a></div><div class="ttdeci">void * mplist_value(MPlist *plist)</div><div class="ttdoc">Return the value of the first property in a property list.</div><div class="ttdef"><b>Definition:</b> plist.c:1087</div></div>
<div class="ttc" id="astructMPlist_html"><div class="ttname"><a href="structMPlist.html">MPlist</a></div><div class="ttdoc">Type of property list objects.</div><div class="ttdef"><b>Definition:</b> plist.h:4</div></div>
<div class="ttc" id="astructMText_html"><div class="ttname"><a href="structMText.html">MText</a></div><div class="ttdoc">Type of M-texts.</div><div class="ttdef"><b>Definition:</b> internal.h:287</div></div>
</div><!-- fragment --> </dd></dl>
</div>
</div>
<a id="gaa5de29f63f6eb770059c2f55ce8237ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa5de29f63f6eb770059c2f55ce8237ed">◆ </a></span>minput_config_command()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int minput_config_command </td>
<td>(</td>
<td class="paramtype">MSymbol </td>
<td class="paramname"><em>language</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">MSymbol </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">MSymbol </td>
<td class="paramname"><em>command</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structMPlist.html">MPlist</a> * </td>
<td class="paramname"><em>keyseqlist</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">@brief Configure the key sequence of an input method command.
The minput_config_command() function assigns a list of key
sequences @b keyseqlist to the command @b command of the input method
specified by @b language and @b name.
If @b keyseqlist is a non-empty plist, it must be a list of key
sequences, and each key sequence must be a plist of symbols.
If @b keyseqlist is an empty plist, any configuration and
customization of the command are cancelled, and default key
sequences become effective.
If @b keyseqlist is NULL, the configuration of the command is
canceled, and the original key sequences (what saved in per-user
customization file, or the default one) become effective.
In the latter two cases, @b command can be #Mnil to make all the
commands of the input method the target of the operation.
If @b name is #Mnil, this function configures the key assignment of a
global command, not that of a specific input method.
The configuration takes effect for input methods opened or
re-opened later in the current session. In order to make the
configuration take effect for the future session, it must be saved
in a per-user customization file by the function
minput_save_config().
@par Return value:
If the operation was successful, this function returns 0,
otherwise returns -1. The operation fails in these cases:
<ul>
<li>@b keyseqlist is not in a valid form.
<li>@b command is not available for the input method.
<li>@b language and @b name do not specify an existing input method.
</ul>
@par See Also:
minput_get_commands(), minput_save_config().
</pre><dl class="section user"><dt>Example:</dt><dd><div class="fragment"><div class="line"><span class="comment">/* Add "C-x u" to the "start" command of Unicode input method. */</span></div>
<div class="line">{</div>
<div class="line"> MSymbol start_command = <a class="code" href="group__m17nSymbol.html#ga0f19d07c2dd83d37705ca628caaf8cd1">msymbol</a> (<span class="stringliteral">"start"</span>);</div>
<div class="line"> MSymbol unicode = <a class="code" href="group__m17nSymbol.html#ga0f19d07c2dd83d37705ca628caaf8cd1">msymbol</a> (<span class="stringliteral">"unicode"</span>);</div>
<div class="line"> <a class="code" href="structMPlist.html">MPlist</a> *cmd, *plist, *key_seq_list, *key_seq;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* At first get the current key-sequence assignment. */</span></div>
<div class="line"> cmd = <a class="code" href="group__m17nInputMethod.html#ga4472e21e6a1e65056f5815c3ce36e41b">minput_get_command</a> (<a class="code" href="group__m17nSymbol.html#ga8769a573efbb023b4d77f9d03babc09f">Mt</a>, unicode, start_command);</div>
<div class="line"> <span class="keywordflow">if</span> (! cmd)</div>
<div class="line"> {</div>
<div class="line"> <span class="comment">/* The input method does not have the command "start". Here</span></div>
<div class="line"><span class="comment"> should come some error handling code. */</span></div>
<div class="line"> }</div>
<div class="line"> <span class="comment">/* Now CMD == ((start DESCRIPTION STATUS KEY-SEQUENCE ...) ...).</span></div>
<div class="line"><span class="comment"> Extract the part (KEY-SEQUENCE ...). */</span></div>
<div class="line"> plist = <a class="code" href="group__m17nPlist.html#ga5c7598c133f6a177a2ad5781fc712f6e">mplist_next</a> (<a class="code" href="group__m17nPlist.html#ga5c7598c133f6a177a2ad5781fc712f6e">mplist_next</a> (<a class="code" href="group__m17nPlist.html#ga5c7598c133f6a177a2ad5781fc712f6e">mplist_next</a> (<a class="code" href="group__m17nPlist.html#ga855f3010b216bcf5f0914553fc034295">mplist_value</a> (cmd))));</div>
<div class="line"> <span class="comment">/* Copy it because we should not modify it directly. */</span></div>
<div class="line"> key_seq_list = <a class="code" href="group__m17nPlist.html#ga03cb2253e439ec15d0bbbac6f86f0e37">mplist_copy</a> (plist);</div>
<div class="line"> </div>
<div class="line"> key_seq = <a class="code" href="group__m17nPlist.html#ga86cff73047b6462271d086f7365782ff">mplist</a>();</div>
<div class="line"> <a class="code" href="group__m17nPlist.html#gaf5d13d2df5af9260356aa415e3965def">mplist_add</a> (key_seq, <a class="code" href="group__m17nSymbol.html#ga6592d4eb3c46fe7fb8993c252b8fedeb">Msymbol</a>, <a class="code" href="group__m17nSymbol.html#ga0f19d07c2dd83d37705ca628caaf8cd1">msymbol</a> (<span class="stringliteral">"C-x"</span>));</div>
<div class="line"> <a class="code" href="group__m17nPlist.html#gaf5d13d2df5af9260356aa415e3965def">mplist_add</a> (key_seq, <a class="code" href="group__m17nSymbol.html#ga6592d4eb3c46fe7fb8993c252b8fedeb">Msymbol</a>, <a class="code" href="group__m17nSymbol.html#ga0f19d07c2dd83d37705ca628caaf8cd1">msymbol</a> (<span class="stringliteral">"u"</span>));</div>
<div class="line"> <a class="code" href="group__m17nPlist.html#gaf5d13d2df5af9260356aa415e3965def">mplist_add</a> (key_seq_list, <a class="code" href="group__m17nPlist.html#ga933000e154873f9bfcaa56d976bd259b">Mplist</a>, key_seq);</div>
<div class="line"> <a class="code" href="group__m17nObject.html#ga248ba287a615a2cf3cdb99c13275453b">m17n_object_unref</a> (key_seq);</div>
<div class="line"> </div>
<div class="line"> <a class="code" href="group__m17nInputMethod.html#gaa5de29f63f6eb770059c2f55ce8237ed">minput_config_command</a> (<a class="code" href="group__m17nSymbol.html#ga8769a573efbb023b4d77f9d03babc09f">Mt</a>, unicode, start_command, key_seq_list);</div>
<div class="line"> <a class="code" href="group__m17nObject.html#ga248ba287a615a2cf3cdb99c13275453b">m17n_object_unref</a> (key_seq_list);</div>
<div class="line">}</div>
<div class="ttc" id="agroup__m17nInputMethod_html_gaa5de29f63f6eb770059c2f55ce8237ed"><div class="ttname"><a href="group__m17nInputMethod.html#gaa5de29f63f6eb770059c2f55ce8237ed">minput_config_command</a></div><div class="ttdeci">int minput_config_command(MSymbol language, MSymbol name, MSymbol command, MPlist *keyseq)</div><div class="ttdef"><b>Definition:</b> input.c:4446</div></div>
<div class="ttc" id="agroup__m17nObject_html_ga248ba287a615a2cf3cdb99c13275453b"><div class="ttname"><a href="group__m17nObject.html#ga248ba287a615a2cf3cdb99c13275453b">m17n_object_unref</a></div><div class="ttdeci">int m17n_object_unref(void *object)</div><div class="ttdoc">Decrement the reference count of a managed object.</div><div class="ttdef"><b>Definition:</b> m17n-core.c:599</div></div>
<div class="ttc" id="agroup__m17nPlist_html_ga03cb2253e439ec15d0bbbac6f86f0e37"><div class="ttname"><a href="group__m17nPlist.html#ga03cb2253e439ec15d0bbbac6f86f0e37">mplist_copy</a></div><div class="ttdeci">MPlist * mplist_copy(MPlist *plist)</div><div class="ttdoc">Copy a property list.</div><div class="ttdef"><b>Definition:</b> plist.c:768</div></div>
<div class="ttc" id="agroup__m17nPlist_html_ga86cff73047b6462271d086f7365782ff"><div class="ttname"><a href="group__m17nPlist.html#ga86cff73047b6462271d086f7365782ff">mplist</a></div><div class="ttdeci">MPlist * mplist()</div><div class="ttdoc">Create a property list object.</div><div class="ttdef"><b>Definition:</b> plist.c:748</div></div>
<div class="ttc" id="agroup__m17nPlist_html_ga933000e154873f9bfcaa56d976bd259b"><div class="ttname"><a href="group__m17nPlist.html#ga933000e154873f9bfcaa56d976bd259b">Mplist</a></div><div class="ttdeci">MSymbol Mplist</div><div class="ttdoc">Symbol whose name is "plist".</div><div class="ttdef"><b>Definition:</b> plist.c:726</div></div>
<div class="ttc" id="agroup__m17nPlist_html_gaf5d13d2df5af9260356aa415e3965def"><div class="ttname"><a href="group__m17nPlist.html#gaf5d13d2df5af9260356aa415e3965def">mplist_add</a></div><div class="ttdeci">MPlist * mplist_add(MPlist *plist, MSymbol key, void *val)</div><div class="ttdoc">Add a property at the end of a property list.</div><div class="ttdef"><b>Definition:</b> plist.c:891</div></div>
<div class="ttc" id="agroup__m17nSymbol_html_ga0f19d07c2dd83d37705ca628caaf8cd1"><div class="ttname"><a href="group__m17nSymbol.html#ga0f19d07c2dd83d37705ca628caaf8cd1">msymbol</a></div><div class="ttdeci">MSymbol msymbol(const char *name)</div><div class="ttdoc">Get a symbol.</div><div class="ttdef"><b>Definition:</b> symbol.c:249</div></div>
<div class="ttc" id="agroup__m17nSymbol_html_ga6592d4eb3c46fe7fb8993c252b8fedeb"><div class="ttname"><a href="group__m17nSymbol.html#ga6592d4eb3c46fe7fb8993c252b8fedeb">Msymbol</a></div><div class="ttdeci">MSymbol Msymbol</div><div class="ttdoc">Symbol whose name is "symbol".</div><div class="ttdef"><b>Definition:</b> symbol.c:228</div></div>
<div class="ttc" id="agroup__m17nSymbol_html_ga8769a573efbb023b4d77f9d03babc09f"><div class="ttname"><a href="group__m17nSymbol.html#ga8769a573efbb023b4d77f9d03babc09f">Mt</a></div><div class="ttdeci">MSymbol Mt</div><div class="ttdoc">Symbol whose name is "t".</div><div class="ttdef"><b>Definition:</b> symbol.c:212</div></div>
</div><!-- fragment --> </dd></dl>
</div>
</div>
<a id="ga09c8aea172323731cd3e946b3ef43a50"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga09c8aea172323731cd3e946b3ef43a50">◆ </a></span>minput_get_variable()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structMPlist.html">MPlist</a>* minput_get_variable </td>
<td>(</td>
<td class="paramtype">MSymbol </td>
<td class="paramname"><em>language</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">MSymbol </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">MSymbol </td>
<td class="paramname"><em>variable</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">@brief Get information about input method variable(s).
The minput_get_variable() function returns information about
variable @b variable of the input method specified by @b language and @b name.
An input method variable controls behavior of an input method.
There are two kinds of variables, global and local. A global
variable has a global definition, and the description and the value
may be inherited by a local variable. Each input method defines a
local variable which has local value. It may also declare a
local variable that inherits definition of a global variable of
the same name.
If @b language is #Mt and @b name is #Mnil, information about a global
variable is returned. Otherwise information about a local variable
is returned.
If @b variable is #Mnil, information about all variables is
returned.
The return value is a @e well-formed plist (@ref m17nPlist) of this
format:
</pre> <pre class="fragment"> ((NAME DESCRIPTION STATUS VALUE [VALID-VALUE ...]) ...)
</pre><p> <code>NAME</code> is a symbol representing the variable name.</p>
<p><code>DESCRIPTION</code> is an M-text describing the variable, or <a class="el" href="group__m17nSymbol.html#ga0346fc05efcccc8f11271b51c0fe3eeb" title="Symbol whose name is "nil".">Mnil</a> if the variable has no description.</p>
<p><code>STATUS</code> is a symbol representing how the value is decided. The value is <a class="el" href="group__m17nSymbol.html#ga0346fc05efcccc8f11271b51c0fe3eeb" title="Symbol whose name is "nil".">Mnil</a> (the default value), <b>Mcustomized</b> (the value is customized by per-user customization file), or <b>Mconfigured</b> (the value is set by the call of <a class="el" href="group__m17nInputMethod.html#ga15f7939874de15330d3d9aa0c450e424" title="Configure the value of an input method variable.">minput_config_variable()</a>). For a local variable only, it may also be <b>Minherited</b> (the value is inherited from the corresponding global variable).</p>
<p><code>VALUE</code> is the initial value of the variable. If the key of this element is <a class="el" href="group__m17nSymbol.html#ga8769a573efbb023b4d77f9d03babc09f" title="Symbol whose name is "t".">Mt</a>, the variable has no initial value. Otherwise, the key is <a class="el" href="group__m17nPlist.html#ga0ce08eb57aa339db4d4745e75e80fdd8" title="Symbol whose name is "integer".">Minteger</a>, <a class="el" href="group__m17nSymbol.html#ga6592d4eb3c46fe7fb8993c252b8fedeb" title="Symbol whose name is "symbol".">Msymbol</a>, or <a class="el" href="group__m17nPlist.html#ga1a22859374071a0ca66f12452afee8bd" title="Symbol whose name is "mtext".">Mtext</a> and the value is of the corresponding type.</p>
<p><code>VALID-VALUEs</code> (if any) specify which values the variable can have. They have the same type (i.e. having the same key) as <code>VALUE</code> except for the case that VALUE is an integer. In that case, <code>VALID-VALUE</code> may be a plist of two integers specifying the range of possible values.</p>
<p>If there no <code>VALID-VALUE</code>, the variable can have any value as long as the type is the same as <code>VALUE</code>.</p>
<p>If <b>variable</b> is not <a class="el" href="group__m17nSymbol.html#ga0346fc05efcccc8f11271b51c0fe3eeb" title="Symbol whose name is "nil".">Mnil</a>, the first element of the returned plist contains the information about <b>variable</b>.</p>
<dl class="section user"><dt>Return value:</dt><dd></dd></dl>
<p>If the requested information was found, a pointer to a non-empty plist is returned. As the plist is kept in the library, the caller must not modify nor free it.</p>
<p>Otherwise (the specified input method or the specified variable does not exist), <code>NULL</code> is returned. <br />
</p>
</div>
</div>
<a id="ga15f7939874de15330d3d9aa0c450e424"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga15f7939874de15330d3d9aa0c450e424">◆ </a></span>minput_config_variable()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int minput_config_variable </td>
<td>(</td>
<td class="paramtype">MSymbol </td>
<td class="paramname"><em>language</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">MSymbol </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">MSymbol </td>
<td class="paramname"><em>variable</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structMPlist.html">MPlist</a> * </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Configure the value of an input method variable. </p>
<p>The <a class="el" href="group__m17nInputMethod.html#ga15f7939874de15330d3d9aa0c450e424" title="Configure the value of an input method variable.">minput_config_variable()</a> function assigns <b>value</b> to the variable <b>variable</b> of the input method specified by <b>language</b> and <b>name</b>.</p>
<p>If <b>value</b> is a non-empty plist, it must be a plist of one element whose key is <a class="el" href="group__m17nPlist.html#ga0ce08eb57aa339db4d4745e75e80fdd8" title="Symbol whose name is "integer".">Minteger</a>, <a class="el" href="group__m17nSymbol.html#ga6592d4eb3c46fe7fb8993c252b8fedeb" title="Symbol whose name is "symbol".">Msymbol</a>, or <a class="el" href="group__m17nPlist.html#ga1a22859374071a0ca66f12452afee8bd" title="Symbol whose name is "mtext".">Mtext</a>, and the value is of the corresponding type. That value is assigned to the variable.</p>
<p>If <b>value</b> is an empty plist, any configuration and customization of the variable are canceled, and the default value is assigned to the variable.</p>
<p>If <b>value</b> is NULL, the configuration of the variable is canceled, and the original value (what saved in per-user customization file, or the default value) is assigned to the variable.</p>
<p>In the latter two cases, <b>variable</b> can be <a class="el" href="group__m17nSymbol.html#ga0346fc05efcccc8f11271b51c0fe3eeb" title="Symbol whose name is "nil".">Mnil</a> to make all the variables of the input method the target of the operation.</p>
<p>If <b>name</b> is <a class="el" href="group__m17nSymbol.html#ga0346fc05efcccc8f11271b51c0fe3eeb" title="Symbol whose name is "nil".">Mnil</a>, this function configures the value of global variable, not that of a specific input method.</p>
<p>The configuration takes effect for input methods opened or re-opened later in the current session. To make the configuration take effect for the future session, it must be saved in a per-user customization file by the function <a class="el" href="group__m17nInputMethod.html#ga08b59a97ca5194abfb04dc4cc96919d6" title="Save configurations in per-user customization file.">minput_save_config()</a>.</p>
<dl class="section user"><dt>Return value:</dt><dd></dd></dl>
<p>If the operation was successful, this function returns 0, otherwise returns -1. The operation fails in these cases: </p><ul>
<li>
<b>value</b> is not in a valid form, the type does not match the definition, or the value is our of range. </li>
<li>
<b>variable</b> is not available for the input method. </li>
<li>
<b>language</b> and <b>name</b> do not specify an existing input method. <br />
</li>
</ul>
<dl class="section user"><dt>See Also:</dt><dd><a class="el" href="group__m17nInputMethod.html#ga09c8aea172323731cd3e946b3ef43a50">minput_get_variable()</a>, <a class="el" href="group__m17nInputMethod.html#ga08b59a97ca5194abfb04dc4cc96919d6" title="Save configurations in per-user customization file.">minput_save_config()</a>. <br />
</dd></dl>
</div>
</div>
<a id="ga5bf6821ca0d9bb5a738aba60225e247d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5bf6821ca0d9bb5a738aba60225e247d">◆ </a></span>minput_config_file()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* minput_config_file </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the name of per-user customization file. </p>
<p>The <a class="el" href="group__m17nInputMethod.html#ga5bf6821ca0d9bb5a738aba60225e247d" title="Get the name of per-user customization file.">minput_config_file()</a> function returns the absolute path name of per-user customization file into which <a class="el" href="group__m17nInputMethod.html#ga08b59a97ca5194abfb04dc4cc96919d6" title="Save configurations in per-user customization file.">minput_save_config()</a> save configurations. It is usually <code>config.mic</code> under the directory <code>${HOME}/.m17n.d</code> (${HOME} is user's home directory). It is not assured that the file of the returned name exists nor is readable/writable. If <a class="el" href="group__m17nInputMethod.html#ga08b59a97ca5194abfb04dc4cc96919d6" title="Save configurations in per-user customization file.">minput_save_config()</a> fails and returns -1, an application program might check the file, make it writable (if possible), and try <a class="el" href="group__m17nInputMethod.html#ga08b59a97ca5194abfb04dc4cc96919d6" title="Save configurations in per-user customization file.">minput_save_config()</a> again.</p>
<dl class="section user"><dt>Return value:</dt><dd></dd></dl>
<p>This function returns a string. As the string is kept in the library, the caller must not modify nor free it.</p>
<dl class="section user"><dt>See Also:</dt><dd><a class="el" href="group__m17nInputMethod.html#ga08b59a97ca5194abfb04dc4cc96919d6" title="Save configurations in per-user customization file.">minput_save_config()</a> </dd></dl>
</div>
</div>
<a id="ga08b59a97ca5194abfb04dc4cc96919d6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga08b59a97ca5194abfb04dc4cc96919d6">◆ </a></span>minput_save_config()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int minput_save_config </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Save configurations in per-user customization file. </p>
<p>The <a class="el" href="group__m17nInputMethod.html#ga08b59a97ca5194abfb04dc4cc96919d6" title="Save configurations in per-user customization file.">minput_save_config()</a> function saves the configurations done so far in the current session into the per-user customization file.</p>
<dl class="section user"><dt>Return value:</dt><dd></dd></dl>
<p>If the operation was successful, 1 is returned. If the per-user customization file is currently locked, 0 is returned. In that case, the caller may wait for a while and try again. If the configuration file is not writable, -1 is returned. In that case, the caller may check the name of the file by calling <a class="el" href="group__m17nInputMethod.html#ga5bf6821ca0d9bb5a738aba60225e247d" title="Get the name of per-user customization file.">minput_config_file()</a>, make it writable if possible, and try again.</p>
<dl class="section user"><dt>See Also:</dt><dd><a class="el" href="group__m17nInputMethod.html#ga5bf6821ca0d9bb5a738aba60225e247d" title="Get the name of per-user customization file.">minput_config_file()</a> <br />
</dd></dl>
</div>
</div>
<a id="gaf3a27feb1cab27ce0bdf7768d6bebe38"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf3a27feb1cab27ce0bdf7768d6bebe38">◆ </a></span>minput_list()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structMPlist.html">MPlist</a>* minput_list </td>
<td>(</td>
<td class="paramtype">MSymbol </td>
<td class="paramname"><em>language</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">@brief List available input methods.
The minput_list() function returns a list of currently available
input methods whose language is @b language. If @b language is #Mnil,
all input methods are listed.
@par Return value:
The returned value is a plist of this form:
((LANGUAGE-NAME INPUT-METHOD-NAME SANE) ...)
The third element SANE of each input method is #Mt if it can be
successfully used, or #Mnil if it has some problem (e.g. syntax
error of MIM file, unavailable external module, unavailable
including input method).
</pre><dl class="section user"><dt>Example:</dt><dd><div class="fragment"><div class="line"><span class="preprocessor">#include <stdio.h></span></div>
<div class="line"><span class="preprocessor">#include <string.h></span></div>
<div class="line"><span class="preprocessor">#include <<a class="code" href="m17n_8h.html">m17n.h</a>></span></div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">int</span></div>
<div class="line">main (<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span> **argv)</div>
<div class="line">{</div>
<div class="line"> <a class="code" href="structMPlist.html">MPlist</a> *imlist, *pl;</div>
<div class="line"> </div>
<div class="line"> <a class="code" href="group__m17nIntro.html#ga66879b35a1fee08b3e5966f6650c39f9">M17N_INIT</a>();</div>
<div class="line"> imlist = <a class="code" href="group__m17nInputMethod.html#gaf3a27feb1cab27ce0bdf7768d6bebe38">minput_list</a> ((argc > 1) ? <a class="code" href="group__m17nSymbol.html#ga0f19d07c2dd83d37705ca628caaf8cd1">msymbol</a> (argv[1]) : <a class="code" href="group__m17nSymbol.html#ga0346fc05efcccc8f11271b51c0fe3eeb">Mnil</a>);</div>
<div class="line"> <span class="keywordflow">for</span> (pl = imlist; <a class="code" href="group__m17nPlist.html#ga79d757b26382412e7ea69e914bc06a07">mplist_key</a> (pl) != <a class="code" href="group__m17nSymbol.html#ga0346fc05efcccc8f11271b51c0fe3eeb">Mnil</a>; pl = <a class="code" href="group__m17nPlist.html#ga5c7598c133f6a177a2ad5781fc712f6e">mplist_next</a> (pl))</div>
<div class="line"> {</div>
<div class="line"> <a class="code" href="structMPlist.html">MPlist</a> *p = <a class="code" href="group__m17nPlist.html#ga855f3010b216bcf5f0914553fc034295">mplist_value</a> (pl);</div>
<div class="line"> MSymbol lang, name, sane;</div>
<div class="line"> </div>
<div class="line"> lang = <a class="code" href="group__m17nPlist.html#ga855f3010b216bcf5f0914553fc034295">mplist_value</a> (p);</div>
<div class="line"> p = <a class="code" href="group__m17nPlist.html#ga5c7598c133f6a177a2ad5781fc712f6e">mplist_next</a> (p);</div>
<div class="line"> name = <a class="code" href="group__m17nPlist.html#ga855f3010b216bcf5f0914553fc034295">mplist_value</a> (p);</div>
<div class="line"> p = <a class="code" href="group__m17nPlist.html#ga5c7598c133f6a177a2ad5781fc712f6e">mplist_next</a> (p);</div>
<div class="line"> sane = <a class="code" href="group__m17nPlist.html#ga855f3010b216bcf5f0914553fc034295">mplist_value</a> (p);</div>
<div class="line"> </div>
<div class="line"> printf (<span class="stringliteral">"%s %s %s\n"</span>, <a class="code" href="group__m17nSymbol.html#ga551d4628363900cad49a908b598b821b">msymbol_name</a> (lang), <a class="code" href="group__m17nSymbol.html#ga551d4628363900cad49a908b598b821b">msymbol_name</a> (name),</div>
<div class="line"> sane == <a class="code" href="group__m17nSymbol.html#ga8769a573efbb023b4d77f9d03babc09f">Mt</a> ? <span class="stringliteral">"ok"</span> : <span class="stringliteral">"no"</span>);</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <a class="code" href="group__m17nObject.html#ga248ba287a615a2cf3cdb99c13275453b">m17n_object_unref</a> (imlist);</div>
<div class="line"> <a class="code" href="group__m17nIntro.html#gac1e2228145ac9d98c6cf4fea8e9d84d4">M17N_FINI</a>();</div>
<div class="line"> exit (0);</div>
<div class="line">}</div>
<div class="ttc" id="agroup__m17nInputMethod_html_gaf3a27feb1cab27ce0bdf7768d6bebe38"><div class="ttname"><a href="group__m17nInputMethod.html#gaf3a27feb1cab27ce0bdf7768d6bebe38">minput_list</a></div><div class="ttdeci">MPlist * minput_list(MSymbol lang)</div><div class="ttdef"><b>Definition:</b> input.c:5079</div></div>
<div class="ttc" id="agroup__m17nIntro_html_ga66879b35a1fee08b3e5966f6650c39f9"><div class="ttname"><a href="group__m17nIntro.html#ga66879b35a1fee08b3e5966f6650c39f9">M17N_INIT</a></div><div class="ttdeci">#define M17N_INIT()</div><div class="ttdoc">Initialize the m17n library.</div><div class="ttdef"><b>Definition:</b> m17n-core.c:170</div></div>
<div class="ttc" id="agroup__m17nIntro_html_gac1e2228145ac9d98c6cf4fea8e9d84d4"><div class="ttname"><a href="group__m17nIntro.html#gac1e2228145ac9d98c6cf4fea8e9d84d4">M17N_FINI</a></div><div class="ttdeci">#define M17N_FINI()</div><div class="ttdoc">Finalize the m17n library.</div><div class="ttdef"><b>Definition:</b> m17n-core.c:185</div></div>
<div class="ttc" id="agroup__m17nSymbol_html_ga0346fc05efcccc8f11271b51c0fe3eeb"><div class="ttname"><a href="group__m17nSymbol.html#ga0346fc05efcccc8f11271b51c0fe3eeb">Mnil</a></div><div class="ttdeci">MSymbol Mnil</div><div class="ttdoc">Symbol whose name is "nil".</div><div class="ttdef"><b>Definition:</b> symbol.c:205</div></div>
<div class="ttc" id="agroup__m17nSymbol_html_ga551d4628363900cad49a908b598b821b"><div class="ttname"><a href="group__m17nSymbol.html#ga551d4628363900cad49a908b598b821b">msymbol_name</a></div><div class="ttdeci">char * msymbol_name(MSymbol symbol)</div><div class="ttdef"><b>Definition:</b> symbol.c:379</div></div>
<div class="ttc" id="am17n_8h_html"><div class="ttname"><a href="m17n_8h.html">m17n.h</a></div></div>
</div><!-- fragment --> </dd></dl>
</div>
</div>
<a id="gab6d3ebaf43705f994aebb990feada7aa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab6d3ebaf43705f994aebb990feada7aa">◆ </a></span>minput_get_variables()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structMPlist.html">MPlist</a>* minput_get_variables </td>
<td>(</td>
<td class="paramtype">MSymbol </td>
<td class="paramname"><em>language</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">MSymbol </td>
<td class="paramname"><em>name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">@brief Get a list of variables of an input method (obsolete).
This function is obsolete. Use minput_get_variable() instead.
The minput_get_variables() function returns a plist (#MPlist) of
variables used to control the behavior of the input method
specified by @b language and @b name. The plist is @e well-formed
(@ref m17nPlist) of the following format:
</pre> <pre class="fragment"> (VARNAME (DOC-MTEXT DEFAULT-VALUE [ VALUE ... ] )
VARNAME (DOC-MTEXT DEFAULT-VALUE [ VALUE ... ] )
...)
</pre> <pre class="fragment">@c VARNAME is a symbol representing the variable name.
@c DOC-MTEXT is an M-text describing the variable.
@c DEFAULT-VALUE is the default value of the variable. It is a
symbol, integer, or M-text.
@c VALUEs (if any) specifies the possible values of the variable.
If @c DEFAULT-VALUE is an integer, @c VALUE may be a plist (@c FROM
@c TO), where @c FROM and @c TO specifies a range of possible
values.
For instance, suppose an input method has the variables:
@li name:intvar, description:"value is an integer",
initial value:0, value-range:0..3,10,20
@li name:symvar, description:"value is a symbol",
initial value:nil, value-range:a, b, c, nil
@li name:txtvar, description:"value is an M-text",
initial value:empty text, no value-range (i.e. any text)
Then, the returned plist is as follows.
</pre> <pre class="fragment"> (intvar ("value is an integer" 0 (0 3) 10 20)
symvar ("value is a symbol" nil a b c nil)
txtvar ("value is an M-text" ""))
</pre> <pre class="fragment">@par Return value:
If the input method uses any variables, a pointer to #MPlist is
returned. As the plist is kept in the library, the caller must not
modify nor free it. If the input method does not use any
variable, @c NULL is returned.
</pre>
</div>
</div>
<a id="gaec5679f07f92df8aba39e49fc90341bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaec5679f07f92df8aba39e49fc90341bd">◆ </a></span>minput_set_variable()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int minput_set_variable </td>
<td>(</td>
<td class="paramtype">MSymbol </td>
<td class="paramname"><em>language</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">MSymbol </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">MSymbol </td>
<td class="paramname"><em>variable</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the initial value of an input method variable. </p>
<p>The <a class="el" href="group__m17nInputMethod.html#gaec5679f07f92df8aba39e49fc90341bd" title="Set the initial value of an input method variable.">minput_set_variable()</a> function sets the initial value of input method variable <b>variable</b> to <b>value</b> for the input method specified by <b>language</b> and <b>name</b>.</p>
<p>By default, the initial value is 0.</p>
<p>This setting gets effective in a newly opened input method.</p>
<dl class="section user"><dt>Return value:</dt><dd>If the operation was successful, 0 is returned. Otherwise -1 is returned, and <a class="el" href="group__m17nError.html#ga995a2e373cfd6a8e5eaca8686b5b0a73" title="External variable to hold error code of the m17n library.">merror_code</a> is set to <code>MERROR_IM</code>. <br />
</dd></dl>
</div>
</div>
<a id="ga63f6d2d105b01b7721f732b2433ea78e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga63f6d2d105b01b7721f732b2433ea78e">◆ </a></span>minput_get_commands()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structMPlist.html">MPlist</a>* minput_get_commands </td>
<td>(</td>
<td class="paramtype">MSymbol </td>
<td class="paramname"><em>language</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">MSymbol </td>
<td class="paramname"><em>name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get information about input method commands. </p>
<p>The <a class="el" href="group__m17nInputMethod.html#ga63f6d2d105b01b7721f732b2433ea78e" title="Get information about input method commands.">minput_get_commands()</a> function returns information about input method commands of the input method specified by <b>language</b> and <b>name</b>. An input method command is a pseudo key event to which one or more actual input key sequences are assigned.</p>
<p>There are two kinds of commands, global and local. Global commands are used by multiple input methods for the same purpose, and have global key assignments. Local commands are used only by a specific input method, and have only local key assignments.</p>
<p>Each input method may locally change key assignments for global commands. The global key assignment for a global command is effective only when the current input method does not have local key assignments for that command.</p>
<p>If <b>name</b> is <a class="el" href="group__m17nSymbol.html#ga0346fc05efcccc8f11271b51c0fe3eeb" title="Symbol whose name is "nil".">Mnil</a>, information about global commands is returned. In this case <b>language</b> is ignored.</p>
<p>If <b>name</b> is not <a class="el" href="group__m17nSymbol.html#ga0346fc05efcccc8f11271b51c0fe3eeb" title="Symbol whose name is "nil".">Mnil</a>, information about those commands that have local key assignments in the input method specified by <b>language</b> and <b>name</b> is returned.</p>
<dl class="section user"><dt>Return value:</dt><dd>If no input method commands are found, this function returns <code>NULL</code>.</dd></dl>
<p>Otherwise, a pointer to a plist is returned. The key of each element in the plist is a symbol representing a command, and the value is a plist of the form COMMAND-INFO described below.</p>
<p>The first element of COMMAND-INFO has the key <a class="el" href="group__m17nPlist.html#ga1a22859374071a0ca66f12452afee8bd" title="Symbol whose name is "mtext".">Mtext</a>, and the value is an M-text describing the command.</p>
<p>If there are no more elements, that means no key sequences are assigned to the command. Otherwise, each of the remaining elements has the key <a class="el" href="group__m17nPlist.html#ga933000e154873f9bfcaa56d976bd259b" title="Symbol whose name is "plist".">Mplist</a>, and the value is a plist whose keys are <a class="el" href="group__m17nSymbol.html#ga6592d4eb3c46fe7fb8993c252b8fedeb" title="Symbol whose name is "symbol".">Msymbol</a> and values are symbols representing input keys, which are currently assigned to the command.</p>
<p>As the returned plist is kept in the library, the caller must not modify nor free it. <br />
</p>
</div>
</div>
<a id="ga617c6a8028c05381f4f8a0ec781f1855"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga617c6a8028c05381f4f8a0ec781f1855">◆ </a></span>minput_assign_command_keys()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int minput_assign_command_keys </td>
<td>(</td>
<td class="paramtype">MSymbol </td>
<td class="paramname"><em>language</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">MSymbol </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">MSymbol </td>
<td class="paramname"><em>command</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structMPlist.html">MPlist</a> * </td>
<td class="paramname"><em>keyseq</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Assign a key sequence to an input method command (obsolete). </p>
<p>This function is obsolete. Use <a class="el" href="group__m17nInputMethod.html#gaa5de29f63f6eb770059c2f55ce8237ed">minput_config_command()</a> instead.</p>
<p>The <a class="el" href="group__m17nInputMethod.html#ga617c6a8028c05381f4f8a0ec781f1855" title="Assign a key sequence to an input method command (obsolete).">minput_assign_command_keys()</a> function assigns input key sequence <b>keyseq</b> to input method command <b>command</b> for the input method specified by <b>language</b> and <b>name</b>. If <b>name</b> is <a class="el" href="group__m17nSymbol.html#ga0346fc05efcccc8f11271b51c0fe3eeb" title="Symbol whose name is "nil".">Mnil</a>, the key sequence is assigned globally no matter what <b>language</b> is. Otherwise the key sequence is assigned locally.</p>
<p>Each element of <b>keyseq</b> must have the key <b>msymbol</b> and the value must be a symbol representing an input key.</p>
<p><b>keyseq</b> may be <code>NULL</code>, in which case, all assignments are deleted globally or locally.</p>
<p>This assignment gets effective in a newly opened input method.</p>
<dl class="section user"><dt>Return value:</dt><dd>If the operation was successful, 0 is returned. Otherwise -1 is returned, and <a class="el" href="group__m17nError.html#ga995a2e373cfd6a8e5eaca8686b5b0a73" title="External variable to hold error code of the m17n library.">merror_code</a> is set to <code>MERROR_IM</code>. <br />
</dd></dl>
</div>
</div>
<a id="ga7d429265a08a1ca8fa55c7ebfcfad6f7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7d429265a08a1ca8fa55c7ebfcfad6f7">◆ </a></span>minput_parse_im_names()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structMPlist.html">MPlist</a>* minput_parse_im_names </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structMText.html">MText</a> * </td>
<td class="paramname"><em>mt</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Parse input method names. </p>
<p>The <a class="el" href="group__m17nInputMethod.html#ga7d429265a08a1ca8fa55c7ebfcfad6f7" title="Parse input method names.">minput_parse_im_names()</a> function parses M-text <b>mt</b> and returns a list of input method names. Input method names in <b>mt</b> must be separated by comma (","). Input methods whose language is <a class="el" href="group__m17nSymbol.html#ga8769a573efbb023b4d77f9d03babc09f" title="Symbol whose name is "t".">Mt</a> can be specified by its name only (i.e. just "latn-post" instead of "t-latn-post").</p>
<dl class="section user"><dt>Return value:</dt><dd>The <a class="el" href="group__m17nInputMethod.html#ga7d429265a08a1ca8fa55c7ebfcfad6f7" title="Parse input method names.">minput_parse_im_names()</a> returns a plist of which elements are plist of LANGUAGE and NAME of input methods as below: ((LANGUAGE1 NAME1) (LANGUAGE2 NAME2) ...) Both LANGUAGEn and NAMEn are symbols. LANGUAGEn is <a class="el" href="group__m17nSymbol.html#ga8769a573efbb023b4d77f9d03babc09f" title="Symbol whose name is "t".">Mt</a> if the corresponding input method is not limited to a specific language. If a specified input method doesn't exist, the corresponding element in the above plist is a sub-part of <b>mt</b> for that non-existing input method name. For instance, if "symbol,unknown,unicode" is specified as <b>mt</b> and "unknown" doesn't exist, the return value is: ((t symbol) "unknown" (t unicode)) <br />
</dd></dl>
</div>
</div>
<a id="ga955cd9e0b9fd8cf426aed3f3584337ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga955cd9e0b9fd8cf426aed3f3584337ff">◆ </a></span>minput_callback()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int minput_callback </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structMInputContext.html">MInputContext</a> * </td>
<td class="paramname"><em>ic</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">MSymbol </td>
<td class="paramname"><em>command</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call a callback function. </p>
<p>The <a class="el" href="group__m17nInputMethod.html#ga955cd9e0b9fd8cf426aed3f3584337ff" title="Call a callback function.">minput_callback()</a> functions calls a callback function <b>command</b> assigned for the input context <b>ic</b>. The caller must set specific elements in <b>ic->plist</b> if the callback function requires.</p>
<dl class="section user"><dt>Return value:</dt><dd>If there exists a specified callback function, 0 is returned. Otherwise -1 is returned. By side effects, <b>ic->plist</b> may be modified. <br />
</dd></dl>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="ga4f2d5dc3e6c637d18e2ecf24edfff456"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4f2d5dc3e6c637d18e2ecf24edfff456">◆ </a></span>Minput_method</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MSymbol Minput_method</td>
</tr>
</table>
</div><div class="memdoc">
<p>Symbol whose name is "input-method". </p>
</div>
</div>
<a id="ga5516535b28981c4b02b33368f3d56d56"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5516535b28981c4b02b33368f3d56d56">◆ </a></span>Minput_preedit_start</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MSymbol Minput_preedit_start</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ga3f96ecb6d7f7f82bc1ba5e47f8da0b92"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3f96ecb6d7f7f82bc1ba5e47f8da0b92">◆ </a></span>Minput_preedit_done</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MSymbol Minput_preedit_done</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="gacb0619c67c071d453dd2920ffc26d0ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gacb0619c67c071d453dd2920ffc26d0ed">◆ </a></span>Minput_preedit_draw</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MSymbol Minput_preedit_draw</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="gad3739f8097f1c52f10a8581828b7bb95"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad3739f8097f1c52f10a8581828b7bb95">◆ </a></span>Minput_status_start</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MSymbol Minput_status_start</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ga49febb92bb4320bc27f20043517f3169"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga49febb92bb4320bc27f20043517f3169">◆ </a></span>Minput_status_done</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MSymbol Minput_status_done</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="gae75d45c1dbe0483768e9364af4d282f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae75d45c1dbe0483768e9364af4d282f9">◆ </a></span>Minput_status_draw</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MSymbol Minput_status_draw</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ga6bb355b1b5521571056b96a854f3c6c8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6bb355b1b5521571056b96a854f3c6c8">◆ </a></span>Minput_candidates_start</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MSymbol Minput_candidates_start</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ga6ff3deabad4489cef99fff428b2628e2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6ff3deabad4489cef99fff428b2628e2">◆ </a></span>Minput_candidates_done</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MSymbol Minput_candidates_done</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ga6bf782d7824557ec10e3988f6fcf4834"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6bf782d7824557ec10e3988f6fcf4834">◆ </a></span>Minput_candidates_draw</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MSymbol Minput_candidates_draw</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="gaf19d77434bb1a12bdcb50f46448f1402"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf19d77434bb1a12bdcb50f46448f1402">◆ </a></span>Minput_set_spot</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MSymbol Minput_set_spot</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="gafa306a028998a972bf3a05c8609fe65e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafa306a028998a972bf3a05c8609fe65e">◆ </a></span>Minput_toggle</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MSymbol Minput_toggle</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ga5f07520efe1e533af2b2322fca2bc9a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5f07520efe1e533af2b2322fca2bc9a2">◆ </a></span>Minput_reset</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MSymbol Minput_reset</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ga1ca3d6e04f44fada82ed3c81069be23c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1ca3d6e04f44fada82ed3c81069be23c">◆ </a></span>Minput_get_surrounding_text</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MSymbol Minput_get_surrounding_text</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="gab1bfef46ab8e9daa6f3cf53b912b7da8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab1bfef46ab8e9daa6f3cf53b912b7da8">◆ </a></span>Minput_delete_surrounding_text</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MSymbol Minput_delete_surrounding_text</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ga3edb37986f3bcdd15d73884c0d9b239b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3edb37986f3bcdd15d73884c0d9b239b">◆ </a></span>Minput_focus_out</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MSymbol Minput_focus_out</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ga0d721c64e73c1e362f3cc44716b6c6ab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0d721c64e73c1e362f3cc44716b6c6ab">◆ </a></span>Minput_focus_in</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MSymbol Minput_focus_in</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ga2b2dd61bcb633e89865ebeda1cd9f466"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2b2dd61bcb633e89865ebeda1cd9f466">◆ </a></span>Minput_focus_move</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MSymbol Minput_focus_move</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="gaf84d56e3015c4b26802debcbd9352806"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf84d56e3015c4b26802debcbd9352806">◆ </a></span>Minherited</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MSymbol Minherited</td>
</tr>
</table>
</div><div class="memdoc">
<p>These are the predefined symbols describing status of input method command and variable, and are used in a return value of <a class="el" href="group__m17nInputMethod.html#ga4472e21e6a1e65056f5815c3ce36e41b">minput_get_command()</a> and <a class="el" href="group__m17nInputMethod.html#ga09c8aea172323731cd3e946b3ef43a50">minput_get_variable()</a>. <br />
</p>
</div>
</div>
<a id="ga07679cd0d5bf8e137d5dc554a30aa106"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga07679cd0d5bf8e137d5dc554a30aa106">◆ </a></span>Mcustomized</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MSymbol Mcustomized</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="gae01597fe66dfef937b4c5c47e54abbd0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae01597fe66dfef937b4c5c47e54abbd0">◆ </a></span>Mconfigured</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MSymbol Mconfigured</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="gadb0ff8e5e616a810ed27113b17ad363b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadb0ff8e5e616a810ed27113b17ad363b">◆ </a></span>minput_default_driver</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structMInputDriver.html">MInputDriver</a> minput_default_driver</td>
</tr>
</table>
</div><div class="memdoc">
<p>The default driver for internal input methods. </p>
<p>The variable <a class="el" href="group__m17nInputMethod.html#gadb0ff8e5e616a810ed27113b17ad363b" title="The default driver for internal input methods.">minput_default_driver</a> is the default driver for internal input methods.</p>
<p>The member <a class="el" href="structMInputDriver.html#adab132de1505f5945e55f5a4f00805e4" title="Open an input method.">MInputDriver::open_im()</a> searches the m17n database for an input method that matches the tag < <a class="el" href="group__m17nInputMethod.html#ga4f2d5dc3e6c637d18e2ecf24edfff456" title="Symbol whose name is "input-method".">Minput_method</a>, <b>language</b>, <b>name></b> and loads it.</p>
<p>The member <a class="el" href="structMInputDriver.html#a159fe7401cd0913dc8c480a18efeff64" title="List of callback functions.">MInputDriver::callback_list()</a> is <code>NULL</code>. Thus, it is programmers responsibility to set it to a plist of proper callback functions. Otherwise, no feedback information (e.g. preedit text) can be shown to users.</p>
<p>The macro <a class="el" href="group__m17nIntro.html#ga66879b35a1fee08b3e5966f6650c39f9" title="Initialize the m17n library.">M17N_INIT()</a> sets the variable <a class="el" href="group__m17nInputMethod.html#ga0e4d7a69ac0861d4b9b58990a0f03702" title="The driver for internal input methods.">minput_driver</a> to the pointer to this driver so that all internal input methods use it.</p>
<p>Therefore, unless <code>minput_driver</code> is set differently, the driver dependent arguments <b>arg</b> of the functions whose name begins with "minput_" are all ignored. <br />
</p>
</div>
</div>
<a id="ga0e4d7a69ac0861d4b9b58990a0f03702"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0e4d7a69ac0861d4b9b58990a0f03702">◆ </a></span>minput_driver</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structMInputDriver.html">MInputDriver</a>* minput_driver</td>
</tr>
</table>
</div><div class="memdoc">
<p>The driver for internal input methods. </p>
<p>The variable <a class="el" href="group__m17nInputMethod.html#ga0e4d7a69ac0861d4b9b58990a0f03702" title="The driver for internal input methods.">minput_driver</a> is a pointer to the input method driver that is used by internal input methods. The macro <a class="el" href="group__m17nIntro.html#ga66879b35a1fee08b3e5966f6650c39f9" title="Initialize the m17n library.">M17N_INIT()</a> initializes it to a pointer to <a class="el" href="group__m17nInputMethod.html#gadb0ff8e5e616a810ed27113b17ad363b" title="The default driver for internal input methods.">minput_default_driver</a> if <m17n<em></em>.h> is included. <br />
</p>
</div>
</div>
<a id="gaf03ec92f0d20d9bff8b9031461270d41"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf03ec92f0d20d9bff8b9031461270d41">◆ </a></span>Minput_driver</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MSymbol Minput_driver</td>
</tr>
</table>
</div><div class="memdoc">
<p>The variable <a class="el" href="group__m17nInputMethod.html#gaf03ec92f0d20d9bff8b9031461270d41">Minput_driver</a> is a symbol for a foreign input method. See <a class="el" href="group__m17nInputMethod.html#foreign-input-method">foreign input method</a> for the detail. <br />
</p>
</div>
</div>
</div><!-- contents -->
<hr>
<ADDRESS>
<a href="http://www.m17n.org/m17n-lib-en/index.html" target="mulewindow"><img src="parrot.png" align=bottom alt="m17n-lib Home" border=0></a>
</ADDRESS>
</body>
</HTML>
<!-- Copyright information
Copyright (C) 2001 Information-technology Promotion Agency (IPA)
Copyright (C) 2001-2011
National Institute of Advanced Industrial Science and Technology (AIST)
This file is part of the m17n library documentation.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.2 or
any later version published by the Free Software Foundation; with no
Invariant Section, no Front-Cover Texts,
and no Back-Cover Texts. A copy of the license is included in the
appendix entitled "GNU Free Documentation License".
-->
|
