XCreateIC() XCreateIC()
Name
XCreateIC - create an input context.
Synopsis
XIC XCreateIC(im, ...)
XIM im;
Arguments
im Specifies the input method.
... Specifies the variable length argument list to set XIC values.
Returns
The created input context.
Availability
Release 5 and later.
Description
XCreateIC() creates an input context associated with the specified input method. The first argument to this function is the "parent" input
method, and it is followed by a NULL-terminated variable-length argument list of input context attribute name/value pairs. The tables
below list the standard attribute names and their types. Note that the XNInputStyle attribute and XNFontSet sub-attribute for the Preedit
and Status areas must be specified when the IC is created. XNSpotLocation must be specified for the Preedit area if the pre-edit interac-
tion style is XIMPreeditPosition. All the Preedit and Status callbacks must be specified in the call to XCreateIC() if the interaction
style is XIMPreeditCallbacks or XIMStatusCallbacks. Any other attributes may be set with XCreateIC(), but are not required.
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 original argument list at that point.
XCreateIC() returns a NULL value if no input context could be created. A NULL value could be returned for any of the following reasons:
o A required argument was not set.
o A read-only argument was set (for example, XNFilterEvents).
o The argument name is not recognized.
o The input method encountered an implementation-dependent error.
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.
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
XOpenIM(), XSetICFocus(), XSetICValues(), XDestroyIC(), XIMOfIC(), XmbResetIC(), XwcResetIC().
Xlib - Input Contexts XCreateIC()
