1XSupportsLocale(3) XLIB FUNCTIONS XSupportsLocale(3)
2
6 XSupportsLocale, XSetLocaleModifiers - determine locale support and
7 configure locale modifiers
8
10 Bool XSupportsLocale(void);
11 char *XSetLocaleModifiers(char *modifier_list);
13
15 modifier_list
16 Specifies the modifiers.
17
19 The XSupportsLocale function returns True if Xlib functions are capable
20 of operating under the current locale. If it returns False, Xlib
21 locale-dependent functions for which the XLocaleNotSupported return
22 status is defined will return XLocaleNotSupported. Other Xlib locale-
23 dependent routines will operate in the ``C'' locale.
24 The XSetLocaleModifiers function sets the X modifiers for the current
26 locale setting. The modifier_list argument is a null-terminated string
27 of the form ``{@category=value}'', that is, having zero or more con‐
28 catenated ``@category=value'' entries, where category is a category
29 name and value is the (possibly empty) setting for that category. The
30 values are encoded in the current locale. Category names are
31 restricted to the POSIX Portable Filename Character Set.
32 The local host X locale modifiers announcer (on POSIX-compliant sys‐
34 tems, the XMODIFIERS environment variable) is appended to the modi‐
35 fier_list to provide default values on the local host. If a given cat‐
36 egory appears more than once in the list, the first setting in the list
37 is used. If a given category is not included in the full modifier
38 list, the category is set to an implementation-dependent default for
39 the current locale. An empty value for a category explicitly specifies
40 the implementation-dependent default.
41 If the function is successful, it returns a pointer to a string. The
43 contents of the string are such that a subsequent call with that string
44 (in the same locale) will restore the modifiers to the same settings.
45 If modifier_list is a NULL pointer, XSetLocaleModifiers also returns a
46 pointer to such a string, and the current locale modifiers are not
47 changed.
48 If invalid values are given for one or more modifier categories sup‐
50 ported by the locale, a NULL pointer is returned, and none of the cur‐
51 rent modifiers are changed.
52 At program startup, the modifiers that are in effect are unspecified
54 until the first successful call to set them. Whenever the locale is
55 changed, the modifiers that are in effect become unspecified until the
56 next successful call to set them. Clients should always call XSetLo‐
57 caleModifiers with a non-NULL modifier_list after setting the locale
58 before they call any locale-dependent Xlib routine.
59 The only standard modifier category currently defined is ``im'', which
61 identifies the desired input method. The values for input method are
62 not standardized. A single locale may use multiple input methods,
63 switching input method under user control. The modifier may specify
64 the initial input method in effect or an ordered list of input methods.
65 Multiple input methods may be specified in a single im value string in
66 an implementation-dependent manner.
67 The returned modifiers string is owned by Xlib and should not be modi‐
69 fied or freed by the client. It may be freed by Xlib after the current
70 locale or modifiers are changed. Until freed, it will not be modified
71 by Xlib.
72
74 Xlib - C Language X Interface
75X Version 11 libX11 1.6.5 XSupportsLocale(3)