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

NAME

6       XkbGetKeyboard  -    Retrieves one or more components of a keyboard de‐
7       vice description
8

SYNOPSIS

10       XkbDescPtr XkbGetKeyboard (Display *display, unsigned  int  which,  un‐
11              signed int device_spec);
12

ARGUMENTS

14       display
15              connection to the X server
16
17       device_spec
18              device ID, or XkbUseCoreKbd
19
20       bits_to_change
21              determines events to be selected / deselected
22
23       values_for_bits
24              1=>select, 0->deselect; for events in bits_to_change
25

DESCRIPTION

27       XkbGetKeyboard  allocates  and returns a pointer to a keyboard descrip‐
28       tion. It queries the server for those components specified in the which
29       parameter  for  device device_spec and copies the results to the XkbDe‐
30       scRec it allocated. The remaining fields in  the  keyboard  description
31       are set to NULL. The valid masks for which are those listed in Table 1.
32
33
34               Table 1 Mask Bits for XkbDescRec
35       ──────────────────────────────────────────────────
36       Mask Bit               XkbDescRec Field   Value
37       ──────────────────────────────────────────────────
38       XkbControlsMask        ctrls              (1L<<0)
39       XkbServerMapMask       server             (1L<<1)
40       XkbIClientMapMask      map                (1L<<2)
41       XkbIndicatorMapMask    indicators         (1L<<3)
42       XkbNamesMask           names              (1L<<4)
43       XkbCompatMapMask       compat             (1L<<5)
44       XkbGeometryMask        geom               (1L<<6)
45       XkbAllComponentsMask   All Fields         (1L<<7)
46
47       XkbGetKeyboard  is used to read the current description for one or more
48       components of a keyboard device. It  calls  XkbGetKeyboardByName(3)  as
49       follows:
50
51       XkbGetKeyboardByName(dpy, device_spec, NULL, which, which, False).
52
53       If  successful,  XkbGetKeyboard  returns a pointer to a newly allocated
54       XkbDescRec structure, which is  described  in  XkbGetKeyboardByName(3),
55       and  which  should be freed with XkbFreeKeyboard(3).  If XkbGetKeyboard
56       does not succeed, it returns NULL.
57

DIAGNOSTICS

59       BadAlloc       Unable to allocate storage
60

SEE ALSO

62       XkbGetKeyboardByName(3)
63
64
65
66X Version 11                     libX11 1.8.7                XkbGetKeyboard(3)
Impressum