Struct x11rb::protocol::xproto::GrabKeyboardRequest

pub struct GrabKeyboardRequest {
    pub owner_events: bool,
    pub grab_window: u32,
    pub time: u32,
    pub pointer_mode: GrabMode,
    pub keyboard_mode: GrabMode,
}

Grab the keyboard.

Actively grabs control of the keyboard and generates FocusIn and FocusOut events. Further key events are reported only to the grabbing client.

Any active keyboard grab by this client is overridden. If the keyboard is actively grabbed by some other client, AlreadyGrabbed is returned. If grab_window is not viewable, GrabNotViewable is returned. If the keyboard is frozen by an active grab of another client, GrabFrozen is returned. If the specified time is earlier than the last-keyboard-grab time or later than the current X server time, GrabInvalidTime is returned. Otherwise, the last-keyboard-grab time is set to the specified time.

Fields

• 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 - Timestamp to avoid race conditions when running X over the network.

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

• GrabPointer: request

Example

/*
 * Grabs the keyboard actively
 *
 */
void my_example(xcb_connection_t *conn, xcb_screen_t *screen) {
    xcb_grab_keyboard_cookie_t cookie;
    xcb_grab_keyboard_reply_t *reply;

    cookie = xcb_grab_keyboard(
        conn,
        true,                /* report events */
        screen->root,        /* grab the root window */
        XCB_CURRENT_TIME,
        XCB_GRAB_MODE_ASYNC, /* process events as normal, do not require sync */
        XCB_GRAB_MODE_ASYNC
    );

    if ((reply = xcb_grab_keyboard_reply(conn, cookie, NULL))) {
        if (reply->status == XCB_GRAB_STATUS_SUCCESS)
            printf("successfully grabbed the keyboard\\n");

        free(reply);
    }
}

Fields

owner_events: bool

grab_window: u32

time: u32

pointer_mode: GrabMode

keyboard_mode: GrabMode

Implementations

impl GrabKeyboardRequest

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

Serialize this request into bytes for the provided connection

pub fn try_parse_request( header: RequestHeader, value: &[u8] ) -> Result<GrabKeyboardRequest, ParseError>

Parse this request given its header, its body, and any fds that go along with it

Trait Implementations

impl Clone for GrabKeyboardRequest

fn clone(&self) -> GrabKeyboardRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GrabKeyboardRequest

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

Formats the value using the given formatter.

impl Default for GrabKeyboardRequest

fn default() -> GrabKeyboardRequest

Returns the “default value” for a type.

impl Hash for GrabKeyboardRequest

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for GrabKeyboardRequest

fn cmp(&self, other: &GrabKeyboardRequest) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for GrabKeyboardRequest

fn eq(&self, other: &GrabKeyboardRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for GrabKeyboardRequest

fn partial_cmp(&self, other: &GrabKeyboardRequest) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl ReplyRequest for GrabKeyboardRequest

type Reply = GrabKeyboardReply

The kind of reply that this request generates.

impl Request for GrabKeyboardRequest

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 GrabKeyboardRequest

impl Eq for GrabKeyboardRequest

impl StructuralPartialEq for GrabKeyboardRequest