XGetICValues()XGetICValues()NameXGetICValues – get input context attributes.
Synopsis
char *XGetICValues(ic, ...)
XIC ic;
Arguments
ic Specifies the input context.
... Specifies the variable length argument list to set or get XIC
values.
Returns
NULL if no error occurred; otherwise, the name of the first attribute
that could not be obtained.
Availability
Release 5 and later.
DescriptionXGetICValues() queries the values of input context attributes. The
first argument is the input context, and it is followed by a NULL-ter‐
minated variable-length argument list of attribute name/value pairs.
The standard attributes and their types are listed in the tables below.
Input Context Attributes
Name Type Notes
XNInputStyle XIMStyle Required at IC creation; may not be
changed.
XNClientWindow Window Must be set before IC use; may not be
changed.
XNFocusWindow Window Changes may cause geometry negotiation.
XNResourceName char *
XNResourceClass char *
XNGeometryCallback XIMCallback *XNFilterEvents unsigned long Read-only attribute; may not be set.
XNPreeditAttributes XVaNestedList See sub-attributes below.
XNStatusAttributes XVaNestedList See sub-attributes below.
Pre-edit and Status Area Sub-attributes
Name Type Notes
XNArea XRectangle *
XNAreaNeeded XRectangle *
XNSpotLocation XPoint * Required at IC
creation for
XIMPreeditPosi‐
tion style.
XNColormap Colormap
XNStdColormap Atom
XNForeground unsigned long
XNBackground unsigned long
XNBackgroundPixmap Pixmap
XNFontSet XFontSet Required at IC
creation;
changes may
cause geometry
negotiation.
XNLineSpacing int Changes may
cause geometry
negotiation.
XNCursor Cursor
XNPreeditStartCallback XIMCallback * Required at IC
creation for
XIMPreeditCall‐
backs style.
XNPreeditDoneCallback XIMCallback * Required at IC
creation for
XIMPreeditCall‐
backs style.
XNPreeditDrawCallback XIMCallback * Required at IC
creation for
XIMPreeditCall‐
backs style.
XNPreeditCaretCallback XIMCallback * Required at IC
creation for
XIMPreeditCall‐
backs style.
XNStatusStartCallback XIMCallback * Required at IC
creation for
XIMStatusCall‐
backs style.
XNStatusDoneCallback XIMCallback * Required at IC
creation for
XIMStatusCall‐
backs style.
XNStatusDrawCallback XIMCallback * Required at IC
creation for
XIMStatusCall‐
backs style.
In addition to the attribute names above, the special name XNVaNestedList
indicates that the following argument is a XVaNestedList of attribute
name/value pairs. When a nested list is encountered in an argument list, the
contents of the nested list are processed as if they appeared in the originalargument list at that point.
The XGetICValues() function returns NULL if no error occurred; other‐
wise, it returns the name of the first attribute that could not be
obtained. An attribute could be not obtained for any of the following
reasons:
· The attribute name is not recognized.
· The input method encountered an implementation-dependent error.
Each attribute value argument to XGetICValues() (the argument that fol‐
lows the attribute name) must be the address of a location into which
the value is to be stored. For attributes that are pointer types
(XNArea, for example), XGetICValues() returns a pointer to a copy of
the attribute value. In this case, the client must free the memory
allocated for that copy with XFree().
See AlsoXCreateIC(), XOpenIM(), XSetICFocus(), XSetICValues(), XmbResetIC(),
XwcResetIC().
Xlib - Input Contexts XGetICValues()
