2
.\" $XFree86: xc/doc/man/Xi/XChgKbd.man,v 1.2 2001/01/27 18:20:21 dawes Exp $
5
.\" Copyright ([\d,\s]*) by Hewlett-Packard Company, Ardent Computer,
7
.\" Permission to use, copy, modify, distribute, and sell this documentation
8
.\" for any purpose and without fee is hereby granted, provided that the above
9
.\" copyright notice and this permission notice appear in all copies.
10
.\" Ardent, and Hewlett-Packard make no representations about the
11
.\" suitability for any purpose of the information in this document. It is
12
.\" provided \`\`as is'' without express or implied warranty.
14
.\" $Xorg: XChgKbd.man,v 1.3 2000/08/17 19:41:56 cpqbld Exp $
15
.ds xL Programming With Xlib
16
.TH XChangeKeyboardDevice __LIB_MAN_SUFFIX__ __xorgversion__ "X FUNCTIONS"
2
.\" Title: xchangekeyboarddevice
3
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
4
.\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
6
.\" Manual: [FIXME: manual]
7
.\" Source: [FIXME: source]
10
.TH "XCHANGEKEYBOARDDEVIC" "libmansuffix" "10/02/2009" "[FIXME: source]" "[FIXME: manual]"
11
.\" -----------------------------------------------------------------
12
.\" * set default formatting
13
.\" -----------------------------------------------------------------
14
.\" disable hyphenation
16
.\" disable justification (adjust text to left margin only)
18
.\" -----------------------------------------------------------------
19
.\" * MAIN CONTENT STARTS HERE *
20
.\" -----------------------------------------------------------------
18
22
XChangeKeyboardDevice \- change which device is used as the X keyboard
21
Status XChangeKeyboardDevice\^(\^Display *\fIdisplay\fP\^, XDevice
27
Specifies the connection to the X server.
30
Specifies the device to be used as the X keyboard.
32
The \fIXChangeKeyboardDevice\fP request causes the server to use the specified
33
device as the X keyboard. The device must have been previously opened by the
34
requesting client via \fIXOpenDevice\fP or a \fIBadDevice\fP error will result.
35
The device must support input class \fIKeys\fP, or a \fIBadMatch\fP error
36
will result. If the server implementation does not support using the requested
37
device as the X keyboard, a \fIBadDevice\fP error will result.
39
If the specified device is grabbed by another client, \fIAlreadyGrabbed\fP
40
is returned. If the specified device is frozen by a grab on another device,
41
\fIGrabFrozen\fP is returned.
42
If the request is successful, \fISuccess\fP is returned.
44
If the request succeeds,
45
a \fIChangeDeviceNotify\fP event is sent to all clients that have selected that
46
event. A \fIMappingNotify\fP event with request = \fIMappingKeyboard\fP
47
is sent to all clients.
48
The specified device becomes the X keyboard and
49
the old X keyboard becomes accessible through the input extension
52
\fIXChangeKeyboardDevice\fP can generate a \fIBadDevice\fP or a \fIBadMatch\fP
57
An invalid device was specified. The specified device does not exist, has
58
not been opened by this client via \fIXOpenInputDevice\fP, or is already
59
one of the core X device (pointer or keyboard). This error may
61
the server implementation does not support using the specified device as
65
This error may occur if an \fIXChangeKeyboardDevice\fP request was made
66
specifying a device that has no keys.
26
#include <X11/extensions/XInput\&.h>
30
Status XChangeKeyboardDevice( Display *display,
36
Specifies the connection to the X server\&.
41
Specifies the device to be used as the X keyboard\&.
49
The XChangeKeyboardDevice request causes the server to use the
50
specified device as the X keyboard\&. The device must have been
51
previously opened by the requesting client via XOpenDevice or a
52
BadDevice error will result\&. The device must support input
53
class Keys, or a BadMatch error will result\&. If the server
54
implementation does not support using the requested device as
55
the X keyboard, a BadDevice error will result\&.
65
If the specified device is grabbed by another client,
66
AlreadyGrabbed is returned\&. If the specified device is frozen
67
by a grab on another device, GrabFrozen is returned\&. If the
68
request is successful, Success is returned\&.
78
If the request succeeds, a ChangeDeviceNotify event is sent to
79
all clients that have selected that event\&. A MappingNotify
80
event with request = MappingKeyboard is sent to all clients\&.
81
The specified device becomes the X keyboard and the old X
82
keyboard becomes accessible through the input extension
93
XChangeKeyboardDevice can generate a BadDevice or a BadMatch
106
An invalid device was specified\&. The specified device
107
does not exist, has not been opened by this client via
108
XOpenInputDevice, or is already one of the core X device
109
(pointer or keyboard)\&. This error may also occur if the
110
server implementation does not support using the
111
specified device as the X keyboard\&.
122
This error may occur if an XChangeKeyboardDevice request
123
was made specifying a device that has no keys\&.
134
XChangePointerDevice(libmansuffix)