Struct State 

pub struct State<Id> { /* private fields */ }

Available on crate feature tree only.

The nodes, their structure and what is expanded, selected and checked.

Implementations

impl<Id: Copy + Eq + Hash> State<Id>

pub fn new(roots: impl IntoIterator<Item = Node<Id>>) -> Self

A tree in Mode::Single with every node collapsed. Ids must be unique across the whole tree.

pub fn with_mode(self, mode: Mode) -> Self

pub fn with_expanded(self, ids: impl IntoIterator<Item = Id>) -> Self

Starts with these nodes expanded. Lazy nodes stay collapsed until the user expands them, so nothing loads unasked.

pub fn mode(&self) -> Mode

pub fn roots(&self) -> &[Id]

pub fn node(&self, id: Id) -> Option<&Node<Id>>

pub fn parent(&self, id: Id) -> Option<Id>

pub fn children(&self, id: Id) -> &[Id]

The loaded children of a node, empty for a leaf or a node whose children have not arrived.

pub fn has_children(&self, id: Id) -> bool

Whether a node has children, or may have once they load.

pub fn is_loaded(&self, id: Id) -> bool

Whether a node’s children are known: a leaf, or loaded.

pub fn is_loading(&self, id: Id) -> bool

pub fn set_loading(&mut self, id: Id)

Marks a node as loading, such as while the app refreshes it. Its children stay until new ones arrive.

pub fn is_expanded(&self, id: Id) -> bool

pub fn is_selected(&self, id: Id) -> bool

pub fn is_focused(&self) -> bool

pub fn highlighted(&self) -> Option<Id>

The node the keyboard acts on.

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

The selected nodes, in tree order.

pub fn checked(&self) -> Vec<Id>

The checked nodes, parents included, in tree order.

pub fn check_state(&self, id: Id) -> CheckState

Whether a node’s checkbox is checked, unchecked, or indeterminate because only some of its children are checked.

pub fn visible(&self) -> Vec<Id>

The nodes on screen when scrolled through: roots and the children of expanded nodes, in tree order.

pub fn len(&self) -> usize

How many nodes the tree holds.

pub fn is_empty(&self) -> bool

pub fn update(&mut self, event: Event<Id>) -> Option<Output<Id>>

Applies an event and returns what the app may need to act on.

pub fn key_event( &self, keymap: &Keymap<Action>, key: &Event, ) -> Option<Event<Id>>

Turns a key press into an event: first through keymap, then as typeahead for a letter or digit. A symbol typed with Shift, such as *, also matches its chord without Shift.

Trait Implementations

impl<Id: Clone> Clone for State<Id>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Id: Debug> Debug for State<Id>

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

Formats the value using the given formatter.