---
name: "m17nInputMethodWin"
section: "3m17n"
platform: "linux"
package: "m17n-docs"
version: "1.8.4-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/m17nInputMethodWin"
---

# m17nInputMethodWin(3m17n)

\- Input method support on window systems.

## NAME

m17nInputMethodWin\_-\_Input\_Method\_( -  - Input method support on window systems.

## SYNOPSIS

### Data Structures

struct **MInputGUIArgIC**\
 Type of the argument to the function **minput\_create\_ic()**.  struct **MInputXIMArgIM**\
 Structure pointed to by the argument **arg** of the function **minput\_open\_im()**.  struct **MInputXIMArgIC**\
 Structure pointed to by the argument **arg** of the function **minput\_create\_ic()**.

### Functions

MSymbol **minput\_event\_to\_key** (**MFrame** \*frame, void \*event)\
 Convert an event to an input key.

### Variables

**MInputDriver** **minput\_gui\_driver**\
 Input driver for internal input methods on window systems.  MSymbol **Mxim**\
 Symbol of the name 'xim'.

## Detailed Description

Input method support on window systems.

The input driver `minput_gui_driver` 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 `minput_gui_driver` for more details.

In the m17n-X library, the foreign input method of name `Mxim` is provided. It uses XIM (X Input Method) as a background input engine. The symbol `Mxim` has a property `Minput_driver` whose value is a pointer to the input driver `minput_xim_driver`. See the documentation of `minput_xim_driver` for more details. \

## Data Structure Documentation

### MInputGUIArgIC

Type of the argument to the function **minput\_create\_ic()**.

**FIELD DOCUMENTATION:**

**MFrame\* MInputGUIArgIC::frame** **Frame of the client.**

**MDrawWindow MInputGUIArgIC::client** **Window on which to display the preedit and status text.**

**MDrawWindow MInputGUIArgIC::focus** **Window that the input context has a focus on.**

### MInputXIMArgIM

**Structure pointed to by the argument arg of the function minput\_open\_im().**

**FIELD DOCUMENTATION:**

**Display\* MInputXIMArgIM::display** **The meaning of the following four members are the same as arguments to XOpenIM().** \
\
  **Display of the client.**

**XrmDatabase MInputXIMArgIM::db** **Pointer to the X resource database.**

**char\* MInputXIMArgIM::res\_class** **Full class name of the application.**

**char\* MInputXIMArgIM::res\_name** **Full resource name of the application.**

**char\* MInputXIMArgIM::locale** **Locale name under which an XIM is opened.**

**char\* MInputXIMArgIM::modifier\_list** **Arguments to XSetLocaleModifiers().**

### MInputXIMArgIC

**Structure pointed to by the argument arg of the function minput\_create\_ic().**

**FIELD DOCUMENTATION:**

**XIMStyle MInputXIMArgIC::input\_style** **Used as the arguments of** `XCreateIC` **following** `XNInputStyle`**. If this is zero, (** `XIMPreeditNothing` **\|** `XIMStatusNothing`**) is used, and \<preedit\_attrs\> and \<status\_attrs\> are set to** `NULL`**.** \

**Window MInputXIMArgIC::client\_win** **Used as the argument of** `XCreateIC` **following** `XNClientWindow`**.**

**Window MInputXIMArgIC::focus\_win** **Used as the argument of** `XCreateIC` **following** `XNFocusWindow`**.**

**XVaNestedList MInputXIMArgIC::preedit\_attrs** **If non-** `NULL`**, used as the argument of** `XCreateIC` **following** `XNPreeditAttributes`**.** \

**XVaNestedList MInputXIMArgIC::status\_attrs** **If non-** `NULL`**, used as the argument of** `XCreateIC` **following** `XNStatusAttributes`**.** \

## Variable Documentation

### MInputDriver minput\_gui\_driver

**Input driver for internal input methods on window systems. The input driver** `minput_gui_driver` **is for internal input methods to be used on window systems.**

**It creates sub-windows for a preedit text and a status text, and displays them at the input spot set by the function minput\_set\_spot().**

**The macro M17N\_INIT() set the variable** `minput_driver` **to the pointer to this driver so that all internal input methods use it.**

**Therefore, unless** `minput_driver` **is changed from the default, the driver dependent arguments to the functions whose name begin with minput\_ must are treated as follows.**

**The argument arg of the function minput\_open\_im() is ignored.**

**The argument arg of the function minput\_create\_ic() must be a pointer to the structure MInputGUIArgIC. See the documentation of MInputGUIArgIC for more details.**

**If the argument key of function minput\_filter() is** `Mnil`**, the argument arg must be a pointer to the object of type** `XEvent`**. In that case, key is generated from arg.**

**The argument arg of the function minput\_lookup() must be the same one as that of the function minput\_filter().** \

### MSymbol Mxim

**Symbol of the name 'xim'. The variable Mxim is a symbol of name 'xim'. It is a name of the input method driver minput\_xim\_driver.** \

## Author

**Generated automatically by Doxygen for The m17n Library from the source code.**

## COPYRIGHT

**Copyright (C) 2001 Information-technology Promotion Agency (IPA)**\
 **Copyright (C) 2001-2011 National Institute of Advanced Industrial Science and Technology (AIST)**\
 **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\>.**