Skip to main content

InteractionState

Struct InteractionState 

Source
pub struct InteractionState { /* private fields */ }
Expand description

The tracked interaction state of one piece: whether the pointer is over it, whether it is pressed, and whether it has the keyboard (docs/gestures.md “State styling”).

Create one, attach it with Decorate::interaction, and read it from any reactive modifier. Each read is tracked, so the modifier follows the state with no handler in between:

ⓘ
let state = InteractionState::new();
row((icon, title))
    .interaction(state)
    .background(move || if state.pressed() { PRESSED } else if state.hovered() { HOVER } else { REST })
    .opacity(move || if state.pressed() { 0.7 } else { 1.0 })

hovered follows the pointer where one exists and stays false on a touch-only device. pressed is true from the pointer-down itself until the release, the pointer leaving, or the platform taking the gesture away. focused follows keyboard focus on a piece that can take it (Decorate::focusable, or a control inside). All three read false while the piece is disabled (Decorate::enabled).

Implementations§

Source§

impl InteractionState

Source

pub fn new() -> Self

A state with nothing hovered, pressed or focused, owned by the scope it is created in.

Source

pub fn hovered(&self) -> bool

Whether the pointer is over the piece. Tracked.

Source

pub fn pressed(&self) -> bool

Whether the piece is pressed. Tracked.

Source

pub fn focused(&self) -> bool

Whether the piece has keyboard focus. Tracked.

Trait Implementations§

Source§

impl Clone for InteractionState

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for InteractionState

Source§

impl Default for InteractionState

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoReactive<T, StaticMark> for T
where T: Clone + 'static,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.