Skip to main content

DockingPlugin

Struct DockingPlugin 

Source
pub struct DockingPlugin {
    pub drag_manager: DragManager,
    pub hovered_splitter: Option<NodeId>,
    pub drop_zone_detector: DropZoneDetector,
    pub cross_container_preview: Option<CrossContainerPreview>,
    pub docking_context: DockingContext,
    pub dock_animations: DockAnimationState,
    pub scrollbar_drag_node: Option<NodeId>,
}
Expand description

Plugin providing docking widget types and cross-widget docking state.

Owns drag management, drop zone detection, animations, and the docking context (container registry cache).

Fields§

§drag_manager: DragManager

Manages drag state for splitter resizing and tab operations.

§hovered_splitter: Option<NodeId>

Tracks which splitter separator is under the mouse.

§drop_zone_detector: DropZoneDetector

Detects drop zones for tab drag operations.

§cross_container_preview: Option<CrossContainerPreview>

Active cross-container drop preview state.

§docking_context: DockingContext

Container registry cache for efficient drag lookups.

§dock_animations: DockAnimationState

Animation state for ghost tabs, groups, and drop previews.

§scrollbar_drag_node: Option<NodeId>

DockTabs node whose scrollbar thumb is being dragged.

Implementations§

Source§

impl DockingPlugin

Source

pub fn new() -> Self

Create a new docking plugin with default state.

Source

pub fn invalidate_cache(&mut self)

Invalidate the docking container cache.

Source

pub fn update_animations(&mut self, dt: f32) -> bool

Update all docking animations with the given delta time. Returns true if any animation is still active.

Source

pub fn is_dragging(&self) -> bool

Check if there is an active drag operation.

Source

pub fn invalidate_removed_nodes(&mut self, tree: &UiTree)

Invalidate any references to nodes that no longer exist.

Trait Implementations§

Source§

impl Default for DockingPlugin

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl UiPlugin for DockingPlugin

Source§

fn name(&self) -> &str

Plugin name for debugging and logging.
Source§

fn register_widgets(&self, registry: &mut WidgetTypeRegistry)

Register widget type descriptors this plugin provides. Read more
Source§

fn post_layout(&mut self, _tree: &mut UiTree)

Called after Taffy layout for custom post-processing.
Source§

fn update(&mut self, dt: f32, _tree: &mut UiTree)

Per-frame update (animations, state cleanup, etc.)
Source§

fn as_any(&self) -> &dyn Any

Downcast support — return self as &dyn Any.
Source§

fn as_any_mut(&mut self) -> &mut dyn Any

Downcast support — return self as &mut dyn Any.
Source§

fn handle_event( &mut self, _event: &UiInputEvent, _ctx: &mut PluginEventContext<'_>, ) -> bool

Handle a UI input event. Return true if consumed. Read more

Auto Trait Implementations§

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

Source§

fn downcast(&self) -> &T

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert 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>

Convert 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)

Convert &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)

Convert &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> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

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

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

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

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,