Struct x11rb::protocol::xproto::GrabPointerRequest

pub struct GrabPointerRequest {
    pub owner_events: bool,
    pub grab_window: u32,
    pub event_mask: EventMask,
    pub pointer_mode: GrabMode,
    pub keyboard_mode: GrabMode,
    pub confine_to: u32,
    pub cursor: u32,
    pub time: u32,
}

Grab the pointer.

Actively grabs control of the pointer. Further pointer events are reported only to the grabbing client. Overrides any active pointer grab by this client.

Fields

• event_mask - Specifies which pointer events are reported to the client.

TODO: which values?

• confine_to - 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 XCB_NONE means don’t confine the pointer.

• cursor - Specifies the cursor that should be displayed or XCB_NONE to not change the cursor.
• owner_events - If 1, the grab_window will still get the pointer events. If 0, events are not reported to the grab_window.
• grab_window - Specifies the window on which the pointer should be grabbed.
• time - The time argument allows you to avoid certain circumstances that come up if applications take a long time to respond or if there are long network delays. Consider a situation where you have two applications, both of which normally grab the pointer when clicked on. If both applications specify the timestamp from the event, the second application may wake up faster and successfully grab the pointer before the first application. The first application then will get an indication that the other application grabbed the pointer before its request was processed.

The special value XCB_CURRENT_TIME will be replaced with the current server time.

• pointer_mode -
• keyboard_mode -

Errors

• Value - TODO: reasons?
• Window - The specified window does not exist.

See

• GrabKeyboard: request

Example

/*
 * Grabs the pointer actively
 *
 */
void my_example(xcb_connection_t *conn, xcb_screen_t *screen, xcb_cursor_t cursor) {
    xcb_grab_pointer_cookie_t cookie;
    xcb_grab_pointer_reply_t *reply;

    cookie = xcb_grab_pointer(
        conn,
        false,               /* get all pointer events specified by the following mask */
        screen->root,        /* grab the root window */
        XCB_NONE,            /* which events to let through */
        XCB_GRAB_MODE_ASYNC, /* pointer events should continue as normal */
        XCB_GRAB_MODE_ASYNC, /* keyboard mode */
        XCB_NONE,            /* confine_to = in which window should the cursor stay */
        cursor,              /* we change the cursor to whatever the user wanted */
        XCB_CURRENT_TIME
    );

    if ((reply = xcb_grab_pointer_reply(conn, cookie, NULL))) {
        if (reply->status == XCB_GRAB_STATUS_SUCCESS)
            printf("successfully grabbed the pointer\\n");
        free(reply);
    }
}

Fields

owner_events: bool

grab_window: u32

event_mask: EventMask

pointer_mode: GrabMode

keyboard_mode: GrabMode

confine_to: u32

cursor: u32

time: u32

Implementations

impl GrabPointerRequest

pub fn serialize(self) -> ([Cow<'static, [u8]>; 1], Vec<OwnedFd>)

Serialize this request into bytes for the provided connection

Trait Implementations

impl Clone for GrabPointerRequest

fn clone(&self) -> GrabPointerRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GrabPointerRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for GrabPointerRequest

fn default() -> GrabPointerRequest

Returns the “default value” for a type.

impl ReplyRequest for GrabPointerRequest

type Reply = GrabPointerReply

The kind of reply that this request generates.

impl Request for GrabPointerRequest

const EXTENSION_NAME: Option<&'static str> = None

The protocol name of the extension that this request belongs to, or None for core requests

fn serialize(self, _major_opcode: u8) -> (Vec<u8>, Vec<OwnedFd>)

Serialize this request into its X11 protocol wire representation.

impl Copy for GrabPointerRequest