Struct TreeView 

pub struct TreeView { /* private fields */ }

A tree of expandable rows. See the module docs.

Implementations

impl TreeView

pub fn new(id: impl Into<ElementId>, items: Vec<TreeItem>) -> Self

A tree over items. id keys its cursor, expansion and selection; give every instance its own.

pub fn max_h(self, height: impl Into<Pixels>) -> Self

Caps the tree’s height. Taller content scrolls inside it, and only the rows in view are built. Without a cap the tree is as tall as its open rows unless its parent bounds it.

pub fn selection_mode(self, mode: SelectionMode) -> Self

None (the default), Single or Multiple.

pub fn selected_keys(self, keys: impl IntoIterator<Item = SharedString>) -> Self

The controlled selection.

pub fn default_selected_keys( self, keys: impl IntoIterator<Item = SharedString>, ) -> Self

The initial selection of an uncontrolled tree.

pub fn disallow_empty_selection(self, v: bool) -> Self

Keeps the last selected row from being deselected.

pub fn expanded_keys(self, keys: impl IntoIterator<Item = SharedString>) -> Self

The controlled set of expanded parents.

pub fn default_expanded_keys( self, keys: impl IntoIterator<Item = SharedString>, ) -> Self

The parents expanded at first in an uncontrolled tree.

pub fn disabled_keys(self, keys: impl IntoIterator<Item = SharedString>) -> Self

Rows that behave as TreeItem::is_disabled.

pub fn is_disabled(self, disabled: bool) -> Self

A disabled tree renders dimmed, leaves the tab order and ignores input.

pub fn on_selection_change( self, f: impl Fn(&HashSet<SharedString>, &mut Window, &mut App) + 'static, ) -> Self

Reports the selection after a press, Enter, Space or Escape changed it.

pub fn on_expanded_change( self, f: impl Fn(&HashSet<SharedString>, &mut Window, &mut App) + 'static, ) -> Self

Reports the expanded set after a chevron, a key or a press changed it.

Trait Implementations

impl Disableable for TreeView

fn is_disabled(self, disabled: bool) -> Self

isDisabled — whether the component is disabled.

impl IntoElement for TreeView

type Element = ViewElement<TreeView>

The specific type of element into which the implementing type is converted. Useful for converting other types into elements automatically, like Strings

fn into_element(self) -> Self::Element

Convert self into a type that implements Element.

fn into_any_element(self) -> AnyElement

Convert self into a dynamically-typed AnyElement.

impl RenderOnce for TreeView

fn render(self, window: &mut Window, cx: &mut App) -> impl IntoElement

Render this component into an element tree. Note that this method takes ownership of self, as compared to Render::render() method which takes a mutable reference.