summaryrefslogtreecommitdiff
path: root/man/XChangeKeyboardDevice.man
diff options
context:
space:
mode:
authorKaleb Keithley <kaleb@freedesktop.org>2003-11-14 15:54:38 +0000
committerKaleb Keithley <kaleb@freedesktop.org>2003-11-14 15:54:38 +0000
commit981020ce68e4c8d9c0dafba631b0fd3328d7fc59 (patch)
treef275214d5531567e7efa08523a5b985bfbde887c /man/XChangeKeyboardDevice.man
R6.6 is the Xorg base-lineXORG-MAIN
Diffstat (limited to 'man/XChangeKeyboardDevice.man')
-rw-r--r--man/XChangeKeyboardDevice.man69
1 files changed, 69 insertions, 0 deletions
diff --git a/man/XChangeKeyboardDevice.man b/man/XChangeKeyboardDevice.man
new file mode 100644
index 0000000..53c2cf3
--- /dev/null
+++ b/man/XChangeKeyboardDevice.man
@@ -0,0 +1,69 @@
+.\"
+.\" Copyright ([\d,\s]*) by Hewlett-Packard Company, Ardent Computer,
+.\"
+.\" Permission to use, copy, modify, distribute, and sell this documentation
+.\" for any purpose and without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.
+.\" Ardent, and Hewlett-Packard make no representations about the
+.\" suitability for any purpose of the information in this document. It is
+.\" provided \`\`as is'' without express or implied warranty.
+.\"
+.\" $Xorg: XChgKbd.man,v 1.4 2001/03/16 17:51:13 pookie Exp $
+.ds xL Programming With Xlib
+.TH XChangeKeyboardDevice 3X11 "Release 6.6" "X Version 11" "X FUNCTIONS"
+.SH NAME
+XChangeKeyboardDevice \- change which device is used as the X keyboard
+.SH SYNTAX
+Status XChangeKeyboardDevice\^(\^\fIdisplay\fP, \fIdevice\fP\^)
+.br
+ Display *\fIdisplay\fP\^;
+.br
+ XDevice *\fIdevice\fP\^;
+.br
+.SH ARGUMENTS
+.TP 12
+.I display
+Specifies the connection to the X server.
+.TP 12
+.I device
+Specifies the device to be used as the X keyboard.
+.SH DESCRIPTION
+The \fIXChangeKeyboardDevice\fP request causes the server to use the specified
+device as the X keyboard. The device must have been previously opened by the
+requesting client via \fIXOpenDevice\fP or a \fIBadDevice\fP error will result.
+The device must support input class \fIKeys\fP, or a \fIBadMatch\fP error
+will result. If the server implementation does not support using the requested
+device as the X keyboard, a \fIBadDevice\fP error will result.
+.LP
+If the specified device is grabbed by another client, \fIAlreadyGrabbed\fP
+is returned. If the specified device is frozen by a grab on another device,
+\fIGrabFrozen\fP is returned.
+If the request is successful, \fISuccess\fP is returned.
+.LP
+If the request succeeds,
+a \fIChangeDeviceNotify\fP event is sent to all clients that have selected that
+event. A \fIMappingNotify\fP event with request = \fIMappingKeyboard\fP
+is sent to all clients.
+The specified device becomes the X keyboard and
+the old X keyboard becomes accessible through the input extension
+protocol requests.
+.LP
+\fIXChangeKeyboardDevice\fP can generate a \fIBadDevice\fP or a \fIBadMatch\fP
+error.
+.SH DIAGNOSTICS
+.TP 12
+\fIBadDevice\fP
+An invalid device was specified. The specified device does not exist, has
+not been opened by this client via \fIXOpenInputDevice\fP, or is already
+one of the core X device (pointer or keyboard). This error may
+also occur if
+the server implementation does not support using the specified device as
+the X keyboard.
+.TP 12
+\fIBadMatch\fP
+This error may occur if an \fIXChangeKeyboardDevice\fP request was made
+specifying a device that has no keys.
+.SH "SEE ALSO"
+XChangePointerDevice
+.br
+\fI\*(xL\fP