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
|
<!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 (GUI)</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="#func-members">Functions</a> |
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">Input Method (GUI)<div class="ingroups"><a class="el" href="group__m17nGUI.html">GUI API</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Input method support on window systems.
<a href="#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for Input Method (GUI):</div>
<div class="dyncontent">
<div class="center"><img src="group__m17nInputMethodWin.png" border="0" usemap="#agroup____m17nInputMethodWin" alt=""/></div>
<map name="agroup____m17nInputMethodWin" id="agroup____m17nInputMethodWin">
<area shape="rect" title="Input method support on window systems." alt="" coords="124,5,271,31"/>
<area shape="rect" href="group__m17nGUI.html" title="API provided by libm17n-gui.so" alt="" coords="5,5,76,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="structMInputGUIArgIC.html">MInputGUIArgIC</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Type of the argument to the function <a class="el" href="group__m17nInputMethod.html#ga8b32df84c645f73ed65e20a1d51c1859" title="Create an input context.">minput_create_ic()</a>. <a href="structMInputGUIArgIC.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="structMInputXIMArgIM.html">MInputXIMArgIM</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Structure pointed to by the argument <b>arg</b> of the function <a class="el" href="group__m17nInputMethod.html#ga34d3e527bfd705d2b7f2b749199c1e11" title="Open an input method.">minput_open_im()</a>. <a href="structMInputXIMArgIM.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="structMInputXIMArgIC.html">MInputXIMArgIC</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Structure pointed to by the argument <b>arg</b> of the function <a class="el" href="group__m17nInputMethod.html#ga8b32df84c645f73ed65e20a1d51c1859" title="Create an input context.">minput_create_ic()</a>. <a href="structMInputXIMArgIC.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="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga58715c630a04fd33f12394e9c93f1bad"><td class="memItemLeft" align="right" valign="top">MSymbol </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethodWin.html#ga58715c630a04fd33f12394e9c93f1bad">minput_event_to_key</a> (<a class="el" href="structMFrame.html">MFrame</a> *frame, void *event)</td></tr>
<tr class="memdesc:ga58715c630a04fd33f12394e9c93f1bad"><td class="mdescLeft"> </td><td class="mdescRight">Convert an event to an input key. <a href="group__m17nInputMethodWin.html#ga58715c630a04fd33f12394e9c93f1bad">More...</a><br /></td></tr>
<tr class="separator:ga58715c630a04fd33f12394e9c93f1bad"><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:ga382ffd93fbaaa7226dd36af4a3fd7100"><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__m17nInputMethodWin.html#ga382ffd93fbaaa7226dd36af4a3fd7100">minput_gui_driver</a></td></tr>
<tr class="memdesc:ga382ffd93fbaaa7226dd36af4a3fd7100"><td class="mdescLeft"> </td><td class="mdescRight">Input driver for internal input methods on window systems. <a href="group__m17nInputMethodWin.html#ga382ffd93fbaaa7226dd36af4a3fd7100">More...</a><br /></td></tr>
<tr class="separator:ga382ffd93fbaaa7226dd36af4a3fd7100"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4e8d34da33638639ecc7386914def510"><td class="memItemLeft" align="right" valign="top">MSymbol </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nInputMethodWin.html#ga4e8d34da33638639ecc7386914def510">Mxim</a></td></tr>
<tr class="memdesc:ga4e8d34da33638639ecc7386914def510"><td class="mdescLeft"> </td><td class="mdescRight">Symbol of the name "xim". <a href="group__m17nInputMethodWin.html#ga4e8d34da33638639ecc7386914def510">More...</a><br /></td></tr>
<tr class="separator:ga4e8d34da33638639ecc7386914def510"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Input method support on window systems. </p>
<p>The input driver <code>minput_gui_driver</code> is provided for internal input methods that is useful on window systems. It displays preedit text and status text at the inputting spot. See the documentation of <code>minput_gui_driver</code> for more details.</p>
<p>In the m17n-X library, the foreign input method of name <code>Mxim</code> is provided. It uses XIM (X Input Method) as a background input engine. The symbol <code>Mxim</code> has a property <code>Minput_driver</code> whose value is a pointer to the input driver <code>minput_xim_driver</code>. See the documentation of <code>minput_xim_driver</code> for more details. <br />
</p>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga58715c630a04fd33f12394e9c93f1bad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga58715c630a04fd33f12394e9c93f1bad">◆ </a></span>minput_event_to_key()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MSymbol minput_event_to_key </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structMFrame.html">MFrame</a> * </td>
<td class="paramname"><em>frame</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>event</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert an event to an input key. </p>
<p>The <a class="el" href="group__m17nInputMethodWin.html#ga58715c630a04fd33f12394e9c93f1bad" title="Convert an event to an input key.">minput_event_to_key()</a> function returns the input key corresponding to event <b>event</b> on <b>frame</b> by a window system dependent manner.</p>
<p>In the m17n-X library, <b>event</b> must be a pointer to the structure <code>XKeyEvent</code>, and it is handled as below.</p>
<p>At first, the keysym name of <b>event</b> is acquired by the function <code>XKeysymToString</code>. Then, the name is modified as below.</p>
<p>If the name is one of "a" .. "z" and <b>event</b> has a Shift modifier, the name is converted to "A" .. "Z" respectively, and the Shift modifier is cleared.</p>
<p>If the name is one byte length and <b>event</b> has a Control modifier, the byte is bitwise anded by 0x1F and the Control modifier is cleared.</p>
<p>If <b>event</b> still has modifiers, the name is preceded by "S-" (Shift), "C-" (Control), "M-" (Meta), "A-" (Alt), "G-" (AltGr), "s-" (Super), and "H-" (Hyper) in this order.</p>
<p>For instance, if the keysym name is "a" and the event has Shift, Meta, and Hyper modifiers, the resulting name is "M-H-A".</p>
<p>At last, a symbol who has the name is returned. <br />
</p>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="ga382ffd93fbaaa7226dd36af4a3fd7100"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga382ffd93fbaaa7226dd36af4a3fd7100">◆ </a></span>minput_gui_driver</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structMInputDriver.html">MInputDriver</a> minput_gui_driver</td>
</tr>
</table>
</div><div class="memdoc">
<p>Input driver for internal input methods on window systems. </p>
<p>The input driver <code>minput_gui_driver</code> is for internal input methods to be used on window systems.</p>
<p>It creates sub-windows for a preedit text and a status text, and displays them at the input spot set by the function <a class="el" href="group__m17nInputMethod.html#gac12030bd2d5c265a7327a9487f9c1376" title="Set the spot of the input context.">minput_set_spot()</a>.</p>
<p>The macro <a class="el" href="group__m17nIntro.html#ga66879b35a1fee08b3e5966f6650c39f9" title="Initialize the m17n library.">M17N_INIT()</a> set the variable <code>minput_driver</code> to the pointer to this driver so that all internal input methods use it.</p>
<p>Therefore, unless <code>minput_driver</code> is changed from the default, the driver dependent arguments to the functions whose name begin with minput_ must are treated as follows.</p>
<p>The argument <b>arg</b> of the function <a class="el" href="group__m17nInputMethod.html#ga34d3e527bfd705d2b7f2b749199c1e11" title="Open an input method.">minput_open_im()</a> is ignored.</p>
<p>The argument <b>arg</b> of the function <a class="el" href="group__m17nInputMethod.html#ga8b32df84c645f73ed65e20a1d51c1859" title="Create an input context.">minput_create_ic()</a> must be a pointer to the structure <code><a class="el" href="structMInputGUIArgIC.html" title="Type of the argument to the function minput_create_ic().">MInputGUIArgIC</a></code>. See the documentation of <code><a class="el" href="structMInputGUIArgIC.html" title="Type of the argument to the function minput_create_ic().">MInputGUIArgIC</a></code> for more details.</p>
<p>If the argument <b>key</b> of function <a class="el" href="group__m17nInputMethod.html#ga6d9c3c97524114496fd8b7f70af92457" title="Filter an input key.">minput_filter()</a> is <code>Mnil</code>, the argument <b>arg</b> must be a pointer to the object of type <code>XEvent</code>. In that case, <b>key</b> is generated from <b>arg</b>.</p>
<p>The argument <b>arg</b> of the function <a class="el" href="group__m17nInputMethod.html#gafe533480c705b877189938a0eecb1b57" title="Look up a text produced in the input context.">minput_lookup()</a> must be the same one as that of the function <a class="el" href="group__m17nInputMethod.html#ga6d9c3c97524114496fd8b7f70af92457" title="Filter an input key.">minput_filter()</a>. <br />
</p>
</div>
</div>
<a id="ga4e8d34da33638639ecc7386914def510"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4e8d34da33638639ecc7386914def510">◆ </a></span>Mxim</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MSymbol Mxim</td>
</tr>
</table>
</div><div class="memdoc">
<p>Symbol of the name "xim". </p>
<p>The variable Mxim is a symbol of name "xim". It is a name of the input method driver <a class="el" href="m17n-X_8h.html#aa416d384957c7e4f69349d62f74e1a19">minput_xim_driver</a>. <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".
-->
|
