Struct x11rb::protocol::xproto::GrabKeyboardRequest

source ·
pub struct GrabKeyboardRequest {
    pub owner_events: bool,
    pub grab_window: u32,
    pub time: u32,
    pub pointer_mode: GrabMode,
    pub keyboard_mode: GrabMode,
}
Expand description

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§

source§

impl GrabKeyboardRequest

source

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

Serialize this request into bytes for the provided connection

Trait Implementations§

source§

impl Clone for GrabKeyboardRequest

source§

fn clone(&self) -> GrabKeyboardRequest

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for GrabKeyboardRequest

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for GrabKeyboardRequest

source§

fn default() -> GrabKeyboardRequest

Returns the “default value” for a type. Read more
source§

impl ReplyRequest for GrabKeyboardRequest

§

type Reply = GrabKeyboardReply

The kind of reply that this request generates.
source§

impl Request for GrabKeyboardRequest

source§

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

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

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

Serialize this request into its X11 protocol wire representation. Read more
source§

impl Copy for GrabKeyboardRequest

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.