Struct gtk4::StateFlags

pub struct StateFlags { /* private fields */ }

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

impl StateFlags

pub const NORMAL: Self = _

State during normal operation

pub const ACTIVE: Self = _

Widget is active

pub const PRELIGHT: Self = _

Widget has a mouse pointer over it

pub const SELECTED: Self = _

Widget is selected

pub const INSENSITIVE: Self = _

Widget is insensitive

pub const INCONSISTENT: Self = _

Widget is inconsistent

pub const FOCUSED: Self = _

Widget has the keyboard focus

pub const BACKDROP: Self = _

Widget is in a background toplevel window

pub const DIR_LTR: Self = _

Widget is in left-to-right text direction

pub const DIR_RTL: Self = _

Widget is in right-to-left text direction

pub const LINK: Self = _

Widget is a link

pub const VISITED: Self = _

The location the widget points to has already been visited

pub const CHECKED: Self = _

Widget is checked

pub const DROP_ACTIVE: Self = _

Widget is highlighted as a drop target for DND

pub const FOCUS_VISIBLE: Self = _

Widget has the visible focus

pub const FOCUS_WITHIN: Self = _

Widget contains the keyboard focus

pub const fn empty() -> Self

Returns an empty set of flags.

pub const fn all() -> Self

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

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.

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

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

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.

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: Self) -> bool

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

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.

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.

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.

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.

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

impl Binary for StateFlags

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

Formats the value using the given formatter.

impl BitAnd<StateFlags> for StateFlags

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

Returns the intersection between the two sets of flags.

type Output = StateFlags

The resulting type after applying the & operator.

impl BitAndAssign<StateFlags> for StateFlags

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

impl BitOr<StateFlags> for StateFlags

fn bitor(self, other: StateFlags) -> Self

Returns the union of the two sets of flags.

type Output = StateFlags

The resulting type after applying the | operator.

impl BitOrAssign<StateFlags> for StateFlags

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

impl BitXor<StateFlags> for StateFlags

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

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

type Output = StateFlags

The resulting type after applying the ^ operator.

impl BitXorAssign<StateFlags> for StateFlags

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

impl Clone for StateFlags

fn clone(&self) -> StateFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StateFlags

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

Formats the value using the given formatter.

impl Display for StateFlags

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

Formats the value using the given formatter.

impl Extend<StateFlags> for StateFlags

fn extend<T: IntoIterator<Item = Self>>(&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<StateFlags> for StateFlags

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

Creates a value from an iterator.

impl<'a> FromValue<'a> for StateFlags

type Checker = GenericValueTypeChecker<StateFlags>

Value type checker.

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

Get the contained value from a Value.

impl Hash for StateFlags

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,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl LowerHex for StateFlags

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

Formats the value using the given formatter.

impl Not for StateFlags

fn not(self) -> Self

Returns the complement of this set of flags.

type Output = StateFlags

The resulting type after applying the ! operator.

impl Octal for StateFlags

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

Formats the value using the given formatter.

impl Ord for StateFlags

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<StateFlags> for StateFlags

fn eq(&self, other: &StateFlags) -> 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<StateFlags> for StateFlags

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

fn static_type() -> Type

Returns the type identifier of Self.

impl Sub<StateFlags> for StateFlags

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

Returns the set difference of the two sets of flags.

type Output = StateFlags

The resulting type after applying the - operator.

impl SubAssign<StateFlags> for StateFlags

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

impl ToValue for StateFlags

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 StateFlags

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

Formats the value using the given formatter.

impl ValueType for StateFlags

type Type = StateFlags

Type to get the Type from.

impl Copy for StateFlags

impl Eq for StateFlags

impl StructuralEq for StateFlags

impl StructuralPartialEq for StateFlags