Struct TreeViewProps 

pub struct TreeViewProps {

    pub name: Option<String>,
    pub fill: bool,
    pub hide_root: bool,
    pub single_click: bool,
    pub selection_follows_focus: bool,
    pub multi_select: bool,
    pub reorder: bool,
    pub tab_indents: bool,
    pub nodes: Vec<TreeViewNodeProps>,
    pub expanded: Option<Vec<ResourceId>>,
    pub selection: Option<Vec<ResourceId>>,
    pub motion: Option<Feel>,
    pub select: Event,
    pub activate: Event,
    pub drop: Event,
}

A tree of nodes: a file explorer, a project’s files, the layers of a drawing, a book’s pages. Each node is the resource it stands for; opening a branch shows the nodes under it, and selecting or activating a node reports its resource.

Fields

name: Option<String>

What the tree is, for assistive technology.

fill: bool

The tree takes the height it is given and scrolls inside itself, rather than sizing to the rows inside another scroll.

hide_root: bool

The tree’s root node — the tree itself, labelled with its name — is not a row: the nodes at the top level are, at the first depth. Off, the tree’s name stands over them as a row of its own. Hide it where a heading or a page title already names the tree.

single_click: bool

A press selects and activates in one, as a navigator sidebar does; a double click activates otherwise.

selection_follows_focus: bool

Moving through the rows with the keyboard selects them as it goes.

multi_select: bool

Whether several nodes may be selected at once (Ctrl-click, Shift-click).

reorder: bool

Rows move: by dragging one onto another (before it, inside it or after it), and by Tab and Shift-Tab to indent and outdent, Alt-Up and Alt-Down to reorder among siblings. A move is reported by the node it lands at (TreeViewNodeProps::drop, TreeViewNodeProps::into) or, at the top level’s end, by the tree’s Self::drop.

tab_indents: bool

Tab and Shift-Tab indent and outdent the focused row. On by itself with Self::reorder; off, Tab moves the focus on as it otherwise would.

nodes: Vec<TreeViewNodeProps>

The nodes, in order, parents before their children.

expanded: Option<Vec<ResourceId>>

The nodes open now, by the resource each stands for. Given, it is where the view says the tree is; without it the tree keeps what a person opened.

selection: Option<Vec<ResourceId>>

The nodes selected, by the resource each stands for.

motion: Option<Feel>

The pace its own motion plays at: branches unfolding, rows arriving and leaving. Unset, the theme’s.

select: Event

A node was selected: carries the resource it shows.

activate: Event

A node was activated (a double click, Enter, an assistive technology): carries the resource it shows.

drop: Event

A node was dropped at the end of the top level, past every row: carries the node that moved.

Trait Implementations

impl Component for TreeViewProps

const NAME: &'static str = "TreeView"

The component’s name, as code calls it.

fn describe() -> Description

fn from_source(source: &mut dyn Source) -> Result<TreeViewProps, Error>

The props source gives.

impl Default for TreeViewProps

fn default() -> TreeViewProps

Returns the “default value” for a type.