Struct xcb::ffi::xproto::xcb_grab_pointer_request_t

#[repr(C)]
pub struct xcb_grab_pointer_request_t {
    pub major_opcode: u8,
    pub owner_events: u8,
    pub length: u16,
    pub grab_window: xcb_window_t,
    pub event_mask: u16,
    pub pointer_mode: u8,
    pub keyboard_mode: u8,
    pub confine_to: xcb_window_t,
    pub cursor: xcb_cursor_t,
    pub time: xcb_timestamp_t,
}

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

major_opcode: u8

owner_events: u8

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

length: u16

grab_window: xcb_window_t

Specifies the window on which the pointer should be grabbed.

event_mask: u16

Specifies which pointer events are reported to the client.

TODO: which values?

pointer_mode: u8

keyboard_mode: u8

confine_to: xcb_window_t

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

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

time: xcb_timestamp_t

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 Copy for xcb_grab_pointer_request_t

impl Clone for xcb_grab_pointer_request_t

fn clone(&self) -> xcb_grab_pointer_request_t

Returns a copy of the value.

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

Performs copy-assignment from source.