NAME
xcbgrabbutton - Grab pointer button(s) SYNOPSIS
#include
Request function xcbvoidcookiet xcbgrabbutton(xcbconnectiont *conn, uint8t ownerevents, xcbwindowt grabwindow, uint16t eventmask, uint8t pointermode, uint8t keyboardmode, xcbwindowt confineto, xcbcursort cursor, uint8t button, uint16t modifiers); REQUEST ARGUMENTS conn The XCB connection to X11. ownerevents If 1, the grabwindow will still get the pointer events. If 0, events are not reported to the grabwindow. grabwindow Specifies the window on which the pointer should be grabbed. eventmask Specifies which pointer events are reported to the client. TODO: which values? pointermode One of the following values: XCBGRABMODESYNC The state of the keyboard appears to freeze: No further keyboard events are generated by the server until the grabbing client issues a releasing Allow‐ Events request or until the keyboard grab is re‐ leased. XCBGRABMODEASYNC Keyboard event processing continues normally. keyboardmode One of the following values: XCBGRABMODESYNC The state of the keyboard appears to freeze: No further keyboard events are generated by the server until the grabbing client issues a releasing Allow‐ Events request or until the keyboard grab is re‐ leased. XCBGRABMODEASYNC Keyboard event processing continues normally. confineto Specifies the window to confine the pointer in (the user will not be able to move the pointer out of that window). The special value XCBNONE means don't confine the pointer. cursor Specifies the cursor that should be displayed or XCBNONE to not change the cursor. button One of the following values: XCBBUTTONINDEXANY Any of the following (or none): XCBBUTTONINDEX1 The left mouse button. XCBBUTTONINDEX2 The right mouse button. XCBBUTTONINDEX3 The middle mouse button. XCBBUTTONINDEX4 Scroll wheel. TODO: direction? XCBBUTTONINDEX5 Scroll wheel. TODO: direction? modifiers The modifiers to grab. Using the special value XCBMODMASKANY means grab the pointer with all possible modifier combinations. DESCRIPTION This request establishes a passive grab. The pointer is actively grabbed as described in GrabPointer, the last-pointer-grab time is set to the time at which the button was pressed (as transmitted in the But‐ tonPress event), and the ButtonPress event is reported if all of the following conditions are true: The pointer is not grabbed and the specified button is logically pressed when the specified modifier keys are logically down, and no other buttons or modifier keys are logically down.
The grab-window contains the pointer.
The confine-to window (if any) is viewable. A passive grab on the same button/key combination does not exist on any
ancestor of grab-window. The interpretation of the remaining arguments is the same as for Grab‐ Pointer. The active grab is terminated automatically when the logical state of the pointer has all buttons released, independent of the logi‐ cal state of modifier keys. Note that the logical state of a device (as seen by means of the protocol) may lag the physical state if device event processing is frozen. This request overrides all previous passive grabs by the same client on the same button/key combinations on the same window. A modifier of AnyModifier is equivalent to issuing the re‐ quest for all possible modifier combinations (including the combination of no modifiers). It is not required that all specified modifiers have currently assigned keycodes. A button of AnyButton is equivalent to is‐ suing the request for all possible buttons. Otherwise, it is not re‐ quired that the button specified currently be assigned to a physical button. An Access error is generated if some other client has already issued a GrabButton request with the same button/key combination on the same window. When using AnyModifier or AnyButton, the request fails com‐ pletely (no grabs are established), and an Access error is generated if there is a conflicting grab for any combination. The request has no ef‐ fect on an active grab. RETURN VALUE Returns an xcbvoidcookiet. Errors (if any) have to be handled in the event loop. If you want to handle errors directly with xcbrequestcheck instead,
use xcbgrabbuttonchecked. See xcb-requests(3) for details. ERRORS xcbaccesserrort Another client has already issued a GrabButton with the same button/key combination on the same window. xcbcursorerrort The specified cursor does not exist. xcbvalueerrort TODO: reasons? xcbwindowerrort The specified window does not exist. SEE ALSO
xcb-requests(3) AUTHOR Generated from xproto.xml. Contact xcb@lists.freedesktop.org for cor‐ rections and improvements. X Version 11 libxcb 1.13 xcbgrabbutton(3)