m17nInputMethodWin(3m17n)

πŸ“¦
version 1.8.4 Β· 2 versions
, in debian trixie, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

πŸ’– NAME πŸ’–

m17nInputMethodWin_-_Input_Method_( - - β€” input method support on window systems. πŸ’…

okay bestie so this is the m17nInputMethodWin page from the m17n library (that's manual section 3m17n), and it's all about how input methods vibe on window systems. it's giving ✨niche but essential✨. let's go 🫢


✨ 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. literally its whole job πŸ’«

πŸ¦‹ 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. no cap, that's the whole topic πŸ’–

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. (yes bestie, go read that one too, it's the sequel πŸ“–)

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(). that's it, that's the struct's whole personality πŸ’…

⭐ 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(). iconic behaviour honestly ✨

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. (yes, "must are" β€” we don't fix the lore, we preserve it πŸ’€)

  • 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().
bestie please actually pay attention to these rules 😭 the driver-dependent args have opinions and they will not be negotiated with.

πŸ’œ 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. periodt. πŸ‘‘


πŸ’œ AUTHOR πŸ’œ

generated automatically by Doxygen for The m17n Library from the source code. (not a human, just vibes and automation πŸ€–)

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>.


okay that's the whole page bestie, you ate it πŸ“ thanks for reading to the end, mwah πŸ’– this was Version 1.8.4, dated Mon Sep 25 2023, straight from The m17n Library β€” catch you on the next man page, byeee πŸ¦‹βœ¨

πŸ“¦ where this page comes from