Struct kas_theme::InputState
source · pub struct InputState { /* private fields */ }
Expand description
Input and highlighting state of a widget
This is mostly an implementation detail used to control the appearance of theme-drawn elements.
Implementations§
source§impl InputState
impl InputState
sourcepub const DISABLED: Self = _
pub const DISABLED: Self = _
Disabled widgets are not responsive to input and usually drawn in grey.
All other states should be ignored when disabled.
sourcepub const DEPRESS: Self = _
pub const DEPRESS: Self = _
Elements such as buttons, handles and menu entries may be depressed
(visually pushed) by a click or touch event or an accelerator key.
This is often visualised by a darker colour and/or by offsetting
graphics. The hover
state should be ignored when depressed.
sourcepub const NAV_FOCUS: Self = _
pub const NAV_FOCUS: Self = _
Keyboard navigation of UIs moves a “focus” from widget to widget.
sourcepub const CHAR_FOCUS: Self = _
pub const CHAR_FOCUS: Self = _
“Character focus” implies this widget is ready to receive text input (e.g. typing into an input field).
sourcepub const SEL_FOCUS: Self = _
pub const SEL_FOCUS: Self = _
“Selection focus” allows things such as text to be selected. Selection focus implies that the widget also has character focus.
sourcepub const fn from_bits(bits: u8) -> Option<Self>
pub const fn from_bits(bits: u8) -> 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: u8) -> Self
pub const fn from_bits_truncate(bits: u8) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u8) -> Self
pub const unsafe fn from_bits_unchecked(bits: u8) -> 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
.
source§impl InputState
impl InputState
sourcepub fn new_all(ev: &EventState, id: &WidgetId) -> Self
pub fn new_all(ev: &EventState, id: &WidgetId) -> Self
Construct, setting all components
sourcepub fn new_except_depress(ev: &EventState, id: &WidgetId) -> Self
pub fn new_except_depress(ev: &EventState, id: &WidgetId) -> Self
Construct, setting all but depress status
sourcepub fn new2(ev: &EventState, id: &WidgetId, id2: &WidgetId) -> Self
pub fn new2(ev: &EventState, id: &WidgetId, id2: &WidgetId) -> Self
Construct, setting all components, also setting hover from id2
Extract NAV_FOCUS
bit
sourcepub fn char_focus(self) -> bool
pub fn char_focus(self) -> bool
Extract CHAR_FOCUS
bit
Trait Implementations§
source§impl Binary for InputState
impl Binary for InputState
source§impl BitAnd<InputState> for InputState
impl BitAnd<InputState> for InputState
source§impl BitAndAssign<InputState> for InputState
impl BitAndAssign<InputState> for InputState
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<InputState> for InputState
impl BitOr<InputState> for InputState
source§fn bitor(self, other: InputState) -> Self
fn bitor(self, other: InputState) -> Self
Returns the union of the two sets of flags.
§type Output = InputState
type Output = InputState
|
operator.source§impl BitOrAssign<InputState> for InputState
impl BitOrAssign<InputState> for InputState
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor<InputState> for InputState
impl BitXor<InputState> for InputState
source§impl BitXorAssign<InputState> for InputState
impl BitXorAssign<InputState> for InputState
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for InputState
impl Clone for InputState
source§fn clone(&self) -> InputState
fn clone(&self) -> InputState
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for InputState
impl Debug for InputState
source§impl Default for InputState
impl Default for InputState
source§fn default() -> InputState
fn default() -> InputState
source§impl Extend<InputState> for InputState
impl Extend<InputState> for InputState
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 FromIterator<InputState> for InputState
impl FromIterator<InputState> for InputState
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl Hash for InputState
impl Hash for InputState
source§impl LowerHex for InputState
impl LowerHex for InputState
source§impl Not for InputState
impl Not for InputState
source§impl Octal for InputState
impl Octal for InputState
source§impl Ord for InputState
impl Ord for InputState
source§fn cmp(&self, other: &InputState) -> Ordering
fn cmp(&self, other: &InputState) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
source§impl PartialEq<InputState> for InputState
impl PartialEq<InputState> for InputState
source§fn eq(&self, other: &InputState) -> bool
fn eq(&self, other: &InputState) -> bool
source§impl PartialOrd<InputState> for InputState
impl PartialOrd<InputState> for InputState
source§fn partial_cmp(&self, other: &InputState) -> Option<Ordering>
fn partial_cmp(&self, other: &InputState) -> 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 Sub<InputState> for InputState
impl Sub<InputState> for InputState
source§impl SubAssign<InputState> for InputState
impl SubAssign<InputState> for InputState
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.