Struct x11rb_protocol::protocol::xproto::CW

source ·
pub struct CW(/* private fields */);
Expand description

§Fields

  • BackPixmap - Overrides the default background-pixmap. The background pixmap and window must have the same root and same depth. Any size pixmap can be used, although some sizes may be faster than others.

If XCB_BACK_PIXMAP_NONE is specified, the window has no defined background. The server may fill the contents with the previous screen contents or with contents of its own choosing.

If XCB_BACK_PIXMAP_PARENT_RELATIVE is specified, the parent’s background is used, but the window must have the same depth as the parent (or a Match error results). The parent’s background is tracked, and the current version is used each time the window background is required.

  • BackPixel - Overrides BackPixmap. A pixmap of undefined size filled with the specified background pixel is used for the background. Range-checking is not performed, the background pixel is truncated to the appropriate number of bits.
  • BorderPixmap - Overrides the default border-pixmap. The border pixmap and window must have the same root and the same depth. Any size pixmap can be used, although some sizes may be faster than others.

The special value XCB_COPY_FROM_PARENT means the parent’s border pixmap is copied (subsequent changes to the parent’s border attribute do not affect the child), but the window must have the same depth as the parent.

  • BorderPixel - Overrides BorderPixmap. A pixmap of undefined size filled with the specified border pixel is used for the border. Range checking is not performed on the border-pixel value, it is truncated to the appropriate number of bits.
  • BitGravity - Defines which region of the window should be retained if the window is resized.
  • WinGravity - Defines how the window should be repositioned if the parent is resized (see ConfigureWindow).
  • BackingStore - A backing-store of WhenMapped advises the server that maintaining contents of obscured regions when the window is mapped would be beneficial. A backing-store of Always advises the server that maintaining contents even when the window is unmapped would be beneficial. In this case, the server may generate an exposure event when the window is created. A value of NotUseful advises the server that maintaining contents is unnecessary, although a server may still choose to maintain contents while the window is mapped. Note that if the server maintains contents, then the server should maintain complete contents not just the region within the parent boundaries, even if the window is larger than its parent. While the server maintains contents, exposure events will not normally be generated, but the server may stop maintaining contents at any time.
  • BackingPlanes - The backing-planes indicates (with bits set to 1) which bit planes of the window hold dynamic data that must be preserved in backing-stores and during save-unders.
  • BackingPixel - The backing-pixel specifies what value to use in planes not covered by backing-planes. The server is free to save only the specified bit planes in the backing-store or save-under and regenerate the remaining planes with the specified pixel value. Any bits beyond the specified depth of the window in these values are simply ignored.
  • OverrideRedirect - The override-redirect specifies whether map and configure requests on this window should override a SubstructureRedirect on the parent, typically to inform a window manager not to tamper with the window.
  • SaveUnder - If 1, the server is advised that when this window is mapped, saving the contents of windows it obscures would be beneficial.
  • EventMask - The event-mask defines which events the client is interested in for this window (or for some event types, inferiors of the window).
  • DontPropagate - The do-not-propagate-mask defines which events should not be propagated to ancestor windows when no client has the event type selected in this window.
  • Colormap - The colormap specifies the colormap that best reflects the true colors of the window. Servers capable of supporting multiple hardware colormaps may use this information, and window man- agers may use it for InstallColormap requests. The colormap must have the same visual type and root as the window (or a Match error results). If CopyFromParent is specified, the parent’s colormap is copied (subsequent changes to the parent’s colormap attribute do not affect the child). However, the window must have the same visual type as the parent (or a Match error results), and the parent must not have a colormap of None (or a Match error results). For an explanation of None, see FreeColormap request. The colormap is copied by sharing the colormap object between the child and the parent, not by making a complete copy of the colormap contents.
  • Cursor - If a cursor is specified, it will be used whenever the pointer is in the window. If None is speci- fied, the parent’s cursor will be used when the pointer is in the window, and any change in the parent’s cursor will cause an immediate change in the displayed cursor.

Implementations§

source§

impl CW

source

pub const BACK_PIXMAP: Self = _

source

pub const BACK_PIXEL: Self = _

source

pub const BORDER_PIXMAP: Self = _

source

pub const BORDER_PIXEL: Self = _

source

pub const BIT_GRAVITY: Self = _

source

pub const WIN_GRAVITY: Self = _

source

pub const BACKING_STORE: Self = _

source

pub const BACKING_PLANES: Self = _

source

pub const BACKING_PIXEL: Self = _

source

pub const OVERRIDE_REDIRECT: Self = _

source

pub const SAVE_UNDER: Self = _

source

pub const EVENT_MASK: Self = _

source

pub const DONT_PROPAGATE: Self = _

source

pub const COLORMAP: Self = _

source

pub const CURSOR: Self = _

source§

impl CW

source

pub fn contains(self, flag: impl Into<u32>) -> bool

Check if this object has all bits set that are also set in flag.

flag can be a single enum variant or a whole other mask.

source

pub fn intersects(self, flag: impl Into<u32>) -> bool

Check if this object has some bits set that are also set in flag.

flag can be a single enum variant or a whole other mask.

source

pub fn remove(self, flags: impl Into<u32>) -> Self

Remove some flags.

All bits that are set in the given flags are removed from the self instance, if they are present.

source

pub fn bits(self) -> u32

Returns the internal value of the object.

Trait Implementations§

source§

impl BitAnd<CW> for u32

§

type Output = CW

The resulting type after applying the & operator.
source§

fn bitand(self, other: CW) -> Self::Output

Performs the & operation. Read more
source§

impl BitAnd<u32> for CW

§

type Output = CW

The resulting type after applying the & operator.
source§

fn bitand(self, other: u32) -> Self::Output

Performs the & operation. Read more
source§

impl BitAnd for CW

§

type Output = CW

The resulting type after applying the & operator.
source§

fn bitand(self, other: Self) -> Self::Output

Performs the & operation. Read more
source§

impl BitAndAssign<CW> for u32

source§

fn bitand_assign(&mut self, other: CW)

Performs the &= operation. Read more
source§

impl BitAndAssign<u32> for CW

source§

fn bitand_assign(&mut self, other: u32)

Performs the &= operation. Read more
source§

impl BitAndAssign for CW

source§

fn bitand_assign(&mut self, other: CW)

Performs the &= operation. Read more
source§

impl BitOr<CW> for u32

§

type Output = CW

The resulting type after applying the | operator.
source§

fn bitor(self, other: CW) -> Self::Output

Performs the | operation. Read more
source§

impl BitOr<u32> for CW

§

type Output = CW

The resulting type after applying the | operator.
source§

fn bitor(self, other: u32) -> Self::Output

Performs the | operation. Read more
source§

impl BitOr for CW

§

type Output = CW

The resulting type after applying the | operator.
source§

fn bitor(self, other: Self) -> Self::Output

Performs the | operation. Read more
source§

impl BitOrAssign<CW> for u32

source§

fn bitor_assign(&mut self, other: CW)

Performs the |= operation. Read more
source§

impl BitOrAssign<u32> for CW

source§

fn bitor_assign(&mut self, other: u32)

Performs the |= operation. Read more
source§

impl BitOrAssign for CW

source§

fn bitor_assign(&mut self, other: CW)

Performs the |= operation. Read more
source§

impl Clone for CW

source§

fn clone(&self) -> CW

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 Debug for CW

source§

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

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

impl Default for CW

source§

fn default() -> CW

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

impl<'de> Deserialize<'de> for CW

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 From<CW> for Option<u32>

source§

fn from(input: CW) -> Self

Converts to this type from the input type.
source§

impl From<CW> for u32

source§

fn from(input: CW) -> Self

Converts to this type from the input type.
source§

impl From<u16> for CW

source§

fn from(value: u16) -> Self

Converts to this type from the input type.
source§

impl From<u32> for CW

source§

fn from(value: u32) -> Self

Converts to this type from the input type.
source§

impl From<u8> for CW

source§

fn from(value: u8) -> Self

Converts to this type from the input type.
source§

impl Hash for CW

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 Ord for CW

source§

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

source§

fn eq(&self, other: &CW) -> 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 PartialOrd for CW

source§

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

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 Copy for CW

source§

impl Eq for CW

source§

impl StructuralPartialEq for CW

Auto Trait Implementations§

§

impl Freeze for CW

§

impl RefUnwindSafe for CW

§

impl Send for CW

§

impl Sync for CW

§

impl Unpin for CW

§

impl UnwindSafe for CW

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>,