DragDropTarget

Struct DragDropTarget 

Source
pub struct DragDropTarget<'ui>(/* private fields */);
Expand description

Drag drop target for accepting payloads

This struct is created by Ui::drag_drop_target and provides methods for accepting different types of payloads.

Implementations§

Source§

impl<'ui> DragDropTarget<'ui>

Source

pub fn accept_payload_empty( &self, name: impl AsRef<str>, flags: DragDropFlags, ) -> Option<DragDropPayloadEmpty>

Accept an empty payload

This is the safest option for drag and drop operations. Use this when you only need to know that a drop occurred, not transfer actual data.

§Arguments
  • name - Payload type name (must match source name)
  • flags - Accept flags

Returns payload info if accepted, None otherwise.

Source

pub fn accept_payload<T: 'static + Copy, Name: AsRef<str>>( &self, name: Name, flags: DragDropFlags, ) -> Option<Result<DragDropPayloadPod<T>, PayloadIsWrongType>>

Accept a typed payload

Attempts to accept a payload with the specified type. Returns Ok(payload) if the type matches, Err(PayloadIsWrongType) if not.

§Arguments
  • name - Payload type name (must match source name)
  • flags - Accept flags

Returns Some(Result<payload, error>) if payload exists, None otherwise.

Source

pub unsafe fn accept_payload_unchecked( &self, name: impl AsRef<str>, flags: DragDropFlags, ) -> Option<DragDropPayload>

Accept raw payload data (unsafe)

§Safety

The returned pointer and size are managed by ImGui and may become invalid at any time. The caller must not access the data after the drag operation completes.

§Arguments
  • name - Payload type name
  • flags - Accept flags
Source

pub fn pop(self)

End the drag drop target

This is called automatically when the token is dropped.

Trait Implementations§

Source§

impl<'ui> Debug for DragDropTarget<'ui>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Drop for DragDropTarget<'_>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl<'ui> Freeze for DragDropTarget<'ui>

§

impl<'ui> !RefUnwindSafe for DragDropTarget<'ui>

§

impl<'ui> !Send for DragDropTarget<'ui>

§

impl<'ui> !Sync for DragDropTarget<'ui>

§

impl<'ui> Unpin for DragDropTarget<'ui>

§

impl<'ui> !UnwindSafe for DragDropTarget<'ui>

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more