Struct tui_tree_widget::TreeState

pub struct TreeState { /* private fields */ }

Keeps the state of what is currently selected and what was opened in a Tree

Example

let mut state = TreeState::default();

Implementations

impl TreeState

pub const fn get_offset(&self) -> usize

pub fn get_all_opened(&self) -> Vec<TreeIdentifierVec>

pub fn selected(&self) -> Vec<usize>

pub fn select(&mut self, identifier: Vec<usize>)

pub fn open(&mut self, identifier: TreeIdentifierVec) -> bool

Open a tree node. Returns true if the node was closed and has been opened. Returns false if the node was already open.

pub fn close(&mut self, identifier: TreeIdentifier<'_>) -> bool

Close a tree node. Returns true if the node was open and has been closed. Returns false if the node was already closed.

pub fn toggle(&mut self, identifier: TreeIdentifierVec)

Toggles a tree node. If the node is in opened then it calls close(). Otherwise it calls open().

pub fn toggle_selected(&mut self)

Toggles the currently selected tree node. See also toggle

pub fn close_all(&mut self)

pub fn select_first(&mut self)

Select the first node.

pub fn select_last(&mut self, items: &[TreeItem<'_>])

Select the last node.

pub fn key_up(&mut self, items: &[TreeItem<'_>])

Handles the up arrow key. Moves up in the current depth or to its parent.

pub fn key_down(&mut self, items: &[TreeItem<'_>])

Handles the down arrow key. Moves down in the current depth or into a child node.

pub fn key_left(&mut self)

Handles the left arrow key. Closes the currently selected or moves to its parent.

pub fn key_right(&mut self)

Handles the right arrow key. Opens the currently selected.

Trait Implementations

impl Clone for TreeState

fn clone(&self) -> TreeState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TreeState

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

Formats the value using the given formatter.

impl Default for TreeState

fn default() -> TreeState

Returns the “default value” for a type.