tui-treelistview 0.2.1

Interactive tree list widget for Ratatui
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93

/// Actions that only change view state.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum TreeViewAction {
    SelectPrev,
    SelectNext,
    SelectParent,
    SelectFirstChild,
    Expand,
    Collapse,
    ExpandOrSelectFirstChild,
    CollapseOrSelectParent,
    ToggleNode,
    ToggleRecursive,
    ExpandAll,
    CollapseAll,
    ToggleGuides,
    ToggleMark,
    SelectFirst,
    SelectLast,
    SelectColumnLeft,
    SelectColumnRight,
    SelectFirstColumn,
    SelectLastColumn,
    ScrollViewUp,
    ScrollViewDown,
    ScrollLeft,
    ScrollRight,
}

/// High-level editing actions for the selected node.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum TreeEditAction {
    ReorderUp,
    ReorderDown,
    AddChild,
    Rename,
    Detach,
    Delete,
    Yank,
    Paste,
}

/// An action produced by the application or user.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum TreeAction<Custom = ()> {
    View(TreeViewAction),
    Edit(TreeEditAction),
    Custom(Custom),
}

impl<C> From<TreeViewAction> for TreeAction<C> {
    fn from(action: TreeViewAction) -> Self {
        Self::View(action)
    }
}

impl<C> From<TreeEditAction> for TreeAction<C> {
    fn from(action: TreeEditAction) -> Self {
        Self::Edit(action)
    }
}

/// A typed edit request enriched with the current selection.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum TreeEditRequest<Id> {
    ReorderUp { node: Id, parent: Id },
    ReorderDown { node: Id, parent: Id },
    AddChild { parent: Id },
    Rename { node: Id },
    Detach { node: Id, parent: Id },
    Delete { node: Id },
    Yank { node: Id },
    Paste { parent: Id },
}

/// An intent that must be handled by the application.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum TreeIntent<Id, Custom = ()> {
    LoadChildren(Id),
    Edit(TreeEditRequest<Id>),
    Custom(Custom),
}

/// The result of handling an action.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum TreeEvent<Id, Custom = ()> {
    /// View state changed.
    Changed,
    /// The action was valid but did not change state.
    Unchanged,
    /// The application or model must perform an operation.
    Intent(TreeIntent<Id, Custom>),
}