Struct gdk4::ToplevelState

pub struct ToplevelState { /* fields omitted */ }

Specifies the state of a toplevel surface.

On platforms that support information about individual edges, the TILED state will be set whenever any of the individual tiled states is set. On platforms that lack that support, the tiled state will give an indication of tiledness without any of the per-edge states being set.

Implementations

impl ToplevelState

pub const MINIMIZED: ToplevelState

the surface is minimized

pub const MAXIMIZED: ToplevelState

the surface is maximized

pub const STICKY: ToplevelState

the surface is sticky

pub const FULLSCREEN: ToplevelState

the surface is maximized without decorations

pub const ABOVE: ToplevelState

the surface is kept above other surfaces

pub const BELOW: ToplevelState

the surface is kept below other surfaces

pub const FOCUSED: ToplevelState

the surface is presented as focused (with active decorations)

pub const TILED: ToplevelState

the surface is in a tiled state

pub const TOP_TILED: ToplevelState

whether the top edge is tiled

pub const TOP_RESIZABLE: ToplevelState

whether the top edge is resizable

pub const RIGHT_TILED: ToplevelState

whether the right edge is tiled

pub const RIGHT_RESIZABLE: ToplevelState

whether the right edge is resizable

pub const BOTTOM_TILED: ToplevelState

whether the bottom edge is tiled

pub const BOTTOM_RESIZABLE: ToplevelState

whether the bottom edge is resizable

pub const LEFT_TILED: ToplevelState

whether the left edge is tiled

pub const LEFT_RESIZABLE: ToplevelState

whether the left edge is resizable

pub const fn empty() -> ToplevelState

Returns an empty set of flags

pub const fn all() -> ToplevelState

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u32) -> Option<ToplevelState>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u32) -> ToplevelState

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u32) -> ToplevelState

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: ToplevelState) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: ToplevelState) -> bool

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: ToplevelState)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: ToplevelState)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: ToplevelState)

Toggles the specified flags in-place.

pub fn set(&mut self, other: ToplevelState, value: bool)

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl Binary for ToplevelState

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

Formats the value using the given formatter.

impl BitAnd<ToplevelState> for ToplevelState

fn bitand(self, other: ToplevelState) -> ToplevelState

Returns the intersection between the two sets of flags.

type Output = ToplevelState

The resulting type after applying the & operator.

impl BitAndAssign<ToplevelState> for ToplevelState

fn bitand_assign(&mut self, other: ToplevelState)

Disables all flags disabled in the set.

impl BitOr<ToplevelState> for ToplevelState

fn bitor(self, other: ToplevelState) -> ToplevelState

Returns the union of the two sets of flags.

type Output = ToplevelState

The resulting type after applying the | operator.

impl BitOrAssign<ToplevelState> for ToplevelState

fn bitor_assign(&mut self, other: ToplevelState)

Adds the set of flags.

impl BitXor<ToplevelState> for ToplevelState

fn bitxor(self, other: ToplevelState) -> ToplevelState

Returns the left flags, but with all the right flags toggled.

type Output = ToplevelState

The resulting type after applying the ^ operator.

impl BitXorAssign<ToplevelState> for ToplevelState

fn bitxor_assign(&mut self, other: ToplevelState)

Toggles the set of flags.

impl Clone for ToplevelState

fn clone(&self) -> ToplevelState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ToplevelState

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

Formats the value using the given formatter.

impl Display for ToplevelState

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

Formats the value using the given formatter.

impl Extend<ToplevelState> for ToplevelState

fn extend<T: IntoIterator<Item = ToplevelState>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<ToplevelState> for ToplevelState

fn from_iter<T: IntoIterator<Item = ToplevelState>>(
    iterator: T
) -> ToplevelState

Creates a value from an iterator.

impl<'a> FromValue<'a> for ToplevelState

type Checker = GenericValueTypeChecker<Self>

Value type checker.

unsafe fn from_value(value: &'a Value) -> Self

Get the contained value from a Value.

impl Hash for ToplevelState

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 LowerHex for ToplevelState

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

Formats the value using the given formatter.

impl Not for ToplevelState

fn not(self) -> ToplevelState

Returns the complement of this set of flags.

type Output = ToplevelState

The resulting type after applying the ! operator.

impl Octal for ToplevelState

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

Formats the value using the given formatter.

impl Ord for ToplevelState

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

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

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

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

This method tests for !=.

impl PartialOrd<ToplevelState> for ToplevelState

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

fn static_type() -> Type

Returns the type identifier of Self.

impl Sub<ToplevelState> for ToplevelState

fn sub(self, other: ToplevelState) -> ToplevelState

Returns the set difference of the two sets of flags.

type Output = ToplevelState

The resulting type after applying the - operator.

impl SubAssign<ToplevelState> for ToplevelState

fn sub_assign(&mut self, other: ToplevelState)

Disables all flags enabled in the set.

impl ToValue for ToplevelState

fn to_value(&self) -> Value

Convert a value to a Value.

fn value_type(&self) -> Type

Returns the type identifer of self.

impl UpperHex for ToplevelState

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

Formats the value using the given formatter.

impl ValueType for ToplevelState

type Type = Self

Type to get the Type from.

impl Copy for ToplevelState

impl Eq for ToplevelState

impl StructuralEq for ToplevelState

impl StructuralPartialEq for ToplevelState