Struct DndContext 

pub struct DndContext<T: Clone + 'static> { /* private fields */ }

Handle to the shared drag state. Cheap to copy: it contains only Dioxus store and signal keys.

Implementations

impl<T: Clone + 'static> DndContext<T>

pub fn from_parts( state: Store<DragState<T>>, announcement: Signal<String>, ) -> Self

Wrap existing state. Prefer crate::core::hooks::use_dnd_provider.

pub fn start( &mut self, payload: T, source: Option<ZoneId>, pointer: Point, grab: Point, effect: DropEffect, mode: DragMode, )

Begin a drag. Notifies all fields (state transition).

pub fn start_with_id(&mut self, id: DragId, start: DragStart<T>)

Begin a drag with a stable source identity.

pub fn set_pointer_kind(&mut self, kind: PointerKind)

Record which pointer device drives the current drag (see DragState::pointer_kind). Draggable sets this right after pickup from the initiating event’s pointerType; call it from custom pointer sources so host-side glue (cursor pollers, raw input bridges) can tell captured pointers from blind ones. Built-in sources install this in their initial snapshot; custom sources that use start or start_with_id can refine the default afterwards.

pub fn request_refocus(&mut self, payload: T)

Record that payload just landed via a keyboard drop and its new element should take focus when it mounts (see DragState::refocus). Draggable calls this on its own keyboard drops; call it from custom keyboard sources to get the same focus continuity.

pub fn claim_refocus(&mut self, payload: &T) -> bool

where T: PartialEq,

Claim a pending focus restoration if it matches payload; returns whether the caller should focus itself. First matching claimant wins - the request is consumed.

pub fn set_source_rect(&mut self, rect: Option<Rect>)

Record the dragged element’s client rect (see DragState::source_rect). Draggable measures and sets this right after pickup; call it from custom drag sources so size-matched ghosts (DragOverlay { match_source: true }) can dress themselves.

pub fn update_pointer(&mut self, pointer: Point)

Update the tracked pointer position (drives DragOverlay). Granular: only pointer subscribers rerun.

pub fn enter(&mut self, zone: ZoneId)

Mark zone as hovered. Granular: only over subscribers rerun.

pub fn leave(&mut self, zone: ZoneId)

Clear hover, but only if zone is still the hovered one (avoids enter/leave races between adjacent zones).

pub fn take(&mut self) -> Option<(T, Option<ZoneId>)>

Consume the payload on a successful drop. Returns (payload, source). After this, dragging() is false.

pub fn take_settling(&mut self, to: Rect) -> Option<(T, Option<ZoneId>)>

Consume the payload on a successful drop, like Self::take, but enter the settling phase instead of resetting: the returned clone goes to the drop handler while the stored payload stays readable and settle records the destination rect, so a settle-enabled crate::core::components::DragOverlay can glide the ghost home. After this, dragging() is false and over() is cleared; call Self::finish_settle (the overlay does) to reset fully.

Custom sources in a joined crate::core::world::DndWorld must call crate::core::world::DndWorld::claim_settle first: world overlays only present and finish a settle for the elected window.

pub fn retarget_settle(&mut self, to: Rect)

Re-aim an in-flight settle at a better rect - typically the landed element’s own, measured after the drop re-rendered the model (SettleSlot does this for you). The overlay’s glide retargets smoothly, mid-flight included. A no-op unless currently settling.

pub fn finish_settle(&mut self)

End the settling phase and reset all state. A no-op unless currently settling, so a late transitionend can never clobber a new drag.

pub fn cancel(&mut self)

Abort the drag and reset all state.

pub fn cancel_with_reason(&mut self, reason: CancelReason)

Abort the drag with an explicit reason for monitor consumers.

pub fn dragging(&self) -> bool

Is a drag currently in flight? False while a completed drop is still settling, even though Self::payload remains readable.

pub fn settling(&self) -> Option<Rect>

Destination rect of a drop currently settling (see Self::take_settling), if any.

pub fn payload(&self) -> Option<T>

Clone of the current payload, if dragging.

pub fn drag_id(&self) -> Option<DragId>

Stable identity of the active draggable.

pub fn has_explicit_drag_id(&self) -> bool

Whether the active source deliberately supplied its stable id.

pub fn drag_session_id(&self) -> Option<DragSessionId>

Fresh identity of the active tracked pointer gesture.

pub fn over(&self) -> Option<ZoneId>

Zone currently hovered.

pub fn source(&self) -> Option<ZoneId>

Zone the drag started from.

pub fn pointer(&self) -> Point

Last known pointer position.

pub fn grab(&self) -> Point

Grab offset inside the dragged element.

pub fn source_rect(&self) -> Option<Rect>

Client rect of the dragged element measured at pickup, if available.

pub fn effect(&self) -> DropEffect

Effect the drag was started with.

pub fn mode(&self) -> DragMode

How the current drag is being driven.

pub fn pointer_kind(&self) -> PointerKind

Which pointer device drives the current drag (meaningful for DragMode::Pointer drags; Mouse otherwise and by default).

pub fn snapshot(&self) -> Option<DragSnapshot<T>>

Complete monitor snapshot of the active drag.

pub fn announce(&mut self, msg: impl Into<String>)

Push a screen-reader announcement (rendered by crate::a11y::LiveRegion). Called automatically by the built-in keyboard interaction; call it yourself for custom flows.

pub fn announcement(&self) -> String

The current announcement text.

Trait Implementations

impl<T: Clone + 'static> Clone for DndContext<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Clone + 'static> Copy for DndContext<T>

impl<T: Clone + 'static> PartialEq for DndContext<T>

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

Equality operator ==.

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

Inequality operator !=.