Struct gdk4::ToplevelState
source · pub struct ToplevelState { /* private fields */ }
Expand description
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§
source§impl ToplevelState
impl ToplevelState
sourcepub const FULLSCREEN: Self = _
pub const FULLSCREEN: Self = _
the surface is maximized without decorations
sourcepub const TOP_RESIZABLE: Self = _
pub const TOP_RESIZABLE: Self = _
whether the top edge is resizable
sourcepub const RIGHT_TILED: Self = _
pub const RIGHT_TILED: Self = _
whether the right edge is tiled
sourcepub const RIGHT_RESIZABLE: Self = _
pub const RIGHT_RESIZABLE: Self = _
whether the right edge is resizable
sourcepub const BOTTOM_TILED: Self = _
pub const BOTTOM_TILED: Self = _
whether the bottom edge is tiled
sourcepub const BOTTOM_RESIZABLE: Self = _
pub const BOTTOM_RESIZABLE: Self = _
whether the bottom edge is resizable
sourcepub const LEFT_TILED: Self = _
pub const LEFT_TILED: Self = _
whether the left edge is tiled
sourcepub const LEFT_RESIZABLE: Self = _
pub const LEFT_RESIZABLE: Self = _
whether the left edge is resizable
sourcepub const fn from_bits(bits: u32) -> Option<Self>
pub const fn from_bits(bits: u32) -> Option<Self>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
sourcepub const fn from_bits_truncate(bits: u32) -> Self
pub const fn from_bits_truncate(bits: u32) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u32) -> Self
pub const unsafe fn from_bits_unchecked(bits: u32) -> Self
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
Safety
The caller of the bitflags!
macro can chose to allow or
disallow extra bits for their bitflags type.
The caller of from_bits_unchecked()
has to ensure that
all bits correspond to a defined flag or that extra bits
are valid for this bitflags type.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
Returns the intersection between the flags in self
and
other
.
Specifically, the returned set contains only the flags which are
present in both self
and other
.
This is equivalent to using the &
operator (e.g.
ops::BitAnd
), as in flags & other
.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
Returns the union of between the flags in self
and other
.
Specifically, the returned set contains all flags which are
present in either self
or other
, including any which are
present in both (see Self::symmetric_difference
if that
is undesirable).
This is equivalent to using the |
operator (e.g.
ops::BitOr
), as in flags | other
.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
Returns the difference between the flags in self
and other
.
Specifically, the returned set contains all flags present in
self
, except for the ones present in other
.
It is also conceptually equivalent to the “bit-clear” operation:
flags & !other
(and this syntax is also supported).
This is equivalent to using the -
operator (e.g.
ops::Sub
), as in flags - other
.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
Returns the symmetric difference between the flags
in self
and other
.
Specifically, the returned set contains the flags present which
are present in self
or other
, but that are not present in
both. Equivalently, it contains the flags present in exactly
one of the sets self
and other
.
This is equivalent to using the ^
operator (e.g.
ops::BitXor
), as in flags ^ other
.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
Returns the complement of this set of flags.
Specifically, the returned set contains all the flags which are
not set in self
, but which are allowed for this type.
Alternatively, it can be thought of as the set difference
between Self::all()
and self
(e.g. Self::all() - self
)
This is equivalent to using the !
operator (e.g.
ops::Not
), as in !flags
.
Trait Implementations§
source§impl Binary for ToplevelState
impl Binary for ToplevelState
source§impl BitAnd<ToplevelState> for ToplevelState
impl BitAnd<ToplevelState> for ToplevelState
source§impl BitAndAssign<ToplevelState> for ToplevelState
impl BitAndAssign<ToplevelState> for ToplevelState
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitOr<ToplevelState> for ToplevelState
impl BitOr<ToplevelState> for ToplevelState
source§fn bitor(self, other: ToplevelState) -> Self
fn bitor(self, other: ToplevelState) -> Self
Returns the union of the two sets of flags.
§type Output = ToplevelState
type Output = ToplevelState
|
operator.source§impl BitOrAssign<ToplevelState> for ToplevelState
impl BitOrAssign<ToplevelState> for ToplevelState
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor<ToplevelState> for ToplevelState
impl BitXor<ToplevelState> for ToplevelState
source§impl BitXorAssign<ToplevelState> for ToplevelState
impl BitXorAssign<ToplevelState> for ToplevelState
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for ToplevelState
impl Clone for ToplevelState
source§fn clone(&self) -> ToplevelState
fn clone(&self) -> ToplevelState
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ToplevelState
impl Debug for ToplevelState
source§impl Display for ToplevelState
impl Display for ToplevelState
source§impl Extend<ToplevelState> for ToplevelState
impl Extend<ToplevelState> for ToplevelState
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl From<ToplevelState> for Value
impl From<ToplevelState> for Value
source§fn from(v: ToplevelState) -> Self
fn from(v: ToplevelState) -> Self
source§impl FromIterator<ToplevelState> for ToplevelState
impl FromIterator<ToplevelState> for ToplevelState
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl<'a> FromValue<'a> for ToplevelState
impl<'a> FromValue<'a> for ToplevelState
§type Checker = GenericValueTypeChecker<ToplevelState>
type Checker = GenericValueTypeChecker<ToplevelState>
source§unsafe fn from_value(value: &'a Value) -> Self
unsafe fn from_value(value: &'a Value) -> Self
Value
. Read moresource§impl HasParamSpec for ToplevelState
impl HasParamSpec for ToplevelState
type ParamSpec = ParamSpecFlags
§type SetValue = ToplevelState
type SetValue = ToplevelState
type BuilderFn = fn(_: &str) -> ParamSpecFlagsBuilder<'_, ToplevelState>
fn param_spec_builder() -> Self::BuilderFn
source§impl Hash for ToplevelState
impl Hash for ToplevelState
source§impl LowerHex for ToplevelState
impl LowerHex for ToplevelState
source§impl Not for ToplevelState
impl Not for ToplevelState
source§impl Octal for ToplevelState
impl Octal for ToplevelState
source§impl Ord for ToplevelState
impl Ord for ToplevelState
source§fn cmp(&self, other: &ToplevelState) -> Ordering
fn cmp(&self, other: &ToplevelState) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere Self: Sized,
source§impl PartialEq<ToplevelState> for ToplevelState
impl PartialEq<ToplevelState> for ToplevelState
source§fn eq(&self, other: &ToplevelState) -> bool
fn eq(&self, other: &ToplevelState) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd<ToplevelState> for ToplevelState
impl PartialOrd<ToplevelState> for ToplevelState
source§fn partial_cmp(&self, other: &ToplevelState) -> Option<Ordering>
fn partial_cmp(&self, other: &ToplevelState) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl StaticType for ToplevelState
impl StaticType for ToplevelState
source§fn static_type() -> Type
fn static_type() -> Type
Self
.source§impl Sub<ToplevelState> for ToplevelState
impl Sub<ToplevelState> for ToplevelState
source§impl SubAssign<ToplevelState> for ToplevelState
impl SubAssign<ToplevelState> for ToplevelState
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
source§impl ToValue for ToplevelState
impl ToValue for ToplevelState
source§impl UpperHex for ToplevelState
impl UpperHex for ToplevelState
source§impl ValueType for ToplevelState
impl ValueType for ToplevelState
§type Type = ToplevelState
type Type = ToplevelState
Type
from. Read moreimpl Copy for ToplevelState
impl Eq for ToplevelState
impl StructuralEq for ToplevelState
impl StructuralPartialEq for ToplevelState
Auto Trait Implementations§
impl RefUnwindSafe for ToplevelState
impl Send for ToplevelState
impl Sync for ToplevelState
impl Unpin for ToplevelState
impl UnwindSafe for ToplevelState
Blanket Implementations§
source§impl<T> IntoClosureReturnValue for Twhere
T: Into<Value>,
impl<T> IntoClosureReturnValue for Twhere T: Into<Value>,
fn into_closure_return_value(self) -> Option<Value>
source§impl<T> PropertyGet for Twhere
T: HasParamSpec,
impl<T> PropertyGet for Twhere T: HasParamSpec,
source§impl<T> StaticTypeExt for Twhere
T: StaticType,
impl<T> StaticTypeExt for Twhere T: StaticType,
source§fn ensure_type()
fn ensure_type()
source§impl<T> ToSendValue for Twhere
T: Send + ToValue + ?Sized,
impl<T> ToSendValue for Twhere T: Send + ToValue + ?Sized,
source§fn to_send_value(&self) -> SendValue
fn to_send_value(&self) -> SendValue
SendValue
clone of self
.