Struct x11rb_protocol::protocol::xproto::GrabButtonRequest

pub struct GrabButtonRequest {
    pub owner_events: bool,
    pub grab_window: Window,
    pub event_mask: u16,
    pub pointer_mode: GrabMode,
    pub keyboard_mode: GrabMode,
    pub confine_to: Window,
    pub cursor: Cursor,
    pub button: ButtonIndex,
    pub modifiers: u16,
}

Grab pointer button(s).

This request establishes a passive grab. The pointer is actively grabbed as described in GrabPointer, the last-pointer-grab time is set to the time at which the button was pressed (as transmitted in the ButtonPress event), and the ButtonPress event is reported if all of the following conditions are true:

The pointer is not grabbed and the specified button is logically pressed when the specified modifier keys are logically down, and no other buttons or modifier keys are logically down.

The grab-window contains the pointer.

The confine-to window (if any) is viewable.

A passive grab on the same button/key combination does not exist on any ancestor of grab-window.

The interpretation of the remaining arguments is the same as for GrabPointer. The active grab is terminated automatically when the logical state of the pointer has all buttons released, independent of the logical state of modifier keys. Note that the logical state of a device (as seen by means of the protocol) may lag the physical state if device event processing is frozen. This request overrides all previous passive grabs by the same client on the same button/key combinations on the same window. A modifier 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 specified modifiers have currently assigned keycodes. A button of AnyButton is equivalent to issuing the request for all possible buttons. Otherwise, it is not required that the button specified currently be assigned to a physical button.

An Access error is generated if some other client has already issued a GrabButton request with the same button/key combination on the same window. When using AnyModifier or AnyButton, the request fails completely (no grabs are established), and an Access error is generated if there is a conflicting grab for any combination. The request has no effect on an active grab.

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.
• event_mask - Specifies which pointer events are reported to the client.

TODO: which values?

• confine_to - 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 - 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 -
• button -

Errors

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

Fields

owner_events: bool

grab_window: Window

event_mask: u16

pointer_mode: GrabMode

keyboard_mode: GrabMode

confine_to: Window

cursor: Cursor

button: ButtonIndex

modifiers: u16

Implementations

impl GrabButtonRequest

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 GrabButtonRequest

fn clone(&self) -> GrabButtonRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GrabButtonRequest

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

Formats the value using the given formatter.

impl Default for GrabButtonRequest

fn default() -> GrabButtonRequest

Returns the “default value” for a type.

impl Hash for GrabButtonRequest

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 GrabButtonRequest

fn cmp(&self, other: &GrabButtonRequest) -> 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<GrabButtonRequest> for GrabButtonRequest

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

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

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

This method tests for !=.

impl PartialOrd<GrabButtonRequest> for GrabButtonRequest

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

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 GrabButtonRequest

impl Eq for GrabButtonRequest

impl StructuralEq for GrabButtonRequest

impl StructuralPartialEq for GrabButtonRequest

impl VoidRequest for GrabButtonRequest