(mfont_list_family_names): Extern it.
[m17n/m17n-lib.git] / src / m17n-gui.h
1 /* m17n-gui.h -- header file for the GUI API of the m17n library.
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_GUI_H_
24 #define _M17N_GUI_H_
25
26 #ifndef _M17N_H_
27 #include <m17n.h>
28 #endif
29
30 #ifdef __cplusplus
31 extern "C"
32 {
33 #endif
34
35 #if !defined (FOR_DOXYGEN) || defined (DOXYGEN_INTERNAL_MODULE)
36
37 extern void m17n_init_win (void);
38 #undef M17N_INIT
39 #define M17N_INIT() m17n_init_win ()
40
41 extern void m17n_fini_win (void);
42 #undef M17N_FINI
43 #define M17N_FINI() m17n_fini_win ()
44
45 #endif
46
47 /***en @defgroup m17nGUI GUI API */
48 /***ja @defgroup m17nGUI GUI API */
49 /*=*/
50
51 /*** @ingroup m17nGUI */
52 /***en @defgroup m17nFrame Frame */
53 /***ja @defgroup m17nFrame ¥Õ¥ì¡¼¥à */
54 /*=*/
55
56 /*** @ingroup m17nFrame */
57 /***en
58     @brief Type of frames.
59
60     The type #MFrame is for a @e frame object.  Each frame holds
61     various information about the corresponding physical display/input
62     device.
63
64     The internal structure of the type #MFrame is concealed from an
65     application program, and its contents depend on the window system
66     in use.  In the m17n-X library, it contains the information about
67     @e display and @e screen in the X Window System.  */
68
69 /***ja
70     @brief ¥Õ¥ì¡¼¥à¤Î·¿Àë¸À.
71
72     #MFrame ¤Ï¡¢@e ¥Õ¥ì¡¼¥à ¥ª¥Ö¥¸¥§¥¯¥ÈÍѤη¿¤Ç¤¢¤ë¡£
73     ¸Ä¡¹¤Î¥Õ¥ì¡¼¥à¤Ï¡¢¤½¤ì¤¬Âбþ¤¹¤ëʪÍýŪ¤Êɽ¼¨¡¿ÆþÎϥǥХ¤¥¹¤Î³Æ¼ï¾ðÊó¤òÊÝ»ý¤¹¤ë¡£
74
75     #MFrame ·¿¤ÎÆâÉô¹½Â¤¤Ï¡¢¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¥×¥í¥°¥é¥à¤«¤é¤Ï¸«¤¨¤Ê¤¤¡£
76     ¤Þ¤¿¤½¤ÎÆâÍƤϻÈÍѤ¹¤ë¥¦¥£¥ó¥É¥¦¥·¥¹¥Æ¥à¤Ë°Í¸¤¹¤ë¡£¤Þ¤¿ m17n-X 
77     ¥é¥¤¥Ö¥é¥ê¤Ë¤ª¤±¤ë¥Õ¥ì¡¼¥à¤Ï¡¢X ¥¦¥£¥ó¥É¥¦¤Î @e display ¤È @e screen 
78     ¤Ë´Ø¤¹¤ë¾ðÊó¤ò»ý¤Ä¡£      */
79
80 typedef struct MFrame MFrame;
81
82 /*=*/
83
84 extern MSymbol Mdevice;
85
86 extern MSymbol Mfont;
87 extern MSymbol Mfont_width;
88 extern MSymbol Mfont_ascent;
89 extern MSymbol Mfont_descent;
90 extern MFrame *mframe_default;
91
92 extern MSymbol Mdisplay;
93 extern MSymbol Mscreen;
94 extern MSymbol Mdrawable;
95 extern MSymbol Mwidget;
96 extern MSymbol Mdepth;
97 extern MSymbol Mcolormap;
98
99 extern MFrame *mframe (MPlist *plist);
100
101 extern void *mframe_get_prop (MFrame *frame, MSymbol key);
102
103 /* end of frame module */
104 /*=*/
105
106 /*** @ingroup m17nGUI  */
107 /***en @defgroup m17nFont Font */
108 /***ja @defgroup m17nFont ¥Õ¥©¥ó¥È */
109 /*=*/
110
111 /*** @ingroup m17nFont */
112 /***en
113     @brief Type of fonts.
114
115     The type #MFont is the structure defining fonts.  It contains
116     information about the following properties of a font: foundry,
117     family, weight, style, stretch, adstyle, registry, size, and
118     resolution.
119
120     This structure is used both for specifying a font in a fontset
121     and for storing information about available system fonts.
122
123     The internal structure is concealed from an application program.  */
124
125 /***ja
126     @brief ¥Õ¥©¥ó¥È¤Î·¿Àë¸À.
127
128     #MFont ·¿¤Ï¥Õ¥©¥ó¥È»ØÄêÍѤι½Â¤ÂΤǤ¢¤ê¡¢¥Õ¥©¥ó¥È¤Î¥×¥í¥Ñ¥Æ¥£¤Ç¤¢¤ë
129     foundry, family, weight, style, stretch, adstyle, registry,
130     size, resolution ¤Ë´Ø¤¹¤ë¾ðÊó¤ò´Þ¤à¡£
131
132     ¤³¤Î¹½Â¤ÂΤϥե©¥ó¥È¥»¥Ã¥ÈÆâ¤Î¥Õ¥©¥ó¥È¤ò»ØÄꤹ¤ëºÝ¤È¡¢»ÈÍѲÄǽ¤Ê¥·¥¹¥Æ¥à¥Õ¥©¥ó¥È¤Î¾ðÊó¤ò³ÊǼ¤¹¤ëºÝ¤ÎξÊý¤ËÍѤ¤¤é¤ì¤ë¡£
133
134     ÆâÉô¹½Â¤¤Ï¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¥×¥í¥°¥é¥à¤«¤é¤Ï¸«¤¨¤Ê¤¤¡£  */
135
136 /***
137     @seealso
138     mfont (), mfont_from_name (), mfont_find ().  */
139
140 typedef struct MFont MFont;
141
142 /*=*/
143
144 extern MSymbol Mx, Mfreetype, Mxft;
145
146 extern MPlist *mfont_freetype_path;
147
148 extern MFont *mfont ();
149
150 extern MFont *mfont_copy (MFont *font);
151
152 extern MFont *mfont_parse_name (const char *name, MSymbol format);
153
154 extern char *mfont_unparse_name (MFont *font, MSymbol format);
155
156 /* These two are obsolete (from 1.1.0).  */
157 extern char *mfont_name (MFont *font);
158 extern MFont *mfont_from_name (const char *name);
159
160 extern MSymbol Mfoundry;
161 extern MSymbol Mfamily;
162 extern MSymbol Mweight;
163 extern MSymbol Mstyle;
164 extern MSymbol Mstretch;
165 extern MSymbol Madstyle;
166 extern MSymbol Mspacing;
167 extern MSymbol Mregistry;
168 extern MSymbol Msize;
169 extern MSymbol Mresolution;
170 extern MSymbol Mmax_advance;
171 extern MSymbol Mfontfile;
172
173 extern MSymbol Mfontconfig;
174
175 extern void *mfont_get_prop (MFont *font, MSymbol key);
176
177 extern int mfont_put_prop (MFont *font, MSymbol key, void *val);
178
179 extern int mfont_set_encoding (MFont *font,
180                                MSymbol encoding_name, MSymbol repertory_name);
181
182
183 /*=*/
184
185 /***en
186     @brief Find a font.
187
188     The mfont_find () function returns a pointer to the available font
189     that matches best with the specification $SPEC in frame $FRAME.
190
191     $SCORE, if not NULL, must point to a place to store the score
192     value which indicates how well the found font matches $SPEC.  The
193     smaller score means a better match.
194
195     $LIMITED_SIZE, if nonzero, forces the font selector to find a
196     font not greater than the #Msize property of $SPEC.  */
197
198 /***ja
199     @brief ¥Õ¥©¥ó¥È¤òõ¤¹.
200
201     ´Ø¿ô mfont_find () ¤Ï¡¢¥Õ¥ì¡¼¥à $FRAME ¾å¤Ç¥Õ¥©¥ó¥ÈÄêµÁ $SPEC 
202     ¤Ë¤â¤Ã¤È¤â¹çÃפ¹¤ë»ÈÍѲÄǽ¤Ê¥Õ¥©¥ó¥È¤Ø¤Î¥Ý¥¤¥ó¥¿¤òÊÖ¤¹¡£  
203
204     $SCORE ¤Ï NULL ¤Ç¤¢¤ë¤«¡¢¸«¤Ä¤«¤Ã¤¿¥Õ¥©¥ó¥È¤¬ $SPEC 
205     ¤Ë¤É¤ì¤Û¤É¹ç¤Ã¤Æ¤¤¤ë¤«¤ò¼¨¤¹¥¹¥³¥¢¤òÊݸ¤¹¤ë¾ì½ê¤Ø¤Î¥Ý¥¤¥ó¥¿¤Ç¤¢¤ë¡£
206     ¥¹¥³¥¢¤¬¾®¤µ¤¤¤Û¤ÉÎɤ¯¹ç¤Ã¤Æ¤¤¤ë¤³¤È¤ò°ÕÌ£¤¹¤ë¡£
207
208     $LIMITED_SIZE ¤¬ 0 ¤Ç¤Ê¤±¤ì¤Ð¡¢$SPEC ¤Î¥×¥í¥Ñ¥Æ¥£ #Msize 
209     ¤è¤êÂ礭¤¯¤Ê¤¤¥Õ¥©¥ó¥È¤À¤±¤¬Ãµ¤µ¤ì¤ë¡£
210 */
211
212 extern MFont *mfont_find (MFrame *frame, MFont *spec,
213                           int *score, int limited_size);
214 extern MSymbol *mfont_selection_priority ();
215
216 extern int mfont_set_selection_priority (MSymbol *keys);
217
218 extern int mfont_resize_ratio (MFont *font);
219
220 extern MPlist *mfont_list (MFrame *frame, MFont *font, MSymbol language,
221                            int maxnum);
222 extern MPlist *mfont_list_family_names (MFrame *frame);
223
224 typedef struct MFontset MFontset;
225
226 extern int mfont_check (MFrame *frame, MFontset *fontset,
227                         MSymbol script, MSymbol language, MFont *font);
228
229 /* end of font module */
230 /*=*/
231
232 /*** @ingroup m17nGUI  */
233 /***en @defgroup m17nFontset Fontset */
234 /***ja @defgroup m17nFontset ¥Õ¥©¥ó¥È¥»¥Ã¥È */
235 /*=*/
236 /*** @addtogroup m17nFontset
237      @{   */
238 extern MFontset *mfontset (char *name);
239
240 extern MSymbol mfontset_name (MFontset *fontset);
241
242 extern MFontset *mfontset_copy (MFontset *fontset, char *name);
243
244 extern int mfontset_modify_entry (MFontset *fontset,
245                                   MSymbol language, MSymbol script,
246                                   MSymbol charset,
247                                   MFont *spec, MSymbol layouter_name,
248                                   int how);
249
250 extern MPlist *mfontset_lookup (MFontset *fontset, MSymbol script,
251                                 MSymbol language, MSymbol charset);
252 /*** @}   */
253 /* end of fontset module */
254 /*=*/
255
256 /*** @ingroup m17nGUI */
257 /***en @defgroup m17nFace Face */
258 /***ja @defgroup m17nFace ¥Õ¥§¡¼¥¹ */
259 /*=*/
260
261 /*** @ingroup m17nFace */
262 /***en
263     @brief Type of faces.
264
265     The type #MFace is the structure of face objects.  The internal
266     structure is concealed from an application program.  */
267
268 /***ja
269     @brief ¥Õ¥§¡¼¥¹¤Î·¿Àë¸À.
270
271     #MFace ·¿¤Ï¥Õ¥§¡¼¥¹¥ª¥Ö¥¸¥§¥¯¥È¤Î¤¿¤á¤Î¹½Â¤ÂΤǤ¢¤ë¡£
272     ÆâÉô¹½Â¤¤Ï¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¥×¥í¥°¥é¥à¤«¤é¤Ï¸«¤¨¤Ê¤¤¡£  */
273
274 typedef struct MFace MFace;
275 /*=*/
276
277 extern MSymbol Mforeground;
278 extern MSymbol Mbackground;
279 extern MSymbol Mvideomode;
280 extern MSymbol Mnormal;
281 extern MSymbol Mreverse;
282 extern MSymbol Mhline;
283 extern MSymbol Mbox;
284 extern MSymbol Mfontset;
285 extern MSymbol Mratio;
286 extern MSymbol Mhook_func;
287 extern MSymbol Mhook_arg;
288
289 /* Predefined faces.  */
290 extern MFace *mface_normal_video;
291 extern MFace *mface_reverse_video;
292 extern MFace *mface_underline;
293 extern MFace *mface_medium;
294 extern MFace *mface_bold;
295 extern MFace *mface_italic;
296 extern MFace *mface_bold_italic;
297 extern MFace *mface_xx_small;
298 extern MFace *mface_x_small;
299 extern MFace *mface_small;
300 extern MFace *mface_normalsize;
301 extern MFace *mface_large;
302 extern MFace *mface_x_large;
303 extern MFace *mface_xx_large;
304 extern MFace *mface_black;
305 extern MFace *mface_white;
306 extern MFace *mface_red;
307 extern MFace *mface_green;
308 extern MFace *mface_blue;
309 extern MFace *mface_cyan;
310 extern MFace *mface_yellow;
311 extern MFace *mface_magenta;
312
313 /* etc */
314 extern MSymbol Mface;
315
316 extern MFace *mface ();
317
318 extern int mface_equal (MFace *face1, MFace *face2);
319
320 extern MFace *mface_copy (MFace *face);
321
322 extern MFace *mface_merge (MFace *dst, MFace *src);
323
324 extern MFace *mface_from_font (MFont *font);
325
326 /*=*/
327
328 /*** @ingroup m17nFace */
329 /***en
330     @brief Type of horizontal line spec of face.
331
332     The type #MFaceHLineProp is to specify the detail of #Mhline
333     property of a face.  The value of the property must be a pointer
334     to an object of this type.  */
335 /***ja
336     @brief ¥Õ¥§¡¼¥¹¤Î¿åÊ¿Àþ»ØÄêÍÑ·¿Àë¸À.
337
338     #MFaceHLineProp ¤Ï¥Õ¥§¡¼¥¹¤Î #Mhline 
339     ¥×¥í¥Ñ¥Æ¥£¤Î¾ÜºÙ¤ò»ØÄꤹ¤ë·¿¤Ç¤¢¤ë¡£¤³¤Î¥×¥í¥Ñ¥Æ¥£¤ÎÃͤϤ³¤Î·¿¤Î¥ª¥Ö¥¸¥§¥¯¥È¤Ç¤Ê¤¯¤Æ¤Ï¤Ê¤é¤Ê¤¤¡£
340       */
341
342 typedef struct
343 {
344   /***en Type of the horizontal line.  */
345   /***ja ¿åÊ¿Àþ¤Î¥¿¥¤¥×.  */
346   enum MFaceHLineType
347     {
348       MFACE_HLINE_BOTTOM,      
349       MFACE_HLINE_UNDER,
350       MFACE_HLINE_STRIKE_THROUGH,
351       MFACE_HLINE_OVER,
352       MFACE_HLINE_TOP
353     } type;
354
355   /***en Width of the line in pixels.  */
356   /***ja ÀþÉý¡Ê¥Ô¥¯¥»¥ëñ°Ì¡Ë.  */
357   unsigned width;
358
359   /***en Color of the line.  If the value is Mnil, foreground color of
360       a merged face is used.  */
361   /***ja Àþ¤Î¿§.  Mnil ¤Ê¤é¤Ð¡¢Åý¹ç¤·¤¿¥Õ¥§¡¼¥¹¤ÎÁ°·Ê¿§¤¬»È¤ï¤ì¤ë¡£  */
362   
363   MSymbol color;
364 } MFaceHLineProp;
365 /*=*/
366
367 /*** @ingroup m17nFace */
368 /***en
369     @brief Type of box spec of face.
370
371     The type #MFaceBoxProp is to specify the detail of #Mbox property
372     of a face.  The value of the property must be a pointer to an
373     object of this type.  */
374 /***ja
375     @brief ¥Õ¥§¡¼¥¹¤Î°Ï¤ßÏÈ»ØÄêÍÑ·¿Àë¸À.
376
377     #MFaceBoxProp ¤Ï¥Õ¥§¡¼¥¹¤Î #Mbox ¥×¥í¥Ñ¥Æ¥£¤Î¾ÜºÙ¤ò»ØÄꤹ¤ë·¿¤Ç¤¢¤ë¡£
378     ¤³¤Î¥×¥í¥Ñ¥Æ¥£¤ÎÃͤϤ³¤Î·¿¤Î¥ª¥Ö¥¸¥§¥¯¥È¤Ø¤Î¥Ý¥¤¥ó¥¿¤Ç¤Ê¤¯¤Æ¤Ï¤Ê¤é¤Ê¤¤¡£
379       */
380
381 typedef struct
382 {
383   /***en Width of the box line in pixels.  */
384   /***ja ÀþÉý¡Ê¥Ô¥¯¥»¥ëñ°Ì¡Ë.  */
385   unsigned width;
386
387   MSymbol color_top;
388   MSymbol color_bottom;
389   MSymbol color_left;
390   MSymbol color_right;
391
392   unsigned inner_hmargin;
393   unsigned inner_vmargin;
394   unsigned outer_hmargin;
395   unsigned outer_vmargin;
396
397 } MFaceBoxProp;
398 /*=*/
399
400 /*** @ingroup m17nFace */
401 /***en
402     @brief Type of hook function of face.
403
404     The type #MFaceHookFunc is to specify the #Mhook property of a
405     face.  The value of the property must be function of this
406     type.  */
407 /***ja
408     @brief ¥Õ¥§¡¼¥¹¤Î¥Õ¥Ã¥¯´Ø¿ô¤Î·¿Àë¸À.
409
410     #MFaceHookFunc ¤Ï¥Õ¥§¡¼¥¹¤Î #Mhook ¥×¥í¥Ñ¥Æ¥£¤ò»ØÄꤹ¤ë·¿¤Ç¤¢¤ë¡£
411     ¤³¤Î¥×¥í¥Ñ¥Æ¥£¤ÎÃͤϡ¢¤³¤Î·¿¤Î´Ø¿ô¤Ç¤Ê¤¯¤Æ¤Ï¤Ê¤é¤Ê¤¤¡£
412       */
413 typedef void (*MFaceHookFunc) (MFace *face, void *arg, void *info);
414 /*=*/
415
416 extern void *mface_get_prop (MFace *face, MSymbol key);
417
418 extern int mface_put_prop (MFace *face, MSymbol key, void *val);
419
420 extern void mface_update (MFrame *frame, MFace *face);
421
422 /* end of face module */
423 /*=*/
424
425 /*** @ingroup m17nGUI */
426 /***en @defgroup m17nDraw Drawing */
427 /***ja @defgroup m17nDraw É½¼¨ */
428 /*=*/
429
430 /*** @ingroup m17nDraw */
431 /***en
432     @brief Window system dependent type for a window.
433
434     The type #MDrawWindow is for a window; a rectangular area that
435     works in several ways like a miniature screen.
436
437     What it actually points depends on a window system.  A program
438     that uses the m17n-X library must coerce the type @c Drawable to
439     this type.  */
440 /***ja 
441     @brief ¥¦¥£¥ó¥É¥¦¥·¥¹¥Æ¥à¤Ë°Í¸¤¹¤ë¡¢¥¦¥£¥ó¥É¥¦¤Î·¿Àë¸À.
442
443     #MDrawWindow ¤Ï¥¦¥£¥ó¥É¥¦¡¢¤¹¤Ê¤ï¤Á´ö¤Ä¤«¤ÎÅÀ¤Ç¥¹¥¯¥ê¡¼¥ó¤Î¥ß¥Ë¥Á¥å¥¢¤È¤·¤ÆƯ¤¯¶ë·ÁÎΰèÍѤη¿¤Ç¤¢¤ë¡£
444
445     ¼ÂºÝ¤Ë²¿¤ò»Ø¤¹¤«¤Ï¥¦¥£¥ó¥É¥¦¥·¥¹¥Æ¥à¤Ë°Í¸¤¹¤ë¡£ m17n X 
446     ¥é¥¤¥Ö¥é¥ê¤òÍøÍѤ¹¤ë¥×¥í¥°¥é¥à¤Ï @c Drawable ·¿¤ò¤³¤Î·¿¤ËÊÑ´¹¤·¤Ê¤¯¤Æ¤Ï¤Ê¤é¤Ê¤¤¡£ */
447
448 typedef void *MDrawWindow;
449 /*=*/
450
451 /*** @ingroup m17nDraw */
452 /***en
453     @brief Window system dependent type for a region.
454
455     The type #MDrawRegion is for a region; an arbitrary set of pixels
456     on the screen (typically a rectangular area).
457
458     What it actually points depends on a window system.  A program
459     that uses the m17n-X library must coerce the type @c Region to
460     this type.  */
461 /***ja
462     @brief ¥¦¥£¥ó¥É¥¦¥·¥¹¥Æ¥à¤Ë°Í¸¤¹¤ë¡¢Îΰè¤Î·¿Àë¸À.
463
464     #MDrawRegion ¤ÏÎΰ衢¤¹¤Ê¤ï¤Á¥¹¥¯¥ê¡¼¥ó¾å¤ÎǤ°Õ¤Î¥Ô¥¯¥»¥ë¤Î½¸¹ç¡Êŵ·¿Åª¤Ë¤Ï¶ë·ÁÎΰè¡ËÍѤη¿¤Ç¤¢¤ë¡£
465
466     ¼ÂºÝ¤Ë²¿¤ò»Ø¤¹¤«¤Ï¥¦¥£¥ó¥É¥¦¥·¥¹¥Æ¥à¤Ë°Í¸¤¹¤ë¡£ m17n X 
467     ¥é¥¤¥Ö¥é¥ê¤òÍøÍѤ¹¤ë¥×¥í¥°¥é¥à¤Ï @c Region ·¿¤ò¤³¤Î·¿¤ËÊÑ´¹¤·¤Ê¤¯¤Æ¤Ï¤Ê¤é¤Ê¤¤¡£  */
468
469 typedef void *MDrawRegion;
470 /*=*/
471
472 /*** @ingroup m17nDraw */
473 /***en
474     @brief Type of a text drawing control.
475
476     The type #MDrawControl is the structure that controls how to draw
477     an M-text.  */
478 /***ja
479     @brief ¥Æ¥­¥¹¥Èɽ¼¨À©¸æ¤Î·¿Àë¸À.
480
481     #MDrawControl ·¿¤Ï¡¢M-text ¤ò¤É¤¦É½¼¨¤¹¤ë¤«¤òÀ©¸æ¤¹¤ë¹½Â¤ÂΤǤ¢¤ë¡£
482       */
483
484
485 typedef struct
486 {
487   /***en If nonzero, draw an M-text as image, i.e. with background
488       filled with background colors of faces put on the M-text.
489       Otherwise, the background is not changed.  */
490   /***ja 0 ¤Ç¤Ê¤±¤ì¤Ð¡¢ M-text ¤ò²èÁü¤È¤·¤Æ¡¢¤¹¤Ê¤ï¤ÁÇطʤò M-text 
491       ¤Î¥Õ¥§¡¼¥¹¤Ç»ØÄꤵ¤ì¤Æ¤¤¤ëÇØ·Ê¿§¤ÇËä¤á¤Æɽ¼¨¤¹¤ë¡£¤½¤¦¤Ç¤Ê¤±¤ì¤ÐÇطʤÏÊѤï¤é¤Ê¤¤¡£  */
492   unsigned as_image : 1;
493
494   /***en If nonzero and the first glyph of each line has negative
495       lbearing, shift glyphs horizontally to right so that no pixel is
496       drawn to the left of the specified position.  */
497   /***ja 0 ¤Ç¤Ê¤¯¡¢³Æ¹Ô¤ÎºÇ½é¤Î¥°¥ê¥Õ¤Î lbearing 
498       ¤¬Éé¤Ê¤é¤Ð¡¢¥°¥ê¥Õ¤ò¿åÊ¿¤Ë±¦¤Ë¤º¤é¤·¤Æ¡¢»ØÄꤷ¤¿°ÌÃÖ¤è¤êº¸¤Ë¥Ô¥¯¥»¥ë¤¬ÉÁ¤«¤ì¤Ê¤¤¤è¤¦¤Ë¤¹¤ë¡£  */
499   unsigned align_head : 1;
500
501   /***en If nonzero, draw an M-text two-dimensionally, i.e., newlines
502       in M-text breaks lines and the following characters are drawn in
503       the next line.  If <format> is non-NULL, and the function
504       returns nonzero line width, a line longer than that width is
505       also broken.  */
506   /***ja 0 ¤Ç¤Ê¤±¤ì¤Ð¡¢M-text ¤ò£²¼¡¸µÅª¤Ë¡¢¤¹¤Ê¤ï¤Á M-text Ãæ¤Î 
507       newline ¤Ç²þ¹Ô¤·¡¢Â³¤¯Ê¸»ú¤Ï¼¡¤Î¹Ô¤Ëɽ¼¨¤¹¤ë¡£¤â¤· <format> ¤¬ 
508       NULL ¤Ç¤Ê¤¯¡¢¤½¤Î´Ø¿ô¤¬ 0 ¤Ç¤Ê¤¤¹ÔÉý¤òÊÖ¤»¤Ð¡¢¤½¤ÎÉý¤è¤êŤ¤¹Ô¤â²þ¹Ô¤µ¤ì¤ë¡£  */
509   unsigned two_dimensional : 1;
510
511   /***en If nonzero, draw an M-text to the right of a specified
512       position.  */
513   /***ja 0 ¤Ç¤Ê¤±¤ì¤Ð¡¢M-text ¤ò»ØÄꤷ¤¿°ÌÃ֤ᦤËɽ¼¨¤¹¤ë¡£  */
514   unsigned orientation_reversed : 1;
515
516   /***en If nonzero, reorder glyphs correctly for bidi text.  */ 
517   /***ja 0 ¤Ê¤±¤ì¤Ð¡¢bidi ¥Æ¥­¥¹¥ÈÍѤ˥°¥ê¥Õ¤òÀµ¤·¤¯À°Î󤹤롣  */
518   unsigned enable_bidi : 1;
519
520   /***en If nonzero, don't draw characters whose general category (in
521       Unicode) is Cf (Other, format).  */
522   /***ja 0 ¤Ç¤Ê¤±¤ì¤Ð¡¢¥æ¥Ë¥³¡¼¥É¤ËÃÖ¤±¤ë°ìÈÌ¥«¥Æ¥´¥ê¤¬ Cf (Other,
523       format) ¤Ç¤¢¤ëʸ»ú¤òɽ¼¨¤·¤Ê¤¤¡£  */
524   unsigned ignore_formatting_char : 1;
525
526   /***en If nonzero, draw glyphs suitable for a terminal.  Not yet
527       implemented.  */
528   /***ja 0 ¤Ç¤Ê¤±¤ì¤Ð¡¢Ã¼ËöÍѤΥ°¥ê¥Õ¤òɽ¼¨¤¹¤ë¡£Ì¤¼ÂÁõ¡£  */
529   unsigned fixed_width : 1;
530
531   /***en If nonzero, draw glyphs with anti-aliasing if a backend font
532       driver supports it.  */
533   /***ja 0 ¤Ç¤Ê¤±¤ì¤Ð¡¢¥¢¥ó¥Á¥¨¡¼¥ê¥¢¥¹¤Ç¥°¥ê¥Õ¤òɽ¼¨¤¹¤ë¡£
534       ¡Ê¥Ð¥Ã¥¯¥¨¥ó¥É¤Î¥Õ¥©¥ó¥È¥É¥é¥¤¥Ð¤¬¥¢¥ó¥Á¥¨¡¼¥ê¥¢¥¹µ¡Ç½¤ò»ý¤Ä¾ì¹ç¤Î¤ß¡£¡Ë */
535   unsigned anti_alias : 1;
536
537   /***en If nonzero, disable the adjustment of glyph positions to
538       avoid horizontal overlapping at font boundary.  */
539   /***ja 0 ¤Ç¤Ê¤±¤ì¤Ð¡¢¥Õ¥©¥ó¥È¶­³¦¤Ç¤Î¿åÊ¿Êý¸þ¤Î¥°¥ê¥Õ¤Î½Å¤Ê¤ê¤òÈò¤±¤ë¤¿¤á¤Î¥°¥ê¥Õ°ÌÃÖ¤ÎÄ´À°¤ò̵¸ú¤Ë¤¹¤ë¡£  */
540   unsigned disable_overlapping_adjustment : 1;
541
542   /***en If nonzero, the values are minimum line ascent and descent
543       pixels.  */
544   /***ja 0 ¤Ç¤Ê¤±¤ì¤Ð¡¢ÃͤϹԤΠascent ¤È descent ¤ÎºÇ¾®Ãͤò¼¨¤¹¡£  */
545   unsigned int min_line_ascent;
546   unsigned int min_line_descent;
547
548   /***en If nonzero, the values are maximum line ascent and descent
549       pixels.  */
550   /***ja 0 ¤Ç¤Ê¤±¤ì¤Ð¡¢ÃͤϹԤΠascent ¤È descent ¤ÎºÇÂçÃͤò¼¨¤¹¡£  */
551   unsigned int max_line_ascent;
552   unsigned int max_line_descent;
553
554   /***en If nonzero, the value specifies how many pixels each line can
555       occupy on the display.  The value zero means that there is no
556       limit.  It is ignored if <format> is non-NULL.  */
557   /***ja 0 ¤Ç¤Ê¤±¤ì¤Ð¡¢ÃͤϤ³¤Î¥Ç¥£¥¹¥×¥ì¥¤¾å¤Ç³Æ¹Ô¤¬Àê¤á¤ë¤³¤È¤Î¤Ç¤­¤ë¥Ô¥¯¥»¥ë¿ô¤ò¼¨¤¹¡£
558       0 ¤Ï¸ÂÄꤵ¤ì¤Ê¤¤¤³¤È¤ò°ÕÌ£¤¹¤ë¡£<format> ¤¬ NULL ¤Ç¤Ê¤±¤ì¤Ð̵»ë¤µ¤ì¤ë¡£   */
559   unsigned int max_line_width;
560
561   /***en If nonzero, the value specifies the distance between tab
562       stops in columns (the width of one column is the width of a
563       space in the default font of the frame).  The value zero means
564       8.  */
565   /***ja 0 ¤Ç¤Ê¤±¤ì¤Ð¡¢Ãͤϥ¿¥Ö¥¹¥È¥Ã¥×´Ö¤Îµ÷Î¥¤ò¥³¥é¥àñ°Ì
566       ¡Ê¥³¥é¥à¤Ï¥Õ¥ì¡¼¥à¤Î¥Ç¥Õ¥©¥ë¥È¥Õ¥©¥ó¥È¤Ë¤ª¤±¤ë¶õÇòʸ»ú¤ÎÉý¤Ç¤¢¤ë¡Ë¤Ç¼¨¤¹¡£ 
567       0 ¤Ï 8 ¤ò°ÕÌ£¤¹¤ë¡£ */
568   unsigned int tab_width;
569
570   /***en If non-NULL, the value is a function that calculates the
571       indentation and width limit of each line based on the line
572       number LINE and the coordinate Y.  The function store the
573       indentation and width limit at the place pointed by INDENT and
574       WIDTH respectively.
575
576       The indentation specifies how many pixels the first glyph of
577       each line is shifted to the right (if the member
578       <orientation_reversed> is zero) or to the left (otherwise).  If
579       the value is negative, each line is shifted to the reverse
580       direction.
581
582       The width limit specifies how many pixels each line can occupy
583       on the display.  The value 0 means that there is no limit.
584
585       LINE and Y are reset to 0 when a line is broken by a newline
586       character, and incremented each time when a long line is broken
587       because of the width limit.
588
589       This has an effect only when <two_dimensional> is nonzero.  */
590   /***ja 0 ¤Ç¤Ê¤±¤ì¤Ð¡¢Ãͤϴؿô¤Ç¤¢¤ê¡¢¤½¤Î´Ø¿ô¤Ï¹ÔÈÖ¹æ LINE ¤ÈºÂɸ Y 
591       ¤Ë´ð¤Å¤¤¤Æ³Æ¹Ô¤Î¥¤¥ó¥Ç¥ó¥È¤ÈºÇÂçÉý¤ò·×»»¤·¡¢¤½¤ì¤¾¤ì¤òINDENT ¤È
592       WIDTH ¤Ç»Ø¤µ¤ì¤ë¾ì½ê¤ËÊݸ¤¹¤ë¡£
593
594       ¥¤¥ó¥Ç¥ó¥È¤Ï¡¢³Æ¹Ô¤ÎºÇ½é¤Î¥°¥ê¥Õ¤ò±¦¡Ê¥á¥ó¥Ð 
595       <orientation_reversed> ¤¬ 0 
596       ¤Î»þ¡Ë¤¢¤ë¤¤¤Ïº¸¡Ê¤½¤ì°Ê³°¤Î»þ¡Ë¤Ë²¿¥Ô¥¯¥»¥ë¤º¤é¤¹¤«¤ò»ØÄꤹ¤ë¡£Ãͤ¬Éé¤Ê¤é¤ÐµÕÊý¸þ¤Ë¤º¤é¤¹¡£
597
598       ºÇÂçÉý¤Ï¡¢³Æ¹Ô¤¬¥Ç¥£¥¹¥×¥ì¥¤¾å¤ÇÀê¤á¤ë¤³¤È¤Î¤Ç¤­¤ë¥Ô¥¯¥»¥ë¿ô¤ÎºÇÂçÃͤǤ¢¤ë¡£Ãͤ¬
599       0 ¤Î¾ì¹ç¤ÏÀ©¸Â¤ò¼õ¤±¤Ê¤¤¤³¤È¤ò°ÕÌ£¤¹¤ë¡£
600
601       LINE ¤È Y ¤Ï²þ¹Ôʸ»ú¤Ë¤è¤Ã¤Æ¹Ô¤¬²þ¤Þ¤Ã¤¿ºÝ¤Ë¤Ï 0 
602       ¤Ë¥ê¥»¥Ã¥È¤µ¤ì¡¢Ä¹¤¤¹Ô¤¬ºÇÂçÉý¤ÎÀ©¸Â¤Ë¤è¤Ã¤Æ²þ¹Ô¤µ¤ì¤ë¤¿¤Ó¤Ë 1 Áý¤ä¤µ¤ì¤ë¡£
603
604       ¤³¤ì¤Ï <two_dimensional> ¤¬ 0 ¤Ç¤Ê¤¤¾ì¹ç¤Ë¤Î¤ßÍ­¸ú¤Ç¤¢¤ë¡£  */
605   void (*format) (int line, int y, int *indent, int *width);
606
607   /***en If non-NULL, the value is a function that calculates a line
608       breaking position when a line is too long to fit within the
609       width limit.  POS is the position of the character next to the
610       last one that fits within the limit.  FROM is the position of the
611       first character of the line, and TO is the position of the last
612       character displayed on the line if there were not width limit.
613       LINE and Y are the same as the arguments to <format>.
614
615       The function must return a character position to break the
616       line.
617
618       The function should not modify MT.
619
620       The mdraw_default_line_break () function is useful for such a
621       script that uses SPACE as a word separator.  */
622   /***ja NULL ¤Ç¤Ê¤±¤ì¤Ð¡¢ÃͤϹԤ¬ºÇÂçÉýÃæ¤Ë¼ý¤Þ¤é¤Ê¤¤¾ì¹ç¤Ë¹Ô¤ò²þ¤á¤ë°ÌÃÖ¤ò·×»»¤¹¤ë´Ø¿ô¤Ç¤¢¤ë¡£
623       POS ¤ÏºÇÂçÉý¤Ë¼ý¤Þ¤ëºÇ¸å¤Îʸ»ú¤Î¼¡¤Îʸ»ú¤Î°ÌÃ֤Ǥ¢¤ë¡£FROM
624       ¤Ï¹Ô¤ÎºÇ½é¤Îʸ»ú¤Î°ÌÃÖ¡¢TO 
625       ¤ÏºÇÂçÉý¤¬»ØÄꤵ¤ì¤Æ¤¤¤Ê¤±¤ì¤Ð¤½¤Î¹Ô¤Ëɽ¼¨¤µ¤ì¤ëºÇ¸å¤Îʸ»ú¤Î°ÌÃ֤Ǥ¢¤ë¡£LINE 
626       ¤È Y ¤Ï <format> ¤Î°ú¿ô¤ÈƱÍͤǤ¢¤ë¡£
627
628       ¤³¤Î´Ø¿ô¤Ï¹Ô¤ò²þ¤á¤ëʸ»ú°ÌÃÖ¤òÊÖ¤µ¤Ê¤¯¤Æ¤Ï¤Ê¤é¤Ê¤¤¡£¤Þ¤¿ MT ¤òÊѹ¹¤·¤Æ¤Ï¤Ê¤é¤Ê¤¤¡£
629
630       ´Ø¿ô mdraw_default_line_break ()
631       ¤Ï¡¢¶õÇò¤ò¸ì¤Î¶èÀÚ¤ê¤È¤·¤ÆÍѤ¤¤ë¥¹¥¯¥ê¥×¥ÈÍѤȤ·¤ÆÍ­ÍѤǤ¢¤ë¡£  */
632   int (*line_break) (MText *mt, int pos, int from, int to, int line, int y);
633
634   int with_cursor;
635
636   /***en Specifies the character position to display a cursor.  If it
637       is greater than the maximum character position, the cursor is
638       displayed next to the last character of an M-text.  If the value
639       is negative, even if <cursor_width> is nonzero, cursor is not
640       displayed.  */
641   /***ja ¥«¡¼¥½¥ë¤òɽ¼¨¤¹¤ëʸ»ú°ÌÃÖ¤ò¼¨¤¹¡£ºÇÂç¤Îʸ»ú°ÌÃÖ¤è¤êÂ礭¤±¤ì¤Ð¡¢¥«¡¼¥½¥ë¤Ï 
642       M-text ¤ÎºÇ¸å¤Îʸ»ú¤ÎÎÙ¤Ëɽ¼¨¤µ¤ì¤ë¡£Éé¤Ê¤é¤Ð¡¢
643       <cursor_width> ¤¬ 0 ¤Ç¤Ê¤¯¤Æ¤â¥«¡¼¥½¥ë¤Ïɽ¼¨¤µ¤ì¤Ê¤¤¡£
644         */
645   int cursor_pos;
646
647   /***en If nonzero, display a cursor at the character position
648       <cursor_pos>.  If the value is positive, it is the pixel width
649       of the cursor.  If the value is negative, the cursor width is
650       the same as the underlining glyph(s).  */
651   /***ja 0 ¤Ç¤Ê¤±¤ì¤Ð¡¢<cursor_pos> ¤Ë¥«¡¼¥½¥ë¤òɽ¼¨¤¹¤ë¡£
652       Ãͤ¬Àµ¤Ê¤é¤Ð¡¢¥«¡¼¥½¥ë¤ÎÉý¤Ï¤½¤ÎÃÍ¡Ê¥Ô¥¯¥»¥ëñ°Ì¡Ë¤Ç¤¢¤ë¡£
653       Éé¤Ê¤é¤Ð¡¢¥«¡¼¥½¥ë¤Î¤¢¤ë¥°¥ê¥Õ¤ÈƱ¤¸Éý¤Ç¤¢¤ë¡£  */
654   int cursor_width;
655
656   /***en If nonzero and <cursor_width> is also nonzero, display double
657       bar cursors; at the character position <cursor_pos> and at the
658       logically previous character.  Both cursors have one pixel width
659       with horizontal fringes at upper or lower positions.  */
660   /***ja If 0 ¤Ç¤Ê¤¯¡¢¤«¤Ä <cursor_width> ¤â 0 ¤Ç¤Ê¤±¤ì¤Ð¡¢¥Ð¡¼¥«¡¼¥½¥ë¤òʸ»ú°ÌÃÖ
661       <cursor_pos> ¤ÈÏÀÍýŪ¤Ë¤½¤ì¤ÎÁ°¤Ë¤¢¤ëʸ»ú¤Î£²¥ö½ê¤Ëɽ¼¨¤¹¤ë¡£
662       ÁÐÊý¤È¤â£±¥Ô¥¯¥»¥ëÉý¤Ç¡¢¾å¤«²¼¤Ë¿åÊ¿¤Î¾þ¤ê¤¬¤Ä¤¯¡£*/
663   int cursor_bidi;
664
665   /***en If nonzero, on drawing partial text, pixels of surrounding
666       texts that intrude into the drawing area are also drawn.  For
667       instance, some CVC sequence of Thai text (C is consonant, V is
668       upper vowel) is drawn so that V is placed over the middle of two
669       Cs.  If this CVC sequence is already drawn and only the last C
670       is drawn again (for instance by updating cursor position), the
671       right half of V is erased if this member is zero.  By setting
672       this member to nonzero, even with such a drawing, we can keep
673       this CVC sequence correctly displayed.  */
674   /***ja 0 ¤Ç¤Ê¤±¤ì¤Ð¡¢¥Æ¥­¥¹¥È¤Î°ìÉôʬ¤òɽ¼¨¤¹¤ëºÝ¤Ë¡¢Á°¸å¤Î¥Æ¥­¥¹¥È¤Î¤¦¤Á¤½¤Îɽ¼¨Îΰè¤Ë¿¯Æþ¤¹¤ëÉôʬ¤âɽ¼¨¤¹¤ë¡£
675       ¤¿¤È¤¨¤Ð¡¢¥¿¥¤¸ì¥Æ¥­¥¹¥È »Ò²»-Êì²»-»Ò²» 
676       ¤È¤¤¤¦¥·¡¼¥¯¥¨¥ó¥¹¤Î¤¤¤¯¤Ä¤«¤Ï¡¢Êì²»¤¬Æó¤Ä¤Î»Ò²»¤Î´Ö¤Ë¾å¤Ë¤Î¤ë¤è¤¦¤ËÉÁ¤«¤ì¤ë¡£
677       ¤³¤Î¤è¤¦¤Ê¥·¡¼¥¯¥¨¥ó¥¹¤¬¤¹¤Ç¤ËÉÁ¤«¤ì¤Æ¤ª¤ê¡¢ºÇ¸å¤Î»Ò²»¤À¤±¤òÉÁ¤­Ä¾¤¹¾ì¹ç
678       ¡Ê¤¿¤È¤¨¤Ð¡¢¥«¡¼¥½¥ë°ÌÃÖ¤ò¹¹¿·¤¹¤ëºÝ¤Ê¤É¡Ë¤³¤Î¥á¥ó¥Ð¤¬ 0 
679       ¤Ç¤¢¤ì¤Ð¡¢Êì²»¤Î±¦È¾Ê¬¤¬¾Ã¤µ¤ì¤Æ¤·¤Þ¤¦¡£¤³¤ì¤ò 0 °Ê³°¤Ë¤¹¤ë¤³¤È¤Ë¤è¤Ã¤Æ¡¢¤½¤Î¤è¤¦¤ÊºÝ¤Ë¤â
680       »Ò²»-Êì²»-»Ò²» ¤Î¥·¡¼¥¯¥¨¥ó¥¹¤òÀµ¤·¤¯É½¼¨¤·Â³¤±¤ë¤³¤È¤¬¤Ç¤­¤ë¡£  */
681   int partial_update;
682
683   /***en If nonzero, don't cache the result of any drawing information
684       of an M-text.  */
685   /***ja 0 ¤Ç¤Ê¤±¤ì¤Ð¡¢M-text ¤Îɽ¼¨¤Ë´Ø¤¹¤ë¾ðÊó¤ò¥­¥ã¥Ã¥·¥å¤·¤Ê¤¤¡£
686        */
687   int disable_caching;
688
689   /* If non-NULL, limit the drawing effect to the specified region.  */
690   MDrawRegion clip_region;
691
692 } MDrawControl;
693
694 extern int mdraw_line_break_option;
695
696 /*=*/
697
698 /*** @ingroup m17nDraw */
699 /***en
700     @brief Type of metric for glyphs and texts.
701
702     The type #MDrawMetric is for a metric of a glyph and a drawn text.
703     It is also used to represent a rectangle area of a graphic
704     device.  */
705 /***ja
706     @brief ¥°¥ê¥Õ¤È¥Æ¥­¥¹¥È¤ÎÀ£Ë¡¤Î·¿Àë¸À.
707
708     #MDrawMetric ¤Ï¥°¥ê¥Õ¤Èɽ¼¨¤µ¤ì¤¿¥Æ¥­¥¹¥È¤ÎÀ£Ë¡ÍѤη¿¤Ç¤¢¤ë¡£
709     ¤Þ¤¿¡¢É½¼¨¥Ç¥Ð¥¤¥¹¤Î¶ë·ÁÎΰè¤òɽ¤¹¤Î¤Ë¤âÍѤ¤¤é¤ì¤ë¡£ */
710
711 typedef struct {
712   int x, y;
713   unsigned int width, height;
714 } MDrawMetric;
715
716 /*=*/
717
718 /*** @ingroup m17nDraw */
719 /***en
720     @brief Type of information about a glyph.
721
722     The type #MDrawGlyphInfo is the structure that contains
723     information about a glyph.  It is used by mdraw_glyph_info ().  */
724 /***ja
725     @brief ¥°¥ê¥Õ¤Ë´Ø¤¹¤ë¾ðÊó¤Î·¿Àë¸À.
726
727     #MDrawGlyphInfo ·¿¤Ï¥°¥ê¥Õ¤Ë´Ø¤¹¤ë¾ðÊó¤ò´Þ¤à¹½Â¤ÂΤǤ¢¤ë¡£
728     mdraw_glyph_info () ¤Ï¤³¤ì¤òÍѤ¤¤ë¡£  */
729
730 typedef struct
731 {
732   /***en Character range corresponding to the glyph.  */
733   /***ja ¥°¥ê¥Õ¤ËÂбþ¤¹¤ëʸ»ú¤ÎÈÏ°Ï.  */
734   int from, to;
735
736   /***en Character ranges corresponding to the line of the glyph.  */
737   /***ja  ¥°¥ê¥Õ¤ÎÎó¤ËÂбþ¤¹¤ëʸ»ú¤ÎÈÏ°Ï.  */
738   int line_from, line_to;
739
740   /***en X/Y coordinates of the glyph.  */
741   /***ja ¥°¥ê¥Õ¤Î X/Y ºÂɸ.  */
742   int x, y;
743
744   /***en Metric of the glyph.  */
745   /***ja ¥°¥ê¥Õ¤ÎÀ£Ë¡.  */
746   MDrawMetric metrics;
747
748   /***en Font used for the glyph.  Set to NULL if no font is found for
749       the glyph.  */
750   /***ja ¥°¥ê¥Õ¤Ë»È¤ï¤ì¤ë¥Õ¥©¥ó¥È¡£¸«¤Ä¤«¤é¤Ê¤±¤ì¤Ð NULL¡£ */
751       
752   MFont *font;
753
754   /***en Character ranges corresponding to logically previous and next
755       glyphs.  Note that we do not need the members prev_to and
756       next_from because they must be the same as the members from and
757       to respectively.  */
758   /***ja ÏÀÍýŪ¤ÊÁ°¸å¤Î¥°¥ê¥Õ¤ËÂбþ¤¹¤ëʸ»ú¤ÎÈÏ°Ï¡£¥á¥ó¥Ð prev_to ¤È
759       next_from ¤Ï¡¢¤½¤ì¤¾¤ì¥á¥ó¥Ð from ¤È to ¤ÈƱ¤¸¤Ç¤¢¤ë¤Ï¤º¤Ê¤Î¤ÇÉÔ
760       ÍפǤ¢¤ë¡£  */
761   int prev_from, next_to;
762
763   /***en Character ranges corresponding to visually left and right
764       glyphs. */
765   /***ja É½¼¨¾å¤Îº¸±¦¤Î¥°¥ê¥Õ¤ËÂбþ¤¹¤ëʸ»ú¤ÎÈÏ°Ï¡£  */
766   int left_from, left_to;
767   int right_from, right_to;
768
769   /***en Logical width of the glyph.  Nominal distance to the next
770       glyph.  */
771   /***ja ¥°¥ê¥Õ¤ÎÏÀÍýŪÉý¡£¼¡¤Î¥°¥ê¥Õ¤È¤Î̾Ìܾå¤Îµ÷Î¥¡£  */
772   int logical_width;
773 } MDrawGlyphInfo;
774
775 /*=*/
776
777 /*** @ingroup m17nDraw */
778 /***en
779     @brief Type of information about a glyph metric and font.
780
781     The type #MDrawGlyph is the structure that contains information
782     about a glyph metric and font.  It is used by the function
783     mdraw_glyph_list ().  */
784 /***ja
785     @brief ¥°¥ê¥Õ¤ÎÀ£Ë¡¤È¥Õ¥©¥ó¥È¤Ë´Ø¤¹¤ë¾ðÊó¤Î·¿Àë¸À.
786
787     #MDrawGlyph ·¿¤Ï¥°¥ê¥Õ¤ÎÀ£Ë¡¤È¥Õ¥©¥ó¥È¤Ë´Ø¤¹¤ë¾ðÊó¤ò´Þ¤à¹½Â¤ÂΤǤ¢¤ë¡£
788     mdraw_glyph_list () ¤Ï¤³¤ì¤òÍѤ¤¤ë¡£  */
789
790 typedef struct
791 {
792   /***en Character range corresponding to the glyph.  */
793   /***ja ¥°¥ê¥Õ¤ËÂбþ¤¹¤ëʸ»ú¤ÎÈÏ°Ï.  */
794   int from, to;
795
796   /***en Font glyph code of the glyph.  */
797   /***ja ¥Õ¥©¥ó¥ÈÆâ¤Î¥°¥ê¥Õ¥³¡¼¥É¡£  */
798   int glyph_code;
799
800   /***en Logical width of the glyph.  Nominal distance to the next
801       glyph.  */
802   /***ja ¥°¥ê¥Õ¤ÎÏÀÍýŪÉý¡£¼¡¤Î¥°¥ê¥Õ¤È¤Î̾Ìܾå¤Îµ÷Î¥¡£  */
803   int x_advance, y_advance;
804
805   /***en X/Y offset relative to the glyph position.  */
806   /***ja ¥°¥ê¥Õ¤Î°ÌÃÖ¤ËÂФ¹¤ë X/Y ¥ª¥Õ¥»¥Ã¥È.  */
807   int x_off, y_off;
808
809   /***en Metric of the glyph.  */
810   /***ja ¥°¥ê¥Õ¤ÎÀ£Ë¡.  */
811   int lbearing, rbearing, ascent, descent;
812
813   /***en Font used for the glyph.  Set to NULL if no font is found for
814       the glyph.  */
815   /***ja ¥°¥ê¥Õ¤Ë»È¤ï¤ì¤ë¥Õ¥©¥ó¥È¡£¸«¤Ä¤«¤é¤Ê¤±¤ì¤Ð NULL¡£  */
816   MFont *font;
817
818   /***en Type of the font.  One of Mx, Mfreetype, Mxft.  */
819   /***ja ¥Õ¥©¥ó¥È¤Î¥¿¥¤¥×¡£Mx¡¢Mfreetype¡¢Mxft ¤Î¤¤¤º¤ì¤«¡£  */
820   MSymbol font_type;
821
822   /***en Pointer to the font structure.  The actual type is
823       (XFontStruct *) if <font_type> member is Mx, FT_Face if
824       <font_type> member is Mfreetype, and (XftFont *) if <font_type>
825       member is Mxft.  */
826   /***ja ¥Õ¥©¥ó¥È¤Î¹½Â¤ÂΤؤΥݥ¤¥ó¥¿¡£¼ÂºÝ¤Î·¿¤Ï <font_type> ¥á¥ó¥Ð¤¬
827       Mx ¤Ê¤é (XFontStruct *)¡¢ Mfreetype ¤Ê¤é FT_Face¡¢Mxft 
828       ¤Ê¤é (XftFont *)¡£ */
829   void *fontp;
830
831 } MDrawGlyph;
832
833 /*=*/
834
835 /***en
836     @brief Type of textitems.
837
838     The type #MDrawTextItem is for @e textitem objects.
839     Each textitem contains an M-text and some other information to
840     control the drawing of the M-text.  */
841
842 /***ja
843     @brief textitem ¤Î·¿Àë¸À.
844
845     #MDrawTextItem ¤Ï @e ¥Æ¥­¥¹¥È¥¢¥¤¥Æ¥à ¥ª¥Ö¥¸¥§¥¯¥ÈÍѤη¿¤Ç¤¢¤ë¡£
846     ³Æ¥Æ¥­¥¹¥È¥¢¥¤¥Æ¥à¤Ï¡¢ 1 ¸Ä¤Î M-text ¤È¡¢¤½¤Îɽ¼¨¤òÀ©¸æ¤¹¤ë¤¿¤á¤Î¾ðÊó¤ò´Þ¤ó¤Ç¤¤¤ë¡£
847
848     @latexonly \IPAlabel{MTextItem} @endlatexonly  */
849
850 typedef struct
851 {
852   /***en M-text. */
853   /***ja M-text. */
854   MText *mt;                      
855
856   /***en Optional change in the position (in the unit of pixel) along
857       the X-axis before the M-text is drawn.  */
858   /***ja M-text É½¼¨Á°¤Ë¹Ô¤Ê¤¦X¼´Êý¸þ¤Î°ÌÃÖÄ´À° (¥Ô¥¯¥»¥ëñ°Ì) */
859   int delta;                     
860
861   /***en Pointer to a face object.  Each property of the face, if not
862       Mnil, overrides the same property of face(s) specified as a text
863       property in <mt>.  */
864   /***ja ¥Õ¥§¡¼¥¹¥ª¥Ö¥¸¥§¥¯¥È¤Ø¤Î¥Ý¥¤¥ó¥¿¡£¥Õ¥§¡¼¥¹¤Î³Æ¥×¥í¥Ñ¥Æ¥£¤Ï 
865       Mnil ¤Ç¤Ê¤±¤ì¤Ð <mt> ¤Ç»ØÄꤵ¤ì¤¿¥Õ¥§¡¼¥¹¤ÎƱ¤¸¥×¥í¥Ñ¥Æ¥£¤ËÍ¥À褹¤ë*/
866   MFace *face;
867
868   /***en Pointer to a draw control object.  The M-text <mt> is drawn
869       by mdraw_text_with_control () with this control object.  */
870   /***ja É½¼¨À©¸æ¥ª¥Ö¥¸¥§¥¯¥È¤Ø¤Î¥Ý¥¤¥ó¥¿¡£ mdraw_text_with_control () 
871       ¤Ï¤³¤Î¥ª¥Ö¥¸¥§¥¯¥È¤òÍѤ¤¤Æ M-text <mt> ¤òɽ¼¨¤¹¤ë¡£  */
872   MDrawControl *control;
873
874 } MDrawTextItem;
875
876 /*=*/
877
878 extern int mdraw_text (MFrame *frame, MDrawWindow win, int x, int y,
879                        MText *mt, int from, int to);
880
881 extern int mdraw_image_text (MFrame *frame, MDrawWindow win, int x, int y,
882                              MText *mt, int from, int to);
883
884 extern int mdraw_text_with_control (MFrame *frame, MDrawWindow win,
885                                     int x, int y, MText *mt, int from, int to,
886                                     MDrawControl *control);
887
888 extern int mdraw_coordinates_position (MFrame *frame,
889                                        MText *mt, int from, int to,
890                                        int x, int y, MDrawControl *control);
891
892 extern int mdraw_text_extents (MFrame *frame,
893                                MText *mt, int from, int to,
894                                MDrawControl *control,
895                                MDrawMetric *overall_ink_return,
896                                MDrawMetric *overall_logical_return,
897                                MDrawMetric *overall_line_return);
898
899 extern int mdraw_text_per_char_extents (MFrame *frame,
900                                         MText *mt, int from, int to,
901                                         MDrawControl *control,
902                                         MDrawMetric *ink_array_return,
903                                         MDrawMetric *logical_array_return,
904                                         int array_size,
905                                         int *num_chars_return,
906                                         MDrawMetric *overall_ink_return,
907                                         MDrawMetric *overall_logical_return);
908
909 extern int mdraw_glyph_info (MFrame *frame, MText *mt, int from, int pos,
910                              MDrawControl *control, MDrawGlyphInfo *info);
911
912 extern int mdraw_glyph_list (MFrame *frame, MText *mt, int from, int to,
913                              MDrawControl *control, MDrawGlyph *glyphs,
914                              int array_size, int *num_glyphs_return);
915
916 extern void mdraw_text_items (MFrame *frame, MDrawWindow win, int x, int y,
917                               MDrawTextItem *items, int nitems);
918
919 extern void mdraw_per_char_extents (MFrame *frame, MText *mt,
920                                     MDrawMetric *array_return,
921                                     MDrawMetric *overall_return);
922
923 extern int mdraw_default_line_break (MText *mt, int pos,
924                                      int from, int to, int line, int y);
925
926 extern void mdraw_clear_cache (MText *mt);
927
928 /* end of drawing module */
929 /*=*/
930
931 /*** @ingroup m17nGUI */
932 /***en @defgroup m17nInputMethodWin Input Method (GUI) */
933 /***ja @defgroup m17nInputMethodWin ÆþÎϥ᥽¥Ã¥É (GUI) */
934 /*=*/
935
936 extern MInputDriver minput_gui_driver;
937
938 /*=*/
939 /*** @ingroup m17nInputMethodWin */
940 /***en 
941     @brief Type of the argument to the function minput_create_ic ().
942
943     The type #MInputGUIArgIC is for the argument $ARG of the function
944     minput_create_ic () to create an input context of an internal
945     input method.  */
946
947 /***ja
948     @brief ´Ø¿ô minput_create_ic () ¤Î°ú¿ô¤Î·¿Àë¸À.
949
950     #MInputGUIArgIC ¤Ï¡¢´Ø¿ô minput_create_ic () 
951     ¤¬ÆâÉôÆþÎϥ᥽¥Ã¥É¤ÎÆþÎÏ¥³¥ó¥Æ¥¯¥¹¥È¤òÀ¸À®¤¹¤ëºÝ¤Î¡¢°ú¿ô $ARG ÍѤη¿¤Ç¤¢¤ë¡£  */
952
953 typedef struct
954 {
955   /***en Frame of the client.  */
956   /***ja ¥¯¥é¥¤¥¢¥ó¥È¤Î¥Õ¥ì¡¼¥à  */
957   MFrame *frame;
958
959   /***en Window on which to display the preedit and status text.  */
960   /***ja preedit ¥Æ¥­¥¹¥È¤È status ¥Æ¥­¥¹¥È¤òɽ¼¨¤¹¤ë¥¦¥£¥ó¥É¥¦  */
961   MDrawWindow client;
962
963   /***en Window that the input context has a focus on.  */
964   /***ja ÆþÎÏ¥³¥ó¥Æ¥¯¥¹¥È¤¬¥Õ¥©¡¼¥«¥¹¤ò¤ª¤¤¤Æ¤¤¤ë¥¦¥£¥ó¥É¥¦  */
965   MDrawWindow focus;
966 } MInputGUIArgIC;
967
968 /*=*/
969
970 extern MSymbol minput_event_to_key (MFrame *frame, void *event);
971
972 /* end of input module */
973 /*=*/
974 /* end of window modules */
975 /*=*/
976
977 extern MFace *mdebug_dump_face (MFace *face, int indent);
978 extern MFont *mdebug_dump_font (MFont *font);
979 extern MFontset *mdebug_dump_fontset (MFontset *fontset, int indent);
980
981 #ifdef __cplusplus
982 }
983 #endif
984
985 #endif /* _M17N_GUI_H_ */
986
987 /*
988   Local Variables:
989   coding: euc-japan
990   End:
991 */