Struct native_windows_gui::CheckBoxFlags
source · [−]pub struct CheckBoxFlags { /* private fields */ }
Expand description
The CheckBox flags
- NONE: No flags. Equivalent to a invisible default checkbox.
- VISIBLE: The checkbox is immediatly visible after creation
- DISABLED: The checkbox cannot be interacted with by the user. It also has a grayed out look.
- TRISTATE: The checkbox will have a 3rd state
- PUSHLIKE: The checkbox will look like a regular button
- TAB_STOP: The control can be selected using tab navigation
Implementations
sourceimpl CheckBoxFlags
impl CheckBoxFlags
pub const NONE: Self = _
pub const VISIBLE: Self = _
pub const DISABLED: Self = _
pub const TRISTATE: Self = _
pub const PUSHLIKE: Self = _
pub const TAB_STOP: Self = _
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 CheckBoxFlags
impl Binary for CheckBoxFlags
sourceimpl BitAnd<CheckBoxFlags> for CheckBoxFlags
impl BitAnd<CheckBoxFlags> for CheckBoxFlags
type Output = CheckBoxFlags
type Output = CheckBoxFlags
The resulting type after applying the &
operator.
sourceimpl BitAndAssign<CheckBoxFlags> for CheckBoxFlags
impl BitAndAssign<CheckBoxFlags> for CheckBoxFlags
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<CheckBoxFlags> for CheckBoxFlags
impl BitOr<CheckBoxFlags> for CheckBoxFlags
sourcefn bitor(self, other: CheckBoxFlags) -> Self
fn bitor(self, other: CheckBoxFlags) -> Self
Returns the union of the two sets of flags.
type Output = CheckBoxFlags
type Output = CheckBoxFlags
The resulting type after applying the |
operator.
sourceimpl BitOrAssign<CheckBoxFlags> for CheckBoxFlags
impl BitOrAssign<CheckBoxFlags> for CheckBoxFlags
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<CheckBoxFlags> for CheckBoxFlags
impl BitXor<CheckBoxFlags> for CheckBoxFlags
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 = CheckBoxFlags
type Output = CheckBoxFlags
The resulting type after applying the ^
operator.
sourceimpl BitXorAssign<CheckBoxFlags> for CheckBoxFlags
impl BitXorAssign<CheckBoxFlags> for CheckBoxFlags
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for CheckBoxFlags
impl Clone for CheckBoxFlags
sourcefn clone(&self) -> CheckBoxFlags
fn clone(&self) -> CheckBoxFlags
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 CheckBoxFlags
impl Debug for CheckBoxFlags
sourceimpl Extend<CheckBoxFlags> for CheckBoxFlags
impl Extend<CheckBoxFlags> for CheckBoxFlags
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<CheckBoxFlags> for CheckBoxFlags
impl FromIterator<CheckBoxFlags> for CheckBoxFlags
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 Hash for CheckBoxFlags
impl Hash for CheckBoxFlags
sourceimpl LowerHex for CheckBoxFlags
impl LowerHex for CheckBoxFlags
sourceimpl Not for CheckBoxFlags
impl Not for CheckBoxFlags
type Output = CheckBoxFlags
type Output = CheckBoxFlags
The resulting type after applying the !
operator.
sourceimpl Octal for CheckBoxFlags
impl Octal for CheckBoxFlags
sourceimpl Ord for CheckBoxFlags
impl Ord for CheckBoxFlags
sourcefn cmp(&self, other: &CheckBoxFlags) -> Ordering
fn cmp(&self, other: &CheckBoxFlags) -> Ordering
1.21.0 · sourcefn max(self, other: Self) -> Self
fn max(self, other: Self) -> Self
Compares and returns the maximum of two values. Read more
1.21.0 · sourcefn min(self, other: Self) -> Self
fn min(self, other: Self) -> Self
Compares and returns the minimum of two values. Read more
1.50.0 · sourcefn clamp(self, min: Self, max: Self) -> Selfwhere
Self: PartialOrd<Self>,
fn clamp(self, min: Self, max: Self) -> Selfwhere
Self: PartialOrd<Self>,
Restrict a value to a certain interval. Read more
sourceimpl PartialEq<CheckBoxFlags> for CheckBoxFlags
impl PartialEq<CheckBoxFlags> for CheckBoxFlags
sourcefn eq(&self, other: &CheckBoxFlags) -> bool
fn eq(&self, other: &CheckBoxFlags) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourceimpl PartialOrd<CheckBoxFlags> for CheckBoxFlags
impl PartialOrd<CheckBoxFlags> for CheckBoxFlags
sourcefn partial_cmp(&self, other: &CheckBoxFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &CheckBoxFlags) -> 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 Sub<CheckBoxFlags> for CheckBoxFlags
impl Sub<CheckBoxFlags> for CheckBoxFlags
type Output = CheckBoxFlags
type Output = CheckBoxFlags
The resulting type after applying the -
operator.
sourceimpl SubAssign<CheckBoxFlags> for CheckBoxFlags
impl SubAssign<CheckBoxFlags> for CheckBoxFlags
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
sourceimpl UpperHex for CheckBoxFlags
impl UpperHex for CheckBoxFlags
impl Copy for CheckBoxFlags
impl Eq for CheckBoxFlags
impl StructuralEq for CheckBoxFlags
impl StructuralPartialEq for CheckBoxFlags
Auto Trait Implementations
impl RefUnwindSafe for CheckBoxFlags
impl Send for CheckBoxFlags
impl Sync for CheckBoxFlags
impl Unpin for CheckBoxFlags
impl UnwindSafe for CheckBoxFlags
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
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