diff options
| author | Peter Hutterer <peter@cs.unisa.edu.au> | 2008-04-27 16:33:00 +0930 |
|---|---|---|
| committer | Peter Hutterer <peter@cs.unisa.edu.au> | 2008-04-27 16:33:00 +0930 |
| commit | 51886a38dd42bb62bf3ffcadbf73472e6d2b514f (patch) | |
| tree | 2d9391f69d1e4e9c3f20b2cda3bea630fc8a158c /man/XI.xml | |
| parent | c142891001e53b3c9d1d4a0cfcb0ff555c2f0070 (diff) | |
man: add XI.xml. Contains all libXi man pages in docbook.format.
Note that conversion was half-automated and half-manual. There's a lot of
little things to be fixed up.
Diffstat (limited to 'man/XI.xml')
| -rw-r--r-- | man/XI.xml | 4373 |
1 files changed, 4373 insertions, 0 deletions
diff --git a/man/XI.xml b/man/XI.xml new file mode 100644 index 0000000..5002be6 --- /dev/null +++ b/man/XI.xml @@ -0,0 +1,4373 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<!DOCTYPE reference PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" > +<reference> +<title>X Input Extension Library (MPX)</title> + +<refentry id="XAllowDeviceEvents.man"> + <refentryinfo> + <productname>_vendorversion_</productname> + </refentryinfo> + + <refmeta> + <refentrytitle>XAllowDeviceEvents</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + <refnamediv> + <refname>XAllowDeviceEvents</refname> + <refpurpose>release queued events</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Syntax</title> + <funcsynopsis> + <funcsynopsisinfo>#include <X11/extensions/XInput.h></funcsynopsisinfo> + <funcprototype> + <funcdef> + <function>int XAllowDeviceEvents</function></funcdef> + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef> XDevice *<parameter>device</parameter></paramdef> + <paramdef>int <parameter>event_mode</parameter></paramdef> + <paramdef> Time <parameter>time</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1><title>Arguments</title> + + <para> + <variablelist> + <varlistentry><term><parameter>display</parameter></term> + <listitem><para>Specifies the connection to the X server.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>device</parameter></term> + <listitem><para>Specifies the device from which events are to be allowed.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>event_mode</parameter></term> + <listitem><para>Specifies the event mode.You can pass <constant>AsyncThisDevice</constant> , <constant>SyncThisDevice</constant> , <constant>ReplayThisDevice</constant> , <constant>AsyncOtherDevices</constant> , <constant>SyncAll</constant> ,or <constant>AsyncAll</constant> .</para></listitem> + </varlistentry> + <varlistentry><term><parameter>time</parameter></term> + <listitem><para>Specifies the time.You can pass either a timestamp or <constant>CurrentTime</constant> .</para></listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1><title>Description</title> + <para>The <constant>XAllowDeviceEvents</constant> function releases some queued events if the client has caused a device to freeze. It has no effect if the specified time is earlier than the last-grab time of the most recent active grab for the client and device, or if the specified time is later than the current X server time. </para> + <para> + The following describes the processing that occurs depending on what constant you pass to the event_mode argument. </para> + <para> + <constant>AsyncThisDevice</constant> If the specified device is frozen by the client, event processing for that device continues as usual. If the device is frozen multiple times by the client on behalf of multiple separate grabs, <constant>AsyncThisDevice</constant> thaws for all. <constant>AsyncThisDevice</constant> has no effect if the specified device is not frozen by the client, but the device need not be grabbed by the client. </para> + <para> + <constant>SyncThisDevice</constant> If the specified device is frozen and actively grabbed by the client, event processing for that device continues normally until the next key or button event is reported to the client. At this time, the specified device again appears to freeze. However, if the reported event causes the grab to be released, the specified device does not freeze. <constant>SyncThisDevice</constant> has no effect if the specified device is not frozen by the client or is not grabbed by the client. </para> + <para> + <constant>ReplayThisDevice</constant> If the specified device is actively grabbed by the client and is frozen as the result of an event having been sent to the client (either from the activation of a GrabDeviceButton or from a previous AllowDeviceEvents with mode SyncThisDevice, but not from a GrabDevice), the grab is released and that event is completely reprocessed. This time, however, the request ignores any passive grabs at or above (toward the root) that the grab-window of the grab just released. The request has no effect if the specified device is not grabbed by the client or if it is not frozen as the result of an event. </para> + <para> + <constant>AsyncOtherDevices</constant> If the remaining devices are frozen by the client, event processing for them continues as usual. If the other devices are frozen multiple times by the client on behalf of multiple grabs, <constant>AsyncOtherDevices</constant> "thaws" for all. <constant>AsyncOtherDevices</constant> has no effect if the devices are not frozen by the client. </para> + <para> + <constant>SyncAll</constant> If all devices are frozen by the client, event processing (for all devices) continues normally until the next button or key event is reported to the client for a grabbed device, at which time all devices again appear to freeze. However, if the reported event causes the grab to be released, then the devices do not freeze. If any device is still grabbed, then a subsequent event for it will still cause all devices to freeze. <constant>SyncAll</constant> has no effect unless all devices are frozen by the client. If any device is frozen twice by the client on behalf of two separate grabs, <constant>SyncAll</constant> thaws for both. A subsequent freeze for <constant>SyncAll</constant> will only freeze each device once. </para> + <para> + <constant>AsyncAll</constant> If all devices are frozen by the client, event processing for all devices continues normally. If any device is frozen multiple times by the client on behalf of multiple separate grabs, <constant>AsyncAll</constant> thaws for all. <constant>AsyncAll</constant> has no effect unless all devices are frozen by the client. </para> + <para> + <constant>AsyncThisDevice</constant>, <constant>SyncThisDevice</constant>, and <constant>ReplayThisDevice</constant> have no effect on the processing of events from the remaining devices. <constant>AsyncOtherDevices</constant> has no effect on the processing of events from the specified device. When the event_mode is <constant>SyncAll</constant> or <constant>AsyncAll</constant>, the device parameter is ignored. </para> + <para> + It is possible for several grabs of different devices by the same or different clients to be active simultaneously. If a device is frozen on behalf of any grab, no event processing is performed for the device. It is possible for a single device to be frozen because of several grabs. In this case, the freeze must be released on behalf of each grab before events can again be processed. </para> + <para> + <constant>XAllowDeviceEvents</constant> can generate a <constant>BadDevice</constant> or <constant>BadValue</constant> error. </para> + </refsect1> + + <refsect1><title>Diagnostics</title><para> + <variablelist> + <varlistentry> + <term><errorname>BadDevice</errorname></term> + <listitem><para>An invalid device was specified. The specified device does not exist or has not been opened by this client via <constant>XOpenInputDevice</constant> . This error may also occur if the specified device is the X keyboard or X pointer device. </para> + </listitem> + </varlistentry> + <varlistentry> + <term><errorname>BadValue</errorname></term> + <listitem><para>An invalid mode was specified on the request. </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1><title>See also</title> + <para>XGrabDevice(3)</para> + </refsect1> +</refentry> + +<refentry id="XChangeDeviceDontPropagateList.man"> + <refentryinfo> + <productname>_vendorversion_</productname> + </refentryinfo> + + <refmeta> + <refentrytitle>XChangeDeviceDontPropagateList</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + <refnamediv> + <refname>XChangeDeviceDontPropagateList, XGetDeviceDontPropagateList</refname> + <refpurpose>query or change the dont-propagate-list for extension devices</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Syntax</title> + <funcsynopsis> + <funcsynopsisinfo>#include <X11/extensions/XInput.h></funcsynopsisinfo> + <funcprototype> + <funcdef>int <function>XChangeDeviceDontPropagateList</function></funcdef> + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef> Window*<parameter>window</parameter></paramdef> + <paramdef> int *<parameter>count</parameter></paramdef> + <paramdef> XEventClass *<parameter>event_list</parameter></paramdef> + <paramdef> int<parameter>mode</parameter></paramdef> + </funcprototype> + <funcprototype> + <funcdef>XEventClass* <function>XGetDeviceDontPropagateList</function></funcdef> + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef> Window *<parameter>window</parameter></paramdef> + <paramdef> int *<parameter>count</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1><title>Arguments</title> + + <para> + <variablelist> + <varlistentry><term><parameter>display</parameter></term> + <listitem><para>Specifies the connection to the X server.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>window</parameter></term> + <listitem><para>Specifies the window whose dont-propagate-list is to be queried or modified.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>event_list</parameter></term> + <listitem><para>Specifies a pointer to a list of event classes.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>mode</parameter></term> + <listitem><para>Specifies the mode.You can pass <constant>AddToList</constant>, or <constant>DeleteFromList</constant>.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>count</parameter></term> + <listitem><para>Specifies the number of event classes in the list.</para></listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1><title>Description</title> + <para>The <constant>XChangeDeviceDontPropagateList</constant> request modifies the list of events that should not be propagated to ancestors of the event window. This request allows extension events to be added to or deleted from that list. By default, all events are propagated to ancestor windows. Once modified, the list remains modified for the life of the window. Events are not removed from the list because the client that added them has terminated. </para> + <para> + Suppression of event propagation is not allowed for all input extension events. If a specified event class is one that cannot be suppressed, a <constant>BadClass</constant> error will result. Events that can be suppressed include <constant>DeviceKeyPress</constant>, <constant>DeviceKeyRelease</constant>, <constant>DeviceButtonPress</constant>, <constant>DeviceButtonRelease</constant>, <constant>DeviceMotionNotify</constant>, <constant>ProximityIn</constant>, and <constant>ProximityOut</constant>. </para> + <para> + <constant>XChangeDeviceDontPropagateList</constant> can generate a <constant>BadDevice</constant>, <constant>BadClass</constant>, or <constant>BadValue</constant> error. </para> + <para> + The <constant>XGetDeviceDontPropagateList</constant> request queries the list of events that should not be propagated to ancestors of the event window. </para> + <para> + <constant>XGetDeviceDontPropagateList</constant> can generate a <constant>BadClass</constant> or <constant>BadWindow</constant> error. </para> + </refsect1> + + <refsect1><title>Diagnostics</title><para> + <variablelist> + <varlistentry> + <term><errorname>BadDevice</errorname></term> + <listitem><para>An invalid device was specified. The specified device does not exist or has not been opened by this client via <constant>XOpenInputDevice</constant>. This error may also occur if some other client has caused the specified device to become the X keyboard or X pointer device via the <constant>XChangeKeyboardDevice</constant> or <constant>XChangePointerDevice</constant> requests. </para> + </listitem> + </varlistentry> + <varlistentry> + <term><errorname>BadValue</errorname></term> + <listitem><para>Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of alternatives can generate this error. </para> + </listitem> + </varlistentry> + <varlistentry> + <term><errorname>BadWindow</errorname></term> + <listitem><para>An invalid window id was specified. </para> + </listitem> + </varlistentry> + <varlistentry> + <term><errorname>BadClass</errorname></term> + <listitem><para>An invalid event class was specified. </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> +</refentry> + +<refentry id="XChangeKeyboardDevice.man"> + <refentryinfo> + <productname>_vendorversion_</productname> + </refentryinfo> + + <refmeta> + <refentrytitle>XChangeKeyboardDevice</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + <refnamediv> + <refname>XChangeKeyboardDevice</refname> + <refpurpose>change which device is used as the X keyboard</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Syntax</title> + <funcsynopsis> + <funcsynopsisinfo>#include <X11/extensions/XInput.h></funcsynopsisinfo> + <funcprototype> + <funcdef><function>Status XChangeKeyboardDevice</function></funcdef> + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef> XDevice*<parameter>device</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1><title>Arguments</title> + <para> + <variablelist> + <varlistentry><term><parameter>display</parameter></term> + <listitem><para>Specifies the connection to the X server.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>device</parameter></term> + <listitem><para>Specifies the device to be used as the X keyboard.</para></listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1><title>Description</title> + <para>The <constant>XChangeKeyboardDevice</constant> request causes the server to use the specified device as the X keyboard. The device must have been previously opened by the requesting client via <constant>XOpenDevice</constant> or a <constant>BadDevice</constant> error will result. The device must support input class <constant>Keys</constant>, or a <constant>BadMatch</constant> error will result. If the server implementation does not support using the requested device as the X keyboard, a <constant>BadDevice</constant> error will result. </para> + <para> + If the specified device is grabbed by another client, <constant>AlreadyGrabbed</constant> is returned. If the specified device is frozen by a grab on another device, <constant>GrabFrozen</constant> is returned. If the request is successful, <constant>Success</constant> is returned. </para> + <para> + If the request succeeds, a <constant>ChangeDeviceNotify</constant> event is sent to all clients that have selected that event. A <constant>MappingNotify</constant> event with request = <constant>MappingKeyboard</constant> is sent to all clients. The specified device becomes the X keyboard and the old X keyboard becomes accessible through the input extension protocol requests. </para> + <para> + <constant>XChangeKeyboardDevice</constant> can generate a <constant>BadDevice</constant> or a <constant>BadMatch</constant> error. </para> + </refsect1> + + <refsect1><title>Diagnostics</title><para> + <variablelist> + <varlistentry> + <term><errorname>BadDevice</errorname></term> + <listitem><para>An invalid device was specified. The specified device does not exist, has not been opened by this client via <constant>XOpenInputDevice</constant>, or is already one of the core X device (pointer or keyboard). This error may also occur if the server implementation does not support using the specified device as the X keyboard. </para> + </listitem> + </varlistentry> + <varlistentry> + <term><errorname>BadMatch</errorname></term> + <listitem><para>This error may occur if an <constant>XChangeKeyboardDevice</constant> request was made specifying a device that has no keys. </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1><title>See also</title> + <para>XChangePointerDevice</para> + </refsect1> +</refentry> + +<refentry id="XChangePointerDevice.man"> + <refentryinfo> + <productname>_vendorversion_</productname> + </refentryinfo> + + <refmeta> + <refentrytitle>XChangePointerDevice</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + <refnamediv> + <refname>XChangePointerDevice</refname> + <refpurpose>change which device is the X pointer</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Syntax</title> + <funcsynopsis> + <funcsynopsisinfo>#include <X11/extensions/XInput.h></funcsynopsisinfo> + <funcprototype> + <funcdef><function>Status XChangePointerDevice</function></funcdef> + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef> XDevice *<parameter>device</parameter></paramdef> + <paramdef> int <parameter>xaxis</parameter></paramdef> + <paramdef> int <parameter>yaxis</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1><title>Arguments</title> + + <para> + <variablelist> + <varlistentry><term><parameter>display</parameter></term> + <listitem><para>Specifies the connection to the X server.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>device</parameter></term> + <listitem><para>Specifies the device to be used as the X pointer.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>xaxis</parameter></term> + <listitem><para>Specifies the axis of the device to be used as the X pointer x-axis.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>yaxis</parameter></term> + <listitem><para>Specifies the axis of the device to be used as the X pointer y-axis.</para></listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1><title>Description</title> + <para>The <constant>XChangePointerDevice</constant> request causes the server to use the specified device as the X pointer. The device must have been opened by the client via <constant>XOpenDevice</constant> or a <constant>BadDevice</constant> error will result. The device must support input class <constant>Valuators</constant> or a <constant>BadMatch</constant> error will result. If the implementation does not support use of the specified device as the X pointer, a <constant>BadDevice</constant> error will result. </para> + <para> + If the specified device is grabbed by another client, <constant>AlreadyGrabbed</constant> is returned. If the specified device is frozen by a grab on another device, <constant>GrabFrozen</constant> is returned. If the request is successful, <constant>Success</constant> is returned. </para> + <para> + If the request succeeds, a <constant>ChangeDeviceNotify</constant> event is sent to all clients that have selected that event. A <constant>MappingNotify</constant> event with request = <constant>MappingPointer</constant> is sent to all clients. The specified device becomes the X pointer, and the old X pointer becomes accessible through the input extension protocol requests. </para> + <para> + <constant>XChangePointerDevice</constant> can generate a <constant>BadDevice</constant> or a <constant>BadMatch</constant> error. </para> + </refsect1> + + <refsect1><title>Diagnostics</title><para> + <variablelist> + <varlistentry> + <term><errorname>BadDevice</errorname></term> + <listitem><para>An invalid device was specified. The specified device does not exist, has not been opened by this client via <constant>XOpenInputDevice</constant>, or is already one of the core X input devices (pointer or keyboard). This error may also occur if the server implementation does not support using the specified device as the X pointer. </para> + </listitem> + </varlistentry> + <varlistentry> + <term><errorname>BadMatch</errorname></term> + <listitem><para>This error may occur if an <constant>XChangePointerDevice</constant> request was made specifying a device that has less than two valuators, or specifying a valuator index beyond the range supported by the device. </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1><title>See also</title> + <para>XChangeKeyboardDevice</para> + </refsect1> +</refentry> + +<refentry id="XDeviceBell.man"> + <refentryinfo> + <productname>_vendorversion_</productname> + </refentryinfo> + + <refmeta> + <refentrytitle>XDeviceBell</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + <refnamediv> + <refname>XDeviceBell</refname> + <refpurpose>ring a bell on a device supported through the input extension</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Syntax</title> + <funcsynopsis> + <funcsynopsisinfo>#include <X11/extensions/XInput.h></funcsynopsisinfo> + <funcprototype> + <funcdef> + <function>Status XDeviceBell</function></funcdef> + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef> XDevice *<parameter>device</parameter></paramdef> + <paramdef> XID *<parameter>feedbackclass</parameter></paramdef> + <paramdef> XID *<parameter>feedbackid</parameter></paramdef> + <paramdef> int *<parameter>percent</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1><title>Arguments</title> + + <para> + <variablelist> + <varlistentry><term><parameter>display</parameter></term> + <listitem><para>Specifies the connection to the X server.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>device</parameter></term> + <listitem><para>Specifies the device with which the bell is associated.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>feedbackclass</parameter></term> + <listitem><para>Specifies the class of the feedback with which the bell is associated.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>feedbackid</parameter></term> + <listitem><para>Specifies the id of the feedback with which the bell is associated.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>percent</parameter></term> + <listitem><para>Specifies the volume in the range -100 to 100 at which the bell should be rung.</para></listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1><title>Description</title> + <para>The <constant>XDeviceBell</constant> request causes the server to ring a bell on the specified feedback of the specified device, if possible. The specified volume is relative to the base volume for the bell. If an invalid device is specified, a <constant>BadDevice</constant> error will be returned. The feedbackclass and feedbackid parameters contain values returned by an <constant>XGetFeedbackControl</constant> request and uniquely identify the bell to ring. If a feedbackclass is specified that does not support a bell, or if a nonexistent feedbackid is specified, or a percent value is specified that is not in the range -100 to 100, a <constant>BadValue</constant> error will be returned. </para> + <para> + The volume at which the bell is rung when the percent argument is nonnegative is: base \- [(base * percent) / 100] + percent </para> + <para> + The volume at which the bell rings when the percent argument is negative is: base + [(base * percent) / 100] </para> + <para> + To change the base volume of the bell, use <constant>XChangeFeedbackControl</constant> . </para> + <para> + <constant>XDeviceBell</constant> can generate a <constant>BadDevice</constant> or a <constant>BadValue</constant> error. </para> + </refsect1> + + <refsect1><title>Diagnostics</title><para> + <variablelist> + <varlistentry> + <term><errorname>BadDevice</errorname></term> + <listitem><para>An invalid device was specified. The specified device does not exist, or has not been opened by this client via <constant>XOpenInputDevice</constant> . </para> + </listitem> + </varlistentry> + <varlistentry> + <term><errorname>BadValue</errorname></term> + <listitem><para>An invalid feedbackclass, feedbackid, or percent value was specified. </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1><title>See also</title> + <para>XChangeFeedbackControl(3), XBell(3)</para> + </refsect1> +</refentry> + +<refentry id="XGetDeviceControl.man"> + <refentryinfo> + <productname>_vendorversion_</productname> + </refentryinfo> + + <refmeta> + <refentrytitle>XGetDeviceControl</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + <refnamediv> + <refname>XGetDeviceControl, XChangeDeviceControl</refname> + <refpurpose>query and change input device controls</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Syntax</title> + <funcsynopsis> + <funcsynopsisinfo>#include <X11/extensions/XInput.h></funcsynopsisinfo> + <funcprototype> + <funcdef><function>XDeviceControl *XGetDeviceControl</function></funcdef> + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef> XDevice*<parameter>device</parameter></paramdef> + <paramdef> int *<parameter>controlType</parameter></paramdef> + </funcprototype> + <funcprototype> + <funcdef><function>int XChangeDeviceControl</function></funcdef> + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef> XDevice*<parameter>device</parameter></paramdef> + <paramdef> int <parameter>controlType</parameter></paramdef> + <paramdef> XDeviceControl *<parameter>control</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1><title>Arguments</title> + + <para> + <variablelist> + <varlistentry><term><parameter>display</parameter></term> + <listitem><para>Specifies the connection to the X server.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>device</parameter></term> + <listitem><para>Specifies the device whose control is to be interrogated or modified.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>controlType</parameter></term> + <listitem><para>Specifies the type of control to be interrogated or changed.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>control</parameter></term> + <listitem><para>Specifies the address of an <constant>XDeviceControl</constant> structure that containsthe new values for the Device.</para></listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1><title>Description</title> + <para>These requests are provided to manipulate those input devices that support device control. A <constant>BadMatch</constant> error will be generated if the requested device does not support any device controls. </para> + <para> + Valid device control types that can be used with these requests include the following: </para> + <para> + DEVICE_RESOLUTION Queries or changes the resolution of valuators on input devices. </para> + <para> + The <constant>XGetDeviceControl</constant> request returns a pointer to an <constant>XDeviceControl</constant> structure. </para> + <para> + <constant>XGetDeviceControl</constant> can generate a <constant>BadDevice</constant> or <constant>BadMatch</constant> error. </para> + <para> + The <constant>XChangeDeviceControl</constant> request modifies the values of one control on the specified device. The control is identified by the id field of the <constant>XDeviceControl</constant> structure that is passed with the request. </para> + <para> + <constant>XChangeDeviceControl</constant> can generate a <constant>BadDevice</constant>, <constant>BadMatch</constant>, or <constant>BadValue</constant> error. .SH STRUCTURES Each control is described by a structure specific to that control. These structures are defined in the file <constant>XInput.h</constant> . </para> + <para> + <constant>XDeviceControl</constant> is a generic structure that contains two fields that are at the beginning of each class of control: </para> + <para> + <synopsis> + typedef struct { + XID <structfield>class</structfield>; + int <structfield>length</structfield>; + } <structname>XDeviceControl</structname>; + </synopsis> + </para> + <para> + The <constant>XDeviceResolutionState</constant> structure defines the information that is returned for device resolution for devices with valuators. </para> + <para> + <synopsis> + typedef struct { + XID <structfield>control</structfield>; + int <structfield>length</structfield>; + int <structfield>num_valuators</structfield>; + int* <structfield>resolutions</structfield>; + int* <structfield>min_resolutions</structfield>; + int* <structfield>max_resolutions</structfield>; + } <structname>XDeviceResolutionState</structname>; + </synopsis> + </para> + <para> + The <constant>XDeviceResolutionControl</constant> structure defines the attributes that can be controlled for keyboard Devices. </para> + <para> + <synopsis> + typedef struct { + XID <structfield>control</structfield>; + int <structfield>length</structfield>; + int <structfield>first_valuator</structfield>; + int <structfield>num_valuators</structfield>; + int* <structfield>resolutions</structfield>; + } <structname>XDeviceResolutionControl</structname>; + </synopsis> + </para> + </refsect1> + + <refsect1><title>Diagnostics</title><para> + <variablelist> + <varlistentry> + <term><errorname>BadDevice</errorname></term> + <listitem><para>An invalid device was specified. The specified device does not exist or has not been opened by this client via <constant>XOpenInputDevice</constant> . This error may also occur if some other client has caused the specified device to become the X keyboard or X pointer device via the <constant>XChangeKeyboardDevice</constant> or <constant>XChangePointerDevice</constant> requests. </para> + </listitem> + </varlistentry> + <varlistentry> + <term><errorname>BadMatch</errorname></term> + <listitem><para>This error may occur if an <constant>XGetDeviceControl</constant> request was made specifying a device that has no controls or an <constant>XChangeDeviceControl</constant> request was made with an <constant>XDeviceControl</constant> structure that contains an invalid Device type. It may also occur if an invalid combination of mask bits is specified ( <constant>DvKey</constant> but no <constant>DvAutoRepeatMode</constant> for keyboard Devices), or if an invalid KeySym is specified for a string Device. </para> + </listitem> + </varlistentry> + <varlistentry> + <term><errorname>BadValue</errorname></term> + <listitem><para>Some numeric value falls outside the range of values accepted by the <constant>XChangeDeviceControl</constant> request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of alternatives can generate this error. </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1><title>See also</title> + <para></para> + </refsect1> +</refentry> + +<refentry id="XGetDeviceKeyMapping.man"> + <refentryinfo> + <productname>_vendorversion_</productname> + </refentryinfo> + + <refmeta> + <refentrytitle>XGetDeviceKeyMapping</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + <refnamediv> + <refname>XGetDeviceKeyMapping, XChangeDeviceKeyMapping</refname> + <refpurpose>query or change device key mappings</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Syntax</title> + <funcsynopsis> + <funcsynopsisinfo>#include <X11/extensions/XInput.h></funcsynopsisinfo> + <funcprototype> + <funcdef><function>KeySym *XGetDeviceKeyMapping</function></funcdef> + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef> XDevice *<parameter>device</parameter></paramdef> + <paramdef> KeyCode <parameter>first_keycode</parameter></paramdef> + <paramdef> int <parameter>keycode_count</parameter></paramdef> + <paramdef> int *<parameter>keysyms_per_keycode_return</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1><title>Arguments</title> + + <para> + <variablelist> + <varlistentry><term><parameter>display</parameter></term> + <listitem><para>Specifies the connection to the X server.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>device</parameter></term> + <listitem><para>Specifies the device whose key mapping is to be queried or modified.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>first_keycode</parameter></term> + <listitem><para>Specifies the first KeyCode to be returned.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>keycode_count</parameter></term> + <listitem><para>Specifies the number of KeyCodes to be returned or modified.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>keysyms_per_keycode</parameter></term> + <listitem><para>Specifies the number of KeySyms per KeyCode.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>keysyms_per_keycode_return</parameter></term> + <listitem><para>Specifies the address of a variable into which the number of KeySyms per KeyCodewill be returned.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>keysyms</parameter></term> + <listitem><para>Specifies the address of an array of KeySyms.</para></listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1><title>Description</title> + <para>For the specified device, the <constant>XGetDeviceKeyMapping</constant> request returns the symbols for the specified number of KeyCodes starting with first_keycode. The value specified in first_keycode must be greater than or equal to min_keycode as returned by <constant>XListInputDevices</constant>, or a <constant>BadValue</constant> error results. In addition, the following expression must be less than or equal to max_keycode as returned by <constant>XListInputDevices</constant>: </para> + <para> + first_keycode + keycode_count - 1 + </para> + <para> + If this is not the case, a <constant>BadValue</constant> error results. The number of elements in the KeySyms list is: </para> + <para> + keycode_count * keysyms_per_keycode_return + </para> + <para> + KeySym number N, counting from zero, for KeyCode K has the following index in the list, counting from zero: (K - first_code) * keysyms_per_code_return + N </para> + <para> + The X server arbitrarily chooses the keysyms_per_keycode_return value to be large enough to report all requested symbols. A special KeySym value of <constant>NoSymbol</constant> is used to fill in unused elements for individual KeyCodes. To free the storage returned by <constant>XGetDeviceKeyMapping</constant>, use <constant>XFree</constant>. </para> + <para> + If the specified device does not support input class keys, a <constant>BadMatch</constant> error will result. </para> + <para> + <constant>XGetDeviceKeyMapping</constant> can generate a <constant>BadDevice</constant>, <constant>BadMatch</constant>, or <constant>BadValue</constant> error. </para> + <para> + For the specified device, the <constant>XChangeDeviceKeyMapping</constant> request defines the symbols for the specified number of KeyCodes starting with first_keycode. The symbols for KeyCodes outside this range remain unchanged. The number of elements in keysyms must be: </para> + <para> + num_codes * keysyms_per_keycode </para> + <para> + The specified first_keycode must be greater than or equal to min_keycode returned by <constant>XListInputDevices</constant>, or a <constant>BadValue</constant> error results. In addition, the following expression must be less than or equal to max_keycode as returned by <constant>XListInputDevices</constant>, or a <constant>BadValue</constant> error results: </para> + <para> + first_keycode + num_codes - 1</para> + <para> + KeySym number N, counting from zero, for KeyCode K has the following index in keysyms, counting from zero: </para> + <para> + (K - first_keycode) * keysyms_per_keycode + N</para> + <para> + The specified keysyms_per_keycode can be chosen arbitrarily by the client to be large enough to hold all desired symbols. A special KeySym value of <constant>NoSymbol</constant> should be used to fill in unused elements for individual KeyCodes. It is legal for <constant>NoSymbol</constant> to appear in nontrailing positions of the effective list for a KeyCode. <constant>XChangeDeviceKeyMapping</constant> generates a <constant>DeviceMappingNotify</constant> event that is sent to all clients that have selected that type of event. </para> + <para> + There is no requirement that the X server interpret this mapping. It is merely stored for reading and writing by clients. </para> + <para> + If the specified device does not support input class keys, a <constant>BadMatch</constant> error results. </para> + <para> + <constant>XChangeDeviceKeyMapping</constant> can generate a <constant>BadDevice</constant>, <constant>BadMatch</constant>, <constant>BadAlloc</constant>, or <constant>BadValue</constant> error. </para> + <para> + </para> + </refsect1> + + <refsect1><title>Diagnostics</title><para> + <variablelist> + <varlistentry> + <term><errorname>BadDevice</errorname></term> + <listitem><para>An invalid device was specified. The specified device does not exist or has not been opened by this client via <constant>XOpenInputDevice</constant> . This error may also occur if the specified device is the X keyboard or X pointer device. </para> + </listitem> + </varlistentry> + <varlistentry> + <term><errorname>BadMatch</errorname></term> + <listitem><para>This error may occur if an <constant>XGetDeviceKeyMapping</constant> or <constant>XChangeDeviceKeyMapping</constant> request was made specifying a device that has no keys. </para> + </listitem> + </varlistentry> + <varlistentry> + <term><errorname>BadValue</errorname></term> + <listitem><para>Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of alternatives can generate this error. </para> + </listitem> + </varlistentry> + <varlistentry> + <term><errorname>BadAlloc</errorname></term> + <listitem><para>The server failed to allocate the requested resource or server memory. </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1><title>See also</title> + <para>XSetDeviceButtonMapping(3), XSetDeviceModifierMapping(3)</para> + </refsect1> +</refentry> + +<refentry id="XGetDeviceModifierMapping.man"> + <refentryinfo> + <productname>_vendorversion_</productname> + </refentryinfo> + + <refmeta> + <refentrytitle>XGetDeviceModifierMapping</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + <refnamediv> + <refname>XGetDeviceModifierMapping, XSetDeviceModifierMapping</refname> + <refpurpose>query or change device modifier mappings</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Syntax</title> + <funcsynopsis> + <funcsynopsisinfo>#include <X11/extensions/XInput.h></funcsynopsisinfo> + <funcprototype> + <funcdef><function>int XSetDeviceModifierMapping</function></funcdef> + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef> XDevice *<parameter>device</parameter></paramdef> + <paramdef> XModifierKeymap *<parameter>modmap</parameter></paramdef> + </funcprototype> + <funcprototype> + <funcdef><function>XModifierKeymap *XGetDeviceModifierMapping</function></funcdef> + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef> XDevice *<parameter>device</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1><title>Arguments</title> + + <para> + <variablelist> + <varlistentry><term><parameter>display</parameter></term> + <listitem><para>Specifies the connection to the X server.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>device</parameter></term> + <listitem><para>Specifies the device whose modifier mapping is to be queried or modified.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>modmap</parameter></term> + <listitem><para>Specifies a pointer to the <constant>XModifierKeymap</constant> structure.</para></listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1><title>Description</title> + <para>The <constant>XSetDeviceModifierMapping</constant> request specifies the KeyCodes of the keys (if any) that are to be used as modifiers for the specified device. If it succeeds, the X server generates a <constant>DeviceMappingNotify</constant> event, and <constant>XSetDeviceModifierMapping</constant> returns <constant>MappingSuccess</constant> . X permits at most eight modifier keys. If more than eight are specified in the <constant>XModifierKeymap</constant> structure, a <constant>BadLength</constant> error results. </para> + <para> + The modifiermap member of the <constant>XModifierKeymap</constant> structure contains eight sets of max_keypermod KeyCodes, one for each modifier in the order <constant>Shift</constant>, <constant>Lock</constant>, <constant>Control</constant>, <constant>Mod1</constant>, <constant>Mod2</constant>, <constant>Mod3</constant>, <constant>Mod4</constant>, and <constant>Mod5</constant> . Only nonzero KeyCodes have meaning in each set, and zero KeyCodes are ignored. In addition, all of the nonzero KeyCodes must be in the range specified by min_keycode and max_keycode as returned by <constant>XListInputDevices</constant>, or a <constant>BadValue</constant> error results. No KeyCode may appear twice in the entire map, or a <constant>BadValue</constant> error results. </para> + <para> + An X server can impose restrictions on how modifiers can be changed, for example, if certain keys do not generate up transitions in hardware, if auto-repeat cannot be disabled on certain keys, or if multiple modifier keys are not supported. If some such restriction is violated, the status reply is <constant>MappingFailed</constant>, and none of the modifiers are changed. If the new KeyCodes specified for a modifier differ from those currently defined and any (current or new) keys for that modifier are in the logically down state, <constant>XSetDeviceModifierMapping</constant> returns <constant>MappingBusy</constant>, and none of the modifiers is changed. </para> + <para> + <constant>XSetDeviceModifierMapping</constant> can generate + <constant>BadLength</constant>, <constant>BadDevice</constant>, <constant>BadMatch</constant>, <constant>BadAlloc</constant>, and <constant>BadValue</constant> errors. </para> + <para> + The <constant>XGetDeviceModifierMapping</constant> request returns a pointer to a newly created <constant>XModifierKeymap</constant> structure that contains the keys being used as modifiers. The structure should be freed after use by calling <constant>XFreeModifierMapping </constant> . If only zero values appear in the set for any modifier, that modifier is disabled. </para> + <para> + <constant>XGetDeviceModifierMapping</constant> can generate <constant>BadDevice</constant> and <constant>BadMatch</constant> errors. + </para> + </refsect1> + <refsect1><title>Structures</title> + <para> + The <constant>XModifierKeymap</constant> structure contains: + </para> + <para> + <synopsis> + typedef struct { + int <structfield>max_keypermod</structfield>; + KeyCode *<structfield>modifiermap</structfield>; + } <structname>XModifierKeymap</structname>; + </synopsis> + </para> + </refsect1> + + <refsect1><title>Diagnostics</title><para> + <variablelist> + <varlistentry> + <term><errorname>BadLength</errorname></term> + <listitem><para>More than eight keys were specified in the <constant>XModifierKeymap</constant> structure. </para> + </listitem> + </varlistentry> + <varlistentry> + <term><errorname>BadAlloc</errorname></term> + <listitem><para>The server failed to allocate the requested resource or server memory. </para> + </listitem> + </varlistentry> + <varlistentry> + <term><errorname>BadDevice</errorname></term> + <listitem><para>An invalid device was specified. The specified device does not exist or has not been opened by this client via <constant>XOpenInputDevice</constant> . This error may also occur if the specified device is the X keyboard or X pointer device. </para> + </listitem> + </varlistentry> + <varlistentry> + <term><errorname>BadMatch</errorname></term> + <listitem><para>This error may occur if an <constant>XGetDeviceModifierMapping</constant> or <constant>XChangeDeviceModifierMapping</constant> request was made specifying a device that has no keys. </para> + </listitem> + </varlistentry> + <varlistentry> + <term><errorname>BadValue</errorname></term> + <listitem><para>Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of alternatives can generate this error. </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1><title>See also</title> + <para>XSetDeviceKeyMapping(3), XSetDeviceButtonMapping(3)</para> + </refsect1> +</refentry> + +<refentry id="XGetDeviceMotionEvents.man"> + <refentryinfo> + <productname>_vendorversion_</productname> + </refentryinfo> + + <refmeta> + <refentrytitle>XGetDeviceMotionEvents</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + <refnamediv> + <refname>XGetDeviceMotionEvents, XDeviceTimeCoord</refname> + <refpurpose>get device motion history</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Syntax</title> + <funcsynopsis> + <funcsynopsisinfo>#include <X11/extensions/XInput.h></funcsynopsisinfo> + <funcprototype> + <funcdef><function>XDeviceTimeCoord *XGetDeviceMotionEvents</function></funcdef> + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef> XDevice *<parameter>device</parameter></paramdef> + <paramdef> Time <parameter>start</parameter></paramdef> + <paramdef> Time <parameter>stop</parameter></paramdef> + <paramdef> int *<parameter>nevents_return</parameter></paramdef> + <paramdef> int *<parameter>mode_return</parameter></paramdef> + <paramdef> int *<parameter>axis_count_return</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1><title>Arguments</title> + + <para> + <variablelist> + <varlistentry><term><parameter>display</parameter></term> + <listitem><para>Specifies the connection to the X server.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>device</parameter></term> + <listitem><para>Specifies the device whose motion history is to be queried.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>start</parameter></term> + <term><parameter>stop</parameter></term> + <listitem><para>Specify the time interval in which the events are returned from the motionhistory buffer.You can pass a timestamp or <constant>CurrentTime</constant>.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>nevents_return</parameter></term> + <listitem><para>Returns the number of events from the motion history buffer.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>mode_return</parameter></term> + <listitem><para>Returns the mode of the device (<constant>Absolute</constant> or <constant>Relative</constant>).</para></listitem> + </varlistentry> + <varlistentry><term><parameter>axis_count_return</parameter></term> + <listitem><para>Returns the count of axes being reported.</para></listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1><title>Description</title> + <para>The server may retain the recent history of the device motion and do so to a finer granularity than is reported by <constant>DeviceMotionNotify</constant> events. The <constant>XGetDeviceMotionEvents</constant> request makes this history available. </para> + <para> + The <constant>XGetDeviceMotionEvents</constant> request returns all events in the motion history buffer that fall between the specified start and stop times, inclusive. If the start time is later than the stop time or if the start time is in the future, no events are returned. If the stop time is in the future, it is equivalent to specifying <constant>CurrentTime</constant> . </para> + <para> + The <constant>mode</constant> indicates whether the device is reporting absolute positional data (mode= <constant>Absolute</constant> ) or relative motion data (mode= <constant>Relative</constant> ). Some devices allow their mode to be changed via the <constant>XSetDeviceMode</constant> request. These constants are defined in the file XI.h. The <constant>axis_count</constant> returns the number of axes or valuators being reported by the device. </para> + <para> + <constant>XGetDeviceMotionEvents</constant> can generate a <constant>BadDevice</constant>, or <constant>BadMatch</constant> error. + </para> +</refsect1> + <refsect1><title>Structures</title> + <para> + The <constant>XDeviceTimeCoord</constant> structure contains: </para> + <para> + <synopsis> + typedef struct { + Time <structfield>time</structfield>; + int *<structfield>data</structfield>; + } <structname>XDeviceTimeCoord</structname>; + </synopsis> + </para> + <para> + The time member is set to the time, in milliseconds. The data member is a pointer to an array of integers. These integers are set to the values of each valuator or axis reported by the device. There is one element in the array per axis of motion reported by the device. The value of the array elements depends on the mode of the device. If the mode is <constant>Absolute</constant>, the values are the raw values generated by the device. These may be scaled by client programs using the maximum values that the device can generate. The maximum value for each axis of the device is reported in the max_val field of the <constant>XAxisInfo</constant> returned by the <constant>XListInputDevices</constant> request. If the mode is <constant>Relative</constant>, the data values are the relative values generated by the device. </para> + <para> + You should use <constant>XFreeDeviceMotionEvents</constant> to free the data returned by this request. </para> + <para> + Errors returned by this request: <constant>BadDevice</constant>, <constant>BadMatch</constant> . </para> + </refsect1> + + <refsect1><title>Diagnostics</title> + <para> + <variablelist> + <varlistentry> + <term><errorname>BadDevice</errorname></term> + <listitem><para>An invalid device was specified. The specified device does not exist or has not been opened by this client via <constant>XOpenInputDevice</constant> . This error may also occur if the specified device is the X keyboard or X pointer device. </para> + </listitem> + </varlistentry> + <varlistentry> + <term><errorname>BadMatch</errorname></term> + <listitem><para>This error may occur if an <constant>XGetDeviceMotionEvents</constant> request is made specifying a device that has no valuators and reports no axes of motion. </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> +</refentry> + +<refentry id="XGetExtensionVersion.man"> + <refentryinfo> + <productname>_vendorversion_</productname> + </refentryinfo> + + <refmeta> + <refentrytitle>XGetExtensionVersion</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + <refnamediv> + <refname>XQueryInputVersion, XGetExtensionVersion</refname> + <refpurpose>query the version of the input extension.</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Syntax</title> + <funcsynopsis> + <funcsynopsisinfo>#include <X11/extensions/XInput.h></funcsynopsisinfo> + <funcprototype> + <funcdef><function>XExtensionVersion *XQueryInputVersion</function></funcdef> + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef> int <parameter>major</parameter></paramdef> + <paramdef> int <parameter>minor</parameter></paramdef> + </funcprototype> + <funcprototype> + <funcdef><function>XExtensionVersion *XGetExtensionVersion</function></funcdef> + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef>char *<parameter>name</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1><title>Arguments</title> + + <para> + <variablelist> + <varlistentry><term><parameter>display</parameter></term> + <listitem><para>Specifies the connection to the X server.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>name</parameter></term> + <listitem><para>Specifies the extension to be queried. The input extension name is definedin the header file <constant>XI.h</constant>.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>major</parameter></term> + <listitem><para>Specifies the major version as supported by the client.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>minor</parameter></term> + <listitem><para>Specifies the minor version as supported by the client.</para></listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1><title>Description</title> + <para>The <constant>XQueryInputVersion</constant> request queries the version of the input extension and returns an <constant>XExtensionVersion</constant> structure. This structure contains a major_version and minor_version number which can be compared with constants defined in <constant>XI.h</constant> . The client must specify the highest version numbers it can supports. </para> + <para> + The <constant>XGetExtensionVersion</constant> request is deprecated and should not be used. Clients issuing a <constant>XgetExtensionVersion</constant> request will not be able to use MPX features. The <constant>XGetExtensionVersion</constant> request queries the version of the input extension, and returns an <constant>XExtensionVersion</constant> structure. This structure contains a major_version and minor_version number which can be compared with constants defined in <constant>XI.h</constant> . Support for additional protocol requests added to the input extension after its initial release is indicated by a version number corresponding to the added requests. Each version contains all the protocol requests contained by previous versions. </para> + <para> + You should use <constant>XFree</constant> to free the <constant>XExtensionVersion</constant> structure. + </para> + </refsect1> + <refsect1><title>Structures</title> + <para> + This request returns an XExtensionVersion structure. + </para> + <para> + <synopsis> + typedef struct { + int <structfield>present</structfield>; + short <structfield>major_version</structfield>; + short <structfield>minor_version; </structfield> + } <structname>XExtensionVersion</structname>; + </synopsis> + </para> + + </refsect1> +</refentry> + +<refentry id="XGetFeedbackControl.man"> + <refentryinfo> + <productname>_vendorversion_</productname> + </refentryinfo> + + <refmeta> + <refentrytitle>XGetFeedbackControl</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + <refnamediv> + <refname>XGetFeedbackControl, XChangeFeedbackControl</refname> + <refpurpose>query and change input device feedbacks</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Syntax</title> + <funcsynopsis> + <funcsynopsisinfo>#include <X11/extensions/XInput.h></funcsynopsisinfo> + <funcprototype> + <funcdef><function>XFeedbackState *XGetFeedbackControl</function></funcdef> + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef> XDevice *<parameter>device</parameter></paramdef> + <paramdef> int *<parameter>num_feedbacks</parameter></paramdef> + </funcprototype> + <funcprototype> + <funcdef><function>int XChangeFeedbackControl</function></funcdef> + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef> XDevice* <parameter>device</parameter></paramdef> + <paramdef> Mask <parameter>mask</parameter></paramdef> + <paramdef> XFeedbackControl *<parameter>control</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1><title>Arguments</title> + + <para> + <variablelist> + <varlistentry><term><parameter>display</parameter></term> + <listitem><para>Specifies the connection to the X server.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>device</parameter></term> + <listitem><para>Specifies the device whose feedbacks are to be queried or modified.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>num_feedbacks</parameter></term> + <listitem><para>Specifies an address into which the number of feedbacks supported by thedevice is to be returned.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>mask</parameter></term> + <listitem><para>Specifies a mask specific to each type of feedback that describes howthe feedback is to be modified.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>control</parameter></term> + <listitem><para>Specifies the address of an <constant>XFeedbackControl</constant> structure that containsthe new values for the feedback.</para></listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1><title>Description</title> + <para>These requests are provided to manipulate those input devices that support feedbacks. A <constant>BadMatch</constant> error will be generated if the requested device does not support feedbacks. Whether or not a given device supports feedbacks can be determined by examining the information returned by the <constant>XOpenDevice</constant> request. For those devices that support feedbacks, <constant>XOpenDevice</constant> will return an <constant>XInputClassInfo</constant> structure with the input_class field equal to the constant <constant>FeedbackClass</constant> (defined in the file <constant>XI.h</constant> ). </para> + <para> + The <constant>XGetFeedbackControl</constant> request returns a pointer to a list of <constant>XFeedbackState</constant> structures. Each item in this list describes one of the feedbacks supported by the device. The items are variable length, so each contains its length to allow traversal to the next item in the list. </para> + <para> + The feedback classes that are currently defined are: <constant>KbdFeedbackClass</constant> , <constant>PtrFeedbackClass</constant> , <constant>StringFeedbackClass</constant> , <constant>IntegerFeedbackClass</constant> , <constant>LedFeedbackClass</constant> , and <constant>BellFeedbackClass</constant> . These constants are defined in the file <constant>XI.h</constant> . An input device may support zero or more classes of feedback, and may support multiple feedbacks of the same class. Each feedback contains a class identifier and an id that is unique within that class for that input device. The id is used to identify the feedback when making an <constant>XChangeFeedbackControl</constant> request. </para> + <para> + <constant>XGetFeedbackControl</constant> can generate a <constant>BadDevice</constant> or <constant>BadMatch</constant> error. </para> + <para> + The <constant>XChangeFeedbackControl</constant> request modifies the values of one feedback on the specified device. The feedback is identified by the id field of the <constant>XFeedbackControl</constant> structure that is passed with the request. The fields of the feedback that are to be modified are identified by the bits of the mask that is passed with the request. </para> + <para> + <constant>XChangeFeedbackControl</constant> can generate a <constant>BadDevice</constant> , <constant>BadMatch</constant> , or <constant>BadValue</constant> error. + + </para> + </refsect1> + <refsect1><title>Structures</title> + <para> + + Each class of feedback is described by a structure specific to that class. These structures are defined in the file <constant>XInput.h</constant> . <constant>XFeedbackState</constant> and <constant>XFeedbackControl</constant> are generic structures that contain three fields that are at the beginning of each class of feedback: </para> + <para> + <synopsis> + typedef struct { + XID <structfield>class</structfield>; + int <structfield>length</structfield>; + XID <structfield>id</structfield>; + } <structname>XFeedbackState</structname>, + <structname>XFeedbackControl;</structname> + </synopsis> + </para> + <para> + The <constant>XKbdFeedbackState</constant> structure defines the attributes that are returned for feedbacks equivalent to those on the X keyboard. </para> + <para> + <synopsis> + typedef struct { + XID <structfield>class</structfield>; + int <structfield>length</structfield>; + XID <structfield>id</structfield>; + int <structfield>click</structfield>; + int <structfield>percent</structfield>; + int <structfield>pitch</structfield>; + int <structfield>duration</structfield>; + int <structfield>led_mask</structfield>; + int <structfield>global_auto_repeat</structfield>; + char <structfield>auto_repeats[32]</structfield>; + } <structname>XKbdFeedbackState</structname>; + </synopsis> + </para> + <para> + The <constant>XPtrFeedbackState</constant> structure defines the attributes that are returned for feedbacks equivalent to those on the the X pointer. </para> + <para> + <synopsis> + typedef struct { + XID <structfield>class</structfield>; + int <structfield>length</structfield>; + XID <structfield>id</structfield>; + int <structfield>accelNum</structfield>; + int <structfield>accelDenom</structfield>; + int <structfield>threshold</structfield>; + } <structname>XPtrFeedbackState</structname>; + </synopsis> + </para> + <para> + The <constant>XIntegerFeedbackState</constant> structure defines attributes that are returned for integer feedbacks. </para> + <para> + <synopsis> + typedef struct { + XID <structfield>class</structfield>; + int <structfield>length</structfield>; + XID <structfield>id</structfield>; + int <structfield>resolution</structfield>; + int <structfield>minVal</structfield>; + int <structfield>maxVal</structfield>; + } <structname>XIntegerFeedbackState</structname>; + </synopsis> + </para> + <para> + The <constant>XStringFeedbackState</constant> structure defines the attributes that are returned for string feedbacks. </para> + <para> + <synopsis> + typedef struct { + XID <structfield>class</structfield>; + int <structfield>length</structfield>; + XID <structfield>id</structfield>; + int <structfield>max_symbols</structfield>; + int <structfield>num_syms_supported</structfield>; + KeySym *<structfield>syms_supported</structfield>; + } <structname>XStringFeedbackState</structname>; + </synopsis> + </para> + <para> + The <constant>XBellFeedbackState</constant> structure defines the attributes that are returned for bell feedbacks. </para> + <para> + <synopsis> + typedef struct { + XID <structfield>class</structfield>; + int <structfield>length</structfield>; + XID <structfield>id</structfield>; + int <structfield>percent</structfield>; + int <structfield>pitch</structfield>; + int <structfield>duration</structfield>; + } <structname>XBellFeedbackState</structname>; + </synopsis> + </para> + <para> + The <constant>XLedFeedbackState</constant> structure defines the attributes that are returned for LED feedbacks. </para> + <para> + <synopsis> + typedef struct { XID <structfield>class</structfield>; + int <structfield>length</structfield>; + XID <structfield>id</structfield>; + int <structfield>led_values</structfield>; + } <structname>XLedFeedbackState</structname>; + </synopsis> + </para> + <para> + The <constant>XPrtFeedbackControl</constant> structure defines the attributes that can be controlled for pointer feedbacks. </para> + <para> + <synopsis> + typedef struct { + XID <structfield>class</structfield>; + int <structfield>length</structfield>; + XID <structfield>id</structfield>; + int <structfield>accelNum</structfield>; + int <structfield>accelDenom</structfield>; + int <structfield>threshold</structfield>; + } <structname>XPtrFeedbackControl</structname>; + </synopsis> + </para> + <para> + The <constant>XKbdFeedbackControl</constant> structure defines the attributes that can be controlled for keyboard feedbacks. </para> + <para> + <synopsis> + typedef struct { + XID <structfield>class</structfield>; + int <structfield>length</structfield>; + XID <structfield>id</structfield>; + int <structfield>click</structfield>; + int <structfield>percent</structfield>; + int <structfield>pitch</structfield>; + int <structfield>duration</structfield>; + int <structfield>led_mask</structfield>; + int <structfield>led_value</structfield>; + int <structfield>key</structfield>; + int <structfield>auto_repeat_mode</structfield>; + } <structname>XKbdFeedbackControl</structname>; + </synopsis> + </para> + <para> + The <constant>XStringFeedbackControl</constant> structure defines the attributes that can be controlled for string feedbacks. </para> + <para> + <synopsis> + typedef struct { + XID <structfield>class</structfield>; + int <structfield>length</structfield>; + XID <structfield>id</structfield>; + int <structfield>num_keysyms</structfield>; + KeySym *<structfield>syms_to_display</structfield>; + } <structname>XStringFeedbackControl</structname>; + </synopsis> + </para> + <para> + The <constant>XIntegerFeedbackControl</constant> structure defines the attributes that can be controlled for integer feedbacks. </para> + <para> + <synopsis> + typedef struct { + XID <structfield>class</structfield>; + int <structfield>length</structfield>; + XID <structfield>id</structfield>; + int <structfield>int_to_display</structfield>; + } <structname>XIntegerFeedbackControl</structname>; + </synopsis> + </para> + <para> + The <constant>XBellFeedbackControl</constant> structure defines the attributes that can be controlled for bell feedbacks. </para> + <para> + <synopsis> + typedef struct { + XID <structfield>class</structfield>; + int <structfield>length</structfield>; + XID <structfield>id</structfield>; + int <structfield>percent</structfield>; + int <structfield>pitch</structfield>; + int <structfield>duration</structfield>; + } <structname>XBellFeedbackControl</structname>; + </synopsis> + </para> + <para> + The <constant>XLedFeedbackControl</constant> structure defines the attributes that can be controlled for LED feedbacks. </para> + <para> + <synopsis> + typedef struct { + XID <structfield>class</structfield>; + int <structfield>length</structfield>; + XID <structfield>id</structfield>; + int <structfield>led_mask</structfield>; + int <structfield>led_values</structfield>; + } <structname>XLedFeedbackControl</structname>; + </synopsis> + </para> + </refsect1> + + <refsect1><title>Diagnostics</title><para> + <variablelist> + <varlistentry> + <term><errorname>BadDevice</errorname></term> + <listitem><para>An invalid device was specified. The specified device does not exist or has not been opened by this client via <constant>XOpenInputDevice</constant> . This error may also occur if some other client has caused the specified device to become the X keyboard or X pointer device via the <constant>XChangeKeyboardDevice</constant> or <constant>XChangePointerDevice</constant> requests. </para> + </listitem> + </varlistentry> + <varlistentry> + <term><errorname>BadMatch</errorname></term> + <listitem><para>This error may occur if an <constant>XGetFeedbackControl</constant> request was made specifying a device that has no feedbacks, or an <constant>XChangeFeedbackControl</constant> request was made with an <constant>XFeedbackControl</constant> structure that contains an invalid feedback type. It may also occur if an invalid combination of mask bits is specified ( <constant>DvKey</constant> but no <constant>DvAutoRepeatMode</constant> for keyboard feedbacks), or if an invalid KeySym is specified for a string feedback. </para> + </listitem> + </varlistentry> + <varlistentry> + <term><errorname>BadValue</errorname></term> + <listitem><para>Some numeric value falls outside the range of values accepted by the <constant>XChangeFeedbackControl</constant> request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of alternatives can generate this error. </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> +</refentry> + + +<refentry id="XGrabDeviceButton.man"> + <refentryinfo> + <productname>_vendorversion_</productname> + </refentryinfo> + + <refmeta> + <refentrytitle>XGrabDeviceButton</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + <refnamediv> + <refname>XGrabDeviceButton, XUngrabDeviceButton</refname> + <refpurpose>grab/ungrab extension input device buttons</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Syntax</title> + <funcsynopsis> + <funcsynopsisinfo>#include <X11/extensions/XInput.h></funcsynopsisinfo> + <funcprototype> + <funcdef><function>int XGrabDeviceButton</function></funcdef> + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef> XDevice *<parameter>device</parameter></paramdef> + <paramdef>unsigned int <parameter>button</parameter></paramdef> + <paramdef> unsigned int <parameter>modifiers</parameter></paramdef> + <paramdef> XDevice*<parameter>modifier_device</parameter></paramdef> + <paramdef> Window <parameter>grab_window</parameter></paramdef> + <paramdef> Bool<parameter>owner_events</parameter></paramdef> + <paramdef> unsigned int <parameter>event_count</parameter></paramdef> + <paramdef> XEventClass*<parameter>event_list</parameter></paramdef> + <paramdef> int <parameter>this_device_mode</parameter></paramdef> + <paramdef> int<parameter>other_devices_mode</parameter></paramdef> + </funcprototype> + <funcprototype> + <funcdef><function>int XUngrabDeviceButton</function></funcdef> + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef> XDevice *<parameter>device</parameter></paramdef> + <paramdef>unsigned int <parameter>button</parameter></paramdef> + <paramdef> unsigned int <parameter>modifiers</parameter></paramdef> + <paramdef> XDevice*<parameter>modifier_device</parameter></paramdef> + <paramdef> Window <parameter>grab_window</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1><title>Arguments</title> + + <para> + <variablelist> + <varlistentry><term><parameter>display</parameter></term> + <listitem><para>Specifies the connection to the X server.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>device</parameter></term> + <listitem><para>Specifies the device that is to be + grabbed or released</para></listitem> + </varlistentry> + <varlistentry><term><parameter>button</parameter></term> + <listitem><para>Specifies the device button that is to + be grabbed or released or <constant>AnyButton</constant>.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>modifiers</parameter></term> + <listitem><para>Specifies the set of keymasks or + <constant>AnyModifier</constant>.The mask is + the bitwise inclusive OR of the valid keymask + bits. Valid bits are: + <constant>Shiftmask</constant>, + <constant>LockMask</constant>, + <constant>ControlMask</constant>, + <constant>Mod1Mask</constant>, + <constant>Mod2Mask,Mod3Mask</constant>, + <constant>Mod4Mask</constant>, + <constant>Mod5Mask</constant>.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>modifier_device</parameter></term> + <listitem><para>specifies the device whose modifiers are to be used. If the modifier_devicespecified is NULL, the X keyboard will be used as the modifier_device.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>grab_window</parameter></term> + <listitem><para>Specifies the grab window.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>owner_events</parameter></term> + <listitem><para>Specifies a Boolean value that indicates whether the deviceevents are to be reported as usual or reported with respect to the grab windowif selected by the event list.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>event_count</parameter></term> + <listitem><para>Specifies the number of event classes in the event list.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>event_list</parameter></term> + <listitem><para>Specifies which events are reported to the client.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>this_device_mode</parameter></term> + <listitem><para>Specifies further processing of events from this device.You can pass <constant>GrabModeSync</constant> or <constant>GrabModeAsync</constant>.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>other_devices_mode</parameter></term> + <listitem><para>Specifies further processing of events from all other devices.You can pass <constant>GrabModeSync</constant> or <constant>GrabModeAsync</constant>.</para></listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1><title>Description</title> + <para>The <constant>XGrabDeviceButton</constant> request establishes a passive grab. In the future, the device is actively grabbed (as for <constant>XGrabDevice</constant> , the last-grab time is set to the time at which the button was pressed (as transmitted in the <constant>DeviceButtonPress</constant> event), and the <constant>DeviceButtonPress</constant> event is reported if all of the following conditions are true: + + <itemizedlist> + <listitem> + <para> + The device is not grabbed, and the specified button is + logically pressed when the specified modifier keys are + logically down on the specified modifier device and no + other buttons or modifier keys are logically down. </para> + </listitem> + <listitem> + <para>Either the grab window is an ancestor of (or is) the + focus window, OR the grab window is a descendent of the + focus window and contains the device. </para> + </listitem> + <listitem> + <para> + A passive grab on the same button/modifier combination + does not exist on any ancestor of grab_window. + </para> + </listitem> + </itemizedlist> + </para> + <para> + The interpretation of the remaining arguments is as for <constant>XGrabDevice</constant> . The active grab is terminated automatically when the logical state of the device has all buttons released (independent of the logical state of the modifier keys). </para> + <para> + Note that the logical state of a device (as seen by client applications) may lag the physical state if device event processing is frozen. </para> + <para> + This request overrides all previous grabs by the same client on the same button/modifier combinations on the same window. A modifiers of <constant>AnyModifier</constant> is equivalent to issuing the grab request for all possible modifier combinations (including the combination of no modifiers). It is not required that all modifiers specified have currently assigned KeyCodes. A button of <constant>AnyButton</constant> is equivalent to issuing the request for all possible buttons. Otherwise, it is not required that the specified button currently be assigned to a physical button. </para> + <para> + A modifier_device of NULL indicates that the X keyboard is to be used as the modifier_device. </para> + <para> + If some other client has already issued a <constant>XGrabDeviceButton</constant> with the same button/modifier combination on the same window, a <constant>BadAccess</constant> error results. When using <constant>AnyModifier</constant> or <constant>AnyButton</constant> , the request fails completely, and a <constant>BadAccess</constant> error results (no grabs are established) if there is a conflicting grab for any combination. <constant>XGrabDeviceButton</constant> has no effect on an active grab. </para> + <para> + <constant>XGrabDeviceButton</constant> can generate <constant>BadClass</constant> , <constant>BadDevice</constant> , <constant>BadMatch</constant> , <constant>BadValue</constant> , and <constant>BadWindow</constant> errors. .P The <constant>XUngrabDeviceButton</constant> request releases the passive grab for a button/modifier combination on the specified window if it was grabbed by this client. A modifier of <constant>AnyModifier</constant> is equivalent to issuing the ungrab request for all possible modifier combinations, including the combination of no modifiers. A button of <constant>AnyButton</constant> is equivalent to issuing the request for all possible buttons. <constant>XUngrabDeviceButton</constant> has no effect on an active grab. </para> + <para> + A modifier_device of NULL indicates that the X keyboard should be used as the modifier_device. </para> + <para> + <constant>XUngrabDeviceButton</constant> can generate <constant>BadDevice</constant> , <constant>BadMatch</constant> , <constant>BadValue</constant> and <constant>BadWindow</constant> errors. </para> + </refsect1> + + <refsect1><title>Diagnostics</title><para> + <variablelist> + <varlistentry> + <term><errorname>BadDevice</errorname></term> + <listitem><para>An invalid device was specified. The specified device does not exist or has not been opened by this client via <constant>XOpenInputDevice</constant> . This error may also occur if the specified device is the X keyboard or X pointer device. </para> + </listitem> + </varlistentry> + <varlistentry> + <term><errorname>BadMatch</errorname></term> + <listitem><para>This error may occur if an <constant>XGrabDeviceButton</constant> request was made specifying a device that has no buttons, or specifying a modifier device that has no keys. </para> + </listitem> + </varlistentry> + <varlistentry> + <term><errorname>BadValue</errorname></term> + <listitem><para>Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of alternatives can generate this error. </para> + </listitem> + </varlistentry> + <varlistentry> + <term><errorname>BadWindow</errorname></term> + <listitem><para>A value for a Window argument does not name a defined Window. </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1><title>See also</title> + <para>XAllowDeviceEvents(3), XGrabDevice(3), XGrabDeviceKey(3)</para> + </refsect1> +</refentry> + +<refentry id="XGrabDeviceKey.man"> + <refentryinfo> + <productname>_vendorversion_</productname> + </refentryinfo> + + <refmeta> + <refentrytitle>XGrabDeviceKey</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + <refnamediv> + <refname>XGrabDeviceKey, XUngrabDeviceKey</refname> + <refpurpose>grab/ungrab extension input device Keys</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Syntax</title> + <funcsynopsis> + <funcsynopsisinfo>#include <X11/extensions/XInput.h></funcsynopsisinfo> + <funcprototype> + <funcdef><function>int XGrabDeviceKey</function></funcdef> + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef>XDevice *<parameter>device</parameter></paramdef> + <paramdef>unsigned int <parameter>Key</parameter></paramdef> + <paramdef>unsigned int <parameter>modifiers</parameter></paramdef> + <paramdef>XDevice *<parameter>modifier_device</parameter></paramdef> + <paramdef>Window <parameter>grab_window</parameter></paramdef> + <paramdef>Bool <parameter>owner_events</parameter></paramdef> + <paramdef>unsigned int <parameter>event_count</parameter></paramdef> + <paramdef>XEventClass <parameter>event_list</parameter></paramdef> + <paramdef>int <parameter>this_device_mode</parameter></paramdef> + <paramdef>int <parameter>other_devices_mode</parameter></paramdef> + </funcprototype> + <funcprototype> + <funcdef><function>int XUngrabDeviceKey</function></funcdef> + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef>XDevice *<parameter>device</parameter></paramdef> + <paramdef>unsigned int <parameter>Key</parameter></paramdef> + <paramdef>unsigned int <parameter>modifiers</parameter></paramdef> + <paramdef>XDevice *<parameter>modifier_device</parameter></paramdef> + <paramdef>Window <parameter>grab_window</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1><title>Arguments</title> + + <para> + <variablelist> + <varlistentry><term><parameter>display</parameter></term> + <listitem><para>Specifies the connection to the X server.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>device</parameter></term> + <listitem><para>Specifies the device that is to be + grabbed or released.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>Key</parameter></term> + <listitem><para>Specifies the device Key that is to be + grabbed released or <constant>AnyKey</constant>.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>modifiers</parameter></term> + <listitem><para>Specifies the set of keymasks or <constant>AnyModifier</constant>.The mask is the bitwise inclusive OR of the valid keymask bits.Valid bits are: ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,Mod3Mask, Mod4Mask, Mod5Mask.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>modifier_device</parameter></term> + <listitem><para>Specifies the device whose modifiers are to be used. If a modifier_device ofNULL is specified, the X keyboard will be used as the modifier_device.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>grab_window</parameter></term> + <listitem><para>Specifies the grab window.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>owner_events</parameter></term> + <listitem><para>Specifies a Boolean value that indicates whether the deviceevents are to be reported as usual or reported with respect to the grab windowif selected by the event list.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>event_count</parameter></term> + <listitem><para>Specifies the number of event classes in the event list.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>event_list</parameter></term> + <listitem><para>Specifies which device events are reported to the client.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>this_device_mode</parameter></term> + <listitem><para>Specifies further processing of events from this device.You can pass <constant>GrabModeSync</constant> or <constant>GrabModeAsync</constant>.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>other_devices_mode</parameter></term> + <listitem><para>Specifies further processing of events from other devices.You can pass <constant>GrabModeSync</constant>or <constant>GrabModeAsync</constant>.</para></listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1><title>Description</title> + <para>The <constant>XGrabDeviceKey</constant> request establishes a passive grab. In the future, the device is actively grabbed (as for <constant>XGrabDevice</constant>, the last-device-grab time is set to the time at which the Key was pressed (as transmitted in the <constant>DeviceKeyPress</constant> event), and the <constant>DeviceKeyPress</constant> event is reported if all of the following conditions are true: + + <itemizedlist> + <listitem> + <para>The device is not grabbed, and the specified key is logically pressed when the specified modifier keys are logically down, and no other keys or modifier keys are logically down. </para> + </listitem> + <listitem> + <para>The grab_window is an ancestor (or is) the focus window OR the grab window is a descendant of the focus window and contains the device.</para> + </listitem> + <listitem> + <para>The confine_to window (if any) is + viewable.</para> + </listitem> + <listitem> + <para>A passive grab on the same key/modifier combination does not exist on any ancestor of grab_window. </para> + </listitem> + </itemizedlist> + </para> + <para> + The interpretation of the remaining arguments is as for <constant>XGrabDevice</constant> . The active grab is terminated automatically when the logical state of the device has the specified key released. </para> + <para> + Note that the logical state of a device (as seen by means of the X protocol ) may lag the physical state if device event processing is frozen. </para> + <para> + If the key is not <constant>AnyKey</constant>, it must be in the range specified by min_keycode and max_keycode as returned by the <constant>XListInputDevices</constant> request. Otherwise, a <constant>BadValue</constant> error results. </para> + <para> + This request overrides all previous grabs by the same client on the same Key/modifier combinations on the same window. A modifier of <constant>AnyModifier</constant> is equivalent to issuing the grab request for all possible modifier combinations (including the combination of no modifiers). It is not required that all modifiers specified have currently assigned KeyCodes. A key of <constant>AnyKey</constant> is equivalent to issuing the request for all possible keys. Otherwise, it is not required that the specified key currently be assigned to a physical Key. </para> + <para> + If a modifier_device of NULL is specified, the X keyboard will be used as the modifier_device. </para> + <para> + If some other client has already issued a <constant>XGrabDeviceKey</constant> with the same Key/modifier combination on the same window, a <constant>BadAccess</constant> error results. When using <constant>AnyModifier</constant> or <constant>AnyKey</constant> , the request fails completely, and a <constant>BadAccess</constant> error results (no grabs are established) if there is a conflicting grab for any combination. <constant>XGrabDeviceKey</constant> has no effect on an active grab. </para> + <para> + <constant>XGrabDeviceKey</constant> can generate <constant>BadAccess</constant>, <constant>BadClass</constant>, <constant>BadDevice</constant>, <constant>BadMatch</constant>, <constant>BadValue</constant>, and <constant>BadWindow</constant> errors. It returns <constant>Success</constant> on successful completion of the request. + </para> + <para> + The <constant>XUngrabDeviceKey</constant> request releases the passive grab for a key/modifier combination on the specified window if it was grabbed by this client. A modifier of <constant>AnyModifier</constant> is equivalent to issuing the ungrab request for all possible modifier combinations, including the combination of no modifiers. A Key of <constant>AnyKey</constant> is equivalent to issuing the request for all possible Keys. <constant>XUngrabDeviceKey</constant> has no effect on an active grab. </para> + <para> + If a modifier_device of NULL is specified, the X keyboard will be used as the modifier_device. </para> + <para> + <constant>XUngrabDeviceKey</constant> can generate <constant>BadDevice</constant>, <constant>BadMatch</constant>, <constant>BadValue</constant> and <constant>BadWindow</constant> errors. </para> + </refsect1> + + <refsect1><title>Diagnostics</title><para> + <variablelist> + <varlistentry> + <term><errorname>BadDevice</errorname></term> + <listitem><para>An invalid device was specified. The specified device does not exist or has not been opened by this client via <constant>XOpenInputDevice</constant> . This error may also occur if the specified device is the X keyboard or X pointer device. </para> + </listitem> + </varlistentry> + <varlistentry> + <term><errorname>BadMatch</errorname></term> + <listitem><para>This error may occur if an <constant>XGrabDeviceKey</constant> request was made specifying a device that has no keys, or a modifier device that has no keys. </para> + </listitem> + </varlistentry> + <varlistentry> + <term><errorname>BadValue</errorname></term> + <listitem><para>Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of alternatives can generate this error. </para> + </listitem> + </varlistentry> + <varlistentry> + <term><errorname>BadWindow</errorname></term> + <listitem><para>A value for a Window argument does not name a defined Window. </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1><title>See also</title> + <para>XAllowDeviceEvents(3), XGrabDevice(3), XGrabDeviceButton(3)</para> + </refsect1> +</refentry> + +<refentry id="XGrabDevice.man"> + <refentryinfo> + <productname>_vendorversion_</productname> + </refentryinfo> + + <refmeta> + <refentrytitle>XGrabDevice</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + <refnamediv> + <refname>XGrabDevice, XUngrabDevice</refname> + <refpurpose>grab/release the specified extension device</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Syntax</title> + <funcsynopsis> + <funcsynopsisinfo>#include <X11/extensions/XInput.h></funcsynopsisinfo> + <funcprototype> + <funcdef> <function>int XGrabDevice</function></funcdef> + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef>XDevice *<parameter>device</parameter></paramdef> + <paramdef>Window <parameter>grab_window</parameter></paramdef> + <paramdef>Bool <parameter>owner_events</parameter></paramdef> + <paramdef>int <parameter>event_count</parameter></paramdef> + <paramdef>XEventClass *<parameter>event_list</parameter></paramdef> + <paramdef>int <parameter>this_device_mode</parameter></paramdef> + <paramdef>int <parameter>other_devices_mode</parameter></paramdef> + <paramdef>Time <parameter>time</parameter></paramdef> + </funcprototype> + <funcprototype> + <funcdef><function>int XUngrabDevice</function></funcdef> + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef>XDevice *<parameter>device</parameter></paramdef> + <paramdef>Time <parameter>time</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1><title>Arguments</title> + + <para> + <variablelist> + <varlistentry><term><parameter>display</parameter></term> + <listitem><para>Specifies the connection to the X server.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>device</parameter></term> + <listitem><para>Specifies the device to be grabbed or released.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>grab_window</parameter></term> + <listitem><para>Specifies the id of a window to be associated with the device.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>owner_events</parameter></term> + <listitem><para>Specifies a Boolean value that indicates whether theevents from the deviceare to be reported as usual or reported with respect to the grab windowif selected by the event list.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>event_count</parameter></term> + <listitem><para>Specifies the number of elements in the event_list array.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>event_list</parameter></term> + <listitem><para>Specifies a pointer to a list of event classes that indicates which eventsthe client wishes to receive. These event classes must have beenobtained specifying the device being grabbed.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>this_device_mode</parameter></term> + <listitem><para>Specifies further processing of events from this device.You can pass <constant>GrabModeSync</constant>or <constant>GrabModeAsync</constant>.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>other_devices_mode</parameter></term> + <listitem><para>Specifies further processing of events from other devices.You can pass <constant>GrabModeSync</constant>or <constant>GrabModeAsync</constant>.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>time</parameter></term> + <listitem><para>Specifies the time.You can pass either a timestamp or <constant>CurrentTime</constant>.</para></listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1><title>Description</title> + <para>The <constant>XGrabDevice</constant> request actively grabs control of the device and generates <constant>DeviceFocusIn</constant> and <constant>DeviceFocusOut</constant> events. Further device events are reported only to the grabbing client. <constant>XGrabDevice</constant> overrides any active device grab by this client. event_list is a pointer to a list of event classes. This list indicates which events the client wishes to receive while the grab is active. If owner_events is <constant>False</constant>, all generated device events are reported with respect to grab_window if selected. If owner_events is <constant>True</constant> and if a generated device event would normally be reported to this client, it is reported normally; otherwise, the event is reported with respect to the grab_window, and is only reported if specified in the event_list. </para> + <para> + If the this_device_mode argument is <constant>GrabModeAsync</constant>, device event processing continues as usual. If the device is currently frozen by this client, then processing of device events is resumed. If the this_device_mode argument is <constant>GrabModeSync</constant>, the state of the device (as seen by client applications) appears to freeze, and the X server generates no further device events until the grabbing client issues a releasing <constant>XAllowDeviceEvents</constant> call or until the device grab is released. Actual device changes are not lost while the device is frozen; they are simply queued in the server for later processing. </para> + <para> + If other_devices_mode is <constant>GrabModeAsync</constant>, processing of events from other devices is unaffected by activation of the grab. If other_devices_mode is <constant>GrabModeSync</constant>, the state of all devices except the grabbed device (as seen by client applications) appears to freeze, and the X server generates no further events from those devices until the grabbing client issues a releasing <constant>XAllowDeviceEvents</constant> call or until the device grab is released. Actual events are not lost while the devices are frozen; they are simply queued in the server for later processing. </para> + <para> + If the device is actively grabbed by some other client, <constant>XGrabDevice</constant> fails and returns <constant>AlreadyGrabbed</constant>. If grab_window is not viewable, it fails and returns <constant>GrabNotViewable</constant>. If the device is frozen by an active grab of another client, it fails and returns <constant>GrabFrozen</constant>. If the specified time is earlier than the last-device-grab time or later than the current X server time, it fails and returns <constant>GrabInvalidTime</constant>. Otherwise, the last-device-grab time is set to the specified time <constant>( CurrentTime</constant> is replaced by the current X server time). </para> + <para> + If a grabbed device is closed by a client while an active grab by that client is in effect, the active grab is released. If the device is frozen only by an active grab of the requesting client, it is thawed. </para> + <para> + <constant>XGrabDevice</constant> can generate <constant>BadClass</constant>, <constant>BadDevice</constant>, <constant>BadValue</constant>, and <constant>BadWindow</constant> errors. </para> + <para> + The <constant>XUngrabDevice</constant> request releases the device and any queued events if this client has it actively grabbed from either <constant>XGrabDevice</constant> or <constant>XGrabDeviceKey</constant>. If other devices are frozen by the grab, <constant>XUngrabDevice</constant> thaws them. <constant>XUngrabDevice</constant> does not release the device and any queued events if the specified time is earlier than the last-device-grab time or is later than the current X server time. It also generates <constant>DeviceFocusIn</constant> and <constant>DeviceFocusOut</constant> events. The X server automatically performs an <constant>UngrabDevice</constant> request if the event window for an active device grab becomes not viewable. </para> + <para> + <constant>XUngrabDevice</constant> can generate a <constant>BadDevice</constant> error. </para> + </refsect1> + + <refsect1><title>Diagnostics</title><para> + <variablelist> + <varlistentry> + <term><errorname>BadDevice</errorname></term> + <listitem><para>An invalid device was specified. The specified device does not exist or has not been opened by this client via <constant>XOpenInputDevice</constant>. This error may also occur if the specified device is the X keyboard or X pointer device. </para> + </listitem> + </varlistentry> + <varlistentry> + <term><errorname>BadValue</errorname></term> + <listitem><para>Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of alternatives can generate this error. </para> + </listitem> + </varlistentry> + <varlistentry> + <term><errorname>BadWindow</errorname></term> + <listitem><para>A value for a Window argument does not name a defined Window. </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1><title>See also</title> + <para>XAllowDeviceEvents(3),XGrabDeviceButton(3),XGrabDeviceKey(3)</para> + </refsect1> +</refentry> + +<refentry id="XListInputDevices.man"> + <refentryinfo> + <productname>_vendorversion_</productname> + </refentryinfo> + + <refmeta> + <refentrytitle>XListInputDevices</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + <refnamediv> + <refname>XListInputDevices, XFreeDeviceList</refname> + <refpurpose>list available input devices</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Syntax</title> + <funcsynopsis> + <funcsynopsisinfo>#include <X11/extensions/XInput.h></funcsynopsisinfo> + <funcprototype> + <funcdef><function>XDeviceInfo *XListInputDevices</function></funcdef> + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef>int *<parameter>ndevices_return</parameter></paramdef> + </funcprototype> + <funcprototype> + <funcdef><function>int XFreeDeviceList</function></funcdef> + <paramdef>XDeviceInfo *<parameter>list</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1><title>Arguments</title> + + <para> + <variablelist> + <varlistentry><term><parameter>display</parameter></term> + <listitem><para>Specifies the connection to the X server.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>ndevices_return</parameter></term> + <listitem><para>Specifies a pointer to a variable where the number of available devices canbe returned.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>list</parameter></term> + <listitem><para>Specifies the list of devices to free. The <constant>XFreeDeviceList</constant> functionfrees the list of available extension input devices.</para></listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1><title>Description</title> + <para>The <constant>XListInputDevices</constant> request lists the available input devices. This list includes all master pointers and master keyboards as well as the physical input devices currently accessible through the X server, and any input devices that are not currently accessible through the X server but could be accessed if requested. </para> + <para> + A master pointer is a virtual pointer device that does not represent a physical device. It is visually represented through a cursor. A master keyboard is a virtual keyboard device that does not represent a physical device. It is virtually representd through a keyboard focus. A master pointer and a master keyboard are always paired (i.e. if shift is pressed on the master keyboard, a pointer click would be a shift-click). Multiple master pointer/keyboard pairs can exist. </para> + <para> + Physical devices (so-called slave devices) are attached to either a master pointer or a master keyboard, depending on their capabilities. If a slave device generates an event, the event is also generated by the respective master device. Multiple slave devices can be attached to a single master device. </para> + <para> + Some server implementations may make all physical input devices available at the time the server is initialized. Others may wait until requested by a client to access an input device. In the latter case, it is possible that an input device will be listed as available at one time but not at another. </para> + <para> + For each input device available to the server, the XListInputDevices request returns an XDeviceInfo structure. That structure contains a pointer to a list of structures, each of which contains information about one class of input supported by the device. The XDeviceInfo structure is defined as follows: + + <synopsis> + typedef struct _XDeviceInfo { + XID <structfield>id</structfield>; + Atom <structfield>type</structfield>; + char *<structfield>name</structfield>; + int <structfield>num_classes</structfield>; + int <structfield>use</structfield>; + XAnyClassPtr <structfield>inputclassinfo</structfield>; + } <structname>XDeviceInfo</structname>; + </synopsis> + </para> + + <para> + The id is a number in the range 0-128 that uniquely identifies the device. It is assigned to the device when it is initialized by the server. </para> + <para> + The type field is of type Atom and indicates the nature of the device. </para> + <para> + The name field contains a pointer to a null-terminated string that corresponds to one of the defined device types. The name will correspond to one of the following strings (defined in the header file <constant>XI.h</constant>:</para> + <para> + <constant>XI_MOUSE</constant> <constant>XI_TABLET</constant> <constant>XI_KEYBOARD</constant> <constant>XI_TOUCHSCREEN</constant> <constant>XI_TOUCHPAD</constant> <constant>XI_BUTTONBOX</constant> <constant>XI_BARCODE</constant> <constant>XI_TRACKBALL</constant> <constant>XI_QUADRATURE</constant> <constant>XI_ID_MODULE</constant> <constant>XI_ONE_KNOB</constant> <constant>XI_NINE_KNOB</constant> <constant>XI_KNOB_BOX</constant> <constant>XI_SPACEBALL</constant> <constant>XI_DATAGLOVE</constant> <constant>XI_EYETRACKER</constant> <constant>XI_CURSORKEYS</constant> <constant>XI_FOOTMOUSE</constant></para> + <para> + These names may be directly compared with the name field of the XDeviceInfo structure, or used in an XInternAtom request to return an atom that can be compared with the type field of the XDeviceInfo structure. </para> + <para> + The num_classes field is a number in the range 0-255 that specifies the number of input classes supported by the device for which information is returned by ListInputDevices. Some input classes, such as class Focus and class Proximity do not have any information to be returned by ListInputDevices. </para> + <para> + All devices provide an AttachClass. This class specifies the master device a given slave device is attached to. For master devices, the class specifies the respective paired master device. </para> + <para> + The use field specifies how the device is currently being used. If the value is <constant>IsXKeyboard</constant>, the device is a master keyboard. If the value is <constant>IsXPointer</constant>, the device is a master pointer. If the value is <constant>IsXExtensionPointer</constant>, the device is a slave pointer. If the value is <constant>IsXExtensionKeyboard</constant>, the device is a slave keyboard. If the value is <constant>IsXExtensionDevice</constant>, the device is available for use as an extension device. </para> + <para> + The inputclassinfo field contains a pointer to the first input-class specific data. The first two fields are common to all classes. </para> + <para> + The class field is a number in the range 0-255. It uniquely identifies the class of input for which information is returned. Currently defined classes are KeyClass, ButtonClass, and ValuatorClass. </para> + <para> + The length field is a number in the range 0- 255. It specifies the number of bytes of data that are contained in this input class. The length includes the class and length fields. </para> + <para> + The XKeyInfo structure describes the characteristics of the keys on the device. It is defined as follows: </para> + <para> + <synopsis> + typedef struct _XKeyInfo { + XID <structfield>class</structfield>; + int <structfield>length</structfield>; + unsigned short <structfield>min_keycode</structfield>; + unsigned short <structfield>max_keycode</structfield>; + unsigned short <structfield>num_keys</structfield>; + } <structname>XKeyInfo</structname>; + + </synopsis> + </para> + <para> + min_keycode is of type KEYCODE. It specifies the minimum keycode that the device will report. The minimum keycode will not be smaller than 8. </para> + <para> + max_keycode is of type KEYCODE. It specifies the maximum keycode that the device will report. The maximum keycode will not be larger than 255. </para> + <para> + num_keys specifies the number of keys that the device has. </para> + <para> + The XButtonInfo structure defines the characteristics of the buttons on the device. It is defined as follows: </para> + <para> + <synopsis> + typedef struct _XButtonInfo { + XID <structfield>class</structfield>; + int <structfield>length</structfield>; + short <structfield>num_buttons</structfield>; + } <structname>XButtonInfo</structname>; + </synopsis> + </para> + <para> + num_buttons specifies the number of buttons that the device has. </para> + <para> + The XValuatorInfo structure defines the characteristics of the valuators on the device. It is defined as follows: </para> + <para> + <synopsis> + typedef struct _XValuatorInfo { + XID <structfield>class</structfield>; + int <structfield>length</structfield>; + unsigned char <structfield>num_axes</structfield>; + unsigned char <structfield>mode</structfield>; + unsigned long <structfield>motion_buffer</structfield>; + XAxisInfoPtr <structfield>axes</structfield>; + } <structname>XValuatorInfo</structname>; + </synopsis> + </para> + <para> + num_axes contains the number of axes the device supports. </para> + <para> + mode is a constant that has one of the following values: Absolute or Relative. Some devices allow the mode to be changed dynamically via the SetDeviceMode request. </para> + <para> + motion_buffer_size is a cardinal number that specifies the number of elements that can be contained in the motion history buffer for the device. </para> + <para> + The axes field contains a pointer to an XAxisInfo structure. </para> + <para> + The XAxisInfo structure is defined as follows: </para> + <para> + <synopsis> + typedef struct _XAxisInfo { + int <structfield>resolution</structfield>; + int <structfield>min_value</structfield>; + int <structfield>max_value</structfield>; + } <structname>XAxisInfo</structname>; + </synopsis> + </para> + <para> + The resolution contains a number in counts/meter. </para> + <para> + The min_val field contains a number that specifies the minimum value the device reports for this axis. For devices whose mode is Relative, the min_val field will contain 0. </para> + <para> + The max_val field contains a number that specifies the maximum value the device reports for this axis. For devices whose mode is Relative, the max_val field will contain 0. </para> + <para> + The XAttachInfo structure is defined as follows: </para> + <para> + <synopsis> + typedef struct _XAttachInfo { + int <structfield>attached</structfield>; + } <structname>XAttachInfo</structname>; + </synopsis> + </para> + <para> + If the device is a slave device, attached specifies the device ID of the master device this device is attached to. If the device is not attached to a master device, attached is <constant>Floating</constant>. If the device is a master device, attached specifies the device ID of the master device this device is paired with. </para> + <para> + To free the <constant>XDeviceInfo</constant> array created by <constant>XListInputDevices</constant>, use <constant>XFreeDeviceList</constant>. </para> + </refsect1> +</refentry> + +<refentry id="XOpenDevice.man"> + <refentryinfo> + <productname>_vendorversion_</productname> + </refentryinfo> + + <refmeta> + <refentrytitle>XOpenDevice</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + <refnamediv> + <refname>XOpenDevice, XCloseDevice</refname> + <refpurpose>open or close an extension input device</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Syntax</title> + <funcsynopsis> + <funcsynopsisinfo>#include <X11/extensions/XInput.h></funcsynopsisinfo> + <funcprototype> + <funcdef> + <function>XDevice *XOpenDevice</function></funcdef> + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef> XID <parameter>device_id</parameter></paramdef> + </funcprototype> + <funcprototype> + <funcdef><function>XCloseDevice</function></funcdef> + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef> XDevice *<parameter>device</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1><title>Arguments</title> + + <para> + <variablelist> + <varlistentry><term><parameter>display</parameter></term> + <listitem><para>Specifies the connection to the X server.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>device_id</parameter></term> + <listitem><para>Specifies the id of the device to be opened</para></listitem> + </varlistentry> + <varlistentry><term><parameter>device</parameter></term> + <listitem><para>Specifies the device to be closed</para></listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1><title>Description</title> + <para>The <constant>XOpenDevice</constant> request makes an input + device accessible to a client through input extension protocol + requests. If successful, it returns a pointer to an <constant>XDevice</constant> structure. </para> + <para> + The <constant>XCloseDevice</constant> request makes an input device inaccessible to a client through input extension protocol requests. Before terminating, and client that has opened input devices through the input extension should close them via <constant>CloseDevice</constant>. </para> + <para> + When a client makes an <constant>XCloseDevice</constant> request, any active grabs that the client has on the device are released. Any event selections that the client has are deleted, as well as any passive grabs. If the requesting client is the last client accessing the device, the server may disable all access by X to the device. </para> + <para> + <constant>XOpenDevice</constant> and <constant>XCloseDevice</constant> can generate a <constant>BadDevice</constant> error. + + </para> + </refsect1> + <refsect1><title>Structures</title> + <para> + The <constant>XDevice</constant> structure returned by <constant>XOpenDevice</constant> contains: + + <synopsis> + typedef struct { + XID <structfield>device_id</structfield>; + int <structfield>num_classes</structfield>; + XInputClassInfo *<structfield>classes</structfield>; + } <structname>XDevice</structname>; + </synopsis> + </para> + <para> + The classes field is a pointer to an array of XInputClassInfo structures. Each element of this array contains an event type base for a class of input supported by the specified device. The num_classes field indicates the number of elements in the classes array. </para> + <para> + The <constant>XInputClassInfo</constant> structure contains: </para> + <para> + <synopsis> + typedef struct { + unsigned char <structfield>input_class</structfield>; + unsigned char <structfield>event_type_base</structfield>; + } <structname>XInputClassInfo</structname>; + </synopsis> + </para> + <para> + The input_class field identifies one class of input supported by the device. Defined types include <constant>KeyClass</constant>, <constant>ButtonClass</constant>, <constant>ValuatorClass</constant>, <constant>ProximityClass</constant>, <constant>FeedbackClass</constant>, <constant>FocusClass</constant>, and <constant>OtherClass</constant>. The event_type_base identifies the event type of the first event in that class. </para> + <para> + The information contained in the <constant>XInputClassInfo</constant> structure is used by macros to obtain the event classes that clients use in making <constant>XSelectExtensionEvent</constant> requests. Currently defined macros include <constant>DeviceKeyPress</constant>, <constant>DeviceKeyRelease</constant>, <constant>DeviceButtonPress</constant>, <constant>DeviceButtonRelese</constant>, <constant>DeviceMotionNotify</constant>, <constant>DeviceFocusIn</constant>, <constant>DeviceFocusOut</constant>, <constant>ProximityIn</constant>, <constant>ProximityOut</constant>, <constant>DeviceStateNotify</constant>, <constant>DeviceMappingNotify</constant>, <constant>ChangeDeviceNotify</constant>, <constant>DevicePointerMotionHint</constant>, <constant>DeviceButton1Motion</constant>, <constant>DeviceButton2Motion</constant>, <constant>DeviceButton3Motion</constant>, <constant>DeviceButton4Motion</constant>, <constant>DeviceButton5Motion</constant>, <constant>DeviceButtonMotion</constant>, <constant>DeviceOwnerGrabButton</constant>, <constant>DeviceButtonPressGrab</constant>, and <constant>NoExtensionEvent</constant>. </para> + <para> + To obtain the proper event class for a particular device, one of the above macros is invoked using the <constant>XDevice</constant> structure for that device. For example, </para> + <para> + <synopsis> + DeviceKeyPress (*device, type, eventclass); + </synopsis> + </para> + <para> + returns the <constant>DeviceKeyPress</constant> event type and the eventclass for <constant>DeviceKeyPress</constant> events from the specified device. </para> + <para> + This <constant>eventclass</constant> can then be used in an <constant>XSelectExtensionEvent</constant> request to ask the server to send <constant>DeviceKeyPress</constant> events from this device. When a selected event is received via <constant>XNextEvent</constant>, the <constant>type</constant> can be used for comparison with the type in the event. </para> + </refsect1> + + <refsect1><title>Diagnostics</title><para> + <variablelist> + <varlistentry> + <term><errorname>BadDevice</errorname></term> + <listitem><para>An invalid device was specified. The specified device does not exist, or is the X keyboard or X pointer. This error may also occur if some other client has caused the specified device to become the X keyboard or X pointer device via the <constant>XChangeKeyboardDevice</constant> or <constant>XChangePointerDevice</constant> requests. </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> +</refentry> + +<refentry id="XQueryDeviceState.man"> + <refentryinfo> + <productname>_vendorversion_</productname> + </refentryinfo> + + <refmeta> + <refentrytitle>XQueryDeviceState</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + <refnamediv> + <refname>XQueryDeviceState</refname> + <refpurpose>query the state of an extension input device.</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Syntax</title> + <funcsynopsis> + <funcsynopsisinfo>#include <X11/extensions/XInput.h></funcsynopsisinfo> + <funcprototype> + <funcdef> + <function>int XQueryDeviceState</function></funcdef> + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef> XDevice *<parameter>device</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1><title>Arguments</title> + + <para> + <variablelist> + <varlistentry><term><parameter>display</parameter></term> + <listitem><para>Specifies the connection to the X server.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>device</parameter></term> + <listitem><para>Specifies the device whose state is to be queried.</para></listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1><title>Description</title> + <para>The <constant>XQueryDeviceState</constant> request queries the state of an input device. The current state of keys and buttons (up or down), and valuators (current value) on the device is reported by this request. Each key or button is represented by a bit in the <constant>XDeviceState</constant> structure that is returned. Valuators on the device report 0 if they are reporting relative information, and the current value if they are reporting absolute information. </para> + <para> + <constant>XQueryDeviceState</constant> can generate a <constant>BadDevice</constant> error. + + </para> + </refsect1> + <refsect1><title>Structures</title> + <para> + The <constant>XDeviceState</constant> structure contains: </para> + <para> + <synopsis> + typedef struct { + XID <structfield>device_id</structfield>; + int <structfield>num_classes</structfield>; + XInputClass *<structfield>data</structfield>; + } <structname>XDeviceState</structname>; + </synopsis> + </para> + <para> + The <constant>XValuatorState</constant> structure contains: </para> + <para> + <synopsis> + typedef struct { + unsigned char <structfield>class</structfield>; + unsigned char <structfield>length</structfield>; + unsigned char <structfield>num_valuators</structfield>; + unsigned char <structfield>mode</structfield>; + int *<structfield>valuators</structfield>; + } <structname>XValuatorState</structname>; + </synopsis> + </para> + <para> + The <constant>XKeyState</constant> structure contains: </para> + <para> + <synopsis> + typedef struct { + unsigned char <structfield>class</structfield>; + unsigned char <structfield>length</structfield>; + short <structfield>num_keys</structfield>; + char <structfield>keys</structfield>[32]; + } <structname>XKeyState</structname>; + </synopsis> + </para> + <para> + The <constant>XButtonState</constant> structure contains: </para> + <para> + <synopsis> + typedef struct { + unsigned char <structfield>class</structfield>; + unsigned char <structfield>length</structfield>; + short <structfield>num_buttons</structfield>; + char <structfield>buttons</structfield>[32]; + } <structname>XButtonState</structname>; + </synopsis> + </para> + </refsect1> + + <refsect1><title>Diagnostics</title><para> + <variablelist> + <varlistentry> + <term><errorname>BadDevice</errorname></term> + <listitem><para>An invalid device was specified. The specified device does not exist or has not been opened by this client via <constant>XOpenInputDevice</constant>. This error may also occur if some other client has caused the specified device to become the X keyboard or X pointer device via the <constant>XChangeKeyboardDevice</constant> or <constant>XChangePointerDevice</constant> requests. </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> +</refentry> + + +<refentry id="XSelectExtensionEvent.man"> + <refentryinfo> + <productname>_vendorversion_</productname> + </refentryinfo> + + <refmeta> + <refentrytitle>XSelectExtensionEvent</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + <refnamediv> + <refname>XSelectExtensionEvent, XGetSelectedExtensionEvents</refname> + <refpurpose>select extension events, get the list of currently selected extension events</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Syntax</title> + <funcsynopsis> + <funcsynopsisinfo>#include <X11/extensions/XInput.h></funcsynopsisinfo> + <funcprototype> + <funcdef><function>XSelectExtensionEvent</function></funcdef> + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef>Window <parameter>w</parameter></paramdef> + <paramdef>XEventClass *<parameter>event_list</parameter></paramdef> + <paramdef>int <parameter>event_count</parameter></paramdef> + </funcprototype> + <funcprototype> + <funcdef><function>XGetSelectedExtensionEvents</function></funcdef> + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef>Window <parameter>w</parameter></paramdef> + <paramdef>int <parameter>this_client_event_count_return</parameter></paramdef> + <paramdef>XEventClass *<parameter>this_client_event_list_return</parameter></paramdef> + <paramdef>int <parameter>all_clients_event_count_return</parameter></paramdef> + <paramdef>XEventClass *<parameter>all_clients_event_list_return</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1><title>Arguments</title> + <para> + <variablelist> + <varlistentry><term><parameter>display</parameter></term> + <listitem><para>Specifies the connection to the X server.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>w</parameter></term> + <listitem><para>Specifies the window whose events you + are interested in.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>event_list</parameter></term> + <listitem><para>Specifies the list of event classes + that describe the events you are interested + in.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>event_count</parameter></term> + <listitem><para>Specifies the count of event classes + in the event list.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>this_client_event_count_return</parameter></term> + <listitem><para>Returns the count of event classes + selected by this client.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>this_client_event_list_return</parameter></term> + <listitem><para>Returns a pointer to the list of event classes + selected by this client.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>all_clients_event_count_return</parameter></term> + <listitem><para>Returns the count of event classes + selected by all clients.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>all_clients_event_list_return</parameter></term> + <listitem><para>Returns a pointer to the list of event classes + selected by all clients.</para></listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1><title>Description</title> + <para> + The <constant>XSelectExtensionEvent</constant> request causes + the X server to report the events associated with the + specified list of event classes. Initially, X will not report + any of these events. Events are reported relative to a + window. If a window is not interested in a device event, it + usually propagates to the closest ancestor that is interested, + unless the do_not_propagate mask prohibits it. </para><para> + + Multiple clients can select for the same events on the same window + with the following restrictions: + <itemizedlist> + <listitem> + <para> + Multiple clients can select events on the same + window because their event masks are disjoint. + When the X server generates an event, it reports + it to all interested clients. + </para> + </listitem> + <listitem> + <para> + Only one client at a time can select a + <constant>DeviceButtonPress</constant> event with + automatic passive grabbing enabled, which is + associated with the event class + <constant>DeviceButtonPressGrab</constant>. To + receive <constant>DeviceButtonPress</constant> + events without automatic passive grabbing, use + event class <constant>DeviceButtonPress</constant> + but do not specify event class + <constant>DeviceButtonPressGrab</constant>. + </para> + </listitem> + </itemizedlist> + The server reports the event to all interested clients. + </para><para> + + Information contained in the <constant>XDevice</constant> structure returned by + <constant>XOpenDevice</constant> is used + by macros to obtain the event classes that clients use in making + <constant>XSelectExtensionEvent</constant> requests. Currently defined macros include + <constant>DeviceKeyPress</constant>, <constant>DeviceKeyRelease</constant>, <constant>DeviceButtonPress</constant>, + <constant>DeviceButtonRelese</constant>, <constant>DeviceMotionNotify</constant>, <constant>DeviceFocusIn</constant>, + <constant>DeviceFocusOut</constant>, <constant>ProximityIn</constant>, <constant>ProximityOut</constant>, + <constant>DeviceStateNotify</constant>, <constant>DeviceMappiingNotify</constant>, + <constant>ChangeDeviceNotify</constant>, <constant>DevicePointerMotionHint</constant>, + <constant>DeviceButton1Motion</constant>, <constant>DeviceButton2Motion</constant>, <constant>DeviceButton3Motion</constant>, + <constant>DeviceButton4Motion</constant>, <constant>DeviceButton5Motion</constant>, <constant>DeviceButtonMotion</constant>, + <constant>DeviceOwnerGrabButton</constant>, <constant>DeviceButtonPressGrab</constant>, and + <constant>NoExtensionEvent</constant>. + </para><para> + + To obtain the proper event class for a particular device, one of the above + macros is invoked using the <constant>XDevice</constant> structure for that device. For + example, + </para><para> + <synopsis> + DeviceKeyPress (*device, type, eventclass); + </synopsis> + </para><para> + + returns the <constant>DeviceKeyPress</constant> event type and the eventclass for selecting + <constant>DeviceKeyPress</constant> events from this device. + </para><para> + + <constant>XSelectExtensionEvent</constant> + can generate a <constant>BadWindow</constant> or <constant>BadClass</constant> error. + The <constant>XGetSelectedExtensionEvents</constant> + request reports the extension events selected by this client and all clients + for the specified window. This request returns pointers to two + <constant>XEventClass</constant> + arrays. One lists the input extension events selected by this client from + the specified window. The other lists the event classes selected by all + clients from the specified window. You should use <constant>XFree</constant> to free these + two arrays. + </para><para> + + <constant>XGetSelectedExtensionEvents</constant> + can generate a <constant>BadWindow</constant> error. + </para> + </refsect1> + + <refsect1><title>Diagnosis</title> + <para> + <variablelist> + <varlistentry> + <term><errorname>BadWindow</errorname></term> + <listitem><para>A value for a Window argument does not + name a defined window.</para></listitem> + </varlistentry> + <varlistentry> + <term><errorname>BadClass</errorname></term><listitem> + <para> + A value for an <constant>XEventClass</constant> is + invalid. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + +</refentry> + + +<refentry id="XSendExtensionEvent.man"> + <refentryinfo> + <productname>_vendorversion_</productname> + </refentryinfo> + + <refmeta> + <refentrytitle>XSendExtensionEvent</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + <refnamediv> + <refname>XSendExtensionEvent</refname> + <refpurpose>send input extension events to a client</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Syntax</title> + <funcsynopsis> + <funcsynopsisinfo>#include <X11/extensions/XInput.h></funcsynopsisinfo> + <funcprototype> + <funcdef> + <function>Status XSendExtensionEvent</function></funcdef> + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef> XDevice *<parameter>device</parameter></paramdef> + <paramdef> Window <parameter>destination</parameter></paramdef> + <paramdef> Bool <parameter>propagate</parameter></paramdef> + <paramdef> int <parameter>event_count</parameter></paramdef> + <paramdef> XEventClass *<parameter>event_list</parameter></paramdef> + <paramdef> XEvent *<parameter>event_send</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1><title>Arguments</title> + + <para> + <variablelist> + <varlistentry><term><parameter>display</parameter></term> + <listitem><para>Specifies the connection to the X server.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>device</parameter></term> + <listitem><para>Specifies the device from which the events are to be sent.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>destination</parameter></term> + <listitem><para>Specifies the window the event is to be sent to. You can pass window id, <constant>PointerWindow</constant>,or <constant>InputFocus</constant>.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>propagate</parameter></term> + <listitem><para>Specifies a Boolean value that is either True or False.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>event_count</parameter></term> + <listitem><para>Specifies the count of XEventClasses in event_list.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>event_list</parameter></term> + <listitem><para>Specifies the list of event selections to be used.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>event_send</parameter></term> + <listitem><para>Specifies a pointer to the event that is to be sent.</para></listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1><title>Description</title> + <para> + The <constant>XSendExtensionEvent</constant> request identifies the destination + window, determines which clients should receive the specified + events, and ignores any active grabs. This request requires you + to pass an event class list. For a discussion of the valid event + class names, see <constant>XOpenDevice(3)</constant> + This request uses the w argument to identify the destination window as follows: + <itemizedlist> + <listitem> + <para> + If w is <constant>PointerWindow</constant> ,the destination window is the window that contains the pointer. + </para> + </listitem> + <listitem> + <para>If w is <constant>InputFocus</constant>and if the focus window contains the pointer,the destination window is the window that contains the pointer; otherwise, the destination window is the focus window. + </para> + </listitem> + </itemizedlist> + </para> + <para> + To determine which clients should receive the specified events, <constant>XSendExtensionEvent</constant>uses the propagate argument as follows: + <itemizedlist> + <listitem> + <para> If event_list is the empty set,the event is sent to the client that created the destination window. If that client no longer exists,no event is sent. + </para> + </listitem> + <listitem> + <para>If propagate is <constant>False</constant>,the event is sent to every client selecting on destination any of the eventtypes specified by the event_list array. + </para> + </listitem> + <listitem> + <para>If propagate is <constant>True</constant>and no clients have selected on destination any ofthe events specified by the event_list array,the destination is replaced with theclosest ancestor of destination for which some client has selected atype specified by the event-list array and for which no interveningwindow has that type in itsdo-not-propagate-mask. If no such window exists or if the window isan ancestor of the focus window and <constant>InputFocus</constant>was originally specifiedas the destination, the event is not sent to any clients. Otherwise, the event is reported to every client selecting on the finaldestination any of the events specified in the event_list array. + </para> + </listitem> + </itemizedlist> + </para> + <para> + The event in the <constant>XEvent</constant>structure must be one of the events defined by the input extension (or a <constant>BadValue</constant>error results) so that the X server can correctly byte-swapthe contents as necessary. The contents of the event areotherwise unaltered and unchecked by the X server except to force send_event to <constant>True</constant>in the forwarded event and to set the serial number in the event correctly. + </para> + <para> + <constant>XSendExtensionEvent</constant>returns zero if the conversion to wire protocol format failedand returns nonzero otherwise. <constant>XSendExtensionEvent</constant>can generate <constant>BadClass</constant>, <constant>BadDevice</constant>, <constant>BadValue</constant>, and <constant>BadWindow</constant> errors. + </para> + </refsect1> + <refsect1><title>Diagnosis</title> + <para> + <variablelist> + <varlistentry> + <term><errorname>BadDevice</errorname></term> + <listitem><para>An invalid device was specified. The + specified device does not exist or has not been + opened by this client via + <constant>XOpenInputDevice</constant>. This error + may also occur if the specified device is the X + keyboard or X pointer device. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><errorname>BadValue</errorname></term> + <listitem> + <para> + Some numeric value falls outside the range of + values accepted by the request. Unless a specific + range is specified for an argument, the full range + defined by the argument's type is accepted. Any + argument defined as a set of alternatives can + generate this error. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><errorname>BadWindow</errorname></term> + <listitem><para>A value for a Window argument does not + name a defined window.</para></listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> +</refentry> + +<refentry id="XSetDeviceButtonMapping.man"> + <refentryinfo> + <productname>_vendorversion_</productname> + </refentryinfo> + + <refmeta> + <refentrytitle>XSetDeviceButtonMapping</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + <refnamediv> + <refname>XSetDeviceButtonMapping, XGetDeviceButtonMapping</refname> + <refpurpose>query or change device button mappings</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Syntax</title> + <funcsynopsis> + <funcsynopsisinfo>#include <X11/extensions/XInput.h></funcsynopsisinfo> + <funcprototype> + <funcdef> + <function>int XSetDeviceButtonMapping</function></funcdef> + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef> XDevice *<parameter>device</parameter></paramdef> + <paramdef> unsigned char <parameter>map</parameter>[]</paramdef> + <paramdef> int <parameter>nmap</parameter></paramdef> + </funcprototype> + <funcprototype> + <funcdef><function>int XGetDeviceButtonMapping</function></funcdef> + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef>XDevice *<parameter>device</parameter></paramdef> + <paramdef>unsigned char <parameter>map_return</parameter>[]</paramdef> + <paramdef>int <parameter>nmap</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1><title>Arguments</title> + <para> + <variablelist> + <varlistentry><term><parameter>display</parameter></term> + <listitem><para>Specifies the connection to the X server.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>device</parameter></term> + <listitem><para>Specifies the device whose button mapping is to be queried or changed.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>map</parameter></term> + <listitem><para>Specifies the mapping list.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>map_return</parameter></term> + <listitem><para>Returns the mapping list.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>nmap</parameter></term> + <listitem><para>Specifies the number of items in the mapping list.</para></listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1><title>Description</title> + <para>The <constant>XSetDeviceButtonMapping</constant> request sets the mapping of the specified device. If it succeeds, the X server generates a <constant>DeviceMappingNotify</constant> event, and <constant>XSetDeviceButtonMapping</constant> returns <constant>MappingSuccess</constant>. Element map[i] defines the logical button number for the physical button i+1. The length of the list must be the same as <constant>XGetDeviceButtonMapping</constant> would return, or a <constant>BadValue</constant> error results. A zero element disables a button, and elements are not restricted in value by the number of physical buttons. However, no two elements can have the same nonzero value, or a <constant>BadValue</constant> error results. If any of the buttons to be altered are logically in the down state, <constant>XSetDeviceButtonMapping</constant> returns <constant>MappingBusy</constant>, and the mapping is not changed. </para> + <para> + <constant>XSetDeviceButtonMapping</constant> can generate <constant>BadDevice</constant>, <constant>BadMatch</constant>, and <constant>BadValue</constant> errors. </para> + <para> + The <constant>XGetDeviceButtonMapping</constant> request returns the current mapping of the specified device. Buttons are numbered starting from one. <constant>XGetDeviceButtonMapping</constant> returns the number of physical buttons actually on the device. The nominal mapping for a device is map[i]=i+1. The nmap argument specifies the length of the array where the device mapping is returned, and only the first nmap elements are returned in map_return. </para> + <para> + <constant>XGetDeviceButtonMapping</constant> can generate <constant>BadDevice</constant> or <constant>BadMatch</constant> errors. </para> + </refsect1> + + <refsect1><title>Diagnostics</title><para> + <variablelist> + <varlistentry> + <term><errorname>BadDevice</errorname></term> + <listitem><para>An invalid device was specified. The specified device does not exist or has not been opened by this client via <constant>XOpenInputDevice</constant>. This error may also occur if the specified device is the X keyboard or X pointer device. </para> + </listitem> + </varlistentry> + <varlistentry> + <term><errorname>BadMatch</errorname></term> + <listitem><para>This error may occur if an <constant>XGetDeviceButtonMapping</constant> or <constant>XSetDeviceButtonMapping</constant> request was made specifying a device that has no buttons. </para> + </listitem> + </varlistentry> + <varlistentry> + <term><errorname>BadValue</errorname></term> + <listitem><para>Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of alternatives can generate this error. </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1><title>See also</title> + <para>XChangeDeviceKeyboardControl(3), XChangeDeviceKeyMapping(3), XChangeDeviceModifierMapping(3)</para> + </refsect1> +</refentry> + + +<refentry id="XSetDeviceFocus.man"> + <refentryinfo> + <productname>_vendorversion_</productname> + </refentryinfo> + + <refmeta> + <refentrytitle>XSetDeviceFocus</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + <refnamediv> + <refname>XSetDeviceFocus, XGetDeviceFocus</refname> + <refpurpose>control extension input device focus</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Syntax</title> + <funcsynopsis> + <funcsynopsisinfo>#include <X11/extensions/XInput.h></funcsynopsisinfo> + <funcprototype> + <funcdef> + <function>XSetDeviceFocus</function></funcdef> + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef>XDevice *<parameter>device</parameter></paramdef> + <paramdef>Window <parameter>focus</parameter></paramdef> + <paramdef>int <parameter>revert_to</parameter></paramdef> + <paramdef>Time <parameter>time</parameter></paramdef> + </funcprototype> + <funcprototype> + <funcdef><function>XGetDeviceFocus</function></funcdef> + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef>XDevice *<parameter>device</parameter></paramdef> + <paramdef>Window *<parameter>focus_return</parameter></paramdef> + <paramdef>int *<parameter>revert_to_return</parameter></paramdef> + <paramdef>int * <parameter>time_return</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1><title>Arguments</title> + + <para> + <variablelist> + <varlistentry><term><parameter>display</parameter></term> + <listitem><para>Specifies the connection to the X server.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>device</parameter></term> + <listitem><para>Specifies the device whose focus is to be queried or changed.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>focus</parameter></term> + <listitem><para>Specifies the window, <constant>PointerRoot</constant>, <constant>FollowKeyboard</constant>,or <constant>None</constant>.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>focus_return</parameter></term> + <listitem><para>Returns the focus window, <constant>PointerRoot</constant>, <constant>FollowKeyboard</constant>,or <constant>None</constant>.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>revert_to</parameter></term> + <listitem><para>Specifies where the input focus reverts to if the window becomes notviewable.You can pass <constant>RevertToParent</constant>, <constant>RevertToPointerRoot</constant>, <constant>RevertToFollowKeyboard</constant>,or <constant>RevertToNone</constant>.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>revert_to_return</parameter></term> + <listitem><para>Returns the current focus state <constant>RevertToParent</constant>, <constant>RevertToPointerRoot</constant>, <constant>RevertToFollowKeyboard</constant>,or <constant>RevertToNone</constant>.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>time_return</parameter></term> + <listitem><para>Returns the last_focus_time for the device.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>time</parameter></term> + <listitem><para>Specifies the time.You can pass either a timestamp or <constant>CurrentTime</constant>.</para></listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1><title>Description</title> + <para>The <constant>XSetDeviceFocus</constant> request changes the focus of the specified device and its last-focus-change time. It has no effect if the specified time is earlier than the current last-focus-change time or is later than the current X server time. Otherwise, the last-focus-change time is set to the specified time <constant>CurrentTime</constant> is replaced by the current X server time). <constant>XSetDeviceFocus</constant> causes the X server to generate <constant>DeviceFocusIn</constant> and <constant>DeviceFocusOut</constant> events. </para> + <para> + Depending on the focus argument, the following occurs: + + <itemizedlist> + <listitem><para> If focus is <constant>None</constant> , all device events are discarded until a new focus window is set, and the revert_to argument is ignored. + </para></listitem> + <listitem><para>If focus is a window, it becomes the device's focus window. If a generated device event would normally be reported to this window or one of its inferiors, the event is reported as usual. Otherwise, the event is reported relative to the focus window. + </para></listitem> + <listitem><para> + If focus is <constant>PointerRoot</constant> , the focus window is dynamically taken to be the root window of whatever screen the pointer is on at each event from the specified device. In this case, the revert_to argument is ignored. + </para></listitem> + <listitem><para> + If focus is <constant>FollowKeyboard</constant> , the focus window is dynamically taken to be the window to which the X keyboard focus is set at each input event. </para> + </listitem> + </itemizedlist> + </para> + <para> + The specified focus window must be viewable at the time <constant>XSetDeviceFocus</constant> is called, or a <constant>BadMatch</constant> error results. If the focus window later becomes not viewable, the X server evaluates the revert_to argument to determine the new focus window as follows: + + <itemizedlist> + <listitem><para>If revert_to is <constant>RevertToParent</constant> , the focus reverts to the parent (or the closest viewable ancestor), and the new revert_to value is taken to be <constant>RevertToNone</constant>.</para></listitem> + <listitem><para> + If revert_to is <constant>RevertToPointerRoot</constant> , <constant>RevertToFollowKeyboard</constant> , or <constant>RevertToNone</constant> , the focus reverts to <constant>PointerRoot</constant> , <constant>FollowKeyboard</constant> , or <constant>None</constant> , respectively. </para> + </listitem> + </itemizedlist> + </para> + <para> + When the focus reverts, the X server generates + <constant>DeviceFocusIn</constant> and + <constant>DeviceFocusOut</constant> events, but the + last-focus-change time is not affected. </para> <para> Input + extension devices are not required to support the ability to be + focused. Attempting to set the focus of a device that does not + support this request will result in a + <constant>BadMatch</constant> error. Whether or not given + device can support this request can be determined by the + information returned by <constant>XOpenDevice</constant> . For + those devices that support focus, + <constant>XOpenDevice</constant> will return an + <constant>XInputClassInfo</constant> structure with the + input_class field equal to the constant + <constant>FocusClass</constant> (defined in the file + <constant>XI.h</constant>). + </para> + <para> + <constant>XSetDeviceFocus</constant> can generate + <constant>BadDevice</constant>, <constant>BadMatch</constant>, + <constant>BadValue</constant>, and + <constant>BadWindow</constant> errors. + </para> + <para> + The <constant>XGetDeviceFocus</constant> request returns the focus window and the current focus state. </para> + <para> + Not all input extension devices can be focused. Attempting to query the focus state of a device that can't be focused results in a <constant>BadMatch</constant> error. A device that can be focused returns information for input Class Focus when an <constant>XOpenDevice</constant> request is made. </para> + <para> + <constant>XGetDeviceFocus</constant> can generate <constant>BadDevice</constant> , and <constant>BadMatch</constant> errors. </para> + </refsect1> + + <refsect1><title>Diagnostics</title><para> + <variablelist> + <varlistentry> + <term><errorname>BadDevice</errorname></term> + <listitem><para>An invalid device was specified. The specified device does not exist or has not been opened by this client via <constant>XOpenInputDevice</constant> . This error may also occur if the specified device is the X keyboard or X pointer device. </para> + </listitem> + </varlistentry> + <varlistentry> + <term><errorname>BadValue</errorname></term> + <listitem><para>Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of alternatives can generate this error. </para> + </listitem> + </varlistentry> + <varlistentry> + <term><errorname>BadWindow</errorname></term> + <listitem><para>A value for a Window argument does not name a defined Window. </para> + </listitem> + </varlistentry> + <varlistentry> + <term><errorname>BadMatch</errorname></term> + <listitem><para>This error may occur if an <constant>XGetDeviceFocus</constant> or <constant>XSetDeviceFocus</constant> request was made specifying a device that the server implementation does not allow to be focused. </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> +</refentry> + + +<refentry id="XSetDeviceMode.man"> + <refentryinfo> + <productname>_vendorversion_</productname> + </refentryinfo> + + <refmeta> + <refentrytitle>XSetDeviceMode</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + <refnamediv> + <refname>XSetDeviceMode</refname> + <refpurpose>change the mode of a device</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Syntax</title> + <funcsynopsis> + <funcsynopsisinfo>#include <X11/extensions/XInput.h></funcsynopsisinfo> + <funcprototype> + <funcdef><function>XSetDeviceMode</function></funcdef> + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef>XDevice *<parameter>device</parameter></paramdef> + <paramdef>int <parameter>mode</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1><title>Arguments</title> + <para> + <variablelist> + <varlistentry><term><parameter>display</parameter></term> + <listitem><para>Specifies the connection to the X server.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>device</parameter></term> + <listitem><para>Specifies the device whose mode is to be changed.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>mode</parameter></term> + <listitem><para>Specifies the mode.You can pass <constant>Absolute</constant> ,or <constant>Relative</constant>.</para></listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1><title>Description</title> + <para>The <constant>XSetDeviceMode</constant> request changes the mode of an input device that is capable of reporting either absolute positional information or relative motion information. Not all input devices are capable of reporting motion data, and not all are capable of changing modes from <constant>Absolute</constant> to <constant>Relative</constant> . </para> + <para> + <constant>XSetDeviceMode</constant> can generate a <constant>BadDevice</constant> or <constant>BadMode</constant> error. </para> + </refsect1> + + <refsect1><title>Diagnostics</title><para> + <variablelist> + <varlistentry> + <term><errorname>BadDevice</errorname></term> + <listitem><para>An invalid device was specified. The specified device does not exist or has not been opened by this client via <constant>XOpenInputDevice</constant> . This error may also occur if some other client has caused the specified device to become the X keyboard or X pointer device via the <constant>XChangeKeyboardDevice</constant> or <constant>XChangePointerDevice</constant> requests. </para> + </listitem> + </varlistentry> + <varlistentry> + <term><errorname>BadMatch</errorname></term> + <listitem><para>This error may occur if an <constant>XSetDeviceMode</constant> request is made specifying a device that has no valuators and reports no axes of motion. </para> + </listitem> + </varlistentry> + <varlistentry> + <term><errorname>BadMode</errorname></term> + <listitem><para>An invalid mode was specified. This error will also be returned if the specified device is not capable of supporting the <constant>XSetDeviceMode</constant> request. </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> +</refentry> + + +<refentry id="XSetDeviceValuators.man"> + <refentryinfo> + <productname>_vendorversion_</productname> + </refentryinfo> + + <refmeta> + <refentrytitle>XSetDeviceValuators</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + <refnamediv> + <refname>XSetDeviceValuators</refname> + <refpurpose>initialize the valuators on an extension input device</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Syntax</title> + <funcsynopsis> + <funcsynopsisinfo>#include <X11/extensions/XInput.h></funcsynopsisinfo> + <funcprototype> + <funcdef> + <function>XSetDeviceValuators</function></funcdef> + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef>XDevice *<parameter>device</parameter></paramdef> + <paramdef>int *<parameter>valuators</parameter></paramdef> + <paramdef>int <parameter>first_valuator</parameter></paramdef> + <paramdef>int <parameter>num_valuators</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1><title>Arguments</title> + + <para> + <variablelist> + <varlistentry><term><parameter>display</parameter></term> + <listitem><para>Specifies the connection to the X server.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>device</parameter></term> + <listitem><para>Specifies the device whose valuators are to be initialized.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>valuators</parameter></term> + <listitem><para>Specifies a pointer to an array of integer values to be used to initialize thedevice valuators.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>first_valuator</parameter></term> + <listitem><para>Specifies the first valuator to be set. Valuators are numbered beginning withzero.</para></listitem> + </varlistentry> + <varlistentry><term><parameter>num_valuators</parameter></term> + <listitem><para>Specifies the number of valuators to be set.</para></listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1><title>Description</title> + <para>The <constant>XSetDeviceValuators</constant> request sets the current values of the valuators of an input device. The valuators in the range first_valuator to (first_valuator + num_valuators) are set to the specified values. Valuators are numbered beginning with 0. Not all input devices support initialization of valuator values. If this request is made to a device that does not support valuators initialization, a <constant>BadMatch</constant> error will occur. </para> + <para> + If the request succeeds, a status of Success is returned. If another client has the device grabbed, a status of AlreadyGrabbed is returned. </para> + <para> + <constant>XSetDeviceValuators</constant> can generate a <constant>BadLength</constant> , <constant>BadDevice</constant> , <constant>BadMatch</constant> , or <constant>BadValue</constant> error. </para> + </refsect1> + + <refsect1><title>Diagnostics</title><para> + <variablelist> + <varlistentry> + <term><errorname>BadDevice</errorname></term> + <listitem><para>An invalid device was specified. The specified device does not exist or has not been opened by this client via <constant>XOpenInputDevice</constant> . </para> + </listitem> + </varlistentry> + <varlistentry> + <term><errorname>BadMatch</errorname></term> + <listitem><para>This error may occur if an <constant>XSetDeviceValuators</constant> request is made specifying a device that has no valuators and reports no axes of motion, or if such a request is made specifying a device that does not support valuator initialization. </para> + </listitem> + </varlistentry> + <varlistentry> + <term><errorname>BadValue</errorname></term> + <listitem><para>An invalid first_valuator or num_valuators values was specified. </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + +</refentry> + +<!--- MPX --> +<refentry id="XSetClientPointer.man"> + <refentryinfo> + <productname>_vendorversion_</productname> + <pubdate>February 14, 2008</pubdate> + <authorgroup> + <author> + <firstname>Peter</firstname><surname>Hutterer</surname> + <contrib>Specification and implementation.</contrib> + <email>peter@cs.unisa.edu.au</email> + </author> + </authorgroup> + </refentryinfo> + + <refmeta> + <refentrytitle>XSetClientPointer, XGetClientPointer</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + <refnamediv> + <refname>XSetClientPointer, XGetClientPointer</refname> + <refpurpose>set or get the ClientPointer setting.</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Syntax</title> + <funcsynopsis> + <funcsynopsisinfo>#include <X11/extensions/XInput.h></funcsynopsisinfo> + <funcprototype> + <funcdef><function>XSetClientPointer</function></funcdef> + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef>Window <parameter>win</parameter></paramdef> + <paramdef>XDevice *<parameter>device</parameter></paramdef> + </funcprototype> + <funcprototype> + <funcdef>Bool <function>XGetClientPointer</function></funcdef> + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef>Window <parameter>win</parameter></paramdef> + <paramdef>XID *<parameter>device</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + + <refsect1><title>Arguments</title> + <para> + <variablelist> + <varlistentry> + <term><parameter>display</parameter></term> + <listitem><para>Specifies the connection to the X server.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>win</parameter></term> + <listitem><para>Specifies a window belonging to the + client. May be <constant>None</constant>.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>device</parameter></term> + <listitem><para>Specifies the device to set as + ClientPointer.</para></listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1><title>Description</title> + <para> + The ClientPointer is the device that is percieved to be the core + pointer for non-XI protocol requests and replies. 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 <function>XQueryPointer</function> + request will return the coordinates of the ClientPointer. + </para> + <para> + <function>XSetClientPointer</function> request sets the + ClientPointer device for the client that owns the given window. If + <parameter>win</parameter> is <constant>None</constant>, the + requesting client's ClientPointer is set to the + <constant>device</constant>. Only master pointer devices can be + set as ClientPointer. + </para> + <para> + <function>XSetClientPointer</function> and can generate a + <errorname>BadDevice</errorname> and a + <errorname>BadWindow</errorname> error. + </para> + <para> + The <function>XGetClientPointer</function> request returns the + ClientPointer's device ID for the client that owns the given + window. If <parameter>win</parameter> is + <constant>None</constant>, the requesting client's ClientPointer + is returned. + </para> + <para> + <parameter>win</parameter> may be a client ID instead + of a window. + </para> + <para> + <function>XGetClientPointer</function> can generate a + <errorname>BadWindow</errorname> error. + </para> + </refsect1> + + <refsect1><title>Diagnosis</title> + <para> + <variablelist> + <varlistentry> + <term><errorname>BadDevice</errorname></term><listitem> + <para> + An invalid device was specified. The device does + not exist or is not a master pointer device. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><errorname>BadWindow</errorname></term> + <listitem><para>A value for a Window argument does not + name a defined window.</para></listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> +</refentry> + +<refentry id="XQueryDevicePointer.man"> + <refentryinfo> + <productname>_vendorversion_</productname> + <pubdate>February 14, 2008</pubdate> + <authorgroup> + <author> + <firstname>Peter</firstname><surname>Hutterer</surname> + <contrib>Specification and implementation.</contrib> + <email>peter@cs.unisa.edu.au</email> + </author> + </authorgroup> + </refentryinfo> + + <refmeta> + <refentrytitle>XQueryDevicePointer</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + <refnamediv> + <refname>XQueryDevicePointer</refname> + <refpurpose> get device pointer coordinates.</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Syntax</title> + <funcsynopsis> + <funcsynopsisinfo>#include <X11/extensions/XInput.h></funcsynopsisinfo> + <funcprototype> + <funcdef>Bool <function>XQueryDevicePointer</function></funcdef> + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef>XDevice *<parameter>device</parameter></paramdef> + <paramdef>Window <parameter>win</parameter></paramdef> + <paramdef>Window *<parameter>root_return</parameter></paramdef> + <paramdef>Window *<parameter>child_return</parameter></paramdef> + <paramdef>int *<parameter>root_x_return</parameter></paramdef> + <paramdef>int *<parameter>root_y_return</parameter></paramdef> + <paramdef>int *<parameter>win_x_return</parameter></paramdef> + <paramdef>int *<parameter>win_y_return</parameter></paramdef> + <paramdef>unsigned int *<parameter>mask_return</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + + <refsect1><title>Arguments</title> + <para> + <variablelist> + <varlistentry> + <term><parameter>child_return</parameter></term> + <listitem> + <para> + Returns the child window that the pointer is located in, if any. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>device</parameter></term> + <listitem><para>Specifies the device to query.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>display</parameter></term> + <listitem><para>Specifies the connection to the X server.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>mask_return</parameter></term> + <listitem> + <para> + Returns the current state of the modifier keys and pointer buttons. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>root_return</parameter></term> + <listitem> + <para> + Returns the root window that the pointer is in. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>root_x_return</parameter></term> + <term><parameter>root_y_return</parameter></term> + <listitem> + <para> + Return the pointer coordinates relative to the root + window's origin. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>win</parameter></term> + <listitem> + <para> + Specifies the window. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>win_x_return</parameter></term> + <term><parameter>win_y_return</parameter></term> + <listitem><para> + Return the pointer coordinates relative to the + specified window. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1><title>Description</title> + <para> + The <function>XQueryDevicePointer</function> function returns the root + window the device's pointer is logically on and the pointer + coordinates relative to the root window's origin. If + <function>XQueryDevicePointer</function> returns + <constant>False</constant>, the pointer is not on the same screen as + the specified window, and + <function>XQueryDevicePointer</function> returns + <constant>None</constant> to <parameter>child_return</parameter> and + zero to <parameter>win_x_return</parameter> and + <parameter>win_y_return</parameter>. If + <function>XQueryDevicePointer</function> returns + <constant>True</constant>, the pointer coordinates returned to + <parameter>win_x_return</parameter> and + <parameter>win_y_return</parameter> are relative to the origin of the + specified window. In this case, + <function>XQueryDevicePointer</function> returns the child that + contains the pointer, if any, or else <constant>None</constant> to + <parameter>child_return</parameter>. + </para> + <para> + <function>XQueryDevicePointer</function> returns the current + logical state of the keyboard buttons and the modifier keys in + <parameter>mask_return</parameter>. The keyboard paired with the + master pointer is selected to obtain this data. It sets + <parameter>mask_return</parameter> to the bitwise inclusive OR of + one or more of the button or modifier key bitmasks to match the + current state of the mouse buttons and the modifier keys. + </para> + <para> + <function>XQueryDevicePointer</function> is identical to + <function>XQueryPointer</function> but specifies the device + explicitly. + </para> + <para> + <function>XQueryDevicePointer</function> can generate a + <errorname>BadDevice</errorname> and a + <errorname>BadWindow</errorname> error. + </para> + </refsect1> + + <refsect1><title>Diagnosis</title> + <para> + <variablelist> + <varlistentry> + <term><errorname>BadDevice</errorname></term> + <listitem> + <para> + An invalid device was specified. The device does + not exist or is not a pointer device. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><errorname>BadWindow</errorname></term> + <listitem><para>A value for a Window argument does not + name a defined window.</para></listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1><title>See also</title> + <para> + <function>XQueryPointer</function> + </para> + </refsect1> + +</refentry> + +<refentry id="XDefineDeviceCursor.man"> + <refentryinfo> + <productname>_vendorversion_</productname> + <pubdate>February 14, 2008</pubdate> + <authorgroup> + <author> + <firstname>Peter</firstname><surname>Hutterer</surname> + <contrib>Specification and implementation.</contrib> + <email>peter@cs.unisa.edu.au</email> + </author> + </authorgroup> + </refentryinfo> + + <refmeta> + <refentrytitle>XDefineDeviceCursor, XUndefineDeviceCursor</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + <refnamediv> + <refname>XDefineDeviceCursor, XUndefineDeviceCursor</refname> + <refpurpose>define device cursors.</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Syntax</title> + <funcsynopsis> + <funcsynopsisinfo>#include <X11/extensions/XInput.h></funcsynopsisinfo> + <funcprototype> + <funcdef>int <function>XDefineCursor</function></funcdef> + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef>XDevice *<parameter>device</parameter></paramdef> + <paramdef>Window <parameter>win</parameter></paramdef> + <paramdef>Cursor <parameter>cursor</parameter></paramdef> + </funcprototype> + <funcprototype> + <funcdef>int <function>XUndefineCursor</function></funcdef> + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef>XDevice *<parameter>device</parameter></paramdef> + <paramdef>Window <parameter>win</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + + <refsect1><title>Arguments</title> + <para> + <variablelist> + <varlistentry> + <term><parameter>cursor</parameter> </term><listitem> + <para> + Specifies the cursor that is to be displayed or + <constant>None</constant>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>device</parameter></term> + <listitem><para>Specifies the device whose cursor is to + change.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>display</parameter></term> + <listitem><para>Specifies the connection to the X server.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>win</parameter></term> + <listitem><para>Specifies the window.</para></listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1><title>Description</title> + <para> + If a cursor is set, it will be used when the device's pointer is in the + window. If the cursor is <constant>None</constant>, it is equivalent to + <function>XUndefineDefineCursor</function>. + </para> + <para> + <function>XDefineDeviceCursor</function> can generate + <errorname>BadCursor</errorname> and + <errorname>BadWindow</errorname>. + </para> + <para> + The <function>XUndefineDeviceCursor</function> function undoes the + effect of a previous <function>XDefineDeviceCursor</function> for + this window. When the pointer is in the window, the window's + default cursor will now be used. If no default cursor is defined, + the parent's cursor for this device will be used (if defined) or + the parent's default cursor will be used. + </para> + <para> + <function>XDefineDeviceCursor</function> and + <function>XUndefineDeviceCursor</function> are identical to + <function>XDefineCursor</function> and + <function>XUndefineCursor</function> but specify the device + explicitly. + </para> + <para> + <function>XUndefineDevicePointer</function> can generate a + <errorname>BadDevice</errorname> and a + <errorname>BadWindow</errorname> error. + </para> + </refsect1> + + <refsect1><title>Diagnosis</title> + <para> + <variablelist> + <varlistentry> + <term><errorname>BadDevice</errorname></term> + <listitem><para>An invalid device was specified. The + device does not exist or is not a pointer + device.</para></listitem> + + </varlistentry> + <varlistentry> + <term><errorname>BadWindow</errorname></term> + <listitem><para>A value for a Window argument does not + name a defined window.</para></listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1> <title>See also</title> + <para><function>XDefineCursor</function>, <function>XUndefineCursor</function></para> + </refsect1> +</refentry> + +<refentry id="XWarpDevicePointer.man"> + <refentryinfo> + <productname>_vendorversion_</productname> + <pubdate>February 14, 2008</pubdate> + <authorgroup> + <author> + <firstname>Peter</firstname><surname>Hutterer</surname> + <contrib>Specification and implementation.</contrib> + <email>peter@cs.unisa.edu.au</email> + </author> + </authorgroup> + </refentryinfo> + + <refmeta> + <refentrytitle>XWarpDevicePointer</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + <refnamediv> + <refname>XWarpDevicePointer</refname> + <refpurpose>move device pointer.</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Syntax</title> + <funcsynopsis> + <funcsynopsisinfo>#include <X11/extensions/XInput.h></funcsynopsisinfo> + <funcprototype> + <funcdef>Bool <function>XWarpDevicePointer</function></funcdef> + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef>XDevice *<parameter>device</parameter></paramdef> + <paramdef>Window <parameter>src_w</parameter></paramdef> + <paramdef>Window <parameter>dest_w</parameter></paramdef> + <paramdef>int <parameter>src_x</parameter></paramdef> + <paramdef>int <parameter>src_y</parameter></paramdef> + <paramdef>int <parameter>src_width</parameter></paramdef> + <paramdef>int <parameter>src_height</parameter></paramdef> + <paramdef>int <parameter>dest_x</parameter></paramdef> + <paramdef>int <parameter>dest_y</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + + <refsect1><title>Arguments</title> + <para> + <variablelist> + <varlistentry> + <term><parameter>dest_w</parameter></term> + <listitem> + <para> + Specifies the destination window or <constant>None</constant>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dest_x</parameter></term> + <term><parameter>dest_y</parameter></term> + <listitem> + <para> + Specify the x and y coordinates within the + destination window. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>device</parameter></term> + <listitem><para>Specifies the device to move.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>display</parameter></term> + <listitem><para>Specifies the connection to the X server.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>src_x</parameter></term> + <term><parameter>src_y</parameter></term> + <term><parameter>src_width</parameter></term> + <term><parameter>src_height</parameter></term> + <listitem> + <para> + Specify a rectangle in the source window. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>src_w</parameter></term> + <listitem> + <para> + Specifies the source window or + <constant>None</constant>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1><title>Description</title> + <para> + If <parameter>dest_w</parameter> is <constant>None</constant>, <function>XWarpDevicePointer</function> moves the pointer by the offsets + (<parameter>dest_x</parameter>, <parameter>dest_y</parameter>) relative to the current position of the pointer. If + <parameter>dest_w</parameter> is a window, <function>XWarpDevicePointer</function> moves the pointer to the offsets + (<parameter>dest_x</parameter>, <parameter>dest_y</parameter>) + relative to the origin of <parameter>dest_w</parameter>. + However, if <parameter>src_w</parameter> is a window, the move + only takes place if the window <parameter>src_w</parameter> + contains the pointer and if the specified rectangle of + <parameter>src_w</parameter> contains the pointer. + </para> + <para> + The <parameter>src_x</parameter> and <parameter>src_y</parameter> coordinates are relative to the origin of <parameter>src_w</parameter>. + If <parameter>src_height</parameter> is zero, it is replaced with the current height of <parameter>src_w</parameter> + minus <parameter>src_y</parameter>. If <parameter>src_w</parameter>idth is zero, it is replaced with the current + width of <parameter>src_w</parameter> minus <parameter>src_x</parameter>. + </para> + <para> + There is seldom any reason for calling this function. The pointer + should normally be left to the user. If you do use this function, + however, it generates events just as if the user had + instantaneously moved the pointer from one position to another. + Note that you cannot use <function>XWarpDevicePointer</function> to move the pointer outside + the confine_to window of an active pointer grab. An attempt to do + so will only move the pointer as far as the closest edge of the + confine_to window. + </para> + <para> + <function>XWarpDevicePointer</function> is identical to + <function>XWarpPointer</function> but specifies the device + explicitly. + </para> + <para> + <function>XWarpDevicePointer</function> can generate a + <errorname>BadDevice</errorname> and a + <errorname>BadWindow</errorname> error. + </para> + </refsect1> + + <refsect1><title>Diagnosis</title> + <para> + <variablelist> + <varlistentry> + <term><errorname>BadDevice</errorname></term> + <listitem><para>An invalid device was specified. The + device does not exist or is not a pointer + device.</para></listitem> + + </varlistentry> + <varlistentry> + <term><errorname>BadWindow</errorname></term> + <listitem><para>A value for a Window argument does not + name a defined window.</para></listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1><title>See also</title> + <para><function>XWarpPointer</function></para> + </refsect1> +</refentry> + +<refentry id="XChangeDeviceHierarchy.man"> + <refentryinfo> + <productname>_vendorversion_</productname> + <pubdate>February 14, 2008</pubdate> + <authorgroup> + <author> + <firstname>Peter</firstname><surname>Hutterer</surname> + <contrib>Specification and implementation.</contrib> + <email>peter@cs.unisa.edu.au</email> + </author> + </authorgroup> + </refentryinfo> + + <refmeta> + <refentrytitle>XChangeDeviceHierarchy</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + <refnamediv> + <refname>XChangeDeviceHierarchy</refname> + <refpurpose>change the device hierarchy.</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Syntax</title> + <funcsynopsis> + <funcsynopsisinfo>#include <X11/extensions/XInput.h></funcsynopsisinfo> + <funcprototype> + <funcdef>Status <function>XChangeDeviceHierarchy</function></funcdef> + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef>XAnyHierarchyChangeInfo *<parameter>changes</parameter></paramdef> + <paramdef>int <parameter>num_changes</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + + <refsect1><title>Arguments</title> + <para> + <variablelist> + <varlistentry> + <term><parameter>display</parameter></term> + <listitem><para>Specifies the connection to the X server.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>num_changes</parameter></term> + <listitem> + <para> + Specifies the number of elements in changes. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>changes</parameter></term> + <listitem> + <para> + Specifies the changes to be made. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1><title>Description</title> + <para> + <function>XChangeDeviceHierarchy</function> modifies the device + hierarchy by creating or removing master devices or changing the + attachment of slave devices. If <parameter>num_changes</parameter> + is non-zero, <parameter>changes</parameter> is an array of + <type>XAnyHierarchyChangeInfo</type> structures. + </para> + <para> + <function>XChangeDeviceHierarchy</function> processes + <parameter>changes</parameter> in order, effective immediately. If + an error occurs, processing is aborted and the error is reported + to the client. Changes already made remain effective. + </para> + <para> + The list of <parameter>changes</parameter> is any combination of + <structname>XAnyHierarchyChangeInfo</structname>. The + <structfield>type</structfield> of a hierarchy change can be + <constant>CH_CreateMasterDevice</constant>, + <constant>CH_RemoveMasterDevice</constant> or + <constant>CH_ChangeAttachment</constant>. + </para> + <para> + <synopsis> +typedef union { + int <structfield>type</structfield>; + <structfield>XCreateMasterInfo</structfield> create; + <structfield>XRemoveMasterInfo</structfield> remove; + <structfield>XChangeAttachmentInfo</structfield> change; +} <structname>XAnyHierarchyChangeInfo</structname>; + </synopsis> + </para> + <para> + <synopsis> +typedef struct { + int <structfield>type</structfield>; /* <constant>CH_CreateMasterDevice</constant> */ + char* <structfield>name</structfield>; + Bool <structfield>sendCore</structfield>; + Bool <structfield>enable</structfield>; +} <structname>XCreateMasterInfo</structname>; + </synopsis> + </para> + <para> + <synopsis> +typedef struct { + int <structfield>type</structfield>; /* <constant>CH_RemoveMasterDevice</constant> */ + XDevice* <structfield>device</structfield>; + int <structfield>returnMode</structfield>; + XDevice* <structfield>returnPointer</structfield>; + XDevice* <structfield>returnKeyboard</structfield>; +} <structname>XRemoveMasterInfo</structname>; + </synopsis> + </para> + <para> + <synopsis> +typedef struct { + int <structfield>type</structfield>; /* <constant>CH_ChangeAttachment</constant> */ + XDevice* <structfield>device</structfield>; + int <structfield>changeMode</structfield>; + XDevice* <structfield>newMaster</structfield>; +} <structname>XChangeAttachmentInfo</structname>; + </synopsis> + </para> + <para> + <structname>XCreateMasterInfo</structname> creates a new master + pointer and a new master keyboard labelled + "<structfield>name</structfield> pointer" and + "<structfield>name</structfield> keyboard" respectively. If + <structfield>sendCore</structfield> is <constant>True</constant>, the + devices will send core events. If <structfield>enable</structfield> is + <constant>True</constant>, the device is enabled immediately. + </para> + <para> + <structname>XCreateMasterInfo</structname> can generate a + <errorname>BadValue</errorname> error. + </para> + <para> + <structname>XRemoveMasterInfo</structname> removes + <structfield>device</structfield> and its paired master device. If + <structfield>returnMode</structfield> is + <constant>AttachToMaster</constant>, all pointers attached to + <structfield>device</structfield> or its paired master device are + attached to <structfield>returnPointer</structfield>. Likewise, all + keyboards are attached to + <structfield>returnKeyboard</structfield>. + If <structfield>returnMode</structfield> is + <constant>Floating</constant>, all attached devices are set to + floating. + </para> + <para> + <structname>XRemoveMasterInfo</structname> can generate a + <errorname>BadValue</errorname> and a + <errorname>BadDevice</errorname> error. + </para> + <para> + <structname>XChangeAttachmentInfo</structname> changes the + attachment of <structfield>device</structfield> to + <structfield>newMaster</structfield> if + <structfield>changeMode</structfield> is + <constant>AttachToMaster</constant>. Otherwise, if + <structfield>changeMode</structfield> is + <constant>Floating</constant>, <structfield>device</structfield> + is set floating. + </para> + <para> + <function>XChangeAttachmentInfo</function> can generate a + <errorname>BadDevice</errorname> and a + <errorname>BadValue</errorname> error. + </para> + </refsect1> + + + <refsect1><title>Diagnosis</title> + <para> + <variablelist> + <varlistentry> + <term><errorname>BadDevice</errorname></term> + <listitem> + <para> + An invalid device was specified. The device does + not exist or is not a appropriate for the type of + change. + </para> + </listitem> + + </varlistentry> + <varlistentry> + <term><errorname>BadValue</errorname></term> + <listitem> + <para> + Some numeric value falls out of the allowed range. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> +</refentry> + +<refentry id="XPermitDevices.man"> + <refentryinfo> + <productname>_vendorversion_</productname> + <pubdate>February 14, 2008</pubdate> + <authorgroup> + <author> + <firstname>Peter</firstname><surname>Hutterer</surname> + <contrib>Specification and implementation.</contrib> + <email>peter@cs.unisa.edu.au</email> + </author> + </authorgroup> + </refentryinfo> + + <refmeta> + <refentrytitle>XPermitDevices, XDenyDevices, XChangeAccessRule</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + <refnamediv> + <refname>XPermitDevices, XDenyDevices, XChangeAccessRule + </refname> + <refpurpose>change access rules to the window.</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Syntax</title> + <funcsynopsis> + <funcsynopsisinfo>#include <X11/extensions/XInput.h></funcsynopsisinfo> + <funcprototype> + <funcdef>Status <function>XPermitDevices</function></funcdef> + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef>Window <parameter>win</parameter></paramdef> + <paramdef>XID* <parameter>deviceids</parameter></paramdef> + <paramdef>int <parameter>num_devices</parameter></paramdef> + </funcprototype> + <funcprototype> + <funcdef>Status <function>XDenyDevices</function></funcdef> + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef>Window <parameter>win</parameter></paramdef> + <paramdef>XID* <parameter>deviceids</parameter></paramdef> + <paramdef>int <parameter>num_devices</parameter></paramdef> + </funcprototype> + <funcprototype> + <funcdef>Status <function>XChangeAccessRule</function></funcdef> + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef>Window <parameter>win</parameter></paramdef> + <paramdef>int <parameter>rule</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + + <refsect1><title>Arguments</title> + <para> + <variablelist> + <varlistentry> + <term><parameter>deviceids</parameter></term> + <listitem><para>Specifies a list of device IDs to deny/restrict + access.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>display</parameter></term> + <listitem><para>Specifies the connection to the X server.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>num_devices</parameter></term> + <listitem><para>Specifies the number of elements in + <parameter>deviceids</parameter>.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>rule</parameter></term> + <listitem> + <para>Specifies the default access rule for <parameter>win</parameter>.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><parameter>win</parameter></term> + <listitem> + <para> + Specifies the window. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1><title>Description</title> + <para> + Each window features an Access Control List (ACL) to permit or deny + devices from sending events from this window. This is intended to + be used to restrict devices from accessing certain UI elements + in a multi-user environment. It is not to be used as a security + feature. + </para> + <para> + Access rules work hierarchically and if any parent window has an + access rule defined, it applies to all child windows unless + overridden in the child window. + </para> + <para> + Each window's default rule determines the default access mode. If + the default rule is <constant>WindowAccessDenyAll</constant>, no + device can send events to this window. If the default rule is + <constant>WindowAccessNoRule</constant>, any device can access the + window, unless a parent has + <constant>WindowAccessDenyAll</constant> set. If the default rule + is <constant>WindowAccessAllowAll</constant>, any device can + access the window. + </para> + <para> + If a device is specified in the window's deny list, it is denied + access to this window, regardless of the access rule. + If a device is specified in the window's perm list, this + device is allowed to access this window regardless of the parent + window's settings, the deny list, and the default rule. + </para> + <para> + <function>XPermitDevices</function> and + <function>XDenyDevices</function> set the window's perm list + or deny list to the devices specified in + <parameter>deviceids</parameter>. Any previous setting is + overwritten. + </para> + <para> + <function>XPermitDevices</function> and + <function>XDenyDevices</function> can generate a + <errorname>BadDevice</errorname> and a + <errorname>BadWindow</errorname> error. + </para> + <para> + <function>XChangeAccessRule</function> sets the default acess rule + for <parameter>window</parameter>. If <parameter>rule</parameter> + is <constant>WindowAccessDenyAll</constant>, all devices are + denied access to this window. If <parameter>rule</parameter> is + <constant>WindowAccessAllowAll</constant>, all devices are + permitted access to this window. Otherwise, if + <constant>WindowAccessNoRule</constant> is given, the default rule + is reset and all devices are able to send events to the window + unless a parent window restricts access. + </para> + <para> + <function>XChangeAccessRule</function> can generate a + <errorname>BadDevice</errorname> and a + <errorname>BadValue</errorname> error. + </para> + </refsect1> + + <refsect1><title>Diagnosis</title> + <para> + <variablelist> + <varlistentry> + <term><errorname>BadDevice</errorname></term> + <listitem><para>An invalid device was specified. The + device does not exist.</para></listitem> + + </varlistentry> + <varlistentry> + <term><errorname>BadWindow</errorname></term> + <listitem><para>A value for a Window argument does not + name a defined window.</para></listitem> + </varlistentry> + <varlistentry> + <term><errorname>BadValue</errorname></term> + <listitem><para>Some numeric value falls out of the + allowed range.</para></listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1><title>See also</title> + <para> + <function>XWindowClearAccess</function>, + <function>XQueryWindowAccess</function> + </para> + </refsect1> +</refentry> + +<refentry id="XWindowClearAccess.man"> + <refentryinfo> + <productname>_vendorversion_</productname> + <pubdate>February 14, 2008</pubdate> + <authorgroup> + <author> + <firstname>Peter</firstname><surname>Hutterer</surname> + <contrib>Specification and implementation.</contrib> + <email>peter@cs.unisa.edu.au</email> + </author> + </authorgroup> + </refentryinfo> + + <refmeta> + <refentrytitle>XWindowClearAccess</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + <refnamediv> + <refname>XWindowClearAccess</refname> + <refpurpose>remove access rules for the window.</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Syntax</title> + <funcsynopsis> + <funcsynopsisinfo>#include <X11/extensions/XInput.h></funcsynopsisinfo> + <funcprototype> + <funcdef>Status <function>XWindowClearAccess</function></funcdef> + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef>Window <parameter>win</parameter></paramdef> + <paramdef>int <parameter>what</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + + <refsect1><title>Arguments</title> + <para> + <variablelist> + <varlistentry> + <term><parameter>display</parameter></term> + <listitem><para>Specifies the connection to the X server.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>what</parameter></term> + <listitem><para>Specifies the access restrictions to + remove.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>win</parameter></term> + <listitem> + <para> + Specifies the window. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1><title>Description</title> + <para> + <function>XWindowClearAccess</function> removes an access control + restriction from <parameter>window</parameter>. The bitmask + <parameter>what</parameter> defines which restrictions to remove. + </para> + <para> + If <constant>WindowAccessClearPerm</constant> is set, the + perm list of <parameter>win</parameter> is removed. If + <constant>WindowAccessClearDeny</constant> is set, the deny list + of <parameter>win</parameter> is removed. If + <constant>WindowAccessClearRule</constant> is set, the default + rule of the window is set to + <constant>WindowAccessNoRule</constant>. If + <parameter>what</parameter> is equal to + <constant>WindowAccessClearAll</constant>, the window is reset to + the neutral state (neither explicitly permitting nor denying + access). + </para> + <para> + <function>XWindowClearAccess</function> can generate a + <errorname>BadValue</errorname> and a + <errorname>BadWindow</errorname> error. + </para> + </refsect1> + + <refsect1><title>Diagnosis</title> + <para> + <variablelist> + <varlistentry> + <term><errorname>BadValue</errorname></term> + <listitem><para>A value is outside of the permitted range. </para></listitem> + + </varlistentry> + <varlistentry> + <term><errorname>BadWindow</errorname></term> + <listitem><para>A value for a Window argument does not + name a defined window.</para></listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1><title>See also</title> + <para> + <function>XPermitDevices</function>, + <function>XDenyDevices</function>, + <function>XChangeAccessRule</function>, + <function>XQueryWindowAccess</function> + </para> + </refsect1> +</refentry> + +<refentry id="XQueryWindowAccess.man"> + <refentryinfo> + <productname>_vendorversion_</productname> + <pubdate>February 14, 2008</pubdate> + <authorgroup> + <author> + <firstname>Peter</firstname><surname>Hutterer</surname> + <contrib>Specification and implementation.</contrib> + <email>peter@cs.unisa.edu.au</email> + </author> + </authorgroup> + </refentryinfo> + + <refmeta> + <refentrytitle>XQueryWindowAccess</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + <refnamediv> + <refname>XQueryWindowAccess</refname> + <refpurpose>query access rules of the window.</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Syntax</title> + <funcsynopsis> + <funcsynopsisinfo>#include <X11/extensions/XInput.h></funcsynopsisinfo> + <funcprototype> + <funcdef>Status <function>XQueryWindowAccess</function></funcdef> + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef>Window <parameter>win</parameter></paramdef> + <paramdef>int *<parameter>rule_return</parameter></paramdef> + <paramdef>XID **<parameter>permdevices_return</parameter></paramdef> + <paramdef>int *<parameter>nperm_return</parameter></paramdef> + <paramdef>XID **<parameter>denydevices_return</parameter></paramdef> + <paramdef>int *<parameter>ndeny_return</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + + <refsect1><title>Arguments</title> + <para> + <variablelist> + <varlistentry> + <term><parameter>display</parameter></term> + <listitem><para>Specifies the connection to the X server.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>rule_return</parameter></term> + <listitem><para>The default rule of the window.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>permdevices_return</parameter></term> + <listitem><para>List of devices explicitly allowed to access the + window.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>denydevices_return</parameter></term> + <listitem><para>List of devices explicitly denied access the + window.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>nperm_return</parameter></term> + <listitem><para>Number of elements in + <parameter>permdevices_return</parameter>.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>ndeny_return</parameter></term> + <listitem><para>Number of elements in + <parameter>denydevices_return</parameter>.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>win</parameter></term> + <listitem> + <para> + Specifies the window. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1><title>Description</title> + <para> + <function>XQueryWindowAccess</function> queries + <parameter>win</parameter> for its current access control + restriction settings. + </para> + <para> + The value of <parameter>rule_return</parameter> can be either + <constant>WindowAccessNoRule</constant> or + <constant>WindowAccessDenyAll</constant>. + </para> + <para> + If <parameter>nperm_return</parameter> is non-zero, + <parameter>permdevices_return</parameter> points to a list of + device IDs that are permitted access to the window. + </para> + <para> + If <parameter>ndeny_return</parameter> is non-zero, + <parameter>denydevices_return</parameter> points to a list of + device IDs that are denied access to the window. + </para> + <para> + It is the caller's responsibility to free the memory returned in + <parameter>permdevices_return</parameter> and + <parameter>denydevices_return</parameter>. + </para> + <para> + <function>XQueryWindowAccess</function> can generate a + <errorname>BadWindow</errorname> error. + </para> + </refsect1> + + <refsect1><title>Diagnosis</title> + <para> + <variablelist> + <varlistentry> + <term><errorname>BadWindow</errorname></term> + <listitem><para>A value for a Window argument does not + name a defined window.</para></listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1><title>See also</title> + <para> + <function>XPermitDevices</function>, + <function>XDenyDevices</function>, + <function>XChangeAccessRule</function>, + <function>XWindowClearAcess</function> + </para> + </refsect1> +</refentry> + +<refentry id="XiSelectEvent.man"> + <refentryinfo> + <productname>_vendorversion_</productname> + <pubdate>February 14, 2008</pubdate> + <authorgroup> + <author> + <firstname>Peter</firstname><surname>Hutterer</surname> + <contrib>Specification and implementation.</contrib> + <email>peter@cs.unisa.edu.au</email> + </author> + </authorgroup> + </refentryinfo> + + <refmeta> + <refentrytitle>XiSelectEvent</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + <refnamediv> + <refname>XiSelectEvent</refname> + <refpurpose>select for generic events on the window.</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Syntax</title> + <funcsynopsis> + <funcsynopsisinfo>#include <X11/extensions/XInput.h></funcsynopsisinfo> + <funcprototype> + <funcdef>Status <function>XiSelectEvent</function></funcdef> + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef>Window <parameter>win</parameter></paramdef> + <paramdef>XDevice *<parameter>device</parameter></paramdef> + <paramdef>Mask <parameter>mask</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + + <refsect1><title>Arguments</title> + <para> + <variablelist> + <varlistentry> + <term><parameter>display</parameter></term> + <listitem><para>Specifies the connection to the X server.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>device</parameter></term> + <listitem><para>The device to select + <parameter>mask</parameter> for. May be + <constant>NULL</constant>.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>mask</parameter></term> + <listitem><para>Generic event mask.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>win</parameter></term> + <listitem> + <para> + Specifies the window. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1><title>Description</title> + <para> + Events available through the X Generic Event extension (XGE) + cannot be selected with <function>XSelectExtensionEvent</function>. + For these events, <function>XiSelectEvent</function> must be used. + </para> + <para> + <function>XiSelectEvent</function> causes the X server to report + the events defined by <parameter>mask</parameter> on + <parameter>win</parameter>. The <parameter>mask</parameter> + overrides the previously selected event mask. A + <parameter>mask</parameter> of zero de-registers + <parameter>win</parameter> from any generic + events. + </para> + <para> + If <parameter>device</parameter> is a valid device, the event mask + is selected only for this device. If + <parameter>device</parameter> is <constant>NULL</constant>, the + event mask is selected for all devices. + </para> + <para> + A <parameter>mask</parameter> set for a device is stored + seperately for the mask for all devices. Thus, if a mask is set + for all devices, it cannot be unset for a single device. It has to + be unset for all devices first by supplying + <constant>NULL</constant> and then re-set one-by-one for all + devices. + </para> + <para> + <function>XiSelectEvent</function> can generate a + <errorname>BadValue</errorname>, a + <errorname>BadDevice</errorname>, and a + <errorname>BadWindow</errorname> error. + </para> + </refsect1> + + <refsect1><title>Diagnosis</title> + <para> + <variablelist> + <varlistentry> + <term><errorname>BadValue</errorname></term> + <listitem><para>A value is outside of the permitted range. </para></listitem> + </varlistentry> + <varlistentry> + <term><errorname>BadWindow</errorname></term> + <listitem><para>A value for a Window argument does not + name a defined window.</para></listitem> + </varlistentry> + <varlistentry> + <term><errorname>BadDevice</errorname></term> + <listitem><para>An invalid device was specified. The + device does not exist.</para></listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1><title>See also</title> + <para> + <function>XSelectExtensionEvent</function> + </para> + </refsect1> +</refentry> + +<refentry id="XExtendedGrabDevice.man"> + <refentryinfo> + <productname>_vendorversion_</productname> + <pubdate>February 14, 2008</pubdate> + <authorgroup> + <author> + <firstname>Peter</firstname><surname>Hutterer</surname> + <contrib>Specification and implementation.</contrib> + <email>peter@cs.unisa.edu.au</email> + </author> + </authorgroup> + </refentryinfo> + + <refmeta> + <refentrytitle>XExtendedGrabDevice</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + <refnamediv> + <refname>XExtendedGrabDevice</refname> + <refpurpose>actively grab the device.</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Syntax</title> + <funcsynopsis> + <funcsynopsisinfo>#include <X11/extensions/XInput.h></funcsynopsisinfo> + <funcprototype> + <funcdef>Status <function>XExtendedGrabDevice</function></funcdef> + <paramdef>Display *<parameter>display</parameter></paramdef> + <paramdef>XDevice *<parameter>device</parameter></paramdef> + <paramdef>Window <parameter>grab_window</parameter></paramdef> + <paramdef>int <parameter>device_mode</parameter></paramdef> + <paramdef>Bool <parameter>owner_events</parameter></paramdef> + <paramdef>Window <parameter>confine_to</parameter></paramdef> + <paramdef>Cursor <parameter>cursor</parameter></paramdef> + <paramdef>int <parameter>event_count</parameter></paramdef> + <paramdef>XEventClass *<parameter>event_list</parameter></paramdef> + <paramdef>int <parameter>generic_event_count</parameter></paramdef> + <paramdef>XGenericEventMask *<parameter>generic_events</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + + <refsect1><title>Arguments</title> + <para> + <variablelist> + <varlistentry> + <term><parameter>confine_to</parameter></term> + <listitem><para>Specifies the window to confine the pointer + in or <constant>None</constant>.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>cursor</parameter></term> + <listitem><para>Specifies the cursor that is to be + displayed during the grab or <constant>None</constant>.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>display</parameter></term> + <listitem><para>Specifies the connection to the X server.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>device</parameter></term> + <listitem><para>The device to grab.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>device_mode</parameter></term> + <listitem><para>Specifies further processing of device + events. You can pass <constant>GrabModeSync</constant> or + <constant>GrabModeAsync</constant>.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>event_count</parameter></term> + <listitem><para>Specifies the number of elements in the event_list array.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>event_list</parameter></term> + <listitem><para>Specifies a pointer to a list of event + classes that indicates which events the client wishes to receive. These event + classes must have been obtained specifying the device being grabbed. + </para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>generic_event_count</parameter></term> + <listitem><para>Specifies the number of elements in the generic_event_list array.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>generic_event_list</parameter></term> + <listitem><para>Specifies a pointer to a list of generic event masks + that indicates which generic events the client wishes to receive. + </para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>grab_window</parameter></term> + <listitem><para>Specifies the grab window.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>time</parameter></term> + <listitem><para>Specifies the time. You can pass either a timestamp or <constant>CurrentTime</constant>.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>owner_events</parameter></term> + <listitem><para>Specifies a Boolean value that indicates + whether the pointer events are to be reported as usual or reported with respect + to the grab window if selected by the event mask.</para></listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1><title>Description</title> + <para> + The <function>XExtendedGrabDevice</function> request actively grabs control + of the device and generates <function>DeviceFocusIn</function> and + <function>DeviceFocusOut</function> events if the device is a keyboard and + <function>DeviceEnterNotify</function> and + <function>DeviceLeaveNotify</function> if the device is a pointer. Further + device events are reported only to the grabbing client. + <function>XExtendedGrabDevice</function> overrides any active device grab by + this client. <parameter>event_list</parameter> is a pointer to a list of event + classes. This list indicates which events the client wishes to receive + while the grab is active. <parameter>generic_event_list</parameter> is + a pointer to a list of generic event masks. These masks indicates which generic + events the client wishes to receive while the grab is active. + If <parameter>owner_events</parameter> is <constant>False</constant>, all generated device + events are reported with respect to grab_window if selected. If owner_events + is <constant>True</constant> and if a generated device event would normally be reported + to this client, it is reported normally; otherwise, the event is + reported with respect to the <parameter>grab_window</parameter>, and is only reported if specified in + the <parameter>event_list</parameter> or <parameter>generic_event_list</parameter>. + </para> + <para> + If the <parameter>device_mode</parameter> argument is + <constant>GrabModeAsync</constant>, device event processing continues as + usual. If the device is currently frozen by this client, then processing of + device events is resumed. If the <parameter>device_mode</parameter> + argument is <constant>GrabModeSync</constant>, the state of the device (as + seen by client applications) appears to freeze, and the X server generates no + further device events until the grabbing client issues a releasing + <function>XAllowDeviceEvents</function> call or until the device grab is + released. Actual device changes are not lost while the device is frozen; they + are simply queued in the server for later processing. + </para> + <para> + If a cursor is specified and the device is a master pointer, it is + displayed regardless of what window the device's pointer is in. + If <constant>None</constant> is specified, the normal cursor for that window is + displayed when the pointer is in <parameter>grab_window</parameter> or one of its + subwindows; otherwise, the cursor for <parameter>grab_window</parameter> is displayed. + </para> + <para> + If a <parameter>confine_to</parameter> window is specified and the device is a master + pointer, the device's pointer is restricted to stay contained in + that window. The <parameter>confine_to</parameter> window need have no + relationship to the <parameter>grab_window</parameter>. If the + pointer is not initially in the <parameter>confine_to</parameter> + window, it is warped automatically to the closest edge just before + the grab activates and enter/leave events are generated as usual. + If the <parameter>confine_to</parameter> window is subsequently + reconfigured, the pointer is warped automatically, as + necessary, to keep it contained in the window. + </para> + <para> + The <parameter>time</parameter> argument allows you to avoid + certain circumstances that come up if applications take a long + time to respond or if there are long network delays. Consider a + situation where you have two applications, both of which normally + grab the pointer when clicked on. If both applications specify + the timestamp from the event, the second application may wake up + faster and successfully grab the pointer before the first + application. The first application then will get an indication + that the other application grabbed the pointer before its request + was processed. + </para> + <para> + If the device is actively grabbed by some other client, + <function>XExtendedGrabDevice</function> fails and returns + <constant>AlreadyGrabbed</constant>. If + <parameter>grab_window</parameter> is not viewable, it fails and + returns <constant>GrabNotViewable</constant>. If the device is + frozen by an active grab of another client, it fails and returns + <constant>GrabFrozen</constant>. If the specified time is earlier + than the last-device-grab time or later than the current X server + time, it fails and returns <constant>GrabInvalidTime</constant>. + Otherwise, the last-device-grab time is set to the specified time + (<constant>CurrentTime</constant> is replaced by the current X + server time). + </para> + <para> + <function>XExtendedGrabDevice</function> is mostly identical to + <function>XGrabPointer</function> and + <function>XGrabDevice</function> but enables a client to register + for generic event masks. + </para> + <para> + <function>XExtendedGrabDevice</function> can generate a + <errorname>BadValue</errorname>, a + <errorname>BadDevice</errorname>, and a + <errorname>BadWindow</errorname> error. + </para> + </refsect1> + + <refsect1><title>Diagnosis</title> + <para> + <variablelist> + <varlistentry> + <term><errorname>BadValue</errorname></term> + <listitem><para>A value is outside of the permitted range. </para></listitem> + </varlistentry> + <varlistentry> + <term><errorname>BadWindow</errorname></term> + <listitem><para>A value for a Window argument does not + name a defined window.</para></listitem> + </varlistentry> + <varlistentry> + <term><errorname>BadDevice</errorname></term> + <listitem><para>An invalid device was specified. The + device does not exist.</para></listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1><title>See also</title> + <para> + <function>XGrabDevice</function>, + <function>XUngrabDevice</function>, + <function>XGrabPointer</function> + </para> + </refsect1> +</refentry> +</reference> |