Enum wayland_protocols::unstable::xdg_shell::v5::client::xdg_surface::State

#[repr(u32)]
pub enum State {
    Maximized,
    Fullscreen,
    Resizing,
    Activated,
}

types of state on the surface

The different state values used on the surface. This is designed for state values like maximized, fullscreen. It is paired with the configure event to ensure that both the client and the compositor setting the state can be synchronized.

States set in this way are double-buffered. They will get applied on the next commit.

Desktop environments may extend this enum by taking up a range of values and documenting the range they chose in this description. They are not required to document the values for the range that they chose. Ideally, any good extensions from a desktop environment should make its way into standardization into this enum.

The current reserved ranges are:

0x0000 - 0x0FFF: xdg-shell core values, documented below. 0x1000 - 0x1FFF: GNOME 0x2000 - 0x2FFF: EFL

Variants

Maximized

the surface is maximized

The surface is maximized. The window geometry specified in the configure event must be obeyed by the client.

Fullscreen

the surface is fullscreen

The surface is fullscreen. The window geometry specified in the configure event must be obeyed by the client.

Resizing

the surface is being resized

The surface is being resized. The window geometry specified in the configure event is a maximum; the client cannot resize beyond it. Clients that have aspect ratio or cell sizing configuration can use a smaller size, however.

Activated

the surface is now activated

Client window decorations should be painted as if the window is active. Do not assume this means that the window actually has keyboard or pointer focus.

Methods

impl State

pub fn from_raw(n: u32) -> Option<State>

pub fn to_raw(&self) -> u32

Trait Implementations

impl Copy for State

impl Clone for State

fn clone(&self) -> State

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<State> for State

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Debug for State

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

Formats the value using the given formatter.