.\" 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 "m17nInputMethodWin" 3m17n "Mon Sep 25 2023" "Version 1.8.4" "The m17n Library" \" -*- nroff -*- .ad l .nh .SH NAME m17nInputMethodWin_\-_Input_Method_( \- \- Input method support on window systems\&. .SH SYNOPSIS .br .PP .SS "Data Structures" .in +1c .ti -1c .RI "struct \fBMInputGUIArgIC\fP" .br .RI "Type of the argument to the function \fBminput_create_ic()\fP\&. " .ti -1c .RI "struct \fBMInputXIMArgIM\fP" .br .RI "Structure pointed to by the argument \fBarg\fP of the function \fBminput_open_im()\fP\&. " .ti -1c .RI "struct \fBMInputXIMArgIC\fP" .br .RI "Structure pointed to by the argument \fBarg\fP of the function \fBminput_create_ic()\fP\&. " .in -1c .SS "Functions" .in +1c .ti -1c .RI "MSymbol \fBminput_event_to_key\fP (\fBMFrame\fP *frame, void *event)" .br .RI "Convert an event to an input key\&. " .in -1c .SS "Variables" .in +1c .ti -1c .RI "\fBMInputDriver\fP \fBminput_gui_driver\fP" .br .RI "Input driver for internal input methods on window systems\&. " .ti -1c .RI "MSymbol \fBMxim\fP" .br .RI "Symbol of the name 'xim'\&. " .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\&. .br .SH "Data Structure Documentation" .SS MInputGUIArgIC .PP Type of the argument to the function \fBminput_create_ic()\fP\&. .ad l .nh .PP \fBFIELD DOCUMENTATION:\fP .PP .PP \fB\fBMFrame\fP* MInputGUIArgIC::frame\fP Frame of the client\&. .PP \fB\fBMDrawWindow\fP MInputGUIArgIC::client\fP Window on which to display the preedit and status text\&. .PP \fB\fBMDrawWindow\fP MInputGUIArgIC::focus\fP Window that the input context has a focus on\&. .SS MInputXIMArgIM .PP Structure pointed to by the argument \fBarg\fP of the function \fBminput_open_im()\fP\&. .ad l .nh .PP \fBFIELD DOCUMENTATION:\fP .PP .PP \fBDisplay* MInputXIMArgIM::display\fP The meaning of the following four members are the same as arguments to XOpenIM()\&. .br Display of the client\&. .PP \fBXrmDatabase MInputXIMArgIM::db\fP Pointer to the X resource database\&. .PP \fBchar* MInputXIMArgIM::res_class\fP Full class name of the application\&. .PP \fBchar* MInputXIMArgIM::res_name\fP Full resource name of the application\&. .PP \fBchar* MInputXIMArgIM::locale\fP Locale name under which an XIM is opened\&. .PP \fBchar* MInputXIMArgIM::modifier_list\fP Arguments to XSetLocaleModifiers()\&. .SS MInputXIMArgIC .PP Structure pointed to by the argument \fBarg\fP of the function \fBminput_create_ic()\fP\&. .ad l .nh .PP \fBFIELD DOCUMENTATION:\fP .PP .PP \fBXIMStyle MInputXIMArgIC::input_style\fP Used as the arguments of \fCXCreateIC\fP following \fCXNInputStyle\fP\&. If this is zero, ( \fCXIMPreeditNothing\fP | \fCXIMStatusNothing\fP) is used, and and are set to \fCNULL\fP\&. .br .PP \fBWindow MInputXIMArgIC::client_win\fP Used as the argument of \fCXCreateIC\fP following \fCXNClientWindow\fP\&. .PP \fBWindow MInputXIMArgIC::focus_win\fP Used as the argument of \fCXCreateIC\fP following \fCXNFocusWindow\fP\&. .PP \fBXVaNestedList MInputXIMArgIC::preedit_attrs\fP If non\- \fCNULL\fP, used as the argument of \fCXCreateIC\fP following \fCXNPreeditAttributes\fP\&. .br .PP \fBXVaNestedList MInputXIMArgIC::status_attrs\fP If non\- \fCNULL\fP, used as the argument of \fCXCreateIC\fP following \fCXNStatusAttributes\fP\&. .br .SH "Variable Documentation" .PP .SS "\fBMInputDriver\fP minput_gui_driver" .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\&. .br .SS "MSymbol Mxim" .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\&. .br .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 .