Struct x11rb_protocol::protocol::xproto::GrabKeyRequest

pub struct GrabKeyRequest {
    pub owner_events: bool,
    pub grab_window: Window,
    pub modifiers: u16,
    pub key: Keycode,
    pub pointer_mode: GrabMode,
    pub keyboard_mode: GrabMode,
}

Grab keyboard key(s).

Establishes a passive grab on the keyboard. In the future, the keyboard is actively grabbed (as for GrabKeyboard), the last-keyboard-grab time is set to the time at which the key was pressed (as transmitted in the KeyPress event), and the KeyPress event is reported if all of the following conditions are true:

The keyboard is not grabbed and the specified key (which can itself be a modifier key) is logically pressed when the specified modifier keys are logically down, and no other modifier keys are logically down.

Either the grab_window is an ancestor of (or is) the focus window, or the grab_window is a descendant of the focus window and contains the pointer.

A passive grab on the same key combination does not exist on any ancestor of grab_window.

The interpretation of the remaining arguments is as for XGrabKeyboard. The active grab is terminated automatically when the logical state of the keyboard has the specified key released (independent of the logical state of the modifier keys), at which point a KeyRelease event is reported to the grabbing window.

Note that the logical state of a device (as seen by client applications) may lag the physical state if device event processing is frozen.

A modifiers argument of AnyModifier is equivalent to issuing the request for all possible modifier combinations (including the combination of no modifiers). It is not required that all modifiers specified have currently assigned KeyCodes. A keycode argument of AnyKey is equivalent to issuing the request for all possible KeyCodes. Otherwise, the specified keycode must be in the range specified by min_keycode and max_keycode in the connection setup, or a BadValue error results.

If some other client has issued a XGrabKey with the same key combination on the same window, a BadAccess error results. When using AnyModifier or AnyKey, the request fails completely, and a BadAccess error results (no grabs are established) if there is a conflicting grab for any combination.

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.
• key - The keycode of the key to grab.

The special value XCB_GRAB_ANY means grab any key.

• cursor - Specifies the cursor that should be displayed or XCB_NONE to not change the cursor.
• modifiers - The modifiers to grab.

Using the special value XCB_MOD_MASK_ANY means grab the pointer with all possible modifier combinations.

• pointer_mode -
• keyboard_mode -

Errors

• Access - Another client has already issued a GrabKey with the same button/key combination on the same window.
• Value - TODO: reasons?
• Window - The specified window does not exist.

See

• GrabKeyboard: request

Fields

owner_events: bool

grab_window: Window

modifiers: u16

key: Keycode

pointer_mode: GrabMode

keyboard_mode: GrabMode

Implementations

impl GrabKeyRequest

pub fn serialize(self) -> BufWithFds<PiecewiseBuf<'static>>

Serialize this request into bytes for the provided connection

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

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

Trait Implementations

impl Clone for GrabKeyRequest

fn clone(&self) -> GrabKeyRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GrabKeyRequest

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

Formats the value using the given formatter.

impl Default for GrabKeyRequest

fn default() -> GrabKeyRequest

Returns the “default value” for a type.

impl Hash for GrabKeyRequest

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for GrabKeyRequest

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<GrabKeyRequest> for GrabKeyRequest

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

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

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

This method tests for !=.

impl PartialOrd<GrabKeyRequest> for GrabKeyRequest

fn partial_cmp(&self, other: &GrabKeyRequest) -> 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 Request for GrabKeyRequest

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) -> BufWithFds<Vec<u8>>

Serialize this request into its X11 protocol wire representation.

impl Copy for GrabKeyRequest

impl Eq for GrabKeyRequest

impl StructuralEq for GrabKeyRequest

impl StructuralPartialEq for GrabKeyRequest

impl VoidRequest for GrabKeyRequest