1XkbGetUpdatedMap(3) XKB FUNCTIONS XkbGetUpdatedMap(3)
2
6 XkbGetUpdatedMap - Update the client or server map information in an
7 existing keyboard description
8
10 Status XkbGetUpdatedMap (Display *display, unsigned int which, XkbDe‐
11 scPtr xkb);
12
14 display
15 connection to X server
16 which mask selecting subcomponents to populate
18 xkb keyboard description to be updated
20
22 The which parameter is a bitwise inclusive OR of the masks in Table 1.
23 If the needed components of the xkb structure are not already allo‐
24 cated, XkbGetUpdatedMap allocates them. XkbGetUpdatedMap fetches the
25 requested information for the device specified in the XkbDescRec passed
26 in the xkb parameter.
27 Table 1 Xkb Mapping Component Masks
30 and Convenience Functions
31 ────────────────────────────────────────────────────────────────────────────────────────────────
32 Mask Value Map Fields Convenience
33 Functions
34 ────────────────────────────────────────────────────────────────────────────────────────────────
35 XkbKeyTypesMask (1<<0) client types XkbGetKeyTypes
36 size_types XkbResizeKeyType
37 num_types XkbCopyKeyType
38 XkbCopyKeyTypes
39 XkbKeySymsMask (1<<1) client syms XkbGetKeySyms
40 size_syms XkbResizeKeySyms
41 num_syms XkbChangeTypesOfKey
42 key_sym_map
43 XkbModifierMapMask (1<<2) client modmap XkbGetKeyModifierMap
44 XkbExplicitComponentsMask (1<<3) server explicit XkbGetKeyExplicitComponents
45 XkbKeyActionsMask (1<<4) server key_acts XkbGetKeyActions
46 acts XkbResizeKeyActions
47 num_acts
48 size_acts
49 XkbKeyBehaviorsMask (1<<5) server behaviors XkbGetKeyBehaviors
50 XkbVirtualModsMask (1<<6) server vmods XkbGetVirtualMods
51 XkbVirtualModMapMask (1<<7) server vmodmap XkbGetVirtualModMap
52 XkbGetUpdatedMap is synchronous; it queries the server for the desired
54 information, waits for a reply, and then returns. If successful, XkbGe‐
55 tUpdatedMap returns Success. If unsuccessful, XkbGetUpdatedMap returns
56 one of the following: BadAlloc (unable to allocate a component in the
57 XkbDescRec structure), BadValue (some mask bits in which are unde‐
58 fined), BadImplementation (a compatible version of the Xkb extension is
59 not available in the server or the reply from the server was invalid).
60
62 Success The XkbGetUpdatedMap function returns Success if a reply
63 is received to the server query for the desired informa‐
64 tion.
65
67 The complete description of an Xkb keyboard is given by an XkbDescRec.
68 The component structures in the XkbDescRec represent the major Xkb com‐
69 ponents.
70 typedef struct {
72 struct _XDisplay * display; /* connection to X server */
73 unsigned short flags; /* private to Xkb, do not modify */
74 unsigned short device_spec; /* device of interest */
75 KeyCode min_key_code; /* minimum keycode for device */
76 KeyCode max_key_code; /* maximum keycode for device */
77 XkbControlsPtr ctrls; /* controls */
78 XkbServerMapPtr server; /* server keymap */
79 XkbClientMapPtr map; /* client keymap */
80 XkbIndicatorPtr indicators; /* indicator map */
81 XkbNamesPtr names; /* names for all components */
82 XkbCompatMapPtr compat; /* compatibility map */
83 XkbGeometryPtr geom; /* physical geometry of keyboard */
84 } XkbDescRec, *XkbDescPtr;
85 The display field points to an X display structure. The flags field is
87 private to the library: modifying flags may yield unpredictable re‐
88 sults. The device_spec field specifies the device identifier of the
89 keyboard input device, or XkbUseCoreKeyboard, which specifies the core
90 keyboard device. The min_key_code and max_key_code fields specify the
91 least and greatest keycode that can be returned by the keyboard.
92 Each structure component has a corresponding mask bit that is used in
94 function calls to indicate that the structure should be manipulated in
95 some manner, such as allocating it or freeing it. These masks and their
96 relationships to the fields in the XkbDescRec are shown in Table 2.
97 Table 2 Mask Bits for XkbDescRec
99 ──────────────────────────────────────────────────
100 Mask Bit XkbDescRec Field Value
101 ──────────────────────────────────────────────────
102 XkbControlsMask ctrls (1L<<0)
103 XkbServerMapMask server (1L<<1)
104 XkbIClientMapMask map (1L<<2)
105 XkbIndicatorMapMask indicators (1L<<3)
106 XkbNamesMask names (1L<<4)
107 XkbCompatMapMask compat (1L<<5)
108 XkbGeometryMask geom (1L<<6)
109 XkbAllComponentsMask All Fields (0x7f)
110
112 BadAlloc Unable to allocate storage
113 BadImplementation
115 Invalid reply from server
116 BadValue An argument is out of range
118
120 XkbChangeTypesOfKey(3), XkbCopyKeyType(3), XkbCopyKeyTypes(3), Xk‐
121 bGetKeyActions(3), XkbGetKeyBehaviors(3), XkbGetKeyExplicitCompo‐
122 nents(3), XkbGetKeyModifierMap(3), XkbGetKeySyms(3), XkbGetKeyTypes(3),
123 XkbResizeKeyActions(3), XkbResizeKeySyms(3), XkbResizeKeyType(3), Xk‐
124 bGetVirtualModMap(3), XkbGetVirtualMods(3)
125X Version 11 libX11 1.8.7 XkbGetUpdatedMap(3)