Struct kas::draw::InputState

pub struct InputState {
    pub disabled: bool,
    pub error: bool,
    pub hover: bool,
    pub depress: bool,
    pub nav_focus: bool,
    pub char_focus: bool,
}

Input and highlighting state of a widget

This struct is used to adjust the appearance of DrawHandle's primitives.

Multiple instances can be combined via std::ops::BitOr: lhs | rhs.

Fields

disabled: bool

Disabled widgets are not responsive to input and usually drawn in grey.

All other states should be ignored when disabled.

error: bool

Some widgets, such as EditBox, use a red background on error

hover: bool

"Hover" is true if the mouse is over this element

depress: bool

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.

nav_focus: bool

Keyboard navigation of UIs moves a "focus" from widget to widget.

char_focus: bool

"Character focus" implies this widget is ready to receive text input (e.g. typing into an input field).

Trait Implementations

impl BitOr<InputState> for InputState

type Output = Self

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self

Performs the | operation.

impl Clone for InputState

fn clone(&self) -> InputState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for InputState

impl Debug for InputState

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

Formats the value using the given formatter.

impl Default for InputState

fn default() -> InputState

Returns the "default value" for a type.

impl Eq for InputState

impl Hash for InputState

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, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq<InputState> for InputState

fn eq(&self, other: &InputState) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &InputState) -> bool

This method tests for !=.

impl StructuralEq for InputState

impl StructuralPartialEq for InputState