XOpenIM(3X11) XLIB FUNCTIONS XOpenIM(3X11)
NAME
XOpenIM, XCloseIM, XGetIMValues, XDisplayOfIM, XLocaleOfIM
- open, close, and otain input method information
SYNTAX
XIM XOpenIM(display, db, resname, resclass)
Display *display;
XrmDataBase db;
char *resname;
char *resclass;
Status XCloseIM(im)
XIM im;
char * XGetIMValues(im, ...)
XIM im;
Display * XDisplayOfIM(im)
XIM im;
char * XLocaleOfIM(im)
XIM im;
ARGUMENTS
db Specifies a pointer to the resource database.
display Specifies the connection to the X server.
im Specifies the input method.
resclass Specifies the full class name of the applica-
tion.
resname Specifies the full resource name of the applica-
tion.
... Specifies the variable length argument list to
get XIM values.
DESCRIPTION
The XOpenIM function opens an input method, matching the
current locale and modifiers specification. Current
locale and modifiers are bound to the input method at
opening time. The locale associated with an input method
cannot be changed dynamically. This implies the strings
returned by XmbLookupString or XwcLookupString, for any
input context affiliated with a given input method, will
be encoded in the locale current at the time input method
is opened.
The specific input method to which this call will be
routed is identified on the basis of the current locale.
XOpenIM will identify a default input method corresponding
X Version 11 Release 5 1
XOpenIM(3X11) XLIB FUNCTIONS XOpenIM(3X11)
to the current locale. That default can be modified using
XSetLocaleModifiers for the input method modifier.
The db argument is the resource database to be used by the
input method for looking up resources that are private to
the input method. It is not intended that this database
be used to look up values that can be set as IC values in
an input context. If db is NULL, no data base is passed
to the input method.
The res_name and res_class arguments specify the resource
name and class of the application. They are intended to
be used as prefixes by the input method when looking up
resources that are common to all input contexts that may
be created for this input method. The characters used for
resource names and classes must be in the X portable char-
acter set. The resources looked up are not fully speci-
fied if res_name or res_class is NULL.
The res_name and res_class arguments are not assumed to
exist beyond the call to XOpenIM. The specified resource
database is assumed to exist for the lifetime of the input
method.
XOpenIM returns NULL if no input method could be opened.
The XCloseIM function closes the specified input method.
The XGetIMValues function presents a variable argument
list programming interface for querying properties or fea-
tures of the specified input method. This function
returns NULL if it succeeds; otherwise, it returns the
name of the first argument that could not be obtained.
Only one standard argument is defined by Xlib:
XNQueryInputStyle, which must be used to query about input
styles supported by the input method.
A client should always query the input method to determine
which styles are supported. The client should then find
an input style it is capable of supporting.
If the client cannot find an input style that it can sup-
port it should negotiate with the user the continuation of
the program (exit, choose another input method, and so
on).
The argument value must be a pointer to a location where
the returned value will be stored. The returned value is
a pointer to a structure of type XIMStyles. Clients are
responsible for freeing the XIMStyles data structure. To
do so, use XFree.
The XDisplayOfIM function returns the display associated
X Version 11 Release 5 2
XOpenIM(3X11) XLIB FUNCTIONS XOpenIM(3X11)
with the specified input method.
The XLocaleOfIM returns the locale associated with the
specified input method.
SEE ALSO
XCreateIC(3X11), XSetICFocus(3X11), XSetICValues(3X11),
XmbResetIC(3X11)
Xlib - C Language X Interface
X Version 11 Release 5 3