~ubuntu-branches/ubuntu/natty/libxi/natty-201011191114

« back to all changes in this revision

Viewing changes to man/XChangeKeyboardDevice.man

  • Committer: Bazaar Package Importer
  • Author(s): Julien Cristau
  • Date: 2009-11-21 18:39:28 UTC
  • mfrom: (1.1.10 upstream) (0.1.6 experimental)
  • Revision ID: james.westby@ubuntu.com-20091121183928-ek2jwqx3rmhv3zjz
Tags: 2:1.3-1
* Bump Standards-Version to 3.8.3.
* Add build-deps on xmlto and asciidoc to build the manpages.
* New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.\"
2
 
.\" $XFree86: xc/doc/man/Xi/XChgKbd.man,v 1.2 2001/01/27 18:20:21 dawes Exp $
3
 
.\"
4
 
.\"
5
 
.\" Copyright ([\d,\s]*) by Hewlett-Packard Company, Ardent Computer, 
6
 
.\" 
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.
13
 
.\" 
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"
17
 
.SH NAME
 
1
'\" t
 
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/>
 
5
.\"      Date: 10/02/2009
 
6
.\"    Manual: [FIXME: manual]
 
7
.\"    Source: [FIXME: source]
 
8
.\"  Language: English
 
9
.\"
 
10
.TH "XCHANGEKEYBOARDDEVIC" "libmansuffix" "10/02/2009" "[FIXME: source]" "[FIXME: manual]"
 
11
.\" -----------------------------------------------------------------
 
12
.\" * set default formatting
 
13
.\" -----------------------------------------------------------------
 
14
.\" disable hyphenation
 
15
.nh
 
16
.\" disable justification (adjust text to left margin only)
 
17
.ad l
 
18
.\" -----------------------------------------------------------------
 
19
.\" * MAIN CONTENT STARTS HERE *
 
20
.\" -----------------------------------------------------------------
 
21
.SH "NAME"
18
22
XChangeKeyboardDevice \- change which device is used as the X keyboard
19
 
.SH SYNTAX
20
 
.HP
21
 
Status XChangeKeyboardDevice\^(\^Display *\fIdisplay\fP\^, XDevice
22
 
*\fIdevice\fP\^); 
23
 
.br
24
 
.SH ARGUMENTS
25
 
.TP 12
26
 
.I display
27
 
Specifies the connection to the X server.
28
 
.TP 12
29
 
.I device
30
 
Specifies the device to be used as the X keyboard.
31
 
.SH DESCRIPTION
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.
38
 
.LP
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.
43
 
.LP
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
50
 
protocol requests.
51
 
.LP
52
 
\fIXChangeKeyboardDevice\fP can generate a \fIBadDevice\fP or a \fIBadMatch\fP
53
 
error.
54
 
.SH DIAGNOSTICS
55
 
.TP 12
56
 
\fIBadDevice\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
60
 
also occur if 
61
 
the server implementation does not support using the specified device as
62
 
the X keyboard.
63
 
.TP 12
64
 
\fIBadMatch\fP
65
 
This error may occur if an \fIXChangeKeyboardDevice\fP request was made 
66
 
specifying a device that has no keys.
 
23
.SH "SYNOPSIS"
 
24
.sp
 
25
.nf
 
26
#include <X11/extensions/XInput\&.h>
 
27
.fi
 
28
.sp
 
29
.nf
 
30
Status XChangeKeyboardDevice( Display *display,
 
31
                              XDevice *device);
 
32
.fi
 
33
.sp
 
34
.nf
 
35
display
 
36
       Specifies the connection to the X server\&.
 
37
.fi
 
38
.sp
 
39
.nf
 
40
device
 
41
       Specifies the device to be used as the X keyboard\&.
 
42
.fi
 
43
.SH "DESCRIPTION"
 
44
.sp
 
45
.if n \{\
 
46
.RS 4
 
47
.\}
 
48
.nf
 
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\&.
 
56
.fi
 
57
.if n \{\
 
58
.RE
 
59
.\}
 
60
.sp
 
61
.if n \{\
 
62
.RS 4
 
63
.\}
 
64
.nf
 
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\&.
 
69
.fi
 
70
.if n \{\
 
71
.RE
 
72
.\}
 
73
.sp
 
74
.if n \{\
 
75
.RS 4
 
76
.\}
 
77
.nf
 
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
 
83
protocol requests\&.
 
84
.fi
 
85
.if n \{\
 
86
.RE
 
87
.\}
 
88
.sp
 
89
.if n \{\
 
90
.RS 4
 
91
.\}
 
92
.nf
 
93
XChangeKeyboardDevice can generate a BadDevice or a BadMatch
 
94
error\&.
 
95
.fi
 
96
.if n \{\
 
97
.RE
 
98
.\}
 
99
.SH "DIAGNOSTICS"
 
100
.sp
 
101
.if n \{\
 
102
.RS 4
 
103
.\}
 
104
.nf
 
105
BadDevice
 
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\&.
 
112
.fi
 
113
.if n \{\
 
114
.RE
 
115
.\}
 
116
.sp
 
117
.if n \{\
 
118
.RS 4
 
119
.\}
 
120
.nf
 
121
BadMatch
 
122
       This error may occur if an XChangeKeyboardDevice request
 
123
       was made specifying a device that has no keys\&.
 
124
.fi
 
125
.if n \{\
 
126
.RE
 
127
.\}
67
128
.SH "SEE ALSO"
68
 
XChangePointerDevice
69
 
.br
70
 
\fI\*(xL\fP
 
129
.sp
 
130
.if n \{\
 
131
.RS 4
 
132
.\}
 
133
.nf
 
134
XChangePointerDevice(libmansuffix)
 
135
.fi
 
136
.if n \{\
 
137
.RE
 
138
.\}