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

NAME

6       XkbGetDeviceInfo  - Determine whether the X server allows Xkb access to
7       particular capabilities of input devices other than  the  core  X  key‐
8       board, or to determine the status of indicator maps, indicator names or
9       button actions on a non-KeyClass extension device
10

SYNOPSIS

12       XkbDeviceInfoPtr XkbGetDeviceInfo (Display *dpy,  unsigned  int  which,
13              unsigned  int  device_spec, unsigned int ind_class, unsigned int
14              ind_id);
15

ARGUMENTS

17       - dpy  connection to X server
18
19       - which
20              mask indicating information to return
21
22       - device_spec
23              device ID, or XkbUseCoreKbd
24
25       - ind_class
26              feedback class for indicator requests
27
28       - ind_id
29              feedback ID for indicator requests
30

DESCRIPTION

32       To determine whether the X server allows Xkb access to particular capa‐
33       bilities  of input devices other than the core X keyboard, or to deter‐
34       mine the status of indicator maps, indicator names or button actions on
35       a non-KeyClass extension device, use XkbGetDeviceInfo.
36
37       XkbGetDeviceInfo  returns  information about the input device specified
38       by device_spec.  Unlike the device_spec parameter  of  most  Xkb  func‐
39       tions, device_spec does not need to be a keyboard device. It must, how‐
40       ever, indicate either the core keyboard or a valid  X  Input  Extension
41       device.
42
43       The which parameter is a mask specifying optional information to be re‐
44       turned. It is an inclusive OR of one or more of the values from Table 1
45       and causes the returned XkbDeviceInfoRec to contain values for the cor‐
46       responding fields specified in the table.
47
48                                Table 1 XkbDeviceInfoRec Mask Bits
49       ____________________________________________________________________________________
50       Name                         XkbDeviceInfoRec Value     Capability If Set
51                                    Fields Effected
52       ____________________________________________________________________________________
53       XkbXI_KeyboardsMask                           (1L <<0) Clients can use all
54                                                              Xkb requests and events
55                                                              with KeyClass devices
56                                                              supported by the input
57                                                              device extension.
58
59       XkbXI_ButtonActionsMask       num_btns        (1L <<1) Clients can assign key
60                                     btn_acts                 actions to buttons
61                                                              non-KeyClass input
62                                                              extension devices.
63
64       XkbXI_IndicatorNamesMask      leds->names     (1L <<2) Clients can assign
65                                                              names to indicators on
66                                                              non-KeyClass input
67                                                              extension devices.
68
69       XkbXI_IndicatorMapsMask       leds->maps      (1L <<3) Clients can assign
70                                                              indicator maps to
71                                                              indicators on
72                                                              non-KeyClass input
73                                                              extension devices.
74
75       XkbXI_IndicatorStateMask      leds->state     (1L <<4) Clients can request
76                                                              the status of indicators
77                                                              on non-KeyClass input
78                                                              extension devices.
79
80       XkbXI_IndicatorsMask          sz_leds         (0x1c)   XkbXI_IndicatorNamesMask |
81                                     num_leds                 XkbXI_IndicatorMapsMask |
82                                     leds->*                  XkbXI_IndicatorStateMask
83
84       XkbXI_UnsupportedFeaturesMask unsupported     (1L <<15)
85
86       XkbXI_AllDeviceFeaturesMask   Those selected  (0x1e)   XkbXI_IndicatorsMask |
87                                     by Value Column          XkbSI_ButtonActionsMask
88                                     masks
89
90       XkbXI_AllFeaturesMask         Those selected  (0x1f)   XkbSI_AllDeviceFeaturesMask |
91                                     by Value Column          XkbSI_KeyboardsMask
92                                     masks
93
94       XkbXI_AllDetailsMask          Those selected  (0x801f) XkbXI_AllFeaturesMask |
95                                     by Value column          XkbXI_UnsupportedFeaturesMask
96                                     masks
97
98       The XkbDeviceInfoRec returned by XkbGetDeviceInfo always has values for
99       name  (may  be  a  null  string,  ""),  type,  supported,  unsupported,
100       has_own_state, dflt_kbd_fd, and dflt_kbd_fb.  Other fields  are  filled
101       in as specified by which.
102
103       Upon  return,  the  supported  field will be set to the inclusive OR of
104       zero or more bits from Table 1; each bit set indicates an optional  Xkb
105       extension  device feature supported by the server implementation, and a
106       client may modify the associated behavior.
107
108       If the XkbButtonActionsMask bit is set in which,  the  XkbDeviceInfoRec
109       returned  will  have  the button actions (btn_acts field) filled in for
110       all buttons.
111
112       If which includes one of the bits in XkbXI_IndicatorsMask, the feedback
113       class  of  the indicators must be specified in ind_class, and the feed‐
114       back ID of the indicators must be specified in ind_id.  If the  request
115       does not include any of the bits in XkbXI_IndicatorsMask, the ind_class
116       and ind_id parameters are ignored. The class and ID can be obtained via
117       the input device extension XListInputDevices request.
118
119       If  any of the XkbXI_IndicatorsMask bits are set in which, the XkbDevi‐
120       ceInfoRec returned will have filled in the portions of the leds  struc‐
121       ture  corresponding  to  the indicator feedback identified by ind_class
122       and ind_id.  The leds vector of the XkbDeviceInfoRec  is  allocated  if
123       necessary and sz_leds and num_leds filled in. The led_class, led_id and
124       phys_indicators fields of the leds entry corresponding to ind_class and
125       ind_id  are  always  filled in. If which contains XkbXI_IndicatorNames‐
126       Mask, the names_present and names fields of the leds  structure  corre‐
127       sponding  to  ind_class  and ind_id are returned. If which contains Xk‐
128       bXI_IndicatorStateMask, the corresponding state field  is  updated.  If
129       which  contains  XkbXI_IndicatorMapsMask,  the  maps_present  and  maps
130       fields are updated.
131
132       Xkb provides convenience functions to request subsets of  the  informa‐
133       tion  available via XkbGetDeviceInfo.  These convenience functions mir‐
134       ror some of the mask bits. The functions all take  an  XkbDeviceInfoPtr
135       as an input argument and operate on the X Input Extension device speci‐
136       fied by the device_spec field of the structure. Only the parts  of  the
137       structure indicated in the function description are updated. The XkbDe‐
138       viceInfoRec structure used in the function  call  can  be  obtained  by
139       calling XkbGetDeviceInfo or can be allocated by calling XkbAllocDevice‐
140       Info.
141

STRUCTURES

143       Information about X Input Extension devices is  transferred  between  a
144       client program and the Xkb extension in an XkbDeviceInfoRec structure:
145
146       typedef struct {
147           char *               name;          /* name for device */
148           Atom                 type;          /* name for class of devices */
149           unsigned short       device_spec;   /* device of interest */
150           Bool                 has_own_state; /* True=>this device has its own state */
151           unsigned short       supported;     /* bits indicating supported capabilities */
152           unsigned short       unsupported;   /* bits indicating unsupported capabilities */
153           unsigned short       num_btns;      /* number of entries in btn_acts */
154           XkbAction *          btn_acts;      /* button actions */
155           unsigned short       sz_leds;       /* total number of entries in LEDs vector */
156           unsigned short       num_leds;      /* number of valid entries in LEDs vector */
157           unsigned short       dflt_kbd_fb;   /* input extension ID of default (core kbd) indicator */
158           unsigned short       dflt_led_fb;   /* input extension ID of default indicator feedback */
159           XkbDeviceLedInfoPtr  leds;          /* LED descriptions */
160       } XkbDeviceInfoRec, *XkbDeviceInfoPtr;
161
162

SEE ALSO

164       XkbAllocDeviceInfo(3), XListInputDevices(3)
165
166
167
168X Version 11                     libX11 1.7.2              XkbGetDeviceInfo(3)
Impressum