Struct kas::event::HighlightState

pub struct HighlightState {
    pub hover: bool,
    pub depress: bool,
    pub key_focus: bool,
    pub char_focus: bool,
}

Highlighting state of a widget

Fields

hover: bool

"Hover" is true if the mouse is over this element or if an active touch event is over the element.

depress: bool

Elements such as buttons may be depressed (visually pushed) by a click or touch event, but in this state the action can still be cancelled. Elements can also be depressed by keyboard activation.

If true, this likely implies hover is also true.

key_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).

If true, this likely implies key_focus is also true.

Methods

impl HighlightState

pub fn any(self) -> bool

True if any part of the state is true

Trait Implementations

impl Clone for HighlightState

fn clone(&self) -> HighlightState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for HighlightState

impl Debug for HighlightState

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

Formats the value using the given formatter.

impl Default for HighlightState

fn default() -> HighlightState

Returns the "default value" for a type.

impl Eq for HighlightState

impl Hash for HighlightState

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<HighlightState> for HighlightState

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

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

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

This method tests for !=.

impl StructuralEq for HighlightState

impl StructuralPartialEq for HighlightState