Struct imgui::TreeNode

pub struct TreeNode<T, L = &'static str> { /* fields omitted */ }

Builder for a tree node widget

Implementations

impl<T: AsRef<str>> TreeNode<T, &'static str>

pub fn new<I: Into<TreeNodeId<T>>>(id: I) -> TreeNode<T, &'static str>

Constructs a new tree node builder

impl<T: AsRef<str>, L: AsRef<str>> TreeNode<T, L>

pub fn label<I: Into<TreeNodeId<L2>>, L2: AsRef<str>>(
    self,
    label: L2
) -> TreeNode<T, L2>

Sets the tree node label

pub fn opened(self, opened: bool, cond: Condition) -> Self

Sets the opened state of the tree node, which is applied based on the given condition value

pub fn flags(self, flags: TreeNodeFlags) -> Self

Replaces all current settings with the given flags.

pub fn selected(self, value: bool) -> Self

Enables/disables drawing the tree node in selected state.

Disabled by default.

pub fn framed(self, value: bool) -> Self

Enables/disables full-colored frame.

Disabled by default.

pub fn allow_item_overlap(self, value: bool) -> Self

Enables/disables allowing the tree node to overlap subsequent widgets.

Disabled by default.

pub fn tree_push_on_open(self, value: bool) -> Self

Enables/disables automatic tree push when the tree node is open (= adds extra indentation and pushes to the ID stack).

Enabled by default.

pub fn auto_open_on_log(self, value: bool) -> Self

Enables/disables automatic opening of the tree node when logging is active.

By default, logging will automatically open all tree nodes.

Enabled by default.

pub fn default_open(self, value: bool) -> Self

Sets the default open state for the tree node.

Tree nodes are closed by default.

pub fn open_on_double_click(self, value: bool) -> Self

Only open when the tree node is double-clicked.

Disabled by default.

pub fn open_on_arrow(self, value: bool) -> Self

Only open when clicking the arrow part of the tree node.

Disabled by default.

pub fn leaf(self, value: bool) -> Self

Enable/disables leaf mode (no collapsing, no arrow).

Disabled by default.

pub fn bullet(self, value: bool) -> Self

Display a bullet instead of arrow.

Disabled by default.

pub fn frame_padding(self, value: bool) -> Self

Use frame_padding to vertically align text baseline to regular widget height.

Disabled by default.

pub fn nav_left_jumps_back_here(self, value: bool) -> Self

Left direction may move to this tree node from any of its child.

Disabled by default.

pub fn push<'ui>(self, ui: &Ui<'ui>) -> Option<TreeNodeToken<'ui>>

Pushes a tree node and starts appending to it.

Returns Some(TreeNodeToken) if the tree node is open. After content has been rendered, the token can be popped by calling .pop().

Returns None if the tree node is not open and no content should be rendered.

pub fn build<R, F: FnOnce() -> R>(self, ui: &Ui<'_>, f: F) -> Option<R>

Creates a tree node and runs a closure to construct the contents. Returns the result of the closure, if it is called.

Note: the closure is not called if the tree node is not open.

Trait Implementations

impl<T: Clone, L: Clone> Clone for TreeNode<T, L>

fn clone(&self) -> TreeNode<T, L>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug, L: Debug> Debug for TreeNode<T, L>

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

Formats the value using the given formatter.

impl<T: Copy, L: Copy> Copy for TreeNode<T, L>