XSetICValues − set input context attributes.
Synopsis
char * XSetICValues(ic, ...)
XIC ic;
Arguments
icSpecifies the input context.
...Specifies the variable length argument list to set or get XIC values.
Availability
Release 5 and later.
Description
XSetICValues() sets 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 | 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. | ||
| 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. |
Preedit and Status Area Sub-attributes
| Name | Type | Notes | ||
| XNArea | XRectangle * | |||
| XNAreaNeeded | XRectangle * | |||
| XNSpotLocation | XPoint * | Required at IC creation for XIMPreeditPosition style. | ||
| XNColormap | Colormap | |||
| XNStdColormap | Atom |
Preedit and Status Area Sub-attributes (Continued)
| Name | Type | Notes | ||
| 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 XIMPreeditCallbacks style. | ||
| XNPreeditDoneCallback | XIMCallback * | Required at IC creation for XIMPreeditCallbacks style. | ||
| XNPreeditDrawCallback | XIMCallback * | Required at IC creation for XIMPreeditCallbacks style. | ||
| XNPreeditCaretCallback | XIMCallback * | Required at IC creation for XIMPreeditCallbacks style. | ||
| XNStatusStartCallback | XIMCallback * | Required at IC creation for XIMStatusCallbacks style. | ||
| XNStatusDoneCallback | XIMCallback * | Required at IC creation for XIMStatusCallbacks style. | ||
| XNStatusDrawCallback | XIMCallback * | Required at IC creation for XIMStatusCallbacks 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 original argument list at that point. XSetICValues() returns NULL if no error occurred; otherwise, it returns the name of the first attribute that could not be set. An attribute could be not set for any of the following reasons:
•A read-only attribute was set (for example, XNFilterEvents).
•The attribute name is not recognized.
•The input method encountered an input method implementation dependent error. Each value to be set must match the type of the attribute.
Errors
BadAtom A value for an Atom argument does not name a defined Atom.
BadColor A value for a Colormap argument does not name a defined Colormap.
BadCursor A value for a Cursor argument does not name a defined Cursor.
BadPixmap A value for a Pixmap argument does not name a defined Pixmap.
BadWindow A value for a Window argument does not name a defined Window.
See Also
XCreateIC(), XSetICFocus(), XmbResetIC(), XwcResetIC, XGetICValues().
Copyright O’Reilly & Assoc. —