Struct xcb::x::GrabPointer

pub struct GrabPointer {
    pub owner_events: bool,
    pub grab_window: Window,
    pub event_mask: EventMask,
    pub pointer_mode: GrabMode,
    pub keyboard_mode: GrabMode,
    pub confine_to: Window,
    pub cursor: Cursor,
    pub time: Timestamp,
}

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.

Example

// Grabs the pointer actively
let cookie = conn.send_request(&x::GrabPointer {
    owner_events: false,                // get all pointer events specified by the following mask
    grab_window: screen.root(),         // grab the root window
    event_mask: x::EventMask::NO_EVENT, // which event to let through
    pointer_mode: x::GrabMode::Async,   // pointer events should continue as normal
    keyboard_mode: x::GrabMode::Async,  // pointer events should continue as normal
    confine_to: x::Window::none(),      // in which window should the cursor stay
    cursor,                             // we change the cursor
    time: x::CURRENT_TIME,
});
let reply = conn.wait_for_reply(cookie)?;
assert!(reply.status() == x::GrabStatus::Success, "GrabPointer did not succeed");

This request replies GrabPointerReply.

Associated cookie types are GrabPointerCookie and GrabPointerCookieUnchecked.

Fields

owner_events: bool

If 1, the grab_window will still get the pointer events. If 0, events are not reported to the grab_window.

grab_window: Window

Specifies the window on which the pointer should be grabbed.

event_mask: EventMask

Specifies which pointer events are reported to the client.

TODO: which values?

pointer_mode: GrabMode

keyboard_mode: GrabMode

confine_to: Window

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: Cursor

Specifies the cursor that should be displayed or XCB_NONE to not change the cursor.

time: Timestamp

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.

Trait Implementations

impl Clone for GrabPointer

fn clone(&self) -> GrabPointer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GrabPointer

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

Formats the value using the given formatter.

impl RawRequest for GrabPointer

fn raw_request(&self, c: &Connection, checked: bool) -> u64

Actual implementation of the request sending

impl Request for GrabPointer

type Cookie = GrabPointerCookie

The default cookie associated to this request.

const IS_VOID: bool = false

false if the request returns a reply, true otherwise.

impl RequestWithReply for GrabPointer

type Reply = GrabPointerReply

Reply associated with the request

type Cookie = GrabPointerCookie

Default cookie type for the request, as returned by Connection::send_request.

type CookieUnchecked = GrabPointerCookieUnchecked

Unchecked cookie type for the request, as returned by Connection::send_request_unchecked.