1XkbGetUpdatedMap(3)              XKB FUNCTIONS             XkbGetUpdatedMap(3)
2
3
4

NAME

6       XkbGetUpdatedMap  -   Update the client or server map information in an
7       existing keyboard description
8

SYNOPSIS

10       Status XkbGetUpdatedMap (Display *display, unsigned int  which,  XkbDe‐
11              scPtr xkb);
12

ARGUMENTS

14       - display
15              connection to X server
16
17       - which
18              mask selecting subcomponents to populate
19
20       - xkb  keyboard description to be updated
21

DESCRIPTION

23       The  which parameter is a bitwise inclusive OR of the masks in Table 1.
24       If the needed components of the xkb structure  are  not  already  allo‐
25       cated,  XkbGetUpdatedMap  allocates them.  XkbGetUpdatedMap fetches the
26       requested information for the device specified in the XkbDescRec passed
27       in the xkb parameter.
28
29
30                                     Table 1 Xkb Mapping Component Masks
31                                          and Convenience Functions
32       ────────────────────────────────────────────────────────────────────────────────────────────────
33       Mask                             Value    Map      Fields        Convenience
34                                                                        Functions
35       ────────────────────────────────────────────────────────────────────────────────────────────────
36       XkbKeyTypesMask                  (1<<0)   client   types         XkbGetKeyTypes
37                                                          size_types    XkbResizeKeyType
38                                                          num_types     XkbCopyKeyType
39                                                                        XkbCopyKeyTypes
40       XkbKeySymsMask                   (1<<1)   client   syms          XkbGetKeySyms
41                                                          size_syms     XkbResizeKeySyms
42                                                          num_syms      XkbChangeTypesOfKey
43                                                          key_sym_map
44       XkbModifierMapMask               (1<<2)   client   modmap        XkbGetKeyModifierMap
45       XkbExplicitComponentsMask        (1<<3)   server   explicit      XkbGetKeyExplicitComponents
46       XkbKeyActionsMask                (1<<4)   server   key_acts      XkbGetKeyActions
47                                                          acts          XkbResizeKeyActions
48                                                          num_acts
49                                                          size_acts
50       XkbKeyBehaviorsMask              (1<<5)   server   behaviors     XkbGetKeyBehaviors
51       XkbVirtualModsMask               (1<<6)   server   vmods         XkbGetVirtualMods
52       XkbVirtualModMapMask             (1<<7)   server   vmodmap       XkbGetVirtualModMap
53
54       XkbGetUpdatedMap is synchronous; it queries the server for the  desired
55       information, waits for a reply, and then returns. If successful, XkbGe‐
56       tUpdatedMap returns Success. If unsuccessful, XkbGetUpdatedMap  returns
57       one  of  the following: BadAlloc (unable to allocate a component in the
58       XkbDescRec structure), BadValue (some mask  bits  in  which  are  unde‐
59       fined), BadImplementation (a compatible version of the Xkb extension is
60       not available in the server or the reply from the server was invalid).
61

RETURN VALUES

63       Success        The XkbGetUpdatedMap function returns Success if a reply
64                      is received to the server query for the desired informa‐
65                      tion.
66

STRUCTURES

68       The complete description of an Xkb keyboard is given by an  XkbDescRec.
69       The component structures in the XkbDescRec represent the major Xkb com‐
70       ponents.
71
72       typedef struct {
73          struct _XDisplay * display;      /∗ connection to X server */
74          unsigned short     flags;        /∗ private to Xkb, do not modify */
75          unsigned short     device_spec;  /∗ device of interest */
76          KeyCode            min_key_code; /∗ minimum keycode for device */
77          KeyCode            max_key_code; /∗ maximum keycode for device */
78          XkbControlsPtr     ctrls;        /∗ controls */
79          XkbServerMapPtr    server;       /∗ server keymap */
80          XkbClientMapPtr    map;          /∗ client keymap */
81          XkbIndicatorPtr    indicators;   /∗ indicator map */
82          XkbNamesPtr        names;        /∗ names for all components */
83          XkbCompatMapPtr    compat;       /∗ compatibility map */
84          XkbGeometryPtr     geom;         /∗ physical geometry of keyboard */
85       } XkbDescRec, *XkbDescPtr;
86
87       The display field points to an X display structure. The flags field  is
88       private  to  the  library:  modifying  flags  may  yield  unpredictable
89       results. The device_spec field specifies the device identifier  of  the
90       keyboard  input device, or XkbUseCoreKeyboard, which specifies the core
91       keyboard device. The min_key_code and max_key_code fields  specify  the
92       least and greatest keycode that can be returned by the keyboard.
93
94       Each  structure  component has a corresponding mask bit that is used in
95       function calls to indicate that the structure should be manipulated  in
96       some manner, such as allocating it or freeing it. These masks and their
97       relationships to the fields in the XkbDescRec are shown in Table 2.
98
99               Table 2 Mask Bits for XkbDescRec
100       ──────────────────────────────────────────────────
101       Mask Bit               XkbDescRec Field   Value
102       ──────────────────────────────────────────────────
103       XkbControlsMask        ctrls              (1L<<0)
104       XkbServerMapMask       server             (1L<<1)
105       XkbIClientMapMask      map                (1L<<2)
106       XkbIndicatorMapMask    indicators         (1L<<3)
107       XkbNamesMask           names              (1L<<4)
108       XkbCompatMapMask       compat             (1L<<5)
109       XkbGeometryMask        geom               (1L<<6)
110       XkbAllComponentsMask   All Fields         (0x7f)
111

DIAGNOSTICS

113       BadAlloc       Unable to allocate storage
114
115       BadImplementation
116                      Invalid reply from server
117
118       BadValue       An argument is out of range
119

SEE ALSO

121       XkbChangeTypesOfKey(3),     XkbCopyKeyType(3),      XkbCopyKeyTypes(3),
122       XkbGetKeyActions(3),   XkbGetKeyBehaviors(3),   XkbGetKeyExplicitCompo‐
123       nents(3), XkbGetKeyModifierMap(3), XkbGetKeySyms(3), XkbGetKeyTypes(3),
124       XkbResizeKeyActions(3),    XkbResizeKeySyms(3),    XkbResizeKeyType(3),
125       XkbGetVirtualModMap(3), XkbGetVirtualMods(3)
126
127
128
129X Version 11                     libX11 1.6.12             XkbGetUpdatedMap(3)
Impressum