From b620f6995b76742c95b32db054d0b5d9fef7a33d Mon Sep 17 00:00:00 2001 From: Peter Hutterer Date: Sun, 27 Apr 2008 18:57:48 +0930 Subject: man: fixes in XI.xml Some global whitespace replacements (e.g. space before comma) Splitting refnames where two functions are listed. Adding refmiscinfo tags (see libXtst) --- man/XI.xml | 858 +++++++++++++++++++++++++++++++++---------------------------- 1 file changed, 466 insertions(+), 392 deletions(-) (limited to 'man') diff --git a/man/XI.xml b/man/XI.xml index 5002be6..5eb8a0e 100644 --- a/man/XI.xml +++ b/man/XI.xml @@ -2,17 +2,19 @@ -X Input Extension Library (MPX) +X Input Extension Library - _vendorversion_ + __vendorversion__ XAllowDeviceEvents - 3 - + __libmansuffix__ + __xorgversion__ + XINPUT FUNCTIONS + XAllowDeviceEvents release queued events @@ -42,49 +44,49 @@ Specifies the device from which events are to be allowed. event_mode - Specifies the event mode.You can pass AsyncThisDevice , SyncThisDevice , ReplayThisDevice , AsyncOtherDevices , SyncAll ,or AsyncAll . + Specifies the event mode.You can pass AsyncThisDevice, SyncThisDevice, ReplayThisDevice, AsyncOtherDevices, SyncAll,or AsyncAll. time - Specifies the time.You can pass either a timestamp or CurrentTime . + Specifies the time.You can pass either a timestamp or CurrentTime. Description - The XAllowDeviceEvents 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. + The XAllowDeviceEvents 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. - The following describes the processing that occurs depending on what constant you pass to the event_mode argument. + The following describes the processing that occurs depending on what constant you pass to the event_mode argument. - AsyncThisDevice 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, AsyncThisDevice thaws for all. AsyncThisDevice has no effect if the specified device is not frozen by the client, but the device need not be grabbed by the client. + AsyncThisDevice 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, AsyncThisDevice thaws for all.AsyncThisDevice has no effect if the specified device is not frozen by the client, but the device need not be grabbed by the client. - SyncThisDevice 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. SyncThisDevice has no effect if the specified device is not frozen by the client or is not grabbed by the client. + SyncThisDevice 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. SyncThisDevice has no effect if the specified device is not frozen by the client or is not grabbed by the client. - ReplayThisDevice 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. + ReplayThisDevice 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. - AsyncOtherDevices 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, AsyncOtherDevices "thaws" for all. AsyncOtherDevices has no effect if the devices are not frozen by the client. + AsyncOtherDevices 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, AsyncOtherDevices "thaws" for all. AsyncOtherDevices has no effect if the devices are not frozen by the client. - SyncAll 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. SyncAll 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, SyncAll thaws for both. A subsequent freeze for SyncAll will only freeze each device once. + SyncAll 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. SyncAll 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, SyncAll thaws for both. A subsequent freeze for SyncAll will only freeze each device once. - AsyncAll 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, AsyncAll thaws for all. AsyncAll has no effect unless all devices are frozen by the client. + AsyncAll 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, AsyncAll thaws for all. AsyncAll has no effect unless all devices are frozen by the client. - AsyncThisDevice, SyncThisDevice, and ReplayThisDevice have no effect on the processing of events from the remaining devices. AsyncOtherDevices has no effect on the processing of events from the specified device. When the event_mode is SyncAll or AsyncAll, the device parameter is ignored. + AsyncThisDevice, SyncThisDevice, and ReplayThisDevice have no effect on the processing of events from the remaining devices.AsyncOtherDevices has no effect on the processing of events from the specified device. When the event_mode is SyncAll or AsyncAll, the device parameter is ignored. - 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. + 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. - XAllowDeviceEvents can generate a BadDevice or BadValue error. + XAllowDeviceEvents can generate a BadDevice or BadValue error. Diagnostics BadDevice - An invalid device was specified. The specified device does not exist or has not been opened by this client via XOpenInputDevice . This error may also occur if the specified device is the X keyboard or X pointer device. + An invalid device was specified. The specified device does not exist or has not been opened by this client via XOpenInputDevice. This error may also occur if the specified device is the X keyboard or X pointer device. BadValue - An invalid mode was specified on the request. + An invalid mode was specified on the request. @@ -98,15 +100,18 @@ - _vendorversion_ + __vendorversion__ XChangeDeviceDontPropagateList - 3 - + __libmansuffix__ + __xorgversion__ + XINPUT FUNCTIONS + - XChangeDeviceDontPropagateList, XGetDeviceDontPropagateList + XChangeDeviceDontPropagateList + XGetDeviceDontPropagateList query or change the dont-propagate-list for extension devices @@ -153,37 +158,37 @@ Description - The XChangeDeviceDontPropagateList 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. + The XChangeDeviceDontPropagateList 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. - Suppression of event propagation is not allowed for all input extension events. If a specified event class is one that cannot be suppressed, a BadClass error will result. Events that can be suppressed include DeviceKeyPress, DeviceKeyRelease, DeviceButtonPress, DeviceButtonRelease, DeviceMotionNotify, ProximityIn, and ProximityOut. + Suppression of event propagation is not allowed for all input extension events. If a specified event class is one that cannot be suppressed, a BadClass error will result. Events that can be suppressed include DeviceKeyPress, DeviceKeyRelease, DeviceButtonPress, DeviceButtonRelease, DeviceMotionNotify, ProximityIn, and ProximityOut. - XChangeDeviceDontPropagateList can generate a BadDevice, BadClass, or BadValue error. + XChangeDeviceDontPropagateList can generate a BadDevice, BadClass, or BadValue error. - The XGetDeviceDontPropagateList request queries the list of events that should not be propagated to ancestors of the event window. + The XGetDeviceDontPropagateList request queries the list of events that should not be propagated to ancestors of the event window. - XGetDeviceDontPropagateList can generate a BadClass or BadWindow error. + XGetDeviceDontPropagateList can generate a BadClass or BadWindow error. Diagnostics BadDevice - An invalid device was specified. The specified device does not exist or has not been opened by this client via XOpenInputDevice. 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 XChangeKeyboardDevice or XChangePointerDevice requests. + An invalid device was specified. The specified device does not exist or has not been opened by this client via XOpenInputDevice. 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 XChangeKeyboardDevice or XChangePointerDevice requests. BadValue - 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. + 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. BadWindow - An invalid window id was specified. + An invalid window id was specified. BadClass - An invalid event class was specified. + An invalid event class was specified. @@ -193,13 +198,15 @@ - _vendorversion_ + __vendorversion__ XChangeKeyboardDevice - 3 - + __libmansuffix__ + __xorgversion__ + XINPUT FUNCTIONS + XChangeKeyboardDevice change which device is used as the X keyboard @@ -229,25 +236,25 @@ Description - The XChangeKeyboardDevice 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 XOpenDevice or a BadDevice error will result. The device must support input class Keys, or a BadMatch error will result. If the server implementation does not support using the requested device as the X keyboard, a BadDevice error will result. + The XChangeKeyboardDevice 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 XOpenDevice or a BadDevice error will result. The device must support input class Keys, or a BadMatch error will result. If the server implementation does not support using the requested device as the X keyboard, a BadDevice error will result. - If the specified device is grabbed by another client, AlreadyGrabbed is returned. If the specified device is frozen by a grab on another device, GrabFrozen is returned. If the request is successful, Success is returned. + If the specified device is grabbed by another client, AlreadyGrabbed is returned. If the specified device is frozen by a grab on another device, GrabFrozen is returned. If the request is successful, Success is returned. - If the request succeeds, a ChangeDeviceNotify event is sent to all clients that have selected that event. A MappingNotify event with request = MappingKeyboard 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. + If the request succeeds, a ChangeDeviceNotify event is sent to all clients that have selected that event. A MappingNotify event with request = MappingKeyboard 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. - XChangeKeyboardDevice can generate a BadDevice or a BadMatch error. + XChangeKeyboardDevice can generate a BadDevice or a BadMatch error. Diagnostics BadDevice - An invalid device was specified. The specified device does not exist, has not been opened by this client via XOpenInputDevice, 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. + An invalid device was specified. The specified device does not exist, has not been opened by this client via XOpenInputDevice, 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. BadMatch - This error may occur if an XChangeKeyboardDevice request was made specifying a device that has no keys. + This error may occur if an XChangeKeyboardDevice request was made specifying a device that has no keys. @@ -260,13 +267,15 @@ - _vendorversion_ + __vendorversion__ XChangePointerDevice - 3 - + __libmansuffix__ + __xorgversion__ + XINPUT FUNCTIONS + XChangePointerDevice change which device is the X pointer @@ -305,25 +314,25 @@ Description - The XChangePointerDevice request causes the server to use the specified device as the X pointer. The device must have been opened by the client via XOpenDevice or a BadDevice error will result. The device must support input class Valuators or a BadMatch error will result. If the implementation does not support use of the specified device as the X pointer, a BadDevice error will result. + The XChangePointerDevice request causes the server to use the specified device as the X pointer. The device must have been opened by the client via XOpenDevice or a BadDevice error will result. The device must support input class Valuators or a BadMatch error will result. If the implementation does not support use of the specified device as the X pointer, a BadDevice error will result. - If the specified device is grabbed by another client, AlreadyGrabbed is returned. If the specified device is frozen by a grab on another device, GrabFrozen is returned. If the request is successful, Success is returned. + If the specified device is grabbed by another client, AlreadyGrabbed is returned. If the specified device is frozen by a grab on another device, GrabFrozen is returned. If the request is successful, Success is returned. - If the request succeeds, a ChangeDeviceNotify event is sent to all clients that have selected that event. A MappingNotify event with request = MappingPointer 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. + If the request succeeds, a ChangeDeviceNotify event is sent to all clients that have selected that event. A MappingNotify event with request = MappingPointer 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. - XChangePointerDevice can generate a BadDevice or a BadMatch error. + XChangePointerDevice can generate a BadDevice or a BadMatch error. Diagnostics BadDevice - An invalid device was specified. The specified device does not exist, has not been opened by this client via XOpenInputDevice, 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. + An invalid device was specified. The specified device does not exist, has not been opened by this client via XOpenInputDevice, 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. BadMatch - This error may occur if an XChangePointerDevice request was made specifying a device that has less than two valuators, or specifying a valuator index beyond the range supported by the device. + This error may occur if an XChangePointerDevice request was made specifying a device that has less than two valuators, or specifying a valuator index beyond the range supported by the device. @@ -337,13 +346,15 @@ - _vendorversion_ + __vendorversion__ XDeviceBell - 3 - + __libmansuffix__ + __xorgversion__ + XINPUT FUNCTIONS + XDeviceBell ring a bell on a device supported through the input extension @@ -387,27 +398,27 @@ Description - The XDeviceBell 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 BadDevice error will be returned. The feedbackclass and feedbackid parameters contain values returned by an XGetFeedbackControl 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 BadValue error will be returned. + The XDeviceBell 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 BadDevice error will be returned. The feedbackclass and feedbackid parameters contain values returned by an XGetFeedbackControl 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 BadValue error will be returned. The volume at which the bell is rung when the percent argument is nonnegative is: base \- [(base * percent) / 100] + percent The volume at which the bell rings when the percent argument is negative is: base + [(base * percent) / 100] - To change the base volume of the bell, use XChangeFeedbackControl . + To change the base volume of the bell, use XChangeFeedbackControl. - XDeviceBell can generate a BadDevice or a BadValue error. + XDeviceBell can generate a BadDevice or a BadValue error. Diagnostics BadDevice - An invalid device was specified. The specified device does not exist, or has not been opened by this client via XOpenInputDevice . + An invalid device was specified. The specified device does not exist, or has not been opened by this client via XOpenInputDevice. BadValue - An invalid feedbackclass, feedbackid, or percent value was specified. + An invalid feedbackclass, feedbackid, or percent value was specified. @@ -421,15 +432,18 @@ - _vendorversion_ + __vendorversion__ XGetDeviceControl - 3 - + __libmansuffix__ + __xorgversion__ + XINPUT FUNCTIONS + - XGetDeviceControl, XChangeDeviceControl + XGetDeviceControl + XChangeDeviceControl query and change input device controls @@ -472,19 +486,19 @@ Description - These requests are provided to manipulate those input devices that support device control. A BadMatch error will be generated if the requested device does not support any device controls. + These requests are provided to manipulate those input devices that support device control. A BadMatch error will be generated if the requested device does not support any device controls. Valid device control types that can be used with these requests include the following: - DEVICE_RESOLUTION Queries or changes the resolution of valuators on input devices. + DEVICE_RESOLUTION Queries or changes the resolution of valuators on input devices. - The XGetDeviceControl request returns a pointer to an XDeviceControl structure. + The XGetDeviceControl request returns a pointer to an XDeviceControl structure. - XGetDeviceControl can generate a BadDevice or BadMatch error. + XGetDeviceControl can generate a BadDevice or BadMatch error. - The XChangeDeviceControl request modifies the values of one control on the specified device. The control is identified by the id field of the XDeviceControl structure that is passed with the request. + The XChangeDeviceControl request modifies the values of one control on the specified device. The control is identified by the id field of the XDeviceControl structure that is passed with the request. - XChangeDeviceControl can generate a BadDevice, BadMatch, or BadValue error. .SH STRUCTURES Each control is described by a structure specific to that control. These structures are defined in the file XInput.h . + XChangeDeviceControl can generate a BadDevice, BadMatch, or BadValue error..SH STRUCTURES Each control is described by a structure specific to that control. These structures are defined in the file XInput.h. XDeviceControl is a generic structure that contains two fields that are at the beginning of each class of control: @@ -496,7 +510,7 @@ - The XDeviceResolutionState structure defines the information that is returned for device resolution for devices with valuators. + The XDeviceResolutionState structure defines the information that is returned for device resolution for devices with valuators. typedef struct { @@ -510,7 +524,7 @@ - The XDeviceResolutionControl structure defines the attributes that can be controlled for keyboard Devices. + The XDeviceResolutionControl structure defines the attributes that can be controlled for keyboard Devices. typedef struct { @@ -528,17 +542,17 @@ BadDevice - An invalid device was specified. The specified device does not exist or has not been opened by this client via XOpenInputDevice . 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 XChangeKeyboardDevice or XChangePointerDevice requests. + An invalid device was specified. The specified device does not exist or has not been opened by this client via XOpenInputDevice. 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 XChangeKeyboardDevice or XChangePointerDevice requests. BadMatch - This error may occur if an XGetDeviceControl request was made specifying a device that has no controls or an XChangeDeviceControl request was made with an XDeviceControl structure that contains an invalid Device type. It may also occur if an invalid combination of mask bits is specified ( DvKey but no DvAutoRepeatMode for keyboard Devices), or if an invalid KeySym is specified for a string Device. + This error may occur if an XGetDeviceControl request was made specifying a device that has no controls or an XChangeDeviceControl request was made with an XDeviceControl structure that contains an invalid Device type. It may also occur if an invalid combination of mask bits is specified ( DvKey but no DvAutoRepeatMode for keyboard Devices), or if an invalid KeySym is specified for a string Device. BadValue - Some numeric value falls outside the range of values accepted by the XChangeDeviceControl 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. + Some numeric value falls outside the range of values accepted by the XChangeDeviceControl 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. @@ -552,15 +566,18 @@ - _vendorversion_ + __vendorversion__ XGetDeviceKeyMapping - 3 - + __libmansuffix__ + __xorgversion__ + XINPUT FUNCTIONS + - XGetDeviceKeyMapping, XChangeDeviceKeyMapping + XGetDeviceKeyMapping + XChangeDeviceKeyMapping query or change device key mappings @@ -619,11 +636,11 @@ 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 - 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 NoSymbol is used to fill in unused elements for individual KeyCodes. To free the storage returned by XGetDeviceKeyMapping, use XFree. + 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 NoSymbol is used to fill in unused elements for individual KeyCodes. To free the storage returned by XGetDeviceKeyMapping, use XFree. - If the specified device does not support input class keys, a BadMatch error will result. + If the specified device does not support input class keys, a BadMatch error will result. - XGetDeviceKeyMapping can generate a BadDevice, BadMatch, or BadValue error. + XGetDeviceKeyMapping can generate a BadDevice, BadMatch, or BadValue error. For the specified device, the XChangeDeviceKeyMapping 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: @@ -637,13 +654,13 @@ (K - first_keycode) * keysyms_per_keycode + N - 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 NoSymbol should be used to fill in unused elements for individual KeyCodes. It is legal for NoSymbol to appear in nontrailing positions of the effective list for a KeyCode. XChangeDeviceKeyMapping generates a DeviceMappingNotify event that is sent to all clients that have selected that type of event. + 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 NoSymbol should be used to fill in unused elements for individual KeyCodes. It is legal for NoSymbol to appear in nontrailing positions of the effective list for a KeyCode.XChangeDeviceKeyMapping generates a DeviceMappingNotify event that is sent to all clients that have selected that type of event. - There is no requirement that the X server interpret this mapping. It is merely stored for reading and writing by clients. + There is no requirement that the X server interpret this mapping. It is merely stored for reading and writing by clients. - If the specified device does not support input class keys, a BadMatch error results. + If the specified device does not support input class keys, a BadMatch error results. - XChangeDeviceKeyMapping can generate a BadDevice, BadMatch, BadAlloc, or BadValue error. + XChangeDeviceKeyMapping can generate a BadDevice, BadMatch, BadAlloc, or BadValue error. @@ -652,22 +669,22 @@ BadDevice - An invalid device was specified. The specified device does not exist or has not been opened by this client via XOpenInputDevice . This error may also occur if the specified device is the X keyboard or X pointer device. + An invalid device was specified. The specified device does not exist or has not been opened by this client via XOpenInputDevice. This error may also occur if the specified device is the X keyboard or X pointer device. BadMatch - This error may occur if an XGetDeviceKeyMapping or XChangeDeviceKeyMapping request was made specifying a device that has no keys. + This error may occur if an XGetDeviceKeyMapping or XChangeDeviceKeyMapping request was made specifying a device that has no keys. BadValue - 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. + 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. BadAlloc - The server failed to allocate the requested resource or server memory. + The server failed to allocate the requested resource or server memory. @@ -681,15 +698,18 @@ - _vendorversion_ + __vendorversion__ XGetDeviceModifierMapping - 3 - + __libmansuffix__ + __xorgversion__ + XINPUT FUNCTIONS + - XGetDeviceModifierMapping, XSetDeviceModifierMapping + XGetDeviceModifierMapping + XSetDeviceModifierMapping query or change device modifier mappings @@ -727,16 +747,16 @@ Description - The XSetDeviceModifierMapping 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 DeviceMappingNotify event, and XSetDeviceModifierMapping returns MappingSuccess . X permits at most eight modifier keys. If more than eight are specified in the XModifierKeymap structure, a BadLength error results. + The XSetDeviceModifierMapping 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 DeviceMappingNotify event, and XSetDeviceModifierMapping returns MappingSuccess. X permits at most eight modifier keys. If more than eight are specified in the XModifierKeymap structure, a BadLength error results. - The modifiermap member of the XModifierKeymap structure contains eight sets of max_keypermod KeyCodes, one for each modifier in the order Shift, Lock, Control, Mod1, Mod2, Mod3, Mod4, and Mod5 . 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 XListInputDevices, or a BadValue error results. No KeyCode may appear twice in the entire map, or a BadValue error results. + The modifiermap member of the XModifierKeymap structure contains eight sets of max_keypermod KeyCodes, one for each modifier in the order Shift, Lock, Control, Mod1, Mod2, Mod3, Mod4, and Mod5. 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 XListInputDevices, or a BadValue error results. No KeyCode may appear twice in the entire map, or a BadValue error results. - 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 MappingFailed, 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, XSetDeviceModifierMapping returns MappingBusy, and none of the modifiers is changed. + 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 MappingFailed, 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, XSetDeviceModifierMapping returns MappingBusy, and none of the modifiers is changed. XSetDeviceModifierMapping can generate - BadLength, BadDevice, BadMatch, BadAlloc, and BadValue errors. + BadLength, BadDevice, BadMatch, BadAlloc, and BadValue errors. - The XGetDeviceModifierMapping request returns a pointer to a newly created XModifierKeymap structure that contains the keys being used as modifiers. The structure should be freed after use by calling XFreeModifierMapping . If only zero values appear in the set for any modifier, that modifier is disabled. + The XGetDeviceModifierMapping request returns a pointer to a newly created XModifierKeymap structure that contains the keys being used as modifiers. The structure should be freed after use by calling XFreeModifierMapping . If only zero values appear in the set for any modifier, that modifier is disabled. XGetDeviceModifierMapping can generate BadDevice and BadMatch errors. @@ -759,27 +779,27 @@ BadLength - More than eight keys were specified in the XModifierKeymap structure. + More than eight keys were specified in the XModifierKeymap structure. BadAlloc - The server failed to allocate the requested resource or server memory. + The server failed to allocate the requested resource or server memory. BadDevice - An invalid device was specified. The specified device does not exist or has not been opened by this client via XOpenInputDevice . This error may also occur if the specified device is the X keyboard or X pointer device. + An invalid device was specified. The specified device does not exist or has not been opened by this client via XOpenInputDevice. This error may also occur if the specified device is the X keyboard or X pointer device. BadMatch - This error may occur if an XGetDeviceModifierMapping or XChangeDeviceModifierMapping request was made specifying a device that has no keys. + This error may occur if an XGetDeviceModifierMapping or XChangeDeviceModifierMapping request was made specifying a device that has no keys. BadValue - 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. + 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. @@ -793,15 +813,18 @@ - _vendorversion_ + __vendorversion__ XGetDeviceMotionEvents - 3 - + __libmansuffix__ + __xorgversion__ + XINPUT FUNCTIONS + - XGetDeviceMotionEvents, XDeviceTimeCoord + XGetDeviceMotionEvents + XDeviceTimeCoord get device motion history @@ -849,11 +872,11 @@ Description - The server may retain the recent history of the device motion and do so to a finer granularity than is reported by DeviceMotionNotify events. The XGetDeviceMotionEvents request makes this history available. + The server may retain the recent history of the device motion and do so to a finer granularity than is reported by DeviceMotionNotify events. The XGetDeviceMotionEvents request makes this history available. - The XGetDeviceMotionEvents 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 CurrentTime . + The XGetDeviceMotionEvents 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 CurrentTime. - The mode indicates whether the device is reporting absolute positional data (mode= Absolute ) or relative motion data (mode= Relative ). Some devices allow their mode to be changed via the XSetDeviceMode request. These constants are defined in the file XI.h. The axis_count returns the number of axes or valuators being reported by the device. + The mode indicates whether the device is reporting absolute positional data (mode= Absolute ) or relative motion data (mode= Relative ). Some devices allow their mode to be changed via the XSetDeviceMode request. These constants are defined in the file XI.h. The axis_count returns the number of axes or valuators being reported by the device. XGetDeviceMotionEvents can generate a BadDevice, or BadMatch error. @@ -870,11 +893,11 @@ - 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 Absolute, 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 XAxisInfo returned by the XListInputDevices request. If the mode is Relative, the data values are the relative values generated by the device. + 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 Absolute, 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 XAxisInfo returned by the XListInputDevices request. If the mode is Relative, the data values are the relative values generated by the device. - You should use XFreeDeviceMotionEvents to free the data returned by this request. + You should use XFreeDeviceMotionEvents to free the data returned by this request. - Errors returned by this request: BadDevice, BadMatch . + Errors returned by this request: BadDevice, BadMatch. Diagnostics @@ -882,12 +905,12 @@ BadDevice - An invalid device was specified. The specified device does not exist or has not been opened by this client via XOpenInputDevice . This error may also occur if the specified device is the X keyboard or X pointer device. + An invalid device was specified. The specified device does not exist or has not been opened by this client via XOpenInputDevice. This error may also occur if the specified device is the X keyboard or X pointer device. BadMatch - This error may occur if an XGetDeviceMotionEvents request is made specifying a device that has no valuators and reports no axes of motion. + This error may occur if an XGetDeviceMotionEvents request is made specifying a device that has no valuators and reports no axes of motion. @@ -897,15 +920,18 @@ - _vendorversion_ + __vendorversion__ XGetExtensionVersion - 3 - + __libmansuffix__ + __xorgversion__ + XINPUT FUNCTIONS + - XQueryInputVersion, XGetExtensionVersion + XQueryInputVersion + XGetExtensionVersion query the version of the input extension. @@ -946,9 +972,9 @@ Description - The XQueryInputVersion request queries the version of the input extension and returns an XExtensionVersion structure. This structure contains a major_version and minor_version number which can be compared with constants defined in XI.h . The client must specify the highest version numbers it can supports. + The XQueryInputVersion request queries the version of the input extension and returns an XExtensionVersion structure. This structure contains a major_version and minor_version number which can be compared with constants defined in XI.h. The client must specify the highest version numbers it can supports. - The XGetExtensionVersion request is deprecated and should not be used. Clients issuing a XgetExtensionVersion request will not be able to use MPX features. The XGetExtensionVersion request queries the version of the input extension, and returns an XExtensionVersion structure. This structure contains a major_version and minor_version number which can be compared with constants defined in XI.h . 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. + The XGetExtensionVersion request is deprecated and should not be used. Clients issuing a XgetExtensionVersion request will not be able to use MPX features. The XGetExtensionVersion request queries the version of the input extension, and returns an XExtensionVersion structure. This structure contains a major_version and minor_version number which can be compared with constants defined in XI.h. 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. You should use XFree to free the XExtensionVersion structure. @@ -972,15 +998,18 @@ - _vendorversion_ + __vendorversion__ XGetFeedbackControl - 3 - + __libmansuffix__ + __xorgversion__ + XINPUT FUNCTIONS + - XGetFeedbackControl, XChangeFeedbackControl + XGetFeedbackControl + XChangeFeedbackControl query and change input device feedbacks @@ -1026,24 +1055,24 @@ Description - These requests are provided to manipulate those input devices that support feedbacks. A BadMatch 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 XOpenDevice request. For those devices that support feedbacks, XOpenDevice will return an XInputClassInfo structure with the input_class field equal to the constant FeedbackClass (defined in the file XI.h ). + These requests are provided to manipulate those input devices that support feedbacks. A BadMatch 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 XOpenDevice request. For those devices that support feedbacks, XOpenDevice will return an XInputClassInfo structure with the input_class field equal to the constant FeedbackClass (defined in the file XI.h ). - The XGetFeedbackControl request returns a pointer to a list of XFeedbackState 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. + The XGetFeedbackControl request returns a pointer to a list of XFeedbackState 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. - The feedback classes that are currently defined are: KbdFeedbackClass , PtrFeedbackClass , StringFeedbackClass , IntegerFeedbackClass , LedFeedbackClass , and BellFeedbackClass . These constants are defined in the file XI.h . 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 XChangeFeedbackControl request. + The feedback classes that are currently defined are: KbdFeedbackClass, PtrFeedbackClass, StringFeedbackClass, IntegerFeedbackClass, LedFeedbackClass, and BellFeedbackClass. These constants are defined in the file XI.h. 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 XChangeFeedbackControl request. - XGetFeedbackControl can generate a BadDevice or BadMatch error. + XGetFeedbackControl can generate a BadDevice or BadMatch error. - The XChangeFeedbackControl request modifies the values of one feedback on the specified device. The feedback is identified by the id field of the XFeedbackControl 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. + The XChangeFeedbackControl request modifies the values of one feedback on the specified device. The feedback is identified by the id field of the XFeedbackControl 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. - XChangeFeedbackControl can generate a BadDevice , BadMatch , or BadValue error. + XChangeFeedbackControl can generate a BadDevice, BadMatch, or BadValue error. Structures - Each class of feedback is described by a structure specific to that class. These structures are defined in the file XInput.h . XFeedbackState and XFeedbackControl are generic structures that contain three fields that are at the beginning of each class of feedback: + Each class of feedback is described by a structure specific to that class. These structures are defined in the file XInput.h. XFeedbackState and XFeedbackControl are generic structures that contain three fields that are at the beginning of each class of feedback: typedef struct { @@ -1055,7 +1084,7 @@ - The XKbdFeedbackState structure defines the attributes that are returned for feedbacks equivalent to those on the X keyboard. + The XKbdFeedbackState structure defines the attributes that are returned for feedbacks equivalent to those on the X keyboard. typedef struct { @@ -1073,7 +1102,7 @@ - The XPtrFeedbackState structure defines the attributes that are returned for feedbacks equivalent to those on the the X pointer. + The XPtrFeedbackState structure defines the attributes that are returned for feedbacks equivalent to those on the the X pointer. typedef struct { @@ -1087,7 +1116,7 @@ - The XIntegerFeedbackState structure defines attributes that are returned for integer feedbacks. + The XIntegerFeedbackState structure defines attributes that are returned for integer feedbacks. typedef struct { @@ -1101,7 +1130,7 @@ - The XStringFeedbackState structure defines the attributes that are returned for string feedbacks. + The XStringFeedbackState structure defines the attributes that are returned for string feedbacks. typedef struct { @@ -1115,7 +1144,7 @@ - The XBellFeedbackState structure defines the attributes that are returned for bell feedbacks. + The XBellFeedbackState structure defines the attributes that are returned for bell feedbacks. typedef struct { @@ -1129,7 +1158,7 @@ - The XLedFeedbackState structure defines the attributes that are returned for LED feedbacks. + The XLedFeedbackState structure defines the attributes that are returned for LED feedbacks. typedef struct { XID class; @@ -1140,7 +1169,7 @@ - The XPrtFeedbackControl structure defines the attributes that can be controlled for pointer feedbacks. + The XPrtFeedbackControl structure defines the attributes that can be controlled for pointer feedbacks. typedef struct { @@ -1154,7 +1183,7 @@ - The XKbdFeedbackControl structure defines the attributes that can be controlled for keyboard feedbacks. + The XKbdFeedbackControl structure defines the attributes that can be controlled for keyboard feedbacks. typedef struct { @@ -1173,7 +1202,7 @@ - The XStringFeedbackControl structure defines the attributes that can be controlled for string feedbacks. + The XStringFeedbackControl structure defines the attributes that can be controlled for string feedbacks. typedef struct { @@ -1186,7 +1215,7 @@ - The XIntegerFeedbackControl structure defines the attributes that can be controlled for integer feedbacks. + The XIntegerFeedbackControl structure defines the attributes that can be controlled for integer feedbacks. typedef struct { @@ -1198,7 +1227,7 @@ - The XBellFeedbackControl structure defines the attributes that can be controlled for bell feedbacks. + The XBellFeedbackControl structure defines the attributes that can be controlled for bell feedbacks. typedef struct { @@ -1212,7 +1241,7 @@ - The XLedFeedbackControl structure defines the attributes that can be controlled for LED feedbacks. + The XLedFeedbackControl structure defines the attributes that can be controlled for LED feedbacks. typedef struct { @@ -1230,17 +1259,17 @@ BadDevice - An invalid device was specified. The specified device does not exist or has not been opened by this client via XOpenInputDevice . 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 XChangeKeyboardDevice or XChangePointerDevice requests. + An invalid device was specified. The specified device does not exist or has not been opened by this client via XOpenInputDevice. 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 XChangeKeyboardDevice or XChangePointerDevice requests. BadMatch - This error may occur if an XGetFeedbackControl request was made specifying a device that has no feedbacks, or an XChangeFeedbackControl request was made with an XFeedbackControl structure that contains an invalid feedback type. It may also occur if an invalid combination of mask bits is specified ( DvKey but no DvAutoRepeatMode for keyboard feedbacks), or if an invalid KeySym is specified for a string feedback. + This error may occur if an XGetFeedbackControl request was made specifying a device that has no feedbacks, or an XChangeFeedbackControl request was made with an XFeedbackControl structure that contains an invalid feedback type. It may also occur if an invalid combination of mask bits is specified ( DvKey but no DvAutoRepeatMode for keyboard feedbacks), or if an invalid KeySym is specified for a string feedback. BadValue - Some numeric value falls outside the range of values accepted by the XChangeFeedbackControl 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. + Some numeric value falls outside the range of values accepted by the XChangeFeedbackControl 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. @@ -1251,15 +1280,18 @@ - _vendorversion_ + __vendorversion__ XGrabDeviceButton - 3 - + __libmansuffix__ + __xorgversion__ + XINPUT FUNCTIONS + - XGrabDeviceButton, XUngrabDeviceButton + XGrabDeviceButton + XUngrabDeviceButton grab/ungrab extension input device buttons @@ -1345,7 +1377,7 @@ Description - The XGrabDeviceButton request establishes a passive grab. In the future, the device is actively grabbed (as for XGrabDevice , the last-grab time is set to the time at which the button was pressed (as transmitted in the DeviceButtonPress event), and the DeviceButtonPress event is reported if all of the following conditions are true: + The XGrabDeviceButton request establishes a passive grab. In the future, the device is actively grabbed (as for XGrabDevice, the last-grab time is set to the time at which the button was pressed (as transmitted in the DeviceButtonPress event), and the DeviceButtonPress event is reported if all of the following conditions are true: @@ -1353,12 +1385,12 @@ 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. + other buttons or modifier keys are logically down. 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. + focus window and contains the device. @@ -1369,43 +1401,43 @@ - The interpretation of the remaining arguments is as for XGrabDevice . 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). + The interpretation of the remaining arguments is as for XGrabDevice. 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). - Note that the logical state of a device (as seen by client applications) may lag the physical state if device event processing is frozen. + Note that the logical state of a device (as seen by client applications) may lag the physical state if device event processing is frozen. - This request overrides all previous grabs by the same client on the same button/modifier combinations on the same window. A modifiers of AnyModifier 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 AnyButton 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. + This request overrides all previous grabs by the same client on the same button/modifier combinations on the same window. A modifiers of AnyModifier 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 AnyButton 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. - A modifier_device of NULL indicates that the X keyboard is to be used as the modifier_device. + A modifier_device of NULL indicates that the X keyboard is to be used as the modifier_device. - If some other client has already issued a XGrabDeviceButton with the same button/modifier combination on the same window, a BadAccess error results. When using AnyModifier or AnyButton , the request fails completely, and a BadAccess error results (no grabs are established) if there is a conflicting grab for any combination. XGrabDeviceButton has no effect on an active grab. + If some other client has already issued a XGrabDeviceButton with the same button/modifier combination on the same window, a BadAccess error results. When using AnyModifier or AnyButton , the request fails completely, and a BadAccess error results (no grabs are established) if there is a conflicting grab for any combination. XGrabDeviceButton has no effect on an active grab. - XGrabDeviceButton can generate BadClass , BadDevice , BadMatch , BadValue , and BadWindow errors. .P The XUngrabDeviceButton request releases the passive grab for a button/modifier combination on the specified window if it was grabbed by this client. A modifier of AnyModifier is equivalent to issuing the ungrab request for all possible modifier combinations, including the combination of no modifiers. A button of AnyButton is equivalent to issuing the request for all possible buttons. XUngrabDeviceButton has no effect on an active grab. + XGrabDeviceButton can generate BadClass, BadDevice, BadMatch, BadValue, and BadWindow errors..P The XUngrabDeviceButton request releases the passive grab for a button/modifier combination on the specified window if it was grabbed by this client. A modifier of AnyModifier is equivalent to issuing the ungrab request for all possible modifier combinations, including the combination of no modifiers. A button of AnyButton is equivalent to issuing the request for all possible buttons. XUngrabDeviceButton has no effect on an active grab. - A modifier_device of NULL indicates that the X keyboard should be used as the modifier_device. + A modifier_device of NULL indicates that the X keyboard should be used as the modifier_device. - XUngrabDeviceButton can generate BadDevice , BadMatch , BadValue and BadWindow errors. + XUngrabDeviceButton can generate BadDevice, BadMatch, BadValue and BadWindow errors. Diagnostics BadDevice - An invalid device was specified. The specified device does not exist or has not been opened by this client via XOpenInputDevice . This error may also occur if the specified device is the X keyboard or X pointer device. + An invalid device was specified. The specified device does not exist or has not been opened by this client via XOpenInputDevice. This error may also occur if the specified device is the X keyboard or X pointer device. BadMatch - This error may occur if an XGrabDeviceButton request was made specifying a device that has no buttons, or specifying a modifier device that has no keys. + This error may occur if an XGrabDeviceButton request was made specifying a device that has no buttons, or specifying a modifier device that has no keys. BadValue - 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. + 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. BadWindow - A value for a Window argument does not name a defined Window. + A value for a Window argument does not name a defined Window. @@ -1419,15 +1451,18 @@ - _vendorversion_ + __vendorversion__ XGrabDeviceKey - 3 - + __libmansuffix__ + __xorgversion__ + XINPUT FUNCTIONS + - XGrabDeviceKey, XUngrabDeviceKey + XGrabDeviceKey + XUngrabDeviceKey grab/ungrab extension input device Keys @@ -1507,7 +1542,7 @@ - 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. + 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. 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. @@ -1517,53 +1552,53 @@ viewable. - A passive grab on the same key/modifier combination does not exist on any ancestor of grab_window. + A passive grab on the same key/modifier combination does not exist on any ancestor of grab_window. - The interpretation of the remaining arguments is as for XGrabDevice . The active grab is terminated automatically when the logical state of the device has the specified key released. + The interpretation of the remaining arguments is as for XGrabDevice. The active grab is terminated automatically when the logical state of the device has the specified key released. - 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. + 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. - If the key is not AnyKey, it must be in the range specified by min_keycode and max_keycode as returned by the XListInputDevices request. Otherwise, a BadValue error results. + If the key is not AnyKey, it must be in the range specified by min_keycode and max_keycode as returned by the XListInputDevices request. Otherwise, a BadValue error results. - This request overrides all previous grabs by the same client on the same Key/modifier combinations on the same window. A modifier of AnyModifier 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 AnyKey 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. + This request overrides all previous grabs by the same client on the same Key/modifier combinations on the same window. A modifier of AnyModifier 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 AnyKey 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. - If a modifier_device of NULL is specified, the X keyboard will be used as the modifier_device. + If a modifier_device of NULL is specified, the X keyboard will be used as the modifier_device. - If some other client has already issued a XGrabDeviceKey with the same Key/modifier combination on the same window, a BadAccess error results. When using AnyModifier or AnyKey , the request fails completely, and a BadAccess error results (no grabs are established) if there is a conflicting grab for any combination. XGrabDeviceKey has no effect on an active grab. + If some other client has already issued a XGrabDeviceKey with the same Key/modifier combination on the same window, a BadAccess error results. When using AnyModifier or AnyKey, the request fails completely, and a BadAccess error results (no grabs are established) if there is a conflicting grab for any combination.XGrabDeviceKey has no effect on an active grab. XGrabDeviceKey can generate BadAccess, BadClass, BadDevice, BadMatch, BadValue, and BadWindow errors. It returns Success on successful completion of the request. - The XUngrabDeviceKey request releases the passive grab for a key/modifier combination on the specified window if it was grabbed by this client. A modifier of AnyModifier is equivalent to issuing the ungrab request for all possible modifier combinations, including the combination of no modifiers. A Key of AnyKey is equivalent to issuing the request for all possible Keys. XUngrabDeviceKey has no effect on an active grab. + The XUngrabDeviceKey request releases the passive grab for a key/modifier combination on the specified window if it was grabbed by this client. A modifier of AnyModifier is equivalent to issuing the ungrab request for all possible modifier combinations, including the combination of no modifiers. A Key of AnyKey is equivalent to issuing the request for all possible Keys.XUngrabDeviceKey has no effect on an active grab. - If a modifier_device of NULL is specified, the X keyboard will be used as the modifier_device. + If a modifier_device of NULL is specified, the X keyboard will be used as the modifier_device. - XUngrabDeviceKey can generate BadDevice, BadMatch, BadValue and BadWindow errors. + XUngrabDeviceKey can generate BadDevice, BadMatch, BadValue and BadWindow errors. Diagnostics BadDevice - An invalid device was specified. The specified device does not exist or has not been opened by this client via XOpenInputDevice . This error may also occur if the specified device is the X keyboard or X pointer device. + An invalid device was specified. The specified device does not exist or has not been opened by this client via XOpenInputDevice. This error may also occur if the specified device is the X keyboard or X pointer device. BadMatch - This error may occur if an XGrabDeviceKey request was made specifying a device that has no keys, or a modifier device that has no keys. + This error may occur if an XGrabDeviceKey request was made specifying a device that has no keys, or a modifier device that has no keys. BadValue - 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. + 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. BadWindow - A value for a Window argument does not name a defined Window. + A value for a Window argument does not name a defined Window. @@ -1577,15 +1612,18 @@ - _vendorversion_ + __vendorversion__ XGrabDevice - 3 - + __libmansuffix__ + __xorgversion__ + XINPUT FUNCTIONS + - XGrabDevice, XUngrabDevice + XGrabDevice + XUngrabDevice grab/release the specified extension device @@ -1648,38 +1686,38 @@ Description - The XGrabDevice request actively grabs control of the device and generates DeviceFocusIn and DeviceFocusOut events. Further device events are reported only to the grabbing client. XGrabDevice 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 False, all generated device events are reported with respect to grab_window if selected. If owner_events is True 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. + The XGrabDevice request actively grabs control of the device and generates DeviceFocusIn and DeviceFocusOut events. Further device events are reported only to the grabbing client.XGrabDevice 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 False, all generated device events are reported with respect to grab_window if selected. If owner_events is True 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. - If the this_device_mode argument is GrabModeAsync, 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 GrabModeSync, 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 XAllowDeviceEvents 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. + If the this_device_mode argument is GrabModeAsync, 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 GrabModeSync, 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 XAllowDeviceEvents 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. - If other_devices_mode is GrabModeAsync, processing of events from other devices is unaffected by activation of the grab. If other_devices_mode is GrabModeSync, 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 XAllowDeviceEvents 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. + If other_devices_mode is GrabModeAsync, processing of events from other devices is unaffected by activation of the grab. If other_devices_mode is GrabModeSync, 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 XAllowDeviceEvents 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. - If the device is actively grabbed by some other client, XGrabDevice fails and returns AlreadyGrabbed. If grab_window is not viewable, it fails and returns GrabNotViewable. If the device is frozen by an active grab of another client, it fails and returns GrabFrozen. If the specified time is earlier than the last-device-grab time or later than the current X server time, it fails and returns GrabInvalidTime. Otherwise, the last-device-grab time is set to the specified time ( CurrentTime is replaced by the current X server time). + If the device is actively grabbed by some other client, XGrabDevice fails and returns AlreadyGrabbed. If grab_window is not viewable, it fails and returns GrabNotViewable. If the device is frozen by an active grab of another client, it fails and returns GrabFrozen. If the specified time is earlier than the last-device-grab time or later than the current X server time, it fails and returns GrabInvalidTime. Otherwise, the last-device-grab time is set to the specified time ( CurrentTime is replaced by the current X server time). - 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. + 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. - XGrabDevice can generate BadClass, BadDevice, BadValue, and BadWindow errors. + XGrabDevice can generate BadClass, BadDevice, BadValue, and BadWindow errors. - The XUngrabDevice request releases the device and any queued events if this client has it actively grabbed from either XGrabDevice or XGrabDeviceKey. If other devices are frozen by the grab, XUngrabDevice thaws them. XUngrabDevice 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 DeviceFocusIn and DeviceFocusOut events. The X server automatically performs an UngrabDevice request if the event window for an active device grab becomes not viewable. + The XUngrabDevice request releases the device and any queued events if this client has it actively grabbed from either XGrabDevice or XGrabDeviceKey. If other devices are frozen by the grab, XUngrabDevice thaws them.XUngrabDevice 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 DeviceFocusIn and DeviceFocusOut events. The X server automatically performs an UngrabDevice request if the event window for an active device grab becomes not viewable. - XUngrabDevice can generate a BadDevice error. + XUngrabDevice can generate a BadDevice error. Diagnostics BadDevice - An invalid device was specified. The specified device does not exist or has not been opened by this client via XOpenInputDevice. This error may also occur if the specified device is the X keyboard or X pointer device. + An invalid device was specified. The specified device does not exist or has not been opened by this client via XOpenInputDevice. This error may also occur if the specified device is the X keyboard or X pointer device. BadValue - 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. + 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. BadWindow - A value for a Window argument does not name a defined Window. + A value for a Window argument does not name a defined Window. @@ -1693,15 +1731,18 @@ - _vendorversion_ + __vendorversion__ XListInputDevices - 3 - + __libmansuffix__ + __xorgversion__ + XINPUT FUNCTIONS + - XListInputDevices, XFreeDeviceList + XListInputDevices + XFreeDeviceList list available input devices @@ -1737,13 +1778,13 @@ Description - The XListInputDevices 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. + The XListInputDevices 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. - 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. + 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. - 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. + 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. - 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. + 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. 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: @@ -1760,27 +1801,27 @@ - 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. + 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. - The type field is of type Atom and indicates the nature of the device. + The type field is of type Atom and indicates the nature of the device. 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 XI.h: XI_MOUSE XI_TABLET XI_KEYBOARD XI_TOUCHSCREEN XI_TOUCHPAD XI_BUTTONBOX XI_BARCODE XI_TRACKBALL XI_QUADRATURE XI_ID_MODULE XI_ONE_KNOB XI_NINE_KNOB XI_KNOB_BOX XI_SPACEBALL XI_DATAGLOVE XI_EYETRACKER XI_CURSORKEYS XI_FOOTMOUSE - 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. + 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. - 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. + 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. - 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. + 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. - The use field specifies how the device is currently being used. If the value is IsXKeyboard, the device is a master keyboard. If the value is IsXPointer, the device is a master pointer. If the value is IsXExtensionPointer, the device is a slave pointer. If the value is IsXExtensionKeyboard, the device is a slave keyboard. If the value is IsXExtensionDevice, the device is available for use as an extension device. + The use field specifies how the device is currently being used. If the value is IsXKeyboard, the device is a master keyboard. If the value is IsXPointer, the device is a master pointer. If the value is IsXExtensionPointer, the device is a slave pointer. If the value is IsXExtensionKeyboard, the device is a slave keyboard. If the value is IsXExtensionDevice, the device is available for use as an extension device. - The inputclassinfo field contains a pointer to the first input-class specific data. The first two fields are common to all classes. + The inputclassinfo field contains a pointer to the first input-class specific data. The first two fields are common to all classes. - 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. + 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. - 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. + 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. The XKeyInfo structure describes the characteristics of the keys on the device. It is defined as follows: @@ -1796,11 +1837,11 @@ - 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. + 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. - 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. + 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. - num_keys specifies the number of keys that the device has. + num_keys specifies the number of keys that the device has. The XButtonInfo structure defines the characteristics of the buttons on the device. It is defined as follows: @@ -1813,7 +1854,7 @@ - num_buttons specifies the number of buttons that the device has. + num_buttons specifies the number of buttons that the device has. The XValuatorInfo structure defines the characteristics of the valuators on the device. It is defined as follows: @@ -1829,13 +1870,13 @@ - num_axes contains the number of axes the device supports. + num_axes contains the number of axes the device supports. - 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. + 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. - 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. + 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. - The axes field contains a pointer to an XAxisInfo structure. + The axes field contains a pointer to an XAxisInfo structure. The XAxisInfo structure is defined as follows: @@ -1848,11 +1889,11 @@ - The resolution contains a number in counts/meter. + The resolution contains a number in counts/meter. - 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. + 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. - 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. + 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. The XAttachInfo structure is defined as follows: @@ -1863,23 +1904,26 @@ - 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 Floating. If the device is a master device, attached specifies the device ID of the master device this device is paired with. + 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 Floating. If the device is a master device, attached specifies the device ID of the master device this device is paired with. - To free the XDeviceInfo array created by XListInputDevices, use XFreeDeviceList. + To free the XDeviceInfo array created by XListInputDevices, use XFreeDeviceList. - _vendorversion_ + __vendorversion__ XOpenDevice - 3 - + __libmansuffix__ + __xorgversion__ + XINPUT FUNCTIONS + - XOpenDevice, XCloseDevice + XOpenDevice + XCloseDevice open or close an extension input device @@ -1919,11 +1963,11 @@ Description The XOpenDevice request makes an input device accessible to a client through input extension protocol - requests. If successful, it returns a pointer to an XDevice structure. + requests. If successful, it returns a pointer to an XDevice structure. - The XCloseDevice 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 CloseDevice. + The XCloseDevice 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 CloseDevice. - When a client makes an XCloseDevice 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. + When a client makes an XCloseDevice 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. XOpenDevice and XCloseDevice can generate a BadDevice error. @@ -1942,7 +1986,7 @@ - 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. + 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. The XInputClassInfo structure contains: @@ -1954,9 +1998,9 @@ - The input_class field identifies one class of input supported by the device. Defined types include KeyClass, ButtonClass, ValuatorClass, ProximityClass, FeedbackClass, FocusClass, and OtherClass. The event_type_base identifies the event type of the first event in that class. + The input_class field identifies one class of input supported by the device. Defined types include KeyClass, ButtonClass, ValuatorClass, ProximityClass, FeedbackClass, FocusClass, and OtherClass. The event_type_base identifies the event type of the first event in that class. - The information contained in the XInputClassInfo structure is used by macros to obtain the event classes that clients use in making XSelectExtensionEvent requests. Currently defined macros include DeviceKeyPress, DeviceKeyRelease, DeviceButtonPress, DeviceButtonRelese, DeviceMotionNotify, DeviceFocusIn, DeviceFocusOut, ProximityIn, ProximityOut, DeviceStateNotify, DeviceMappingNotify, ChangeDeviceNotify, DevicePointerMotionHint, DeviceButton1Motion, DeviceButton2Motion, DeviceButton3Motion, DeviceButton4Motion, DeviceButton5Motion, DeviceButtonMotion, DeviceOwnerGrabButton, DeviceButtonPressGrab, and NoExtensionEvent. + The information contained in the XInputClassInfo structure is used by macros to obtain the event classes that clients use in making XSelectExtensionEvent requests. Currently defined macros include DeviceKeyPress, DeviceKeyRelease, DeviceButtonPress, DeviceButtonRelese, DeviceMotionNotify, DeviceFocusIn, DeviceFocusOut, ProximityIn, ProximityOut, DeviceStateNotify, DeviceMappingNotify, ChangeDeviceNotify, DevicePointerMotionHint, DeviceButton1Motion, DeviceButton2Motion, DeviceButton3Motion, DeviceButton4Motion, DeviceButton5Motion, DeviceButtonMotion, DeviceOwnerGrabButton, DeviceButtonPressGrab, and NoExtensionEvent. To obtain the proper event class for a particular device, one of the above macros is invoked using the XDevice structure for that device. For example, @@ -1965,16 +2009,16 @@ - returns the DeviceKeyPress event type and the eventclass for DeviceKeyPress events from the specified device. + returns the DeviceKeyPress event type and the eventclass for DeviceKeyPress events from the specified device. - This eventclass can then be used in an XSelectExtensionEvent request to ask the server to send DeviceKeyPress events from this device. When a selected event is received via XNextEvent, the type can be used for comparison with the type in the event. + This eventclass can then be used in an XSelectExtensionEvent request to ask the server to send DeviceKeyPress events from this device. When a selected event is received via XNextEvent, the type can be used for comparison with the type in the event. Diagnostics BadDevice - 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 XChangeKeyboardDevice or XChangePointerDevice requests. + 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 XChangeKeyboardDevice or XChangePointerDevice requests. @@ -1984,13 +2028,15 @@ - _vendorversion_ + __vendorversion__ XQueryDeviceState - 3 - + __libmansuffix__ + __xorgversion__ + XINPUT FUNCTIONS + XQueryDeviceState query the state of an extension input device. @@ -2022,7 +2068,7 @@ Description - The XQueryDeviceState 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 XDeviceState 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. + The XQueryDeviceState 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 XDeviceState 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. XQueryDeviceState can generate a BadDevice error. @@ -2083,7 +2129,7 @@ BadDevice - An invalid device was specified. The specified device does not exist or has not been opened by this client via XOpenInputDevice. 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 XChangeKeyboardDevice or XChangePointerDevice requests. + An invalid device was specified. The specified device does not exist or has not been opened by this client via XOpenInputDevice. 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 XChangeKeyboardDevice or XChangePointerDevice requests. @@ -2094,15 +2140,18 @@ - _vendorversion_ + __vendorversion__ XSelectExtensionEvent - 3 - + __libmansuffix__ + __xorgversion__ + XINPUT FUNCTIONS + - XSelectExtensionEvent, XGetSelectedExtensionEvents + XSelectExtensionEvent + XGetSelectedExtensionEvents select extension events, get the list of currently selected extension events @@ -2274,13 +2323,15 @@ - _vendorversion_ + __vendorversion__ XSendExtensionEvent - 3 - + __libmansuffix__ + __xorgversion__ + XINPUT FUNCTIONS + XSendExtensionEvent send input extension events to a client @@ -2341,7 +2392,7 @@ - If w is PointerWindow ,the destination window is the window that contains the pointer. + If w is PointerWindow,the destination window is the window that contains the pointer. @@ -2371,7 +2422,7 @@ The event in the XEventstructure must be one of the events defined by the input extension (or a BadValueerror 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 Truein the forwarded event and to set the serial number in the event correctly. - XSendExtensionEventreturns zero if the conversion to wire protocol format failedand returns nonzero otherwise. XSendExtensionEventcan generate BadClass, BadDevice, BadValue, and BadWindow errors. + XSendExtensionEventreturns zero if the conversion to wire protocol format failedand returns nonzero otherwise.XSendExtensionEventcan generate BadClass, BadDevice, BadValue, and BadWindow errors. Diagnosis @@ -2413,15 +2464,18 @@ - _vendorversion_ + __vendorversion__ XSetDeviceButtonMapping - 3 - + __libmansuffix__ + __xorgversion__ + XINPUT FUNCTIONS + - XSetDeviceButtonMapping, XGetDeviceButtonMapping + XSetDeviceButtonMapping + XGetDeviceButtonMapping query or change device button mappings @@ -2468,30 +2522,30 @@ Description - The XSetDeviceButtonMapping request sets the mapping of the specified device. If it succeeds, the X server generates a DeviceMappingNotify event, and XSetDeviceButtonMapping returns MappingSuccess. Element map[i] defines the logical button number for the physical button i+1. The length of the list must be the same as XGetDeviceButtonMapping would return, or a BadValue 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 BadValue error results. If any of the buttons to be altered are logically in the down state, XSetDeviceButtonMapping returns MappingBusy, and the mapping is not changed. + The XSetDeviceButtonMapping request sets the mapping of the specified device. If it succeeds, the X server generates a DeviceMappingNotify event, and XSetDeviceButtonMapping returns MappingSuccess. Element map[i] defines the logical button number for the physical button i+1. The length of the list must be the same as XGetDeviceButtonMapping would return, or a BadValue 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 BadValue error results. If any of the buttons to be altered are logically in the down state, XSetDeviceButtonMapping returns MappingBusy, and the mapping is not changed. - XSetDeviceButtonMapping can generate BadDevice, BadMatch, and BadValue errors. + XSetDeviceButtonMapping can generate BadDevice, BadMatch, and BadValue errors. - The XGetDeviceButtonMapping request returns the current mapping of the specified device. Buttons are numbered starting from one. XGetDeviceButtonMapping 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. + The XGetDeviceButtonMapping request returns the current mapping of the specified device. Buttons are numbered starting from one.XGetDeviceButtonMapping 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. - XGetDeviceButtonMapping can generate BadDevice or BadMatch errors. + XGetDeviceButtonMapping can generate BadDevice or BadMatch errors. Diagnostics BadDevice - An invalid device was specified. The specified device does not exist or has not been opened by this client via XOpenInputDevice. This error may also occur if the specified device is the X keyboard or X pointer device. + An invalid device was specified. The specified device does not exist or has not been opened by this client via XOpenInputDevice. This error may also occur if the specified device is the X keyboard or X pointer device. BadMatch - This error may occur if an XGetDeviceButtonMapping or XSetDeviceButtonMapping request was made specifying a device that has no buttons. + This error may occur if an XGetDeviceButtonMapping or XSetDeviceButtonMapping request was made specifying a device that has no buttons. BadValue - 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. + 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. @@ -2506,15 +2560,18 @@ - _vendorversion_ + __vendorversion__ XSetDeviceFocus - 3 - + __libmansuffix__ + __xorgversion__ + XINPUT FUNCTIONS + - XSetDeviceFocus, XGetDeviceFocus + XSetDeviceFocus + XGetDeviceFocus control extension input device focus @@ -2573,20 +2630,20 @@ Description - The XSetDeviceFocus 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 CurrentTime is replaced by the current X server time). XSetDeviceFocus causes the X server to generate DeviceFocusIn and DeviceFocusOut events. + The XSetDeviceFocus 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 CurrentTime is replaced by the current X server time). XSetDeviceFocus causes the X server to generate DeviceFocusIn and DeviceFocusOut events. Depending on the focus argument, the following occurs: - If focus is None , all device events are discarded until a new focus window is set, and the revert_to argument is ignored. + If focus is None , all device events are discarded until a new focus window is set, and the revert_to argument is ignored. 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. - If focus is PointerRoot , 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. + If focus is PointerRoot, 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. - If focus is FollowKeyboard , the focus window is dynamically taken to be the window to which the X keyboard focus is set at each input event. + If focus is FollowKeyboard, the focus window is dynamically taken to be the window to which the X keyboard focus is set at each input event. @@ -2594,9 +2651,9 @@ The specified focus window must be viewable at the time XSetDeviceFocus is called, or a BadMatch 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: - If revert_to is RevertToParent , the focus reverts to the parent (or the closest viewable ancestor), and the new revert_to value is taken to be RevertToNone. + If revert_to is RevertToParent, the focus reverts to the parent (or the closest viewable ancestor), and the new revert_to value is taken to be RevertToNone. - If revert_to is RevertToPointerRoot , RevertToFollowKeyboard , or RevertToNone , the focus reverts to PointerRoot , FollowKeyboard , or None , respectively. + If revert_to is RevertToPointerRoot, RevertToFollowKeyboard, or RevertToNone, the focus reverts to PointerRoot, FollowKeyboard, or None, respectively. @@ -2604,13 +2661,13 @@ When the focus reverts, the X server generates DeviceFocusIn and DeviceFocusOut events, but the - last-focus-change time is not affected. Input + last-focus-change time is not affected. 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 BadMatch error. Whether or not given device can support this request can be determined by the - information returned by XOpenDevice . For + information returned by XOpenDevice. For those devices that support focus, XOpenDevice will return an XInputClassInfo structure with the @@ -2625,33 +2682,33 @@ BadWindow errors. - The XGetDeviceFocus request returns the focus window and the current focus state. + The XGetDeviceFocus request returns the focus window and the current focus state. - 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 BadMatch error. A device that can be focused returns information for input Class Focus when an XOpenDevice request is made. + 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 BadMatch error. A device that can be focused returns information for input Class Focus when an XOpenDevice request is made. - XGetDeviceFocus can generate BadDevice , and BadMatch errors. + XGetDeviceFocus can generate BadDevice, and BadMatch errors. Diagnostics BadDevice - An invalid device was specified. The specified device does not exist or has not been opened by this client via XOpenInputDevice . This error may also occur if the specified device is the X keyboard or X pointer device. + An invalid device was specified. The specified device does not exist or has not been opened by this client via XOpenInputDevice. This error may also occur if the specified device is the X keyboard or X pointer device. BadValue - 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. + 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. BadWindow - A value for a Window argument does not name a defined Window. + A value for a Window argument does not name a defined Window. BadMatch - This error may occur if an XGetDeviceFocus or XSetDeviceFocus request was made specifying a device that the server implementation does not allow to be focused. + This error may occur if an XGetDeviceFocus or XSetDeviceFocus request was made specifying a device that the server implementation does not allow to be focused. @@ -2662,13 +2719,15 @@ - _vendorversion_ + __vendorversion__ XSetDeviceMode - 3 - + __libmansuffix__ + __xorgversion__ + XINPUT FUNCTIONS + XSetDeviceMode change the mode of a device @@ -2695,33 +2754,33 @@ Specifies the device whose mode is to be changed. mode - Specifies the mode.You can pass Absolute ,or Relative. + Specifies the mode.You can pass Absolute,or Relative. Description - The XSetDeviceMode 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 Absolute to Relative . + The XSetDeviceMode 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 Absolute to Relative. - XSetDeviceMode can generate a BadDevice or BadMode error. + XSetDeviceMode can generate a BadDevice or BadMode error. Diagnostics BadDevice - An invalid device was specified. The specified device does not exist or has not been opened by this client via XOpenInputDevice . 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 XChangeKeyboardDevice or XChangePointerDevice requests. + An invalid device was specified. The specified device does not exist or has not been opened by this client via XOpenInputDevice. 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 XChangeKeyboardDevice or XChangePointerDevice requests. BadMatch - This error may occur if an XSetDeviceMode request is made specifying a device that has no valuators and reports no axes of motion. + This error may occur if an XSetDeviceMode request is made specifying a device that has no valuators and reports no axes of motion. BadMode - An invalid mode was specified. This error will also be returned if the specified device is not capable of supporting the XSetDeviceMode request. + An invalid mode was specified. This error will also be returned if the specified device is not capable of supporting the XSetDeviceMode request. @@ -2732,13 +2791,15 @@ - _vendorversion_ + __vendorversion__ XSetDeviceValuators - 3 - + __libmansuffix__ + __xorgversion__ + XINPUT FUNCTIONS + XSetDeviceValuators initialize the valuators on an extension input device @@ -2782,28 +2843,28 @@ Description - The XSetDeviceValuators 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 BadMatch error will occur. + The XSetDeviceValuators 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 BadMatch error will occur. - If the request succeeds, a status of Success is returned. If another client has the device grabbed, a status of AlreadyGrabbed is returned. + If the request succeeds, a status of Success is returned. If another client has the device grabbed, a status of AlreadyGrabbed is returned. - XSetDeviceValuators can generate a BadLength , BadDevice , BadMatch , or BadValue error. + XSetDeviceValuators can generate a BadLength, BadDevice , BadMatch, or BadValue error. Diagnostics BadDevice - An invalid device was specified. The specified device does not exist or has not been opened by this client via XOpenInputDevice . + An invalid device was specified. The specified device does not exist or has not been opened by this client via XOpenInputDevice. BadMatch - This error may occur if an XSetDeviceValuators 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. + This error may occur if an XSetDeviceValuators 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. BadValue - An invalid first_valuator or num_valuators values was specified. + An invalid first_valuator or num_valuators values was specified. @@ -2815,71 +2876,73 @@ - _vendorversion_ + __vendorversion__ February 14, 2008 PeterHutterer Specification and implementation. - peter@cs.unisa.edu.au XSetClientPointer, XGetClientPointer - 3 - + __libmansuffix__ + __xorgversion__ + XINPUT FUNCTIONS + - XSetClientPointer, XGetClientPointer - set or get the ClientPointer setting. + XSetClientPointer + XGetClientPointer + set or get the ClientPointer setting. - Syntax - - #include <X11/extensions/XInput.h> - - XSetClientPointer - Display *display - Window win - XDevice *device - - - Bool XGetClientPointer - Display *display - Window win - XID *device - - + Syntax + + #include <X11/extensions/XInput.h> + + XSetClientPointer + Display *display + Window win + XDevice *device + + + Bool XGetClientPointer + Display *display + Window win + XID *device + + Arguments - - - - display - Specifies the connection to the X server. - - - win - Specifies a window belonging to the - client. May be None. - - - device - Specifies the device to set as - ClientPointer. - - - + + + + display + Specifies the connection to the X server. + + + win + Specifies a window belonging to the + client. May be None. + + + device + Specifies the device to set as + ClientPointer. + + + Description - - 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 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 XQueryPointer request will return the coordinates of the ClientPointer. @@ -2936,21 +2999,22 @@ - _vendorversion_ + __vendorversion__ February 14, 2008 PeterHutterer Specification and implementation. - peter@cs.unisa.edu.au XQueryDevicePointer - 3 - + __libmansuffix__ + __xorgversion__ + XINPUT FUNCTIONS + XQueryDevicePointer get device pointer coordinates. @@ -3113,23 +3177,25 @@ - _vendorversion_ + __vendorversion__ February 14, 2008 PeterHutterer Specification and implementation. - peter@cs.unisa.edu.au XDefineDeviceCursor, XUndefineDeviceCursor - 3 - + __libmansuffix__ + __xorgversion__ + XINPUT FUNCTIONS + - XDefineDeviceCursor, XUndefineDeviceCursor + XDefineDeviceCursor + XUndefineDeviceCursor define device cursors. @@ -3238,21 +3304,22 @@ - _vendorversion_ + __vendorversion__ February 14, 2008 PeterHutterer Specification and implementation. - peter@cs.unisa.edu.au XWarpDevicePointer - 3 - + __libmansuffix__ + __xorgversion__ + XINPUT FUNCTIONS + XWarpDevicePointer move device pointer. @@ -3395,21 +3462,22 @@ - _vendorversion_ + __vendorversion__ February 14, 2008 PeterHutterer Specification and implementation. - peter@cs.unisa.edu.au XChangeDeviceHierarchy - 3 - + __libmansuffix__ + __xorgversion__ + XINPUT FUNCTIONS + XChangeDeviceHierarchy change the device hierarchy. @@ -3595,24 +3663,26 @@ typedef struct { - _vendorversion_ + __vendorversion__ February 14, 2008 PeterHutterer Specification and implementation. - peter@cs.unisa.edu.au XPermitDevices, XDenyDevices, XChangeAccessRule - 3 - + __libmansuffix__ + __xorgversion__ + XINPUT FUNCTIONS + - XPermitDevices, XDenyDevices, XChangeAccessRule - + XPermitDevices + XDenyDevices + XChangeAccessRule change access rules to the window. @@ -3771,21 +3841,22 @@ typedef struct { - _vendorversion_ + __vendorversion__ February 14, 2008 PeterHutterer Specification and implementation. - peter@cs.unisa.edu.au XWindowClearAccess - 3 - + __libmansuffix__ + __xorgversion__ + XINPUT FUNCTIONS + XWindowClearAccess remove access rules for the window. @@ -3858,7 +3929,7 @@ typedef struct { BadValue - A value is outside of the permitted range. + A value is outside of the permitted range. @@ -3881,21 +3952,22 @@ typedef struct { - _vendorversion_ + __vendorversion__ February 14, 2008 PeterHutterer Specification and implementation. - peter@cs.unisa.edu.au XQueryWindowAccess - 3 - + __libmansuffix__ + __xorgversion__ + XINPUT FUNCTIONS + XQueryWindowAccess query access rules of the window. @@ -4015,21 +4087,22 @@ typedef struct { - _vendorversion_ + __vendorversion__ February 14, 2008 PeterHutterer Specification and implementation. - peter@cs.unisa.edu.au XiSelectEvent - 3 - + __libmansuffix__ + __xorgversion__ + XINPUT FUNCTIONS + XiSelectEvent select for generic events on the window. @@ -4119,7 +4192,7 @@ typedef struct { BadValue - A value is outside of the permitted range. + A value is outside of the permitted range. BadWindow @@ -4143,21 +4216,22 @@ typedef struct { - _vendorversion_ + __vendorversion__ February 14, 2008 PeterHutterer Specification and implementation. - peter@cs.unisa.edu.au XExtendedGrabDevice - 3 - + __libmansuffix__ + __xorgversion__ + XINPUT FUNCTIONS + XExtendedGrabDevice actively grab the device. @@ -4258,7 +4332,7 @@ typedef struct { DeviceLeaveNotify if the device is a pointer. Further device events are reported only to the grabbing client. XExtendedGrabDevice overrides any active device grab by - this client. event_list is a pointer to a list of event + 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. generic_event_list is a pointer to a list of generic event masks. These masks indicates which generic @@ -4346,7 +4420,7 @@ typedef struct { BadValue - A value is outside of the permitted range. + A value is outside of the permitted range. BadWindow -- cgit v1.2.3