Struct MutableInteractionSource 

pub struct MutableInteractionSource { /* private fields */ }

Records the press and hover interactions of the nodes bound to it, and exposes them as state.

Implementations

impl MutableInteractionSource

pub fn new() -> Self

Creates a source bound to the runtime of the composition that is active now.

pub fn with_runtime(runtime: RuntimeHandle) -> Self

Creates a source bound to runtime, for use outside composition.

pub fn id(&self) -> u64

Returns an id that is stable for this source and differs from the ids of other sources.

pub fn press(&self, press_position: Point) -> PressInteractionPress

Reports a press at press_position in the node’s local coordinates, in logical pixels, and returns the press to end with Self::release or Self::cancel.

pub fn release(&self, press: PressInteractionPress)

Reports that press ended with the pointer going up.

pub fn cancel(&self, press: PressInteractionPress)

Reports that press ended without the pointer going up.

pub fn enter_hover(&self) -> HoverInteractionEnter

Reports that a pointer came to rest over a node, Compose’s emit(HoverInteraction.Enter()), and returns the enter to end it with.

pub fn exit_hover(&self, enter: HoverInteractionEnter)

Reports that the pointer enter reported left.

pub fn emit(&self, interaction: Interaction)

Records interaction and updates the pressed and hovered state to match.

pub fn collectIsPressedAsState(&self) -> State<bool>

Returns whether the interaction source is currently pressed as a reactive State.

Mirrors Jetpack Compose: InteractionSource.collectIsPressedAsState().

The value flips to true when a PressInteraction::Press is emitted and back to false once every active press has seen a matching PressInteraction::Release or PressInteraction::Cancel. Reading the returned state inside a composable subscribes the enclosing recompose scope, so the composable recomposes whenever the pressed state changes.

pub fn collectIsHoveredAsState(&self) -> State<bool>

Returns whether a pointer rests over a node of this source as a reactive State: true from a HoverInteraction::Enter until every enter has seen its HoverInteraction::Exit.

Mirrors Jetpack Compose: InteractionSource.collectIsHoveredAsState().

pub fn collectLastInteractionAsState(&self) -> State<Option<Interaction>>

Returns the interaction that happened last, or None before the first one, as a reactive State.

Trait Implementations

impl Clone for MutableInteractionSource

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MutableInteractionSource

impl Debug for MutableInteractionSource

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

Formats the value using the given formatter.

impl Default for MutableInteractionSource

fn default() -> Self

Returns the “default value” for a type.

impl Eq for MutableInteractionSource

impl PartialEq for MutableInteractionSource

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

Equality operator ==.

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

Inequality operator !=.