1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
|
'\" t
.\" Copyright (c) 1999 - Sun Microsystems, Inc.
.\" All rights reserved.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the
.\" "Software"), to deal in the Software without restriction, including
.\" without limitation the rights to use, copy, modify, merge, publish,
.\" distribute, and/or sell copies of the Software, and to permit persons
.\" to whom the Software is furnished to do so, provided that the above
.\" copyright notice(s) and this permission notice appear in all copies of
.\" the Software and that both the above copyright notice(s) and this
.\" permission notice appear in supporting documentation.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
.\" OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
.\" HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL
.\" INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING
.\" FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
.\" NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
.\" WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
.\" Except as contained in this notice, the name of a copyright holder
.\" shall not be used in advertising or otherwise to promote the sale, use
.\" or other dealings in this Software without prior written authorization
.\" of the copyright holder.
.\"
.TH XkbGetDeviceLedInfo __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
.SH NAME
XkbGetDeviceLedInfo \- Query the indicator names, maps, and state associated
with an LED feedback of an input extension device
.SH SYNOPSIS
.HP
.B Status XkbGetDeviceLedInfo
.BI "(\^Display *" "dpy" "\^,"
.BI "XkbDeviceInfoPtr " "device_info" "\^,"
.BI "unsigned int " "led_class" "\^,"
.BI "unsigned int " "led_id" "\^,"
.BI "unsigned int " "which" "\^);"
.if n .ti +5n
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- dpy
connection to X server
.TP
.I \- device_info
structure to update with results
.TP
.I \- led_class
LED feedback class assigned by input extension
.TP
.I \- led_id
LED feedback ID assigned by input extension
.TP
.I \- which
mask indicating desired information
.SH DESCRIPTION
.LP
.I XkbGetDeviceLedInfo
queries the server for the desired LED information for the feedback specified by
.I led_class
and
.I led_id
for the X input extension device indicated by
.I device_spec->device_info
and waits for a reply. If successful,
.I XkbGetDeviceLedInfo
backfills the relevant fields of
.I device_info
as determined by
.I which
with the results and returns Success. Valid values for
.I which
are the inclusive OR of any of XkbXI_IndicatorNamesMask,
XkbXI_IndicatorMapsMask, and XkbXI_IndicatorStateMask.
The fields of
.I device_info
that are filled in when this request succeeds are
.I name, type, supported,
and
.I unsupported,
and portions of the
.I leds
structure corresponding to
.I led_class
and
.I led_id
as indicated by the bits set in
.I which.
The
.I device_info->leds
vector is allocated if necessary and
.I sz_leds
and
.I num_leds
filled in. The
.I led_class, led_id
and
.I phys_indicators
fields of the
.I device_info->leds
entry corresponding to
.I led_class
and
.I led_id
are always filled in.
If
.I which
contains XkbXI_IndicatorNamesMask, the
.I names_present
and
.I names
fields of the
.I device_info->leds
structure corresponding to
.I led_class
and
.I led_id
are updated, if
.I which
contains XkbXI_IndicatorStateMask, the corresponding
.I state
field is updated, and if
.I which
contains XkbXI_IndicatorMapsMask, the
.I maps_present
and
.I maps
fields are updated.
If a compatible version of Xkb is not available in the server or the Xkb
extension has not been properly initialized,
.I XkbGetDeviceLedInfo
returns BadAccess. If allocation errors occur, a BadAlloc status is returned. If
the device has no indicators, a BadMatch error is returned. If
.I ledClass
or
.I ledID
have illegal values, a BadValue error is returned. If they have legal values but
do not specify a feedback that contains LEDs and is associated with the
specified device, a BadMatch error is returned.
.SH DIAGNOSTICS
.TP 15
.B BadAccess
The Xkb extension has not been properly initialized
.TP 15
.B BadAlloc
Unable to allocate storage
.TP 15
.B BadMatch
A compatible version of Xkb was not available in the server or an argument has
correct type and range, but is otherwise invalid
.TP 15
.B BadValue
An argument is out of range
|
