Struct imgui::TreeNode

#[must_use]pub struct TreeNode<'a> { /* fields omitted */ }

Builder for a tree node widget

Implementations

impl<'a> TreeNode<'a>

pub fn new<I: Into<TreeNodeId<'a>>>(id: I) -> TreeNode<'a>

Constructs a new tree node builder

pub fn label(mut self: Self, label: &'a ImStr) -> Self

Sets the tree node label

pub fn opened(mut self: 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(mut self: Self, flags: TreeNodeFlags) -> Self

Replaces all current settings with the given flags.

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

Enables/disables drawing the tree node in selected state.

Disabled by default.

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

Enables/disables full-colored frame.

Disabled by default.

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

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

Disabled by default.

pub fn tree_push_on_open(mut self: 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(mut self: 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(mut self: 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(mut self: Self, value: bool) -> Self

Only open when the tree node is double-clicked.

Disabled by default.

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

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

Disabled by default.

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

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

Disabled by default.

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

Display a bullet instead of arrow.

Disabled by default.

pub fn frame_padding(mut self: 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(mut self: Self, value: bool) -> Self

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

Disabled by default.

#[must_use]pub fn push(self, ui: &Ui<'_>) -> Option<TreeNodeToken>

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 must be popped by calling .pop().

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

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

Creates a tree node and runs a closure to construct the contents.

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

Trait Implementations

impl<'a> Clone for TreeNode<'a>

fn clone(&self) -> TreeNode<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for TreeNode<'a>

impl<'a> Debug for TreeNode<'a>

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

Formats the value using the given formatter.