← Back to branch summary

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

« back to all changes in this revision

Viewing changes to man/XISetClientPointer.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:
man/XISetClientPointer.man
 
1
'\" t
 
2
.\"     Title: xisetclientpointer
 
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 "XISETCLIENTPOINTER" "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"
 
22
XISetClientPointer, XIGetClientPointer \- set or get the ClientPointer device\&.
 
23
.SH "SYNOPSIS"
 
24
.sp
 
25
.nf
 
26
#include <X11/extensions/XInput2\&.h>
 
27
.fi
 
28
.sp
 
29
.nf
 
30
XISetClientPointer( Display *display,
 
31
                    Window win,
 
32
                    int deviceid);
 
33
.fi
 
34
.sp
 
35
.nf
 
36
Bool XIGetClientPointer( Display *display,
 
37
                         Window win,
 
38
                         int *device);
 
39
.fi
 
40
.sp
 
41
.nf
 
42
display
 
43
       Specifies the connection to the X server\&.
 
44
.fi
 
45
.sp
 
46
.nf
 
47
win
 
48
       Specifies a window belonging to the client\&. May be None\&.
 
49
.fi
 
50
.sp
 
51
.nf
 
52
deviceid
 
53
       Specifies the ClientPointer device\&.
 
54
.fi
 
55
.SH "DESCRIPTION"
 
56
.sp
 
57
.if n \{\
 
58
.RS 4
 
59
.\}
 
60
.nf
 
61
The ClientPointer is the device that is percieved to be the
 
62
core pointer for non\-XI protocol requests and replies\&. Each
 
63
time a protocol message needs device\-dependent data and the
 
64
device is not explicitly given, the ClientPointer device is
 
65
used to obtain the data\&. For example, a XQueryPointer request
 
66
will return the coordinates of the ClientPointer\&.
 
67
.fi
 
68
.if n \{\
 
69
.RE
 
70
.\}
 
71
.sp
 
72
.if n \{\
 
73
.RS 4
 
74
.\}
 
75
.nf
 
76
XISetClientPointer request sets the ClientPointer device for
 
77
the client that owns the given window\&. If win is None, the
 
78
requesting client\'s ClientPointer is set to the device
 
79
specified with deviceid\&. Only master pointer devices can be set
 
80
as ClientPointer\&.
 
81
.fi
 
82
.if n \{\
 
83
.RE
 
84
.\}
 
85
.sp
 
86
.if n \{\
 
87
.RS 4
 
88
.\}
 
89
.nf
 
90
XISetClientPointer and can generate a BadDevice and a BadWindow
 
91
error\&.
 
92
.fi
 
93
.if n \{\
 
94
.RE
 
95
.\}
 
96
.sp
 
97
.if n \{\
 
98
.RS 4
 
99
.\}
 
100
.nf
 
101
The XIGetClientPointer request returns the ClientPointer\'s
 
102
device ID for the client that owns the given window\&. If win is
 
103
None, the requesting client\'s ClientPointer is returned\&.
 
104
.fi
 
105
.if n \{\
 
106
.RE
 
107
.\}
 
108
.sp
 
109
.if n \{\
 
110
.RS 4
 
111
.\}
 
112
.nf
 
113
win may be a client ID instead of a window\&.
 
114
.fi
 
115
.if n \{\
 
116
.RE
 
117
.\}
 
118
.sp
 
119
.if n \{\
 
120
.RS 4
 
121
.\}
 
122
.nf
 
123
XIGetClientPointer can generate a BadWindow error\&.
 
124
.fi
 
125
.if n \{\
 
126
.RE
 
127
.\}
 
128
.SH "DIAGNOSTICS"
 
129
.sp
 
130
.if n \{\
 
131
.RS 4
 
132
.\}
 
133
.nf
 
134
BadDevice
 
135
       An invalid device was specified\&. The device does not
 
136
       exist or is not a master pointer device\&.
 
137
.fi
 
138
.if n \{\
 
139
.RE
 
140
.\}
 
141
.sp
 
142
.if n \{\
 
143
.RS 4
 
144
.\}
 
145
.nf
 
146
BadWindow
 
147
       A value for a Window argument does not name a defined
 
148
       window\&.
 
149
.fi
 
150
.if n \{\
 
151
.RE
 
152
.\}