Cancel previous changes
[m17n/m17n-lib.git] / src / m17n-X.h
1 /* m17n-X.h -- header file for the GUI API on X Windows.
2    Copyright (C) 2003, 2004
3      National Institute of Advanced Industrial Science and Technology (AIST)
4      Registration Number H15PRO112
5
6    This file is part of the m17n library.
7
8    The m17n library is free software; you can redistribute it and/or
9    modify it under the terms of the GNU Lesser General Public License
10    as published by the Free Software Foundation; either version 2.1 of
11    the License, or (at your option) any later version.
12
13    The m17n library is distributed in the hope that it will be useful,
14    but WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16    Lesser General Public License for more details.
17
18    You should have received a copy of the GNU Lesser General Public
19    License along with the m17n library; if not, write to the Free
20    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
21    02111-1307, USA.  */
22
23 #ifndef _M17N_X_H_
24 #define _M17N_X_H_
25
26 #include <X11/Xlib.h>
27 #include <X11/Xutil.h>
28 #include <X11/Xresource.h>
29
30 #ifdef __cplusplus
31 extern "C"
32 {
33 #endif
34
35 /* For inputting.  */
36
37 extern MInputDriver minput_xim_driver;
38 extern MSymbol Mxim;
39
40 /*** @ingroup m17nInputMethodWin */
41 /***en
42     @brief Structure pointed to by the argument $ARG of the function minput_open_im ().
43
44     The type #MInputXIMArgIM is the structure pointed to by the
45     argument $ARG of the function minput_open_im () for the foreign
46     input method of name #Mxim.  */
47
48 /***ja
49     @brief ´Ø¿ô minput_open_im () ¤Î°ú¿ô $ARG ¤Ë¤è¤Ã¤Æ»Ø¤µ¤ì¤ë¹½Â¤ÂÎ.
50
51     #MInputXIMArgIM ·¿¤Ï¡¢´Ø¿ô minput_open_im () ¤¬Ì¾Á° #Mxim ¤ò»ý
52     ¤Ä³°ÉôÆþÎϥ᥽¥Ã¥É¤òÀ¸À®¤¹¤ëºÝ¤Ë°ú¿ô $ARG ¤Ë¤è¤Ã¤Æ»Ø¤µ¤ì¤ë¹½Â¤ÂΤÇ
53     ¤¢¤ë¡£  */
54
55 typedef struct
56 {
57   /***en The meaning of the following four members are the same as
58       arguments to XOpenIM ().  */
59   /***ja °Ê²¼¤Î£´¤Ä¤Î¥á¥ó¥Ð¤Î°ÕÌ£¤Ï¡¢XOpenIM () ¤Î°ú¿ô¤Î°ÕÌ£¤ÈƱ¤¸¤Ç¤¢
60       ¤ë¡£  */
61
62   /***en Display of the client.  */
63   /***ja ¥¯¥é¥¤¥¢¥ó¥È¤Î¥Ç¥£¥¹¥×¥ì¥¤  */
64   Display *display;
65
66   /***en Pointer to the X resource database.  */
67   /***ja X ¥ê¥½¡¼¥¹¡¦¥Ç¡¼¥¿¥Ù¡¼¥¹¤Ø¤Î¥Ý¥¤¥ó¥¿  */
68   XrmDatabase db;
69
70   /***en Full class name of the application.  */
71   /***ja ¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¤Î´°Á´¤Ê¥¯¥é¥¹Ì¾  */
72   char *res_class;
73
74   /***en Full resource name of the application.  */
75   /***ja ¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¤Î´°Á´¤Ê¥ê¥½¡¼¥¹Ì¾  */
76   char *res_name;
77
78   /***en Locale name under which an XIM is opened.  */
79   /***ja XIM¤¬¥ª¡¼¥×¥ó¤µ¤ì¤¿¥í¥±¡¼¥ë̾  */
80   char *locale;
81
82   /***en Arguments to XSetLocaleModifiers ().  */
83   /***ja XSetLocaleModifiers () ¤Î°ú¿ô  */
84   char *modifier_list;
85 } MInputXIMArgIM;
86
87 /*=*/
88
89 /*** @ingroup m17nInputMethodWin */
90 /***en
91     @brief Structure pointed to by the argument $ARG of the function minput_create_ic ().
92
93     The type #MInputXIMArgIC is the structure pointed to by the
94     argument $ARG of the function minput_create_ic () for the foreign
95     input method of name #Mxim.  */
96
97 /***ja
98     @brief ´Ø¿ô minput_create_ic () ¤Î°ú¿ô $ARG ¤Ë¤è¤Ã¤Æ»Ø¤µ¤ì¤ë¹½Â¤ÂÎ.
99
100     #MInputXIMArgIC ·¿¤Ï¡¢´Ø¿ô minput_create_ic () ¤¬Ì¾Á° #Mxim ¤ò
101     »ý¤Ä³°ÉôÆþÎϥ᥽¥Ã¥ÉÍѤ˸ƤФì¤ëºÝ¤Ë¡¢°ú¿ô $ARG ¤Ë¤è¤Ã¤Æ»Ø¤µ¤ì¤ë¹½
102     Â¤ÂΤǤ¢¤ë¡£ */
103
104 typedef struct
105 {
106   /***en Used as the arguments of @c XCreateIC following @c
107       XNInputStyle.  If this is zero, ( @c XIMPreeditNothing | @c
108       XIMStatusNothing) is used, and <preedit_attrs> and
109       <status_attrs> are set to @c NULL.  */
110   /***ja @c XCreateIC ¤Î @c XNInputStyle ¤Ë³¤¯°ú¿ô¤È¤·¤ÆÍѤ¤¤é¤ì¤ë¡£
111       ¥¼¥í¤Ê¤é¤Ð¡¢ ( @c XIMPreeditNothing | @c XIMStatusNothing) ¤¬ÍÑ
112       ¤¤¤é¤ì¡¢ <preedit_attrs> ¤È <status_attrs> ¤Ï @c NULL ¤ËÀßÄꤵ¤ì
113       ¤ë¡£ */
114
115   XIMStyle input_style;
116   /***en Used as the argument of @c XCreateIC following @c XNClientWindow.  */
117   /***ja @c XCreateIC ¤Î @c XNClientWindow ¤Ë³¤¯°ú¿ô¤È¤·¤ÆÍѤ¤¤é¤ì¤ë¡£  */
118
119
120   Window client_win;
121   /***en Used as the argument of @c XCreateIC following @c XNFocusWindow.  */
122   /***ja @c XCreateIC ¤Î @c XNFocusWindow ¤Ë³¤¯°ú¿ô¤È¤·¤ÆÍѤ¤¤é¤ì¤ë¡£  */
123
124   Window focus_win;
125   /***en If non- @c NULL, used as the argument of @c XCreateIC following
126       @c XNPreeditAttributes.  */
127   /***ja @c NULL¤Ç¤Ê¤±¤ì¤Ð¡¢ @c XCreateIC following ¤Î@c
128       XNPreeditAttributes ¤Ë³¤¯°ú¿ô¤È¤·¤ÆÍѤ¤¤é¤ì¤ë¡£  */
129
130   XVaNestedList preedit_attrs;
131   /***en If non- @c NULL, used as the argument of @c XCreateIC following
132       @c XNStatusAttributes.  */ 
133   /***ja @c NULL¤Ç¤Ê¤±¤ì¤Ð¡¢ @c XCreateIC following ¤Î @c
134       XNStatusAttributes ¤Ë³¤¯°ú¿ô¤È¤·¤ÆÍѤ¤¤é¤ì¤ë¡£  */
135
136   XVaNestedList status_attrs;
137 } MInputXIMArgIC;
138 /*=*/
139
140 #ifdef __cplusplus
141 }
142 #endif
143
144 #endif /* not _M17N_X_H_ */
145
146 /*
147   Local Variables:
148   coding: euc-japan
149   End:
150 */