TreeState

Struct TreeState 

Source
pub struct TreeState<T> { /* private fields */ }
Expand description

State for a Tree component.

Implementations§

Source§

impl<T: Clone> TreeState<T>

Source

pub fn new(roots: Vec<TreeNode<T>>) -> Self

Creates a new tree state with the given root nodes.

§Example
use envision::component::{TreeState, TreeNode};

let roots = vec![
    TreeNode::new("Root 1", 1),
    TreeNode::new("Root 2", 2),
];
let state = TreeState::new(roots);
assert_eq!(state.roots().len(), 2);
Source

pub fn roots(&self) -> &[TreeNode<T>]

Returns the root nodes.

Source

pub fn roots_mut(&mut self) -> &mut Vec<TreeNode<T>>

Returns a mutable reference to the root nodes.

Source

pub fn set_roots(&mut self, roots: Vec<TreeNode<T>>)

Sets the root nodes.

Source

pub fn selected_index(&self) -> usize

Returns the currently selected index in the flattened view.

Source

pub fn is_empty(&self) -> bool

Returns true if the tree is empty.

Source

pub fn selected_path(&self) -> Option<Vec<usize>>

Returns the path of the currently selected node.

Source

pub fn selected_node(&self) -> Option<&TreeNode<T>>

Returns a reference to the currently selected node.

Source

pub fn expand_all(&mut self)

Expands all nodes in the tree.

Source

pub fn collapse_all(&mut self)

Collapses all nodes in the tree.

Source

pub fn visible_count(&self) -> usize

Returns the number of visible nodes.

Trait Implementations§

Source§

impl<T: Clone> Clone for TreeState<T>

Source§

fn clone(&self) -> TreeState<T>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug> Debug for TreeState<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T: Clone> Default for TreeState<T>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<T> Freeze for TreeState<T>

§

impl<T> RefUnwindSafe for TreeState<T>
where T: RefUnwindSafe,

§

impl<T> Send for TreeState<T>
where T: Send,

§

impl<T> Sync for TreeState<T>
where T: Sync,

§

impl<T> Unpin for TreeState<T>
where T: Unpin,

§

impl<T> UnwindSafe for TreeState<T>
where T: UnwindSafe,

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.