← Back to branch summary

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

« back to all changes in this revision

Viewing changes to man/XListDeviceProperties.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/XListDeviceProperties.man
1
 
.\"     Title: XListDeviceProperties
2
 
.\"    Author: Peter Hutterer
3
 
.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
4
 
.\"      Date: <pubdate>July 9, 2008</pubdate>
5
 
.\"    Manual: XINPUT FUNCTIONS
6
 
.\"    Source: __xorgversion__
 
1
'\" t
 
2
.\"     Title: xlistdeviceproperties
 
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
7
9
.\"
8
 
.TH "XLISTDEVICEPROPERTIE" "__libmansuffix__" "<pubdate>July 9, 2008</pubdate>" "__xorgversion__" "XINPUT FUNCTIONS"
 
10
.TH "XLISTDEVICEPROPERTIE" "libmansuffix" "10/02/2009" "[FIXME: source]" "[FIXME: manual]"
 
11
.\" -----------------------------------------------------------------
 
12
.\" * set default formatting
 
13
.\" -----------------------------------------------------------------
9
14
.\" disable hyphenation
10
15
.nh
11
16
.\" disable justification (adjust text to left margin only)
12
17
.ad l
 
18
.\" -----------------------------------------------------------------
 
19
.\" * MAIN CONTENT STARTS HERE *
 
20
.\" -----------------------------------------------------------------
13
21
.SH "NAME"
14
 
XListDeviceProperties - List a device's properties.
15
 
.SH "SYNTAX"
16
 
.sp
17
 
.ft B
18
 
.nf
19
 
#include <X11/extensions/XInput\.h>
20
 
.fi
21
 
.ft
22
 
.HP 28
23
 
.BI "Atom* XListDeviceProperties(Display\ *" "display" ", XDevice\ *" "device" ", int\ *" "nprops_return" ");"
24
 
.SH "ARGUMENTS"
25
 
.PP
26
 
.PP
27
 
\fIdisplay\fR
28
 
.RS 4
29
 
Specifies the connection to the X server\.
30
 
.RE
31
 
.PP
32
 
\fIdevice\fR
33
 
.RS 4
34
 
The device to grab\.
35
 
.RE
36
 
.PP
37
 
\fInprops_return\fR
38
 
.RS 4
39
 
Specifies the number of Atoms returned\.
40
 
.RE
41
 
.PP
42
 
\fInum_values\fR
43
 
.RS 4
44
 
Specifies the number of elements in the values list\.
45
 
.RE
46
 
.PP
47
 
\fIproperty\fR
48
 
.RS 4
49
 
Specifies the property to modify or query\.
50
 
.RE
 
22
XListDeviceProperties \- List a device\'s properties\&.
 
23
.SH "SYNOPSIS"
 
24
.sp
 
25
.nf
 
26
#include <X11/extensions/XInput\&.h>
 
27
.fi
 
28
.sp
 
29
.nf
 
30
Atom* XListDeviceProperties( Display *display,
 
31
                             XDevice *device,
 
32
                             int *nprops_return);
 
33
.fi
 
34
.sp
 
35
.nf
 
36
display
 
37
       Specifies the connection to the X server\&.
 
38
.fi
 
39
.sp
 
40
.nf
 
41
device
 
42
       The device to list the properties for\&.
 
43
.fi
 
44
.sp
 
45
.nf
 
46
nprops_return
 
47
       Specifies the number of Atoms returned\&.
 
48
.fi
51
49
.SH "DESCRIPTION"
52
 
.PP
53
 
The
54
 
\fBXListDeviceProperties\fR
55
 
function returns a list of the properties associated with the input device specified in
56
 
\fIdevice\fR\. Each device may have an arbitrary number of properties attached, some of which were created by the driver and/or server, others created by clients at runtime\.
57
 
.PP
 
50
.sp
 
51
.if n \{\
 
52
.RS 4
 
53
.\}
 
54
.nf
 
55
The XListDeviceProperties function returns a list of the
 
56
properties associated with the input device specified in
 
57
device\&. Each device may have an arbitrary number of properties
 
58
attached, some of which were created by the driver and/or
 
59
server, others created by clients at runtime\&.
 
60
.fi
 
61
.if n \{\
 
62
.RE
 
63
.\}
 
64
.sp
 
65
.if n \{\
 
66
.RS 4
 
67
.\}
 
68
.nf
58
69
The client is expected to free the list of properties using
59
 
\fBXFree\fR\.
60
 
.PP
61
 
 
62
 
\fBXListDeviceProperties\fR
63
 
can generate a
64
 
BadDevice
65
 
error\.
66
 
.SH "DIAGNOSIS"
67
 
.PP
68
 
.PP
69
 
BadAtom
70
 
.RS 4
71
 
A value does not describe a valid named identifier\.
72
 
.RE
73
 
.PP
74
 
BadWindow
75
 
.RS 4
76
 
A value for a Window argument does not name a defined window\.
77
 
.RE
78
 
.PP
79
 
BadDevice
80
 
.RS 4
81
 
An invalid device was specified\. The device does not exist\.
82
 
.RE
 
70
XFree\&.
 
71
.fi
 
72
.if n \{\
 
73
.RE
 
74
.\}
 
75
.sp
 
76
.if n \{\
 
77
.RS 4
 
78
.\}
 
79
.nf
 
80
XListDeviceProperties can generate a BadDevice error\&.
 
81
.fi
 
82
.if n \{\
 
83
.RE
 
84
.\}
 
85
.SH "DIAGNOSTICS"
 
86
.sp
 
87
.if n \{\
 
88
.RS 4
 
89
.\}
 
90
.nf
 
91
BadDevice
 
92
       An invalid device was specified\&. The device does not
 
93
       exist\&.
 
94
.fi
 
95
.if n \{\
 
96
.RE
 
97
.\}
83
98
.SH "SEE ALSO"
84
 
.PP
85
 
 
86
 
\fBXChangeDeviceProperty\fR,
87
 
\fBXGetDeviceProperty\fR,
88
 
\fBXDeleteDeviceProperty\fR\.
89
 
.SH "AUTHOR"
90
 
.PP
91
 
\fBPeter Hutterer\fR
92
 
.sp -1n
93
 
.IP "" 4
94
 
Specification and implementation\.
95
 
 
 
99
.sp
 
100
.if n \{\
 
101
.RS 4
 
102
.\}
 
103
.nf
 
104
XChangeDeviceProperty(libmansuffix),
 
105
XGetDeviceProperty(libmansuffix),
 
106
XDeleteDeviceProperty(libmansuffix)
 
107
.fi
 
108
.if n \{\
 
109
.RE
 
110
.\}