summaryrefslogtreecommitdiff
path: root/man/XListDeviceProperties.man
diff options
context:
space:
mode:
authorPeter Hutterer <peter.hutterer@redhat.com>2008-11-17 11:50:06 +1000
committerPeter Hutterer <peter.hutterer@redhat.com>2008-11-17 12:16:11 +1000
commit305d356e43462834a2fdd2cf59d47b055c2416fd (patch)
tree4b361614f368805ace0718b2110eebca22a5d3d5 /man/XListDeviceProperties.man
parent45b73dc157f326785e1022f5476bfc1f9f514d6e (diff)
Add support for XI 1.5 device properties.libXi-1.2-branch
This is a manual merge from master onto libXi 1.1.4. The branches have diverged too much to make cherry-picking reasonable and readable. This patch includes the property support provided by the combination of the following patches: - 7d5bb99ffce3200f82420c5a5ebac3b445aac633 - 0211e3e8277c590349903989f1676f6af4baa44b - bfd2e08f3530091fbcd8c078f684e9aab9057df0 - bec02767629ed795582ba3f645299d7036093511 - f9a5371d43b2c6023745f766d0e8ceff2acdff60 - e179b124aac13387c6f730197b8852c1f69eb9e3 Man pages are copied from the parsed docbook output from master.
Diffstat (limited to 'man/XListDeviceProperties.man')
-rw-r--r--man/XListDeviceProperties.man95
1 files changed, 95 insertions, 0 deletions
diff --git a/man/XListDeviceProperties.man b/man/XListDeviceProperties.man
new file mode 100644
index 0000000..4f986fc
--- /dev/null
+++ b/man/XListDeviceProperties.man
@@ -0,0 +1,95 @@
+.\" Title: XListDeviceProperties
+.\" Author: Peter Hutterer
+.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
+.\" Date: <pubdate>July 9, 2008</pubdate>
+.\" Manual: XINPUT FUNCTIONS
+.\" Source: __xorgversion__
+.\"
+.TH "XLISTDEVICEPROPERTIE" "__libmansuffix__" "<pubdate>July 9, 2008</pubdate>" "__xorgversion__" "XINPUT FUNCTIONS"
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.SH "NAME"
+XListDeviceProperties - List a device's properties.
+.SH "SYNTAX"
+.sp
+.ft B
+.nf
+#include <X11/extensions/XInput\.h>
+.fi
+.ft
+.HP 28
+.BI "Atom* XListDeviceProperties(Display\ *" "display" ", XDevice\ *" "device" ", int\ *" "nprops_return" ");"
+.SH "ARGUMENTS"
+.PP
+.PP
+\fIdisplay\fR
+.RS 4
+Specifies the connection to the X server\.
+.RE
+.PP
+\fIdevice\fR
+.RS 4
+The device to grab\.
+.RE
+.PP
+\fInprops_return\fR
+.RS 4
+Specifies the number of Atoms returned\.
+.RE
+.PP
+\fInum_values\fR
+.RS 4
+Specifies the number of elements in the values list\.
+.RE
+.PP
+\fIproperty\fR
+.RS 4
+Specifies the property to modify or query\.
+.RE
+.SH "DESCRIPTION"
+.PP
+The
+\fBXListDeviceProperties\fR
+function returns a list of the properties associated with the input device specified in
+\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\.
+.PP
+The client is expected to free the list of properties using
+\fBXFree\fR\.
+.PP
+
+\fBXListDeviceProperties\fR
+can generate a
+BadDevice
+error\.
+.SH "DIAGNOSIS"
+.PP
+.PP
+BadAtom
+.RS 4
+A value does not describe a valid named identifier\.
+.RE
+.PP
+BadWindow
+.RS 4
+A value for a Window argument does not name a defined window\.
+.RE
+.PP
+BadDevice
+.RS 4
+An invalid device was specified\. The device does not exist\.
+.RE
+.SH "SEE ALSO"
+.PP
+
+\fBXChangeDeviceProperty\fR,
+\fBXGetDeviceProperty\fR,
+\fBXDeleteDeviceProperty\fR\.
+.SH "AUTHOR"
+.PP
+\fBPeter Hutterer\fR
+.sp -1n
+.IP "" 4
+Specification and implementation\.
+