File: m17nInputMethodWin.3m17n

package info (click to toggle)
m17n-docs 1.6.2-2
  • links: PTS
  • area: main
  • in suites: buster, jessie, jessie-kfreebsd, stretch, wheezy
  • size: 22,492 kB
  • ctags: 1,495
  • sloc: sh: 1,032; makefile: 406; ansic: 206; perl: 108
file content (145 lines) | stat: -rw-r--r-- 5,251 bytes parent folder | download | duplicates (3)
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
.\" 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".
.TH "Input Method (GUI)" 3m17n "12 Jan 2011" "Version 1.6.2" "The m17n Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Input_Method_(GUI) \- Input method support on window systems.  

.SS "Data Structures"

.in +1c
.ti -1c
.RI "struct \fBMInputGUIArgIC\fP"
.br
.RI "\fIType of the argument to the function \fBminput_create_ic()\fP. \fP"
.ti -1c
.RI "struct \fBMInputXIMArgIM\fP"
.br
.RI "\fIStructure pointed to by the argument \fBarg\fP of the function \fBminput_open_im()\fP. \fP"
.ti -1c
.RI "struct \fBMInputXIMArgIC\fP"
.br
.RI "\fIStructure pointed to by the argument \fBarg\fP of the function \fBminput_create_ic()\fP. \fP"
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "\fBMSymbol\fP \fBminput_event_to_key\fP (\fBMFrame\fP *frame, void *event)"
.br
.RI "\fIConvert an event to an input key. \fP"
.in -1c
.SS "Variables"

.in +1c
.ti -1c
.RI "\fBMInputDriver\fP \fBminput_gui_driver\fP"
.br
.RI "\fIInput driver for internal input methods on window systems. \fP"
.ti -1c
.RI "\fBMSymbol\fP \fBMxim\fP"
.br
.RI "\fISymbol of the name 'xim'. \fP"
.in -1c
.SH "Detailed Description"
.PP 
Input method support on window systems. 

The input driver \fCminput_gui_driver\fP 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 \fCminput_gui_driver\fP for more details.
.PP
In the m17n\-X library, the foreign input method of name \fCMxim\fP is provided. It uses XIM (X Input Method) as a background input engine. The symbol \fCMxim\fP has a property \fCMinput_driver\fP whose value is a pointer to the input driver \fCminput_xim_driver\fP. See the documentation of \fCminput_xim_driver\fP for more details. 
.SH "Data Structure Documentation"
.SS MInputGUIArgIC
.PP
.ad l
.nh
.PP
\fBFIELD DOCUMENTATION:\fP
.PP 
.PP
\fB\fBMFrame\fP* \fBMInputGUIArgIC::frame\fP\fP
.PP
\fB\fBMDrawWindow\fP \fBMInputGUIArgIC::client\fP\fP
.PP
\fB\fBMDrawWindow\fP \fBMInputGUIArgIC::focus\fP\fP

.SS MInputXIMArgIM
.PP
.ad l
.nh
.PP
\fBFIELD DOCUMENTATION:\fP
.PP 
.PP
\fBDisplay* \fBMInputXIMArgIM::display\fP\fP
.PP
\fBXrmDatabase \fBMInputXIMArgIM::db\fP\fP
.PP
\fBchar* \fBMInputXIMArgIM::res_class\fP\fP
.PP
\fBchar* \fBMInputXIMArgIM::res_name\fP\fP
.PP
\fBchar* \fBMInputXIMArgIM::locale\fP\fP
.PP
\fBchar* \fBMInputXIMArgIM::modifier_list\fP\fP

.SS MInputXIMArgIC
.PP
.ad l
.nh
.PP
\fBFIELD DOCUMENTATION:\fP
.PP 
.PP
\fBXIMStyle \fBMInputXIMArgIC::input_style\fP\fP
.PP
\fBWindow \fBMInputXIMArgIC::client_win\fP\fP
.PP
\fBWindow \fBMInputXIMArgIC::focus_win\fP\fP
.PP
\fBXVaNestedList \fBMInputXIMArgIC::preedit_attrs\fP\fP
.PP
\fBXVaNestedList \fBMInputXIMArgIC::status_attrs\fP\fP

.SH "Variable Documentation"
.PP 
.SS "\fBMInputDriver\fP \fBminput_gui_driver\fP"
.PP
Input driver for internal input methods on window systems. The input driver \fCminput_gui_driver\fP is for internal input methods to be used on window systems.
.PP
It creates sub\-windows for a preedit text and a status text, and displays them at the input spot set by the function \fBminput_set_spot()\fP.
.PP
The macro \fBM17N_INIT()\fP set the variable \fCminput_driver\fP to the pointer to this driver so that all internal input methods use it.
.PP
Therefore, unless \fCminput_driver\fP is changed from the default, the driver dependent arguments to the functions whose name begin with minput_ must are treated as follows.
.PP
The argument \fBarg\fP of the function \fBminput_open_im()\fP is ignored.
.PP
The argument \fBarg\fP of the function \fBminput_create_ic()\fP must be a pointer to the structure \fBMInputGUIArgIC\fP. See the documentation of \fBMInputGUIArgIC\fP for more details.
.PP
If the argument \fBkey\fP of function \fBminput_filter()\fP is \fCMnil\fP, the argument \fBarg\fP must be a pointer to the object of type \fCXEvent\fP. In that case, \fBkey\fP is generated from \fBarg\fP.
.PP
The argument \fBarg\fP of the function \fBminput_lookup()\fP must be the same one as that of the function \fBminput_filter()\fP. 
.SS "\fBMSymbol\fP \fBMxim\fP"
.PP
Symbol of the name 'xim'. The variable Mxim is a symbol of name 'xim'. It is a name of the input method driver \fBminput_xim_driver\fP. 
.SH "Author"
.PP 
Generated automatically by Doxygen for The m17n Library from the source code.
.SH COPYRIGHT
Copyright (C) 2001 Information\-technology Promotion Agency (IPA)
.br
Copyright (C) 2001\-2011 National Institute of Advanced Industrial Science and Technology (AIST)
.br
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License 
<http://www.gnu.org/licenses/fdl.html>.