diff options
Diffstat (limited to 'man')
| -rw-r--r-- | man/Makefile.am | 3 | ||||
| -rw-r--r-- | man/XIBarrierReleasePointer.txt | 76 |
2 files changed, 79 insertions, 0 deletions
diff --git a/man/Makefile.am b/man/Makefile.am index af63952..b92d486 100644 --- a/man/Makefile.am +++ b/man/Makefile.am @@ -25,6 +25,7 @@ libmandir = $(LIB_MAN_DIR) # Source files for X Input v2 man pages XI2_txt = \ + XIBarrierReleasePointer.txt \ XIChangeHierarchy.txt \ XIDefineCursor.txt \ XIGrabButton.txt \ @@ -76,6 +77,7 @@ libman_xml = $(libman_txt:.txt=.xml) # They are created by the xmlto command when generating man pages from DocBook # The shadow man page contains a gtroff .so request to include the main man page XI2_shadows = \ + XIBarrierReleasePointers.man \ XIUndefineCursor.man \ XIUngrabButton.man \ XIGrabKeycode.man \ @@ -152,6 +154,7 @@ XIDeleteProperty.man: XIChangeProperty.man XIUngrabEnter.man XIGrabFocusIn.man XIUngrabFocusIn.man: XIGrabEnter.man XIGetSelectedEvents.man: XISelectEvents.man XIFreeDeviceInfo.man: XIQueryDevice.man +XIBarrierReleasePointers.man: XIBarrierReleasePointer.man # String replacements in MAN_SUBSTS now come from xorg-macros.m4 via configure # Unable to use __libmansuffix__ as underscores are lost in txt --> xml conversion diff --git a/man/XIBarrierReleasePointer.txt b/man/XIBarrierReleasePointer.txt new file mode 100644 index 0000000..4fa48fe --- /dev/null +++ b/man/XIBarrierReleasePointer.txt @@ -0,0 +1,76 @@ +XIBARRIERRELEASEPOINTER(libmansuffix) +===================================== + +NAME +---- + + XIBarrierReleasePointer, XIBarrierReleasePointers - allow pointer movement across a pointer barrier + +SYNOPSIS +-------- + + #include <X11/extensions/XInput2.h> + + int XIBarrierReleasePointer( Display *display, + int deviceid, + PointerBarrier barrier, + BarrierEventID eventid); + + int XIBarrierReleasePointers( Display *display, + XIBarrierReleasePointerInfo *barriers, + int num_barriers); + + display + Specifies the connection to the X server. + + deviceid + Specifies the device allowed to move across the barrier. + + barrier + Specifies the barrier. + + eventid + Specifies the unique event ID for this barrier event sequence. + + barriers + List of deviceid, barrier, eventid triplets. + + num_barriers + Number of elements in barriers. + +DESCRIPTION +----------- + + If a pointer is constrained by a pointer barrier, release the pointer + from the barrier and allow it to cross the barrier with the next motion. + If the pointer moves away from the barrier, this request does nothing. + + This request only releases the pointer for the given barrier event + sequence. If the pointer moves away from or through the barrier, a + XI_BarrierLeave event is generated. Future pointer movement constrained + by this barrier will assign a new eventid and require a new + XIBarrierReleasePointer request. + + If the pointer is not currently blocked by the barrier or the barrier + event sequence has ended, this request does nothing. + + XIBarrierReleasePointer and XIBarrierReleasePointers can generate a + BadDevice or BadValue error. + +DIAGNOSTICS +----------- + + BadDevice + An invalid device was specified. The device does not + exist or is not a master pointer device. + + BadValue + A value for a PointerBarrier argument does not name a defined + pointer barrier. + +See also +-------- + + XFixesCreatePointerBarrier(libmansuffix) + + |