pub struct ReorderGroup<K>(/* private fields */);Expand description
Retained logical order and measured spatial geometry. Mouse/keyboard input, cancellation and optional edge autoscroll share the portable engine. Automatic axis detection occurs on acquisition. Host owns model persistence and focus restoration after removal. Cross-list transfer and virtualization are separate application policies; keep this group’s mounted geometry in one scroll source.
Implementations§
Source§impl<K: Clone + Eq + Hash + 'static> ReorderGroup<K>
impl<K: Clone + Eq + Hash + 'static> ReorderGroup<K>
Sourcepub fn new(order: Vec<K>, axis: Axis) -> Result<Self, AnimationError>
pub fn new(order: Vec<K>, axis: Axis) -> Result<Self, AnimationError>
Creates a compatible horizontal/vertical group; duplicate keys fail without mutation.
Sourcepub fn spatial(order: Vec<K>, mode: ReorderAxis) -> Result<Self, AnimationError>
pub fn spatial(order: Vec<K>, mode: ReorderAxis) -> Result<Self, AnimationError>
Creates an automatically detected row/column/grid or explicit spatial mode.
Sourcepub fn autoscroll(
self,
handle: ScrollHandle,
viewport: MotionAnchor,
policy: AutoScroll,
) -> Self
pub fn autoscroll( self, handle: ScrollHandle, viewport: MotionAnchor, policy: AutoScroll, ) -> Self
Enables elapsed-time edge scrolling in a measured native viewport. Pointer coordinates remain fixed while scrolled geometry participates in reorder. After a stalled frame, one tick is capped to 50ms to avoid a scroll jump.
Sourcepub fn order(&self) -> Ref<'_, [K]>
pub fn order(&self) -> Ref<'_, [K]>
Current order. Release the borrow before sending input or changing membership.
Sourcepub fn on_change(
self,
callback: impl Fn(&[K], &mut Window, &mut App) + 'static,
) -> Self
pub fn on_change( self, callback: impl Fn(&[K], &mut Window, &mut App) + 'static, ) -> Self
Invokes after pointer commit or keyboard reorder, outside all group borrows. Capture application entities weakly to avoid a retained self-reference cycle.
Sourcepub fn set_order(&self, order: Vec<K>) -> Result<(), AnimationError>
pub fn set_order(&self, order: Vec<K>) -> Result<(), AnimationError>
Changes external membership/order and cancels a held gesture. Duplicate keys fail transactionally. Use on model changes, not on every render.
Sourcepub fn start_drag(
&self,
key: &K,
pointer: [f64; 2],
window: &mut Window,
cx: &mut App,
) -> bool
pub fn start_drag( &self, key: &K, pointer: [f64; 2], window: &mut Window, cx: &mut App, ) -> bool
Starts dragging from an external handle after the item was measured.
Sourcepub fn cancel(&self, cx: &mut App)
pub fn cancel(&self, cx: &mut App)
Rolls back the current pointer gesture without firing a commit callback.
Sourcepub fn is_dragging(&self) -> bool
pub fn is_dragging(&self) -> bool
Whether a pointer currently owns the group.
Sourcepub fn item<E: IntoElement + StatefulInteractiveElement + 'static>(
&self,
id: impl Into<ElementId>,
key: K,
child: E,
) -> ReorderElement<K, E>
pub fn item<E: IntoElement + StatefulInteractiveElement + 'static>( &self, id: impl Into<ElementId>, key: K, child: E, ) -> ReorderElement<K, E>
Wraps one stable-key item. Child semantics, styles and normal click handlers
remain native. Use drag_listener(false) when providing a separate handle.
Trait Implementations§
Auto Trait Implementations§
impl<K> !RefUnwindSafe for ReorderGroup<K>
impl<K> !Send for ReorderGroup<K>
impl<K> !Sync for ReorderGroup<K>
impl<K> !UnwindSafe for ReorderGroup<K>
impl<K> Freeze for ReorderGroup<K>
impl<K> Unpin for ReorderGroup<K>
impl<K> UnsafeUnpin for ReorderGroup<K>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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