XLocaleOfIM(3)

1XOpenIM(3)                      XLIB FUNCTIONS                      XOpenIM(3)
2
3
4

NAME

6       XOpenIM,  XCloseIM,  XSetIMValues, XGetIMValues, XDisplayOfIM, XLocale‐
7       OfIM, XRegisterIMInstantiateCallback,  XUnregisterIMInstantiateCallback
8       - open, close, and obtain input method information
9

SYNTAX

11       XIM  XOpenIM(Display  *display,  XrmDatabase  db,  char *res_name, char
12              *res_class);
13
14       Status XCloseIM(XIM im);
15
16       char *XSetIMValues(XIM im, ...);
17
18       char *XGetIMValues(XIM im, ...);
19
20       Display *XDisplayOfIM(XIM im);
21
22       char *XLocaleOfIM(XIM im);
23
24       Bool XRegisterIMInstantiateCallback(Display *display,  XrmDatabase  db,
25              char  *res_name,  char  *res_class,  XIDProc  callback, XPointer
26              client_data);
27
28       Bool XUnregisterIMInstantiateCallback(Display *display, XrmDatabase db,
29              char  *res_name,  char  *res_class,  XIDProc  callback, XPointer
30              client_data);
31

ARGUMENTS

33       callback  Specifies a pointer to the input method instantiate callback.
34
35       client_data
36                 Specifies the additional client data.
37
38       db        Specifies a pointer to the resource database.
39
40       display   Specifies the connection to the X server.
41
42       im        Specifies the input method.
43
44       res_class Specifies the full class name of the application.
45
46       res_name  Specifies the full resource name of the application.
47
48       ...       Specifies the variable length argument list to set or get XIM
49                 values.
50

DESCRIPTION

52       The XOpenIM function opens an input method, matching the current locale
53       and modifiers specification.  Current locale and modifiers are bound to
54       the  input method at opening time.  The locale associated with an input
55       method cannot be changed dynamically.  This implies  that  the  strings
56       returned  by  XmbLookupString or XwcLookupString, for any input context
57       affiliated with a given input method will be encoded in the locale cur‐
58       rent at the time the input method is opened.
59
60       The  specific input method to which this call will be routed is identi‐
61       fied on the basis of the  current  locale.   XOpenIM  will  identify  a
62       default input method corresponding to the current locale.  That default
63       can be modified using XSetLocaleModifiers for the  input  method  modi‐
64       fier.
65
66       The db argument is the resource database to be used by the input method
67       for looking up resources that are private to the input method.   It  is
68       not  intended  that this database be used to look up values that can be
69       set as IC values in an input context.  If db is NULL,  no  database  is
70       passed to the input method.
71
72       The  res_name  and  res_class  arguments  specify the resource name and
73       class of the application.  They are intended to be used as prefixes  by
74       the input method when looking up resources that are common to all input
75       contexts that may be created for this  input  method.   The  characters
76       used for resource names and classes must be in the X Portable Character
77       Set.  The resources looked up are not fully specified  if  res_name  or
78       res_class is NULL.
79
80       The  res_name  and  res_class arguments are not assumed to exist beyond
81       the call to XOpenIM.  The specified resource  database  is  assumed  to
82       exist for the lifetime of the input method.
83
84       XOpenIM returns NULL if no input method could be opened.
85
86       The XCloseIM function closes the specified input method.
87
88       The XSetIMValues function presents a variable argument list programming
89       interface for setting attributes of the  specified  input  method.   It
90       returns  NULL  if  it  succeeds;  otherwise, it returns the name of the
91       first argument that could not be set.  Xlib does  not  attempt  to  set
92       arguments  from  the supplied list that follow the failed argument; all
93       arguments in the list preceding the failed argument have been set  cor‐
94       rectly.
95
96       The XGetIMValues function presents a variable argument list programming
97       interface for querying properties or features of  the  specified  input
98       method.   This  function  returns  NULL  if  it succeeds; otherwise, it
99       returns the name of the first argument that could not be obtained.
100
101       Each XIM value argument (following a name) must  point  to  a  location
102       where  the  XIM value is to be stored.  That is, if the XIM value is of
103       type T, the argument must be of type T*.  If  T  itself  is  a  pointer
104       type,  then XGetIMValues allocates memory to store the actual data, and
105       the client is responsible for freeing this data by calling  XFree  with
106       the returned pointer.
107
108       The XDisplayOfIM function returns the display associated with the spec‐
109       ified input method.
110
111       The XLocaleOfIM function returns the locale associated with the  speci‐
112       fied input method.
113
114       The  XRegisterIMInstantiateCallback function registers a callback to be
115       invoked whenever a new input method becomes available for the specified
116       display that matches the current locale and modifiers.
117
118       The function returns True if it succeeds; otherwise, it returns False.
119
120       The  XUnregisterIMInstantiateCallback  function removes an input method
121       instantiation callback previously  registered.   The  function  returns
122       True if it succeeds; otherwise, it returns False.
123

NAME

SYNTAX

ARGUMENTS

DESCRIPTION

SEE ALSO