← Back to branch summary

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

« back to all changes in this revision

Viewing changes to man/XIDefineCursor.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/XIDefineCursor.man
 
1
'\" t
 
2
.\"     Title: xidefinecursor
 
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 "XIDEFINECURSOR" "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
XIDefineCursor, XIUndefineCursor \- define device cursors\&.
 
23
.SH "SYNOPSIS"
 
24
.sp
 
25
.nf
 
26
#include <X11/extensions/XInput2\&.h>
 
27
.fi
 
28
.sp
 
29
.nf
 
30
int XIDefineCursor( Display *display,
 
31
                    int deviceid,
 
32
                    Window win,
 
33
                    Cursor cursor);
 
34
.fi
 
35
.sp
 
36
.nf
 
37
int XIUndefineCursor( Display *display,
 
38
                      int deviceid,
 
39
                      Window win);
 
40
.fi
 
41
.sp
 
42
.nf
 
43
cursor
 
44
       Specifies the cursor that is to be displayed or None\&.
 
45
.fi
 
46
.sp
 
47
.nf
 
48
deviceid
 
49
       Specifies the device whose cursor is to change\&.
 
50
.fi
 
51
.sp
 
52
.nf
 
53
display
 
54
       Specifies the connection to the X server\&.
 
55
.fi
 
56
.sp
 
57
.nf
 
58
win
 
59
       Specifies the window\&.
 
60
.fi
 
61
.SH "DESCRIPTION"
 
62
.sp
 
63
.if n \{\
 
64
.RS 4
 
65
.\}
 
66
.nf
 
67
If a cursor is set, it will be used when the device\'s pointer
 
68
is in the window\&. If the cursor is None, it is equivalent to
 
69
XIUndefineCursor\&.
 
70
.fi
 
71
.if n \{\
 
72
.RE
 
73
.\}
 
74
.sp
 
75
.if n \{\
 
76
.RS 4
 
77
.\}
 
78
.nf
 
79
The deviceid must be a master pointer device or a BadDevice error is
 
80
returned\&.
 
81
.fi
 
82
.if n \{\
 
83
.RE
 
84
.\}
 
85
.sp
 
86
.if n \{\
 
87
.RS 4
 
88
.\}
 
89
.nf
 
90
XIDefineCursor can generate BadDevice, BadCursor and BadWindow\&.
 
91
.fi
 
92
.if n \{\
 
93
.RE
 
94
.\}
 
95
.sp
 
96
.if n \{\
 
97
.RS 4
 
98
.\}
 
99
.nf
 
100
The XIUndefineCursor function undoes the effect of a previous
 
101
XIDefineCursor for this window\&. When the pointer is in the
 
102
window, the window\'s default cursor will now be used\&. If no
 
103
default cursor is defined, the parent\'s cursor for this device
 
104
will be used (if defined) or the parent\'s default cursor will
 
105
be used\&.
 
106
.fi
 
107
.if n \{\
 
108
.RE
 
109
.\}
 
110
.sp
 
111
.if n \{\
 
112
.RS 4
 
113
.\}
 
114
.nf
 
115
XIDefineCursor and XIUndefineCursor are identical to
 
116
XDefineCursor and XUndefineCursor but specify the device
 
117
explicitly\&.
 
118
.fi
 
119
.if n \{\
 
120
.RE
 
121
.\}
 
122
.sp
 
123
.if n \{\
 
124
.RS 4
 
125
.\}
 
126
.nf
 
127
XIUndefineCursor can generate a BadDevice and a BadWindow
 
128
error\&.
 
129
.fi
 
130
.if n \{\
 
131
.RE
 
132
.\}
 
133
.SH "DIAGNOSTICS"
 
134
.sp
 
135
.if n \{\
 
136
.RS 4
 
137
.\}
 
138
.nf
 
139
BadCursor
 
140
       A value for a cursor argument does not name a defined
 
141
       cursor\&.
 
142
.fi
 
143
.if n \{\
 
144
.RE
 
145
.\}
 
146
.sp
 
147
.if n \{\
 
148
.RS 4
 
149
.\}
 
150
.nf
 
151
BadDevice
 
152
       An invalid device was specified\&. The device does not
 
153
       exist or is not a pointer device\&.
 
154
.fi
 
155
.if n \{\
 
156
.RE
 
157
.\}
 
158
.sp
 
159
.if n \{\
 
160
.RS 4
 
161
.\}
 
162
.nf
 
163
BadWindow
 
164
       A value for a Window argument does not name a defined
 
165
       window\&.
 
166
.fi
 
167
.if n \{\
 
168
.RE
 
169
.\}
 
170
.sp
 
171
See also
 
172
.sp
 
173
.if n \{\
 
174
.RS 4
 
175
.\}
 
176
.nf
 
177
XDefineCursor, XUndefineCursor
 
178
.fi
 
179
.if n \{\
 
180
.RE
 
181
.\}