NAME
XGetICValues — get input context attributes.
SYNOPSIS
char ∗XGetICValues(ic, ...)
XIC ic;
ARGUMENTS
icSpecifies 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.
DESCRIPTION
XGetICValues() queries the values of input context attributes. The first argument is the input context, and it is followed by a NULL-terminated 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@T{ Required at IC creation; may not be changed. T} XNClientWindow@Window@T{ Must be set before IC use; may not be changed. T} XNFocusWindow@Window@T{ Changes may cause geometry negotiation. T} XNResourceName@char ∗ XNResourceClass@char ∗ XNGeometryCallback@XIMCallback ∗ XNFilterEvents@unsigned long@T{ Read-only attribute; may not be set. T} XNPreeditAttributes@XVaNestedList@T{ See sub-attributes below. T} XNStatusAttributes@XVaNestedList@T{ See sub-attributes below. T} |
Preedit and Status Area Sub-attributes
| Name | Type | Notes | XNArea@XRectangle ∗ XNAreaNeeded@XRectangle ∗ XNSpotLocation@XPoint ∗@T{ Required at IC creation for XIMPreeditPosition style. T} XNColormap@Colormap XNStdColormap@Atom XNForeground@unsigned long XNBackground@unsigned long XNBackgroundPixmap@Pixmap XNFontSet@XFontSet@T{ Required at IC creation; changes may cause geometry negotiation. T} XNLineSpacing@int@T{ Changes may cause geometry negotiation. T} XNCursor@Cursor XNPreeditStartCallback@XIMCallback ∗@T{ Required at IC creation for XIMPreeditCallbacks style. T} XNPreeditDoneCallback@XIMCallback ∗@T{ Required at IC creation for XIMPreeditCallbacks style. T} XNPreeditDrawCallback@XIMCallback ∗@T{ Required at IC creation for XIMPreeditCallbacks style. T} XNPreeditCaretCallback@XIMCallback ∗@T{ Required at IC creation for XIMPreeditCallbacks style. T} XNStatusStartCallback@XIMCallback ∗@T{ Required at IC creation for XIMStatusCallbacks style. T} XNStatusDoneCallback@XIMCallback ∗@T{ Required at IC creation for XIMStatusCallbacks style. T} XNStatusDrawCallback@XIMCallback ∗@T{ Required at IC creation for XIMStatusCallbacks style. T} |
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 original argument list at that point.
The XGetICValues() function returns NULL if no error occurred; otherwise, 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 follows 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 ALSO
XCreateIC(), XOpenIM(), XSetICFocus(), XSetICValues(), XmbResetIC(), XwcResetIC.
Xlib Reference Manual