Struct TreeView

pub struct TreeView<'context_menu, NodeIdType> { /* private fields */ }

A tree view widget.

Implementations

impl<'context_menu, NodeIdType: NodeId> TreeView<'context_menu, NodeIdType>

pub fn new(id: Id) -> Self

Create a tree view from an unique id.

pub fn with_settings(self, settings: TreeViewSettings) -> Self

Set the settings for this tree view with the TreeViewSettings struct.

pub fn override_indent(self, indent: Option<f32>) -> Self

Override the indent value for this tree view.

By default, this value is ‘None’ which means that the indent value from the current ui is used. If this value is set, this value will be used as the indent value without affecting the ui’s indent value.

pub fn indent_hint_style(self, style: IndentHintStyle) -> Self

Set the style of the indent hint to show the indentation level.

pub fn row_layout(self, layout: RowLayout) -> Self

Set the row layout for this tree.

pub fn fill_space_horizontal(self, fill_space_horizontal: bool) -> Self

Controls whether the tree should fill all available horizontal space.

If the tree is part of a horizontally justified layout, this property has no effect and the tree will always fill horizontal space.

Default is true.

pub fn fill_space_vertical(self, fill_space_vertical: bool) -> Self

Controls whether the tree should fill all available vertical space.

If the tree is part of a vertically justified layout, this property has no effect and the tree will always fill vertical space.

Default is false.

pub fn max_width(self, width: f32) -> Self

Set the maximum width the tree can have.

If the tree is part of a horizontally justified layout, this property has no effect and the tree will always fill the available horizontal space.

pub fn max_height(self, height: f32) -> Self

Set the maximum height the tree can have.

If the tree is part of a vertical justified layout, this property has no effect and the tree will always fill the available vertical space.

pub fn min_width(self, width: f32) -> Self

Set the minimum width the tree can have.

pub fn min_height(self, height: f32) -> Self

Set the minimum height the tree can have.

pub fn allow_multi_selection(self, allow_multi_select: bool) -> Self

Set if the tree view is allowed to select multiple nodes at once.

pub fn fallback_context_menu( self, context_menu: impl FnMut(&mut Ui, &Vec<NodeIdType>) + 'context_menu, ) -> Self

Add a fallback context menu to the tree.

If the node did not configure a context menu directly or if multiple nodes were selected and right-clicked, then this fallback context menu will be opened.

A context menu in egui gets its size the first time it becomes visible. Since all nodes in the tree view share the same context menu you must set the size of the context menu manually for each node if you want to have differently sized context menus.

pub fn show( self, ui: &mut Ui, build_tree_view: impl FnMut(&mut TreeViewBuilder<'_, NodeIdType>), ) -> (Response, Vec<Action<NodeIdType>>)

where NodeIdType: NodeId + Send + Sync + 'static,

Start displaying the tree view.

Construct the tree view using the TreeViewBuilder by adding directories or leaves to the tree.

pub fn show_state( self, ui: &mut Ui, state: &mut TreeViewState<NodeIdType>, build_tree_view: impl FnMut(&mut TreeViewBuilder<'_, NodeIdType>), ) -> (Response, Vec<Action<NodeIdType>>)

where NodeIdType: NodeId + Send + Sync + 'static,

Start displaying the tree view with a TreeViewState.

Construct the tree view using the TreeViewBuilder by adding directories or leaves to the tree.