Struct gtk4::StateFlags
source · pub struct StateFlags { /* private fields */ }
Expand description
Describes a widget state.
Widget states are used to match the widget against CSS pseudo-classes. Note that GTK extends the regular CSS classes and sometimes uses different names.
Implementations§
source§impl StateFlags
impl StateFlags
sourcepub const INSENSITIVE: Self = _
pub const INSENSITIVE: Self = _
Widget is insensitive
sourcepub const INCONSISTENT: Self = _
pub const INCONSISTENT: Self = _
Widget is inconsistent
sourcepub const DROP_ACTIVE: Self = _
pub const DROP_ACTIVE: Self = _
Widget is highlighted as a drop target for DND
sourcepub const FOCUS_VISIBLE: Self = _
pub const FOCUS_VISIBLE: Self = _
Widget has the visible focus
sourcepub const FOCUS_WITHIN: Self = _
pub const FOCUS_WITHIN: Self = _
Widget contains the keyboard focus
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 StateFlags
impl Binary for StateFlags
source§impl BitAnd<StateFlags> for StateFlags
impl BitAnd<StateFlags> for StateFlags
source§impl BitAndAssign<StateFlags> for StateFlags
impl BitAndAssign<StateFlags> for StateFlags
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<StateFlags> for StateFlags
impl BitOr<StateFlags> for StateFlags
source§fn bitor(self, other: StateFlags) -> Self
fn bitor(self, other: StateFlags) -> Self
Returns the union of the two sets of flags.
§type Output = StateFlags
type Output = StateFlags
|
operator.source§impl BitOrAssign<StateFlags> for StateFlags
impl BitOrAssign<StateFlags> for StateFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor<StateFlags> for StateFlags
impl BitXor<StateFlags> for StateFlags
source§impl BitXorAssign<StateFlags> for StateFlags
impl BitXorAssign<StateFlags> for StateFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for StateFlags
impl Clone for StateFlags
source§fn clone(&self) -> StateFlags
fn clone(&self) -> StateFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for StateFlags
impl Debug for StateFlags
source§impl Display for StateFlags
impl Display for StateFlags
source§impl Extend<StateFlags> for StateFlags
impl Extend<StateFlags> for StateFlags
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<StateFlags> for Value
impl From<StateFlags> for Value
source§fn from(v: StateFlags) -> Self
fn from(v: StateFlags) -> Self
source§impl FromIterator<StateFlags> for StateFlags
impl FromIterator<StateFlags> for StateFlags
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 StateFlags
impl<'a> FromValue<'a> for StateFlags
§type Checker = GenericValueTypeChecker<StateFlags>
type Checker = GenericValueTypeChecker<StateFlags>
source§unsafe fn from_value(value: &'a Value) -> Self
unsafe fn from_value(value: &'a Value) -> Self
Value
. Read moresource§impl HasParamSpec for StateFlags
impl HasParamSpec for StateFlags
type ParamSpec = ParamSpecFlags
§type SetValue = StateFlags
type SetValue = StateFlags
type BuilderFn = fn(_: &str) -> ParamSpecFlagsBuilder<'_, StateFlags>
fn param_spec_builder() -> Self::BuilderFn
source§impl Hash for StateFlags
impl Hash for StateFlags
source§impl LowerHex for StateFlags
impl LowerHex for StateFlags
source§impl Not for StateFlags
impl Not for StateFlags
source§impl Octal for StateFlags
impl Octal for StateFlags
source§impl Ord for StateFlags
impl Ord for StateFlags
source§fn cmp(&self, other: &StateFlags) -> Ordering
fn cmp(&self, other: &StateFlags) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere Self: Sized,
source§impl PartialEq<StateFlags> for StateFlags
impl PartialEq<StateFlags> for StateFlags
source§fn eq(&self, other: &StateFlags) -> bool
fn eq(&self, other: &StateFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd<StateFlags> for StateFlags
impl PartialOrd<StateFlags> for StateFlags
source§fn partial_cmp(&self, other: &StateFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &StateFlags) -> 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 StateFlags
impl StaticType for StateFlags
source§fn static_type() -> Type
fn static_type() -> Type
Self
.source§impl Sub<StateFlags> for StateFlags
impl Sub<StateFlags> for StateFlags
source§impl SubAssign<StateFlags> for StateFlags
impl SubAssign<StateFlags> for StateFlags
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 StateFlags
impl ToValue for StateFlags
source§impl UpperHex for StateFlags
impl UpperHex for StateFlags
source§impl ValueType for StateFlags
impl ValueType for StateFlags
§type Type = StateFlags
type Type = StateFlags
Type
from. Read moreimpl Copy for StateFlags
impl Eq for StateFlags
impl StructuralEq for StateFlags
impl StructuralPartialEq for StateFlags
Auto Trait Implementations§
impl RefUnwindSafe for StateFlags
impl Send for StateFlags
impl Sync for StateFlags
impl Unpin for StateFlags
impl UnwindSafe for StateFlags
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
.