Struct cursive_tree_view::TreeView

pub struct TreeView<T: Display + Debug> { /* fields omitted */ }

A low level tree view.

Each view provides a number of low level methods for manipulating its contained items and their structure.

All interactions are performed via relative (i.e. visual) row indices which makes reasoning about behaviour much easier in the context of interactive user manipulation of the tree.

Examples

let mut tree = TreeView::new();

tree.insert_item("root".to_string(), Placement::LastChild, 0);

tree.insert_item("1".to_string(), Placement::LastChild, 0);
tree.insert_item("2".to_string(), Placement::LastChild, 1);
tree.insert_item("3".to_string(), Placement::LastChild, 2);

Implementations

impl<T: Display + Debug> TreeView<T>

pub fn new() -> Self

Creates a new, empty TreeView.

pub fn disable(&mut self)

Disables this view.

A disabled view cannot be selected.

pub fn enable(&mut self)

Re-enables this view.

pub fn set_enabled(&mut self, enabled: bool)

Enable or disable this view.

pub fn is_enabled(&self) -> bool

Returns true if this view is enabled.

pub fn set_on_submit<F>(&mut self, cb: F) where
    F: Fn(&mut Cursive, usize) + 'static, 

Sets a callback to be used when <Enter> is pressed while an item is selected.

Example

tree.set_on_submit(|siv: &mut Cursive, row: usize| {

});

pub fn on_submit<F>(self, cb: F) -> Self where
    F: Fn(&mut Cursive, usize) + 'static, 

Sets a callback to be used when <Enter> is pressed while an item is selected.

Chainable variant.

Example

tree.on_submit(|siv: &mut Cursive, row: usize| {

});

pub fn set_on_select<F>(&mut self, cb: F) where
    F: Fn(&mut Cursive, usize) + 'static, 

Sets a callback to be used when an item is selected.

Example

tree.set_on_select(|siv: &mut Cursive, row: usize| {

});

pub fn on_select<F>(self, cb: F) -> Self where
    F: Fn(&mut Cursive, usize) + 'static, 

Sets a callback to be used when an item is selected.

Chainable variant.

Example

tree.on_select(|siv: &mut Cursive, row: usize| {

});

pub fn set_on_collapse<F>(&mut self, cb: F) where
    F: Fn(&mut Cursive, usize, bool, usize) + 'static, 

Sets a callback to be used when an item has its children collapsed or expanded.

Example

tree.set_on_collapse(|siv: &mut Cursive, row: usize, is_collapsed: bool, children: usize| {

});

pub fn on_collapse<F>(self, cb: F) -> Self where
    F: Fn(&mut Cursive, usize, bool, usize) + 'static, 

Sets a callback to be used when an item has its children collapsed or expanded.

Chainable variant.

Example

tree.on_collapse(|siv: &mut Cursive, row: usize, is_collapsed: bool, children: usize| {

});

pub fn clear(&mut self)

Removes all items from this view.

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

Removes all items from this view, returning them.

pub fn len(&self) -> usize

Returns the number of items in this tree.

pub fn is_empty(&self) -> bool

Returns true if this tree has no items.

pub fn row(&self) -> Option<usize>

Returns the index of the currently selected tree row.

None is returned in case of the tree being empty.

pub fn first_col(&self, row: usize) -> Option<usize>

Returns position on the x axis of the symbol (first character of an item) at the given row.

None is returned in case the specified row does not visually exist.

pub fn item_width(&self, row: usize) -> Option<usize>

Returns total width (including the symbol) of the item at the given row.

None is returned in case the specified row does not visually exist.

pub fn set_selected_row(&mut self, row: usize)

Selects the row at the specified index.

pub fn selected_row(self, row: usize) -> Self

Selects the row at the specified index.

Chainable variant.

pub fn borrow_item(&self, row: usize) -> Option<&T>

Returns a immutable reference to the item at the given row.

None is returned in case the specified row does not visually exist.

pub fn borrow_item_mut(&mut self, row: usize) -> Option<&mut T>

Returns a mutable reference to the item at the given row.

None is returned in case the specified row does not visually exist.

pub fn insert_item(
    &mut self,
    item: T,
    placement: Placement,
    row: usize
) -> Option<usize>

Inserts a new item at the given row with the specified Placement, returning the visual row of the item occupies after its insertion.

None will be returned in case the item is not visible after insertion due to one of its parents being in a collapsed state.

pub fn insert_container_item(
    &mut self,
    item: T,
    placement: Placement,
    row: usize
) -> Option<usize>

Inserts a new container at the given row with the specified Placement, returning the visual row of the container occupies after its insertion.

A container is identical to a normal item except for the fact that it can always be collapsed even if it does not contain any children.

Note: If the container is not visible because one of its parents is collapsed None will be returned since there is no visible row for the container to occupy.

pub fn remove_item(&mut self, row: usize) -> Option<Vec<T>>

Removes the item at the given row along with all of its children.

The returned vector contains the removed items in top to bottom order.

None is returned in case the specified row does not visually exist.

pub fn remove_children(&mut self, row: usize) -> Option<Vec<T>>

Removes all children of the item at the given row.

The returned vector contains the removed children in top to bottom order.

None is returned in case the specified row does not visually exist.

pub fn extract_item(&mut self, row: usize) -> Option<T>

Extracts the item at the given row from the tree.

All of the items children will be moved up one level within the tree.

None is returned in case the specified row does not visually exist.

pub fn collapse_item(&mut self, row: usize)

Collapses the children of the given row.

pub fn expand_item(&mut self, row: usize)

Expands the children of the given row.

pub fn set_collapsed(&mut self, row: usize, collapsed: bool)

Collapses or expands the children of the given row.

pub fn collapsed(self, row: usize, collapsed: bool) -> Self

Collapses or expands the children of the given row.

Chained variant.

pub fn focus_up(&mut self, n: usize)

Select item n rows up from the one currently selected.

pub fn focus_down(&mut self, n: usize)

Select item n rows down from the one currently selected.

pub fn item_parent(&self, row: usize) -> Option<usize>

Returns position of the parent of the item located in row.

None is returned if row is not currenlty visible or if the item has no ancestors.

Trait Implementations

impl<T: Display + Debug> Debug for TreeView<T>

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

Formats the value using the given formatter.

impl<T: Display + Debug> Default for TreeView<T>

fn default() -> Self

Creates a new, empty TreeView.

impl<T: Display + Debug + 'static> View for TreeView<T>

fn draw(&self, printer: &Printer<'_, '_>)

Draws the view with the given printer (includes bounds) and focus.

fn required_size(&mut self, _req: Vec2) -> Vec2

Returns the minimum size the view requires with the given restrictions.

fn layout(&mut self, size: Vec2)

Called once the size for this view has been decided.

fn take_focus(&mut self, _: Direction) -> Result<EventResult, CannotFocus>

Attempt to give this view the focus.

fn on_event(&mut self, event: Event) -> EventResult

Called when an event is received (key press, mouse event, …).

fn important_area(&self, size: Vec2) -> Rect

What part of the view is important and should be visible?

fn needs_relayout(&self) -> bool

Should return true if the view content changed since the last call to layout().

fn call_on_any(
    &mut self,
    &Selector<'_>,
    &'a mut (dyn FnMut(&mut (dyn View + 'static)) + 'a)
)

Runs a closure on the view identified by the given selector.

fn focus_view(&mut self, &Selector<'_>) -> Result<EventResult, ViewNotFound>

Moves the focus to the view identified by the given selector.

fn type_name(&self) -> &'static str

Returns the type of this view.