Skip to main content

DragPreview

Struct DragPreview 

Source
pub struct DragPreview<'a> {
    pub drag_state: &'a DragState,
    pub config: DragPreviewConfig,
}
Expand description

Overlay widget that renders a drag preview at the cursor position.

The preview renders either a custom widget (from DragState::preview) or a text-based fallback from DragPayload::display_text.

§Rendering

  1. Pushes the configured opacity onto the buffer’s opacity stack.
  2. Optionally fills the background.
  3. Renders the custom preview widget or fallback text.
  4. Optionally draws a border.
  5. Pops the opacity.

§Invariants

  • The preview is always clamped to the viewport bounds.
  • Opacity is always restored (pop matches push) even if the area is empty.
  • At EssentialOnly degradation or below, the preview is not rendered (it is decorative).

Fields§

§drag_state: &'a DragState

Current drag state (position, payload, optional custom preview).

§config: DragPreviewConfig

Visual configuration.

Implementations§

Source§

impl<'a> DragPreview<'a>

Source

pub fn new(drag_state: &'a DragState) -> Self

Create a new drag preview for the given state.

Source

pub fn with_config(drag_state: &'a DragState, config: DragPreviewConfig) -> Self

Create a drag preview with custom configuration.

Trait Implementations§

Source§

impl Widget for DragPreview<'_>

Source§

fn render(&self, area: Rect, frame: &mut Frame<'_>)

Render the widget into the frame at the given area. Read more
Source§

fn is_essential(&self) -> bool

Whether this widget is essential and should always render. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for DragPreview<'a>

§

impl<'a> !RefUnwindSafe for DragPreview<'a>

§

impl<'a> !Send for DragPreview<'a>

§

impl<'a> !Sync for DragPreview<'a>

§

impl<'a> Unpin for DragPreview<'a>

§

impl<'a> !UnwindSafe for DragPreview<'a>

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