DockNode

Struct DockNode 

Source
pub struct DockNode<'ui> { /* private fields */ }
Expand description

Opaque reference to an ImGui dock node, valid for the duration of the current frame.

This wraps a raw ImGuiDockNode* and exposes a few read-only queries. Instances are created via DockBuilder::node() / DockBuilder::central_node() with a lifetime tied to a Ui reference.

Implementations§

Source§

impl<'ui> DockNode<'ui>

Source

pub fn is_central(&self) -> bool

Returns true if this node is the central node of its hierarchy

Source

pub fn is_dock_space(&self) -> bool

Returns true if this node is a dock space

Source

pub fn is_empty(&self) -> bool

Returns true if this node is empty (no windows)

Source

pub fn is_split(&self) -> bool

Returns true if this node is a split node

Source

pub fn is_root(&self) -> bool

Returns true if this node is the root of its dock tree

Source

pub fn is_floating(&self) -> bool

Returns true if this node is a floating node

Source

pub fn is_hidden_tab_bar(&self) -> bool

Returns true if this node has its tab bar hidden

Source

pub fn is_no_tab_bar(&self) -> bool

Returns true if this node has no tab bar

Source

pub fn is_leaf(&self) -> bool

Returns true if this node is a leaf node

Source

pub fn depth(&self) -> i32

Returns the depth of this node within the dock tree

Source

pub fn window_menu_button_id(&self) -> ImGuiID

Returns the menu button ID for this node

Source

pub fn root<'a>(&self, _ui: &'a Ui) -> Option<DockNode<'a>>

Returns the root node of this dock tree

Source

pub fn is_in_hierarchy_of(&self, parent: &DockNode<'_>) -> bool

Returns true if self is in the hierarchy of parent

Source

pub fn rect(&self) -> NodeRect

Returns the rectangle of this dock node in screen coordinates.

Auto Trait Implementations§

§

impl<'ui> Freeze for DockNode<'ui>

§

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

§

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

§

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

§

impl<'ui> Unpin for DockNode<'ui>

§

impl<'ui> !UnwindSafe for DockNode<'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