Trait NodeConfig

Source

pub trait NodeConfig<NodeIdType> {
Show 14 methods    // Required methods
    fn id(&self) -> &NodeIdType;
    fn is_dir(&self) -> bool;
    fn label(&mut self, ui: &mut Ui);

    // Provided methods
    fn flatten(&self) -> bool { ... }
    fn default_open(&self) -> bool { ... }
    fn drop_allowed(&self) -> bool { ... }
    fn activatable(&self) -> bool { ... }
    fn node_height(&self) -> Option<f32> { ... }
    fn has_custom_icon(&self) -> bool { ... }
    fn icon(&mut self, ui: &mut Ui) { ... }
    fn has_custom_closer(&self) -> bool { ... }
    fn closer(&mut self, ui: &mut Ui, closer_state: CloserState) { ... }
    fn has_context_menu(&self) -> bool { ... }
    fn context_menu(&mut self, ui: &mut Ui) { ... }
}

Expand description

Provides the configuration of a node in the tree.

Used to configure the appearance and behavior of a node in the tree.

Implementing this trait is not necessary most of the time. The NodeBuilder implements this trait and can be used for most purposes.

Required Methods§

Source

fn id(&self) -> &NodeIdType

Returns the id of this node

Source

fn is_dir(&self) -> bool

Returns whether or not this node is a directory.

Source

fn label(&mut self, ui: &mut Ui)

Renders the label of this node

Provided Methods§

Source

fn flatten(&self) -> bool

Whether or not the directory should be flattened into the parent directiron.

A directory that is flattened is not visible in the tree and cannot be navigated to. Its children appear like the children of the grand parent directory.

For example, this file structure:

Foo
├─ Alice
├─ Bar
│  ├─ Bob
│  └─ Clair
└─ Denis

looks like this when the Bar directory is flattened:

Foo
├─ Alice
├─ Bob
├─ Clair
└─ Denis

This node (Bar in the example) will still appear in Action::SetSelected if it is part of a relevant multi selection process. This node will still be the target of any drag and drop action as if it was visible.

Default value is false. Override to customize.

Source

fn default_open(&self) -> bool

Whether or not a directory should be open by default or closed.

Default is true. Override to customize.

Source

fn drop_allowed(&self) -> bool

Whether or not dropping onto this node is allowed.

Default is true for directories and false otherwise. Override to customize.

Source

fn activatable(&self) -> bool

Whether or not this node can be activated.

If a directory is activatable the double-click to expand/collapse for that node is disabled. Directories can still be expanded/collapsed by clicking on the closer or using the keyboard.

Default is false for directories and true otherwise. Override to customize.

Source