summaryrefslogtreecommitdiff
path: root/man/XIQueryPointer.txt
diff options
context:
space:
mode:
authorPeter Hutterer <peter.hutterer@who-t.net>2009-05-15 14:16:31 +1000
committerPeter Hutterer <peter.hutterer@who-t.net>2009-05-18 10:53:35 +1000
commit615545f9cba36ab7732d2325970a7c84b2fa6e8c (patch)
tree925b1d6ee89ae892c1f5ccc3d73cd86c39dd64ed /man/XIQueryPointer.txt
parent9966ab40b850c780e439f86e165188919f884b64 (diff)
Switch man pages to asciidoc.
The docbook xml is unreadable and unwritable. Switch everything to asciidoc, at least thay we we can write man pages without losing sanity. asciidoc seems to have some issues with __libmansuffix__, so instead we just use libmansuffix (without underscores). The current asciidoc version is buggy for multiple man targets (more than one man page in a single file), so stick a big warning into configure that a patch is required to the the right asciidoc->docbook conversion. Many thanks to Dan Nicholson for the Makefile.am. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Diffstat (limited to 'man/XIQueryPointer.txt')
-rw-r--r--man/XIQueryPointer.txt99
1 files changed, 99 insertions, 0 deletions
diff --git a/man/XIQueryPointer.txt b/man/XIQueryPointer.txt
new file mode 100644
index 0000000..ad7f132
--- /dev/null
+++ b/man/XIQueryPointer.txt
@@ -0,0 +1,99 @@
+XIQUERYPOINTER(libmansuffix)
+============================
+
+NAME
+----
+
+ XIQueryPointer - get device pointer coordinates.
+
+SYNOPSIS
+--------
+
+ #include <X11/extensions/XInput2.h>
+
+ Bool XIQueryPointer( Display *display,
+ int deviceid,
+ Window win,
+ Window *root_return,
+ Window *child_return,
+ int *root_x_return,
+ int *root_y_return,
+ int *win_x_return,
+ int *win_y_return,
+ XIModifierState *modifiers_return,
+ XIGroupState *group_return,
+ XIButtonState *buttons_return);
+
+ buttons_return
+ Returns the current button state.
+
+ child_return
+ Returns the child window that the pointer is located in,
+ if any.
+
+ deviceid
+ Specifies the device to query.
+
+ display
+ Specifies the connection to the X server.
+
+ group_return
+ Returns the current group state.
+
+ modifiers_return
+ Returns the current state of the modifier keys.
+
+ root_return
+ Returns the root window that the pointer is in.
+
+ root_x_return, root_y_return
+ Return the pointer coordinates relative to the root
+ window's origin.
+
+ win
+ Specifies the window.
+
+ win_x_return, win_y_return
+ Return the pointer coordinates relative to the specified
+ window.
+
+DESCRIPTION
+-----------
+
+ The XIQueryPointer function returns the root window the
+ device's pointer is logically on and the pointer coordinates
+ relative to the root window's origin. If XIQueryPointer returns
+ False, the pointer is not on the same screen as the specified
+ window, and XIQueryPointer returns None to child_return and
+ zero to win_x_return and win_y_return. If XIQueryPointer
+ returns True, the pointer coordinates returned to win_x_return
+ and win_y_return are relative to the origin of the specified
+ window. In this case, XIQueryPointer returns the child that
+ contains the pointer, if any, or else None to child_return.
+
+ XIQueryPointer returns the current logical state of the buttons
+ buttons_return. The keyboard paired with the master pointer is
+ selected to obtain the data for modifiers_return and
+ group_return.
+
+ XIQueryPointer is identical to XQueryPointer but specifies the
+ device explicitly.
+
+ XIQueryPointer can generate a BadDevice and a BadWindow error.
+
+DIAGNOSTICS
+-----------
+
+ BadDevice
+ An invalid device was specified. The device does not
+ exist or is not a pointer device.
+
+ BadWindow
+ A value for a Window argument does not name a defined
+ window.
+
+SEE ALSO
+--------
+
+ XQueryPointer(libmansuffix)
+