Skip to main content

DraggableState

Struct DraggableState 

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

Drag position and progress for one control.

Cloning shares the state, so a scope can hold a handle and the modifier can hold another without either owning the truth.

Implementations§

Source§

impl DraggableState

Source

pub fn new(on_delta: impl Fn(f32) + 'static) -> Self

Creates a drag state delivering deltas to on_delta.

Prefer rememberDraggableState inside a composition; this is for callers that own the state themselves.

Source

pub fn update_handler(&self, on_delta: impl Fn(f32) + 'static)

Replaces the delta handler.

A composition calls this every recomposition so the handler closes over the current values rather than the ones the first composition captured.

Source

pub fn is_dragging(&self) -> bool

Whether a drag is in flight. Reactive: a composable that reads it recomposes when the drag starts and when it ends, and not per frame in between.

Source

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

is_dragging as a state a scope can hand around.

Source

pub fn offset(&self) -> f32

Everything this state has been dragged by since it was created.

Source

pub fn drag_by(&self, delta: f32)

Drags by delta as though a finger had moved that far.

This is how a control is driven from outside a gesture — a keyboard arrow, a test, an animation — through exactly the path a finger takes.

Trait Implementations§

Source§

impl Clone for DraggableState

Source§

fn clone(&self) -> DraggableState

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 PartialEq for DraggableState

Source§

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

Two handles are equal when they drive the same control — identity, not value, so a composable that takes one skips on recomposition.

1.0.0 (const: unstable) · Source§

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

Inequality operator !=. 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> 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> 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, <T as TryFrom<U>>::Error>

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.