Struct egui_dnd::DragDropResponse

pub struct DragDropResponse {
    pub update: Option<DragUpdate>,
    /* private fields */
}

Response containing state of the drag & drop list and a potential update to the source list. The update can be applied immediately or at latest when DragDropResponse::is_drag_finished returns true.

Fields

update: Option<DragUpdate>

Contains ongoing information about which index is currently being dragged where. You can use this to consistently update the source list while the drag & drop event is ongoing. If you only want to update the source list when the drag & drop event has finished, use DragDropResponse::final_update instead.

Implementations

impl DragDropResponse

pub fn is_evaluating_drag(&self) -> bool

Returns true if we are currently evaluating whether a drag should be started.

pub fn is_dragging(&self) -> bool

Returns true if we are currently dragging an item.

pub fn dragged_item_id(&self) -> Option<Id>

Returns the id of the item that is currently being dragged.

pub fn is_drag_finished(&self) -> bool

Returns true if the drag & drop event has finished and the item has been dropped. The update should be applied to the source list.

pub fn update_vec<T>(&self, vec: &mut [T])

Utility function to update a Vec with the current drag & drop state. You can use this to consistently update the source list while the drag & drop event is ongoing.

pub fn final_update(&self) -> Option<DragUpdate>

Returns the update if the drag & drop event has finished and the item has been dropped. Useful for the if let syntax.

pub fn cancellation_reason(&self) -> Option<&'static str>

Returns a Option<&str> with the reason if a drag & drop event was cancelled.

Trait Implementations

impl Clone for DragDropResponse

fn clone(&self) -> DragDropResponse

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DragDropResponse

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

Formats the value using the given formatter.