Struct x11rb::protocol::xproto::CW

pub struct CW(/* private fields */);

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

impl CW

pub const BACK_PIXMAP: CW = _

pub const BACK_PIXEL: CW = _

pub const BORDER_PIXMAP: CW = _

pub const BORDER_PIXEL: CW = _

pub const BIT_GRAVITY: CW = _

pub const WIN_GRAVITY: CW = _

pub const BACKING_STORE: CW = _

pub const BACKING_PLANES: CW = _

pub const BACKING_PIXEL: CW = _

pub const OVERRIDE_REDIRECT: CW = _

pub const SAVE_UNDER: CW = _

pub const EVENT_MASK: CW = _

pub const DONT_PROPAGATE: CW = _

pub const COLORMAP: CW = _

pub const CURSOR: CW = _

impl CW

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.

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.

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

Remove some flags.

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

pub fn bits(self) -> u32

Returns the internal value of the object.

Trait Implementations

impl BitAnd<u32> for CW

type Output = CW

The resulting type after applying the & operator.

fn bitand(self, other: u32) -> <CW as BitAnd<u32>>::Output

Performs the & operation.

impl BitAnd for CW

type Output = CW

The resulting type after applying the & operator.

fn bitand(self, other: CW) -> <CW as BitAnd>::Output

Performs the & operation.

impl BitAndAssign<u32> for CW

fn bitand_assign(&mut self, other: u32)

Performs the &= operation.

impl BitAndAssign for CW

fn bitand_assign(&mut self, other: CW)

Performs the &= operation.

impl BitOr<u32> for CW

type Output = CW

The resulting type after applying the | operator.

fn bitor(self, other: u32) -> <CW as BitOr<u32>>::Output

Performs the | operation.

impl BitOr for CW

type Output = CW

The resulting type after applying the | operator.

fn bitor(self, other: CW) -> <CW as BitOr>::Output

Performs the | operation.

impl BitOrAssign<u32> for CW

fn bitor_assign(&mut self, other: u32)

Performs the |= operation.

impl BitOrAssign for CW

fn bitor_assign(&mut self, other: CW)

Performs the |= operation.

impl Clone for CW

fn clone(&self) -> CW

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CW

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

Formats the value using the given formatter.

impl Default for CW

fn default() -> CW

Returns the “default value” for a type.

impl From<u16> for CW

fn from(value: u16) -> CW

Converts to this type from the input type.

impl From<u32> for CW

fn from(value: u32) -> CW

Converts to this type from the input type.

impl From<u8> for CW

fn from(value: u8) -> CW

Converts to this type from the input type.

impl Hash for CW

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

where __H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for CW

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for CW

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

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

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.

impl PartialOrd for CW

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

impl Eq for CW

impl StructuralPartialEq for CW