Struct TreeView 

pub struct TreeView<V: NodeValue> { /* private fields */ }

TreeView

Tree view Mock component for tui-realm

Implementations

impl<V: NodeValue> TreeView<V>

pub fn foreground(self, fg: Color) -> Self

Set widget foreground

pub fn background(self, bg: Color) -> Self

Set widget background

pub fn inactive(self, s: Style) -> Self

Set another style from default to use when component is inactive

pub fn borders(self, b: Borders) -> Self

Set widget border properties

pub fn modifiers(self, m: TextModifiers) -> Self

Set widget text modifiers

pub fn title<S: Into<String>>(self, t: S, a: Alignment) -> Self

Set widget title

pub fn highlight_symbol<S: Into<String>>(self, symbol: S) -> Self

Set symbol to prepend to highlighted node

pub fn highlighted_color(self, color: Color) -> Self

Set color to apply to highlighted item

pub fn initial_node<S: Into<String>>(self, node: S) -> Self

Set initial node for tree state. NOTE: this must be specified after with_tree

pub fn preserve_state(self, preserve: bool) -> Self

Set whether to preserve state on tree change

pub fn indent_size(self, sz: u16) -> Self

Set indent size for widget for each level of depth

pub fn scroll_step(self, step: usize) -> Self

Set scroll step for scrolling command

pub fn with_tree(self, tree: Tree<V>) -> Self

Set tree to use as data

pub fn tree(&self) -> &Tree<V>

Get a reference to tree

pub fn tree_mut(&mut self) -> &mut Tree<V>

Get mutable reference to tree

pub fn set_tree(&mut self, tree: Tree<V>)

Set new tree in component. Current state is preserved if PRESERVE_STATE is set to AttrValue::Flag(true)

pub fn tree_state(&self) -> &TreeState

Get a reference to the current tree state

Trait Implementations

impl<V: NodeValue> Default for TreeView<V>

fn default() -> Self

Returns the “default value” for a type.

impl<V: NodeValue> MockComponent for TreeView<V>

fn view(&mut self, frame: &mut Frame<'_>, area: Rect)

Based on the current properties and states, renders the component in the provided area frame. Render can also mutate the component state if this is required

fn query(&self, attr: Attribute) -> Option<AttrValue>

Query attribute of component properties.

fn attr(&mut self, attr: Attribute, value: AttrValue)

Set attribute to properties. query describes the name, while attr the value it’ll take

fn state(&self) -> State

Get current state from component

fn perform(&mut self, cmd: Cmd) -> CmdResult

Perform a command on the component. The command will may change the component state. The method returns the result of the command applied (what changed if any)