Function x11rb::protocol::xproto::grab_keyboard

source ·
pub fn grab_keyboard<Conn, A>(
    conn: &Conn,
    owner_events: bool,
    grab_window: Window,
    time: A,
    pointer_mode: GrabMode,
    keyboard_mode: GrabMode,
) -> Result<Cookie<'_, Conn, GrabKeyboardReply>, ConnectionError>
where Conn: RequestConnection + ?Sized, A: Into<Timestamp>,
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);
    }
}