XChangePointerKeyboardPairing, XGetPairedPointer, XSetClientPointer man pages.mpx

Use XID instead of int for XGetPairedPointer.

4 files changed, 160 insertions, 0 deletions

diff --git a/man/Makefile.am b/man/Makefile.am
index f91efaf..bbf0583 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -34,6 +34,7 @@ libman_PRE = \
 	XChangeDeviceDontPropagateList.man \
 	XChangeKeyboardDevice.man \
 	XChangePointerDevice.man \
+	XChangePointerKeyboardPairing.man \
 	XDeviceBell.man \
 	XGetDeviceControl.man \
 	XGetDeviceKeyMapping.man \
@@ -41,6 +42,7 @@ libman_PRE = \
 	XGetDeviceMotionEvents.man \
 	XGetExtensionVersion.man \
 	XGetFeedbackControl.man \
+	XGetPairedPointer.man \
 	XGrabDevice.man \
 	XGrabDeviceButton.man \
 	XGrabDeviceKey.man \
@@ -49,6 +51,7 @@ libman_PRE = \
 	XQueryDeviceState.man \
 	XSelectExtensionEvent.man \
 	XSendExtensionEvent.man \
+	XSetClientPointer.man \
 	XSetDeviceButtonMapping.man \
 	XSetDeviceFocus.man \
 	XSetDeviceMode.man \
diff --git a/man/XChangePointerKeyboardPairing.man b/man/XChangePointerKeyboardPairing.man
new file mode 100644
index 0000000..02d9d0b
--- /dev/null
+++ b/man/XChangePointerKeyboardPairing.man
@@ -0,0 +1,53 @@
+.\" Copyright ([\d,\s]*) by Peter Hutterer
+.\" 
+.\" Permission to use, copy, modify, distribute, and sell this documentation 
+.\" for any purpose and without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.
+.\" The authors make no representations about the .\" suitability for any
+.\" purpose of the information in this document.  It is .\" provided \`\`as is''
+.\" without express or implied warranty.
+.\" 
+.ds xL Programming with Xlib
+.TH XChangePointerKeyboardPairing __LIB_MAN_SUFFIX__ __xorgversion__ "X FUNCTIONS"
+.SH NAME
+XChangePointerKeyboardPairing \- change pointer a keyboard is paired with.
+.SH SYNTAX
+.HP
+XChangePointerKeyboardPairing\^(\^Display *\fIdisplay\fP\^, XDevice*
+\fIpointer\fP\^, XDevice *\fIkeyboard\fP\^); 
+.fi
+\fP
+.SH ARGUMENTS
+.TP 12
+.I display
+Specifies the connection to the X server.
+.TP 12
+.I pointer
+The pointer the keyboard is to be paired with.
+.TP 12
+.I keyboard
+The keyboard to pair with the given pointer.
+.SH DESCRIPTION
+A keyboard needs to be paired to a pointer to function properly. Each time a
+keyboard-related request, reply or event requires pointer data (e.g.
+coordinates), this data is retrieved from the pointer. Similarly, the focus
+follows the paired pointer (depending on focus behaviour).
+.LP
+The \fIChangePointerKeyboardPairing\fP
+request changes the pointer for a given keyboard. A keyboard can only be
+paired with one pointer, but a pointer can be paired with multiple keyboards.
+.LP
+By default, a keyboard is paired with the first available unpaired pointer. If
+no unpaired pointer is available, the first available pointer is chosen. If no
+pointer device is available, the virtual core pointer is chosen.
+.LP
+\fIXChangePointerKeyboardPairing\fP can generate a \fIBadDevice\fP error.
+.SH DIAGNOSTICS
+.TP 12
+\fIBadDevice\fP
+An invalid device was specified.  The specified device does not exist,
+or is not a pointer or keyboard device.
+.SH "SEE ALSO"
+XGetPairedPointer(__LIB_MAN_SUFFIX__)
+.br
+\fI\*(xL\fP
diff --git a/man/XGetPairedPointer.man b/man/XGetPairedPointer.man
new file mode 100644
index 0000000..cc1d19f
--- /dev/null
+++ b/man/XGetPairedPointer.man
@@ -0,0 +1,46 @@
+.\" Copyright ([\d,\s]*) by Peter Hutterer
+.\" 
+.\" Permission to use, copy, modify, distribute, and sell this documentation 
+.\" for any purpose and without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.
+.\" The authors make no representations about the .\" suitability for any
+.\" purpose of the information in this document.  It is .\" provided \`\`as is''
+.\" without express or implied warranty.
+.\" 
+.ds xL Programming with Xlib
+.TH XGetPairedPointer __LIB_MAN_SUFFIX__ __xorgversion__ "X FUNCTIONS"
+.SH NAME
+XGetPairedPointer \- get the ID of the pointer paired with the given keyboard.
+.SH SYNTAX
+.HP
+Bool XGetPairedPointer\^(\^Display *\fIdisplay\fP\^, XDevice
+*\fIkeyboard\fP\^, XID* deviceid); 
+.fi
+\fP
+.SH ARGUMENTS
+.TP 12
+.I display
+Specifies the connection to the X server.
+.TP 12
+.I keyboard
+Specifies the keyboard device to query.
+.TP 12
+.I deviceid
+Returns the ID of the pointer device the keyboard is paired with.
+.SH DESCRIPTION
+The \fIXGetPairedPointer\fP
+request retrieves the ID of the device that is paired with the given keyboard.
+\fIXGetPairedPointer\fP returns \fITRUE\fP if the given keyboard is paired
+with a pointer device and sets \fIdeviceid\fP to the ID of this pointer
+device. Otherwise, \fIXGetPairedPointer\fP returns \fIFALSE\fP.
+.LP
+\fIXGetPairedPointer\fP can generate a \fIBadDevice\fP error.
+.SH DIAGNOSTICS
+.TP 12
+\fIBadDevice\fP
+An invalid device was specified.  The specified device does not exist,
+or is not a keyboards device.
+.SH "SEE ALSO"
+XChangePointerKeyboardPairing(__LIB_MAN_SUFFIX__)
+.br
+\fI\*(xL\fP
diff --git a/man/XSetClientPointer.man b/man/XSetClientPointer.man
new file mode 100644
index 0000000..96d63f3
--- /dev/null
+++ b/man/XSetClientPointer.man
@@ -0,0 +1,58 @@
+.\" Copyright ([\d,\s]*) by Peter Hutterer
+.\" 
+.\" Permission to use, copy, modify, distribute, and sell this documentation 
+.\" for any purpose and without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.
+.\" The authors make no representations about the .\" suitability for any
+.\" purpose of the information in this document.  It is .\" provided \`\`as is''
+.\" without express or implied warranty.
+.\" 
+.ds xL Programming with Xlib
+.TH XSetClientPointer __LIB_MAN_SUFFIX__ __xorgversion__ "X FUNCTIONS"
+.SH NAME
+SetClientPointer, XGetClientPointer \- set or get a client's ClientPointer 
+.SH SYNTAX
+.HP
+XSetClientPointer\^(\^Display *\fIdisplay\fP\^, Window \fIwin\fP\^, XDevice *\fIdevice\fP\^); 
+.HP
+XID XGetClientPointer\^(\^Display *\fIdisplay\fP\^, Window \fIwin\fP\^);
+.fi
+\fP
+.SH ARGUMENTS
+.TP 12
+.I display
+Specifies the connection to the X server.
+.TP 12
+.I device
+Specifies the device to set as ClientPointer.
+.TP 12
+.I win
+Specifies a window belonging to the client. May be \fINone\fP.
+.SH DESCRIPTION
+The ClientPointer is the device that is used to fill non-XI protocol
+requests, replies and events. Each time a protocol message needs
+device-dependent data and the device is not explicitly given, the
+ClientPointer device is used to obtain the data. For example, a
+\fIXQueryPointer\fP request will return the coordinates of the ClientPointer.
+The \fIXSetClientPointer\fP
+request sets the ClientPointer device for the client that owns the given
+window. If window is \fINone\fP, the requesting client's ClientPointer is set
+to the given device.
+.LP
+The \fIXGetClientPointer\fP request returns the ClientPointer's device ID for
+the client that owns the given window. If window is \fINone\fP, the requesting
+client's ClientPointer is returned..
+.LP
+\fIXSetClientPointer\fP and \fIXGetClientPointer\fP can generate a
+\fIBadDevice\fP and a \fIBadwindow\fP error.
+.SH DIAGNOSTICS
+.TP 12
+\fIBadDevice\fP
+An invalid device was specified.  The specified device does not exist,
+or is not a pointer device.
+.TP 12
+\fIBadWindow\fP
+A value for a Window argument does not name a defined Window.
+.SH "SEE ALSO"
+.br
+\fI\*(xL\fP