minput_get_command(3m17n) [debian man page]
minput_get_command(3m17n) The m17n Library minput_get_command(3m17n) NAME
minput_get_command - Get information about input method command(s). SYNOPSIS
MPlist* minput_get_command (MSymbol language, MSymbol name, MSymbol command) DESCRIPTION
Get information about input method command(s). The minput_get_command() function returns information about the command command of the input method specified by language and name. An input method command is a pseudo key event to which one or more actual input key sequences are assigned. There are two kinds of commands, global and local. A global command has a global definition, and the description and the key assignment may be inherited by a local command. Each input method defines a local command which has a local key assignment. It may also declare a local command that inherits the definition of a global command of the same name. If language is Mt and name is Mnil, this function returns information about a global command. Otherwise information about a local command is returned. If command is Mnil, information about all commands is returned. The return value is a well-formed plist (Property List) of this format: ((NAME DESCRIPTION STATUS [KEYSEQ ...]) ...) NAME is a symbol representing the command name. DESCRIPTION is an M-text describing the command, or Mnil if the command has no description. STATUS is a symbol representing how the key assignment is decided. The value is Mnil (the default key assignment), Mcustomized (the key assignment is customized by per-user customization file), or Mconfigured (the key assignment is set by the call of minput_config_command()). For a local command only, it may also be Minherited (the key assignment is inherited from the corresponding global command). KEYSEQ is a plist of one or more symbols representing a key sequence assigned to the command. If there's no KEYSEQ, the command is currently disabled (i.e. no key sequence can trigger actions of the command). If command is not Mnil, the first element of the returned plist contains the information about command. RETURN VALUE
If the requested information was found, a pointer to a non-empty plist is returned. As the plist is kept in the library, the caller must not modify nor free it. Otherwise (the specified input method or the specified command does not exist), NULL is returned. Example: MText * get_im_command_description (MSymbol language, MSymbol name, MSymbol command) { /* Return a description of the command COMMAND of the input method specified by LANGUAGE and NAME. */ MPlist *cmd = minput_get_command (langauge, name, command); MPlist *plist; if (! cmds) return NULL; plist = mplist_value (cmds); /* (NAME DESCRIPTION STATUS KEY-SEQ ...) */ plist = mplist_next (plist); /* (DESCRIPTION STATUS KEY-SEQ ...) */ return (mplist_key (plist) == Mtext ? (MText *) mplist_value (plist) : NULL); } 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>. Version 1.6.2 12 Jan 2011 minput_get_command(3m17n)
Check Out this Related Man Page
Symbol(3m17n) The m17n Library Symbol(3m17n) NAME
Symbol - Symbol objects and API for them. Typedefs typedef struct MSymbolStruct * MSymbol Type of symbols. Functions MSymbol msymbol (const char *name) Get a symbol. MSymbol msymbol_as_managing_key (const char *name) Create a managing key. int msymbol_is_managing_key (MSymbol symbol) Check if a symbol is a managing key. MSymbol msymbol_exist (const char *name) Search for a symbol that has a specified name. char * msymbol_name (MSymbol symbol) Get symbol name. int msymbol_put (MSymbol symbol, MSymbol key, void *val) Set the value of a symbol property. void * msymbol_get (MSymbol symbol, MSymbol key) Get the value of a symbol property. int msymbol_put_func (MSymbol symbol, MSymbol key, M17NFunc func) Set the value (function pointer) of a symbol property. M17NFunc msymbol_get_func (MSymbol symbol, MSymbol key) Get the value (function pointer) of a symbol property. Variables MSymbol Mnil Symbol whose name is 'nil'. MSymbol Mt Symbol whose name is 't'. MSymbol Mstring Symbol whose name is 'string'. MSymbol Msymbol Symbol whose name is 'symbol'. Detailed Description Symbol objects and API for them. The m17n library uses objects called symbols as unambiguous identifiers. Symbols are similar to atoms in the X library, but a symbol can have zero or more symbol properties. A symbol property consists of a key and a value, where key is also a symbol and value is anything that can be cast to (void *). 'The symbol property that belongs to the symbol S and whose key is K' may be shortened to 'K property of S'. Symbols are used mainly in the following three ways. o As keys of symbol properties and other properties. o To represent various objects, e.g. charsets, coding systems, fontsets. o As arguments of the m17n library functions to control their behavior. There is a special kind of symbol, a managing key. The value of a property whose key is a managing key must be a managed object. See Managed Object for the detail. Typedef Documentation typedef struct MSymbolStruct* MSymbol Type of symbols. The type MSymbol is for a symbol object. Its internal structure is concealed from application programs. Variable Documentation MSymbol Mnil Symbol whose name is 'nil'. The symbol Mnil has the name 'nil' and, in general, represents false or no. When coerced to 'int', its value is zero. Mnil can't have any symbol property. MSymbol Mt Symbol whose name is 't'. The symbol Mt has the name 't' and, in general, represents true or yes. MSymbol Mstring Symbol whose name is 'string'. The symbol Mstring has the name 'string' and is used as an argument of the functions mchar_define_property(), etc. MSymbol Msymbol Symbol whose name is 'symbol'. The symbol Msymbol has the name 'symbol' and is used as an argument of the functions mchar_define_property(), etc. 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>. Version 1.6.2 12 Jan 2011 Symbol(3m17n)