diff options
Diffstat (limited to 'man/XIGrabButton.txt')
| -rw-r--r-- | man/XIGrabButton.txt | 60 |
1 files changed, 38 insertions, 22 deletions
diff --git a/man/XIGrabButton.txt b/man/XIGrabButton.txt index 45ac25e..a046ac7 100644 --- a/man/XIGrabButton.txt +++ b/man/XIGrabButton.txt @@ -49,6 +49,20 @@ SYNOPSIS int num_modifiers, XIGrabModifiers *modifiers); + int XIGrabTouchBegin( Display *display, + int deviceid, + Window grab_window, + Bool owner_events, + XIEventMask *mask, + int num_modifiers, + XIGrabModifiers *modifiers_inout); + + int XIUngrabTouchBegin( Display *display, + int deviceid, + Window grab_window, + int num_modifiers, + XIGrabModifiers *modifiers); + display Specifies the connection to the X server. @@ -101,8 +115,8 @@ SYNOPSIS DESCRIPTION ----------- - XIGrabButton and XIGrabKeycode establishes a passive grab. The - modifier device for a button grab is the paired master device + XIGrabButton, XIGrabKeycode and XIGrabTouchBegin establish a passive + grab. The modifier device for a button grab is the paired master device if deviceid specifies a master pointer. Otherwise, the modifier device is the device specified with deviceid. In the future, the device is actively grabbed (as for XIGrabDevice, the @@ -110,9 +124,9 @@ DESCRIPTION was pressed and the XI_ButtonPress or XI_KeyPress event is reported if all of the following conditions are true: * The device is not grabbed, and the specified button or - keycode is logically pressed when the specified modifier - keys are logically down on the modifier device and no other - buttons or modifier keys are logically down. + keycode is logically pressed or a touch event occurs when the + specified modifier keys are logically down on the modifier device + and no 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. @@ -156,35 +170,36 @@ DESCRIPTION combination. XIGrabButton and XIGrabKeycode have no effect on an active grab. - On success, XIGrabButton and XIGrabKeycode return 0; + On success, XIGrabButton, XIGrabKeycode and XIGrabTouchBegin return 0; If one or more modifier combinations could not be grabbed, - XIGrabButton and XIGrabKeycode return the number of failed - combinations and modifiers_inout contains the failed combinations + XIGrabButton, XIGrabKeycode and XIGrabTouchBegin return the number of + failed combinations and modifiers_inout contains the failed combinations and their respective error codes. - XIGrabButton and XIGrabKeycode can generate BadClass, BadDevice, - BadMatch, BadValue, and BadWindow errors. + XIGrabButton, XIGrabKeycode and XIGrabTouchBegin can generate BadClass, + BadDevice, BadMatch, BadValue, and BadWindow errors. - XIUngrabButton and XIUngrabKeycode releases the passive grab for - a button/modifier or keycode/modifier combination on the - specified window if it was grabbed by this client. A modifier - of XIAnyModifier is equivalent to issuing the ungrab request + XIUngrabButton, XIUngrabKeycode and XIUngrabTouchBegin release the + passive grab for a button/modifier, keycode/modifier or touch/modifier + combination on the specified window if it was grabbed by this client. A + modifier of XIAnyModifier is equivalent to issuing the ungrab request for all possible modifier combinations, including the combination of no modifiers. A button of XIAnyButton is equivalent to issuing the request for all possible buttons. XIUngrabButton and XIUngrabKeycode have no effect on an active grab. - XIUngrabButton and XIUngrabKeycode can generate BadDevice, - BadMatch, BadValue and BadWindow errors. + XIUngrabButton, XIUngrabKeycode and XIUngrabTouchBegin can generate + BadDevice, BadMatch, BadValue and BadWindow errors. RETURN VALUE ------------ - XIGrabButton and XIGrabKeycode return the number of modifier combination - that could not establish a passive grab. The modifiers are returned in - modifiers_inout, along with the respective error for this modifier - combination. If XIGrabButton or XIGrabKeycode return zero, passive grabs - with all requested modifier combinations were established successfully. + XIGrabButton, XIGrabKeycode and XIGrabTouchBegin return the number of + modifier combination that could not establish a passive grab. The + modifiers are returned in modifiers_inout, along with the respective + error for this modifier combination. If XIGrabButton, XIGrabKeycode + or XIGrabTouchBegin return zero, passive grabs with all requested + modifier combinations were established successfully. DIAGNOSTICS ----------- @@ -195,7 +210,8 @@ DIAGNOSTICS BadMatch This error may occur if XIGrabButton specified a device that has no buttons, or XIGrabKeycode specified a device - that has no keys. + that has no keys, or XIGrabTouchBegin specified a device + that is not touch-capable. BadValue Some numeric value falls outside the range of values |