Struct gtk::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
sourceimpl StateFlags
impl StateFlags
sourcepub const NORMAL: Self = Self{bits: ffi::GTK_STATE_FLAG_NORMAL as u32,}
pub const NORMAL: Self = Self{bits: ffi::GTK_STATE_FLAG_NORMAL as u32,}
State during normal operation.
sourcepub const PRELIGHT: Self = Self{bits: ffi::GTK_STATE_FLAG_PRELIGHT as u32,}
pub const PRELIGHT: Self = Self{bits: ffi::GTK_STATE_FLAG_PRELIGHT as u32,}
Widget has a mouse pointer over it.
sourcepub const SELECTED: Self = Self{bits: ffi::GTK_STATE_FLAG_SELECTED as u32,}
pub const SELECTED: Self = Self{bits: ffi::GTK_STATE_FLAG_SELECTED as u32,}
Widget is selected.
sourcepub const INSENSITIVE: Self = Self{bits: ffi::GTK_STATE_FLAG_INSENSITIVE as u32,}
pub const INSENSITIVE: Self = Self{bits: ffi::GTK_STATE_FLAG_INSENSITIVE as u32,}
Widget is insensitive.
sourcepub const INCONSISTENT: Self = Self{bits: ffi::GTK_STATE_FLAG_INCONSISTENT as u32,}
pub const INCONSISTENT: Self = Self{bits: ffi::GTK_STATE_FLAG_INCONSISTENT as u32,}
Widget is inconsistent.
sourcepub const FOCUSED: Self = Self{bits: ffi::GTK_STATE_FLAG_FOCUSED as u32,}
pub const FOCUSED: Self = Self{bits: ffi::GTK_STATE_FLAG_FOCUSED as u32,}
Widget has the keyboard focus.
sourcepub const BACKDROP: Self = Self{bits: ffi::GTK_STATE_FLAG_BACKDROP as u32,}
pub const BACKDROP: Self = Self{bits: ffi::GTK_STATE_FLAG_BACKDROP as u32,}
Widget is in a background toplevel window.
sourcepub const DIR_LTR: Self = Self{bits: ffi::GTK_STATE_FLAG_DIR_LTR as u32,}
pub const DIR_LTR: Self = Self{bits: ffi::GTK_STATE_FLAG_DIR_LTR as u32,}
Widget is in left-to-right text direction. Since 3.8
sourcepub const DIR_RTL: Self = Self{bits: ffi::GTK_STATE_FLAG_DIR_RTL as u32,}
pub const DIR_RTL: Self = Self{bits: ffi::GTK_STATE_FLAG_DIR_RTL as u32,}
Widget is in right-to-left text direction. Since 3.8
sourcepub const LINK: Self = Self{bits: ffi::GTK_STATE_FLAG_LINK as u32,}
pub const LINK: Self = Self{bits: ffi::GTK_STATE_FLAG_LINK as u32,}
Widget is a link. Since 3.12
sourcepub const VISITED: Self = Self{bits: ffi::GTK_STATE_FLAG_VISITED as u32,}
pub const VISITED: Self = Self{bits: ffi::GTK_STATE_FLAG_VISITED as u32,}
The location the widget points to has already been visited. Since 3.12
sourcepub const CHECKED: Self = Self{bits: ffi::GTK_STATE_FLAG_CHECKED as u32,}
pub const CHECKED: Self = Self{bits: ffi::GTK_STATE_FLAG_CHECKED as u32,}
Widget is checked. Since 3.14
sourcepub const DROP_ACTIVE: Self = Self{bits: ffi::GTK_STATE_FLAG_DROP_ACTIVE as u32,}
pub const DROP_ACTIVE: Self = Self{bits: ffi::GTK_STATE_FLAG_DROP_ACTIVE as u32,}
Widget is highlighted as a drop target for DND. Since 3.20
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
sourceimpl Binary for StateFlags
impl Binary for StateFlags
sourceimpl BitAnd<StateFlags> for StateFlags
impl BitAnd<StateFlags> for StateFlags
type Output = StateFlags
type Output = StateFlags
The resulting type after applying the &
operator.
sourceimpl BitAndAssign<StateFlags> for StateFlags
impl BitAndAssign<StateFlags> for StateFlags
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<StateFlags> for StateFlags
impl BitOr<StateFlags> for StateFlags
sourcefn 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
The resulting type after applying the |
operator.
sourceimpl BitOrAssign<StateFlags> for StateFlags
impl BitOrAssign<StateFlags> for StateFlags
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<StateFlags> for StateFlags
impl BitXor<StateFlags> for StateFlags
sourcefn bitxor(self, other: Self) -> Self
fn bitxor(self, other: Self) -> Self
Returns the left flags, but with all the right flags toggled.
type Output = StateFlags
type Output = StateFlags
The resulting type after applying the ^
operator.
sourceimpl BitXorAssign<StateFlags> for StateFlags
impl BitXorAssign<StateFlags> for StateFlags
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for StateFlags
impl Clone for StateFlags
sourcefn clone(&self) -> StateFlags
fn clone(&self) -> StateFlags
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for StateFlags
impl Debug for StateFlags
sourceimpl Display for StateFlags
impl Display for StateFlags
sourceimpl Extend<StateFlags> for StateFlags
impl Extend<StateFlags> for StateFlags
sourcefn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
Extends a collection with the contents of an iterator. Read more
sourcefn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)Extends a collection with exactly one element.
sourcefn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
sourceimpl FromIterator<StateFlags> for StateFlags
impl FromIterator<StateFlags> for StateFlags
sourcefn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
Creates a value from an iterator. Read more
sourceimpl<'a> FromValue<'a> for StateFlags
impl<'a> FromValue<'a> for StateFlags
type Checker = GenericValueTypeChecker<StateFlags>
type Checker = GenericValueTypeChecker<StateFlags>
Value type checker.
sourceunsafe fn from_value(value: &'a Value) -> Self
unsafe fn from_value(value: &'a Value) -> Self
Get the contained value from a Value
. Read more
sourceimpl Hash for StateFlags
impl Hash for StateFlags
sourceimpl LowerHex for StateFlags
impl LowerHex for StateFlags
sourceimpl Not for StateFlags
impl Not for StateFlags
type Output = StateFlags
type Output = StateFlags
The resulting type after applying the !
operator.
sourceimpl Octal for StateFlags
impl Octal for StateFlags
sourceimpl Ord for StateFlags
impl Ord for StateFlags
sourceimpl PartialEq<StateFlags> for StateFlags
impl PartialEq<StateFlags> for StateFlags
sourcefn eq(&self, other: &StateFlags) -> bool
fn eq(&self, other: &StateFlags) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &StateFlags) -> bool
fn ne(&self, other: &StateFlags) -> bool
This method tests for !=
.
sourceimpl PartialOrd<StateFlags> for StateFlags
impl PartialOrd<StateFlags> for StateFlags
sourcefn partial_cmp(&self, other: &StateFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &StateFlags) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
sourceimpl StaticType for StateFlags
impl StaticType for StateFlags
sourcefn static_type() -> Type
fn static_type() -> Type
Returns the type identifier of Self
.
sourceimpl Sub<StateFlags> for StateFlags
impl Sub<StateFlags> for StateFlags
type Output = StateFlags
type Output = StateFlags
The resulting type after applying the -
operator.
sourceimpl SubAssign<StateFlags> for StateFlags
impl SubAssign<StateFlags> for StateFlags
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
sourceimpl ToValue for StateFlags
impl ToValue for StateFlags
sourceimpl UpperHex for StateFlags
impl UpperHex for StateFlags
sourceimpl ValueType for StateFlags
impl ValueType for StateFlags
type Type = StateFlags
type Type = StateFlags
Type to get the Type
from. Read more
impl 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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> StaticTypeExt for T where
T: StaticType,
impl<T> StaticTypeExt for T where
T: StaticType,
sourcefn ensure_type()
fn ensure_type()
Ensures that the type has been registered with the type system.
sourceimpl<T> ToClosureReturnValue for T where
T: ToValue,
impl<T> ToClosureReturnValue for T where
T: ToValue,
fn to_closure_return_value(&self) -> Option<Value>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> ToSendValue for T where
T: Send + ToValue + ?Sized,
impl<T> ToSendValue for T where
T: Send + ToValue + ?Sized,
sourcefn to_send_value(&self) -> SendValue
fn to_send_value(&self) -> SendValue
Returns a SendValue
clone of self
.