pub struct ChangePropertyRequest<'input> {
    pub mode: PropMode,
    pub window: Window,
    pub property: Atom,
    pub type_: Atom,
    pub format: u8,
    pub data_len: u32,
    pub data: Cow<'input, [u8]>,
}
Expand description

Changes a window property.

Sets or updates a property on the specified window. Properties are for example the window title (WM_NAME) or its minimum size (WM_NORMAL_HINTS). Protocols such as EWMH also use properties - for example EWMH defines the window title, encoded as UTF-8 string, in the _NET_WM_NAME property.

§Fields

  • window - The window whose property you want to change.
  • mode -
  • property - The property you want to change (an atom).
  • type - The type of the property you want to change (an atom).
  • format - Specifies whether the data should be viewed as a list of 8-bit, 16-bit or 32-bit quantities. Possible values are 8, 16 and 32. This information allows the X server to correctly perform byte-swap operations as necessary.
  • data_len - Specifies the number of elements (see format).
  • data - The property data.

§Errors

  • Match - TODO: reasons?
  • Value - TODO: reasons?
  • Window - The specified window does not exist.
  • Atom - property or type do not refer to a valid atom.
  • Alloc - The X server could not store the property (no memory?).

§See

  • InternAtom: request
  • xprop: program

§Example

/*
 * Sets the WM_NAME property of the window to "XCB Example".
 *
 */
void my_example(xcb_connection_t *conn, xcb_window_t window) {
    xcb_change_property(conn,
        XCB_PROP_MODE_REPLACE,
        window,
        XCB_ATOM_WM_NAME,
        XCB_ATOM_STRING,
        8,
        strlen("XCB Example"),
        "XCB Example");
    xcb_flush(conn);
}

Fields§

§mode: PropMode§window: Window§property: Atom§type_: Atom§format: u8§data_len: u32§data: Cow<'input, [u8]>

Implementations§

source§

impl<'input> ChangePropertyRequest<'input>

source

pub fn serialize(self) -> BufWithFds<[Cow<'input, [u8]>; 3]>

Serialize this request into bytes for the provided connection

source

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

source

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

Clone all borrowed data in this ChangePropertyRequest.

Trait Implementations§

source§

impl<'input> Clone for ChangePropertyRequest<'input>

source§

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

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<'input> Debug for ChangePropertyRequest<'input>

source§

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

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

impl<'input> Default for ChangePropertyRequest<'input>

source§

fn default() -> ChangePropertyRequest<'input>

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

impl<'de, 'input> Deserialize<'de> for ChangePropertyRequest<'input>

source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl<'input> Hash for ChangePropertyRequest<'input>

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl<'input> Ord for ChangePropertyRequest<'input>

source§

fn cmp(&self, other: &ChangePropertyRequest<'input>) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl<'input> PartialEq for ChangePropertyRequest<'input>

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<'input> PartialOrd for ChangePropertyRequest<'input>

source§

fn partial_cmp(&self, other: &ChangePropertyRequest<'input>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl<'input> Request for ChangePropertyRequest<'input>

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

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

impl<'input> Serialize for ChangePropertyRequest<'input>

source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
source§

impl<'input> Eq for ChangePropertyRequest<'input>

source§

impl<'input> StructuralPartialEq for ChangePropertyRequest<'input>

source§

impl<'input> VoidRequest for ChangePropertyRequest<'input>

Auto Trait Implementations§

§

impl<'input> Freeze for ChangePropertyRequest<'input>

§

impl<'input> RefUnwindSafe for ChangePropertyRequest<'input>

§

impl<'input> Send for ChangePropertyRequest<'input>

§

impl<'input> Sync for ChangePropertyRequest<'input>

§

impl<'input> Unpin for ChangePropertyRequest<'input>

§

impl<'input> UnwindSafe for ChangePropertyRequest<'input>

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.
source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,