[PATCH libXi] man: passive grabs return the number of failed modifier combinations
Peter Hutterer
peter.hutterer at who-t.net
Wed Oct 26 19:04:24 PDT 2011
Signed-off-by: Peter Hutterer <peter.hutterer at who-t.net>
---
man/XIGrabButton.txt | 10 +++++++++-
man/XIGrabEnter.txt | 10 +++++++++-
2 files changed, 18 insertions(+), 2 deletions(-)
diff --git a/man/XIGrabButton.txt b/man/XIGrabButton.txt
index 2ff0b50..3b5f953 100644
--- a/man/XIGrabButton.txt
+++ b/man/XIGrabButton.txt
@@ -64,7 +64,7 @@ SYNOPSIS
or XIAnyKeycode.
num_modifiers
- Number of elements in modifiers or modifiers_return
+ Number of elements in modifiers or modifiers_inout.
modifiers
Specifies the set of latched and base modifiers or
@@ -178,6 +178,14 @@ DESCRIPTION
XIUngrabButton and XIUngrabKeycode 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.
+
DIAGNOSTICS
-----------
diff --git a/man/XIGrabEnter.txt b/man/XIGrabEnter.txt
index 83e97ca..5203f05 100644
--- a/man/XIGrabEnter.txt
+++ b/man/XIGrabEnter.txt
@@ -51,7 +51,7 @@ SYNOPSIS
Specifies the device that is to be grabbed or released
num_modifiers
- Number of elements in modifiers or modifiers_return
+ Number of elements in modifiers or modifiers_inout.
modifiers
Specifies the set of latched and base modifiers or
@@ -152,6 +152,14 @@ DESCRIPTION
XIUngrabEnter and XIUngrabFocusIn can generate BadDevice,
BadMatch, BadValue and BadWindow errors.
+RETURN VALUE
+------------
+ XIGrabEnter and XIGrabFocusIn 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 XIGrabEnter or XIGrabFocusIn return zero, passive grabs
+ with all requested modifier combinations were established successfully.
+
DIAGNOSTICS
-----------
--
1.7.7
More information about the xorg-devel
mailing list