Struct x11rb_protocol::protocol::xproto::SendEventRequest

pub struct SendEventRequest<'input> {
    pub propagate: bool,
    pub destination: Window,
    pub event_mask: u32,
    pub event: Cow<'input, [u8; 32]>,
}

send an event.

Identifies the destination window, determines which clients should receive the specified event and ignores any active grabs.

The event must be one of the core events or an event defined by an extension, so that the X server can correctly byte-swap the contents as necessary. The contents of event are otherwise unaltered and unchecked except for the send_event field which is forced to ‘true’.

Fields

• destination - The window to send this event to. Every client which selects any event within event_mask on destination will get the event.

The special value XCB_SEND_EVENT_DEST_POINTER_WINDOW refers to the window that contains the mouse pointer.

The special value XCB_SEND_EVENT_DEST_ITEM_FOCUS refers to the window which has the keyboard focus.

• event_mask - Event_mask for determining which clients should receive the specified event. See destination and propagate.
• propagate - If propagate is true and no clients have selected any event on destination, the destination is replaced with the closest ancestor of destination for which some client has selected a type in event_mask and for which no intervening window has that type in its do-not-propagate-mask. If no such window exists or if the window is an ancestor of the focus window and InputFocus was originally specified as the destination, the event is not sent to any clients. Otherwise, the event is reported to every client selecting on the final destination any of the types specified in event_mask.
• event - The event to send to the specified destination.

Errors

• Window - The specified destination window does not exist.
• Value - The given event is neither a core event nor an event defined by an extension.

See

• ConfigureNotify: event

Example

/*
 * Tell the given window that it was configured to a size of 800x600 pixels.
 *
 */
void my_example(xcb_connection_t *conn, xcb_window_t window) {
    /* Every X11 event is 32 bytes long. Therefore, XCB will copy 32 bytes.
     * In order to properly initialize these bytes, we allocate 32 bytes even
     * though we only need less for an xcb_configure_notify_event_t */
    xcb_configure_notify_event_t *event = calloc(32, 1);

    event->event = window;
    event->window = window;
    event->response_type = XCB_CONFIGURE_NOTIFY;

    event->x = 0;
    event->y = 0;
    event->width = 800;
    event->height = 600;

    event->border_width = 0;
    event->above_sibling = XCB_NONE;
    event->override_redirect = false;

    xcb_send_event(conn, false, window, XCB_EVENT_MASK_STRUCTURE_NOTIFY,
                   (char*)event);
    xcb_flush(conn);
    free(event);
}

Fields

propagate: bool

destination: Window

event_mask: u32

event: Cow<'input, [u8; 32]>

Implementations

impl<'input> SendEventRequest<'input>

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

Serialize this request into bytes for the provided connection

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

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

pub fn into_owned(self) -> SendEventRequest<'static>

Clone all borrowed data in this SendEventRequest.

Trait Implementations

impl<'input> Clone for SendEventRequest<'input>

fn clone(&self) -> SendEventRequest<'input>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'input> Debug for SendEventRequest<'input>

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

Formats the value using the given formatter.

impl<'input> Default for SendEventRequest<'input>

fn default() -> SendEventRequest<'input>

Returns the “default value” for a type.

impl<'input> Hash for SendEventRequest<'input>

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<'input> Ord for SendEventRequest<'input>

fn cmp(&self, other: &SendEventRequest<'input>) -> 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<'input> PartialEq<SendEventRequest<'input>> for SendEventRequest<'input>

fn eq(&self, other: &SendEventRequest<'input>) -> bool

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

fn ne(&self, other: &SendEventRequest<'input>) -> bool

This method tests for !=.

impl<'input> PartialOrd<SendEventRequest<'input>> for SendEventRequest<'input>

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

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<'input> Eq for SendEventRequest<'input>

impl<'input> StructuralEq for SendEventRequest<'input>

impl<'input> StructuralPartialEq for SendEventRequest<'input>

impl<'input> VoidRequest for SendEventRequest<'input>