Cursive Tree View

https://docs.rs/cursive_tree_view/latest/cursive_tree_view/
Admin
Cursive Tree View is a tree view widget implementation for the Cursive terminal user interface...
Tokens:25,339
Snippets:172
Trust Score:9.7
Update:9 months ago
Show doc for...
Tokens:
Raw
### Initialize TreeView

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/struct.TreeView_search=std%3A%3Avec

Demonstrates how to create a new, empty TreeView instance. This is the starting point for populating and interacting with the tree structure.

```rust
let mut tree = TreeView::new();
```

--------------------------------

### Create a new TreeView instance in Rust

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/struct.TreeView_search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Provides the implementation for creating a new, empty TreeView. This is the starting point for using the TreeView component.

```rust
pub fn new() -> Self
```

--------------------------------

### Insert Item into TreeView

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/struct.TreeView_search=std%3A%3Avec

Shows how to insert items into the TreeView. Items are added with a specified parent row and placement (e.g., LastChild). This example illustrates adding a root item and then child items.

```rust
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);
```

--------------------------------

### TreeView Item Access and Navigation

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/struct.TreeView

Methods for accessing items by row index, getting row information, and navigating the tree structure.

```APIDOC
## TreeView Item Access and Navigation

### Description
Provides methods for retrieving information about rows, accessing items (both immutable and mutable references), and setting the currently selected row.

### Methods

#### `row()`
- **Description**: Returns the index of the currently selected tree row. `None` is returned in case of the tree being empty.
- **Method**: `pub fn row(&self) -> Option<usize>`

#### `first_col(row: usize)`
- **Description**: Returns the 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.
- **Method**: `pub fn first_col(&self, row: usize) -> Option<usize>`

#### `item_width(row: usize)`
- **Description**: Returns the total width (including the symbol) of the item at the given row. `None` is returned in case the specified `row` does not visually exist.
- **Method**: `pub fn item_width(&self, row: usize) -> Option<usize>`

#### `set_selected_row(row: usize)`
- **Description**: Selects the row at the specified index.
- **Method**: `pub fn set_selected_row(&mut self, row: usize)`

#### `selected_row(row: usize)`
- **Description**: Selects the row at the specified index. Chainable variant.
- **Method**: `pub fn selected_row(self, row: usize) -> Self`

#### `borrow_item(row: usize)`
- **Description**: Returns an immutable reference to the item at the given row. `None` is returned in case the specified `row` does not visually exist.
- **Method**: `pub fn borrow_item(&self, row: usize) -> Option<&T>`

#### `borrow_item_mut(row: usize)`
- **Description**: Returns a mutable reference to the item at the given row. `None` is returned in case the specified `row` does not visually exist.
- **Method**: `pub fn borrow_item_mut(&mut self, row: usize) -> Option<&mut T>`
```

--------------------------------

### TreeView Item Position and Width

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/struct.TreeView

Provides utility methods to get the horizontal position of an item's first character and the total width of an item at a given row. These methods return `Option<usize>` to handle non-existent rows.

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

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

--------------------------------

### TreeView Initialization

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/struct.TreeView_search=

API for creating a new, empty TreeView instance.

```APIDOC
## POST /default

### Description
Creates a new, empty `TreeView`.

### Method
POST

### Endpoint
/default

### Parameters
None

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **TreeView<T>** - A new, empty TreeView instance.

#### Response Example
```json
{
  "tree_view": { /* empty tree view structure */ }
}
```
```

--------------------------------

### Initialize and Populate TreeView in Rust

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/struct.TreeView_search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Demonstrates how to create a new TreeView instance and insert items into it. Items are added with a specified parent row and placement (e.g., LastChild).

```rust
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);
```

--------------------------------

### TreeView Initialization

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/struct.TreeView_search=u32+-%3E+bool

Methods for creating and initializing a new TreeView instance.

```APIDOC
## TreeView::new()

### Description
Creates a new, empty `TreeView`.

### Method
`new()`

### Returns
- `Self` - A new instance of `TreeView`.
```

--------------------------------

### Get Tree View Type Name (Rust)

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/struct.TreeView

Implements the `type_name` method from the `View` trait, returning the static string name of the `TreeView` type.

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

--------------------------------

### TreeView Initialization

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/struct.TreeView_search=

Methods for creating and initializing a new TreeView instance.

```APIDOC
## TreeView::new()

### Description
Creates a new, empty `TreeView`.

### Method
`new()`

### Endpoint
N/A (Constructor)

### Parameters
None

### Request Body
None

### Response
#### Success Response (Self)
- **Self** (TreeView) - A new, empty TreeView instance.

### Response Example
```rust
let tree: TreeView<String> = TreeView::new();
```
```

--------------------------------

### Get Important Area of Tree View (Rust)

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/struct.TreeView

Implements the `important_area` method from the `View` trait, defining which part of the tree view should be prioritized for visibility.

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

--------------------------------

### Get the currently selected row index in TreeView in Rust

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/struct.TreeView_search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Retrieves the index of the currently selected row in the TreeView. Returns None if the tree is empty.

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

--------------------------------

### TreeView Event Callbacks

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/struct.TreeView

Documentation for setting up callbacks for various events like submit, select, and collapse.

```APIDOC
## TreeView Event Callbacks

### Description
Allows setting up callback functions to be executed when specific user interactions occur within the TreeView, such as submitting an item, selecting an item, or collapsing/expanding an item.

### Methods

#### `set_on_submit(cb: F)`
- **Description**: Sets a callback to be used when `<Enter>` is pressed while an item is selected.
- **Method**: `pub fn set_on_submit<F>(&mut self, cb: F) where F: Fn(&mut Cursive, usize) + Send + Sync + 'static`
- **Example**:
  ```rust
  tree.set_on_submit(|siv: &mut Cursive, row: usize| {
      // Callback logic here
  });
  ```

#### `on_submit(cb: F)`
- **Description**: Sets a callback to be used when `<Enter>` is pressed while an item is selected. Chainable variant.
- **Method**: `pub fn on_submit<F>(self, cb: F) -> Self where F: Fn(&mut Cursive, usize) + Send + Sync + 'static`
- **Example**:
  ```rust
  tree.on_submit(|siv: &mut Cursive, row: usize| {
      // Callback logic here
  });
  ```

#### `set_on_select(cb: F)`
- **Description**: Sets a callback to be used when an item is selected.
- **Method**: `pub fn set_on_select<F>(&mut self, cb: F) where F: Fn(&mut Cursive, usize) + Send + Sync + 'static`
- **Example**:
  ```rust
  tree.set_on_select(|siv: &mut Cursive, row: usize| {
      // Callback logic here
  });
  ```

#### `on_select(cb: F)`
- **Description**: Sets a callback to be used when an item is selected. Chainable variant.
- **Method**: `pub fn on_select<F>(self, cb: F) -> Self where F: Fn(&mut Cursive, usize) + Send + Sync + 'static`
- **Example**:
  ```rust
  tree.on_select(|siv: &mut Cursive, row: usize| {
      // Callback logic here
  });
  ```

#### `set_on_collapse(cb: F)`
- **Description**: Sets a callback to be used when an item has its children collapsed or expanded.
- **Method**: `pub fn set_on_collapse<F>(&mut self, cb: F) where F: Fn(&mut Cursive, usize, bool, usize) + Send + Sync + 'static`
- **Example**:
  ```rust
  tree.set_on_collapse(|siv: &mut Cursive, row: usize, is_collapsed: bool, children: usize| {
      // Callback logic here
  });
  ```

#### `on_collapse(cb: F)`
- **Description**: Sets a callback to be used when an item has its children collapsed or expanded. Chainable variant.
- **Method**: `pub fn on_collapse<F>(self, cb: F) -> Self where F: Fn(&mut Cursive, usize, bool, usize) + Send + Sync + 'static`
- **Example**:
  ```rust
  tree.on_collapse(|siv: &mut Cursive, row: usize, is_collapsed: bool, children: usize| {
      // Callback logic here
  });
  ```
```

--------------------------------

### Get the width of an item in TreeView in Rust

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/struct.TreeView_search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Returns the total visual width of an item at a specified row, including any symbols. Returns None if the row is invalid.

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

--------------------------------

### TreeView Initialization and Basic Operations

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/struct.TreeView

This section covers the initialization of a TreeView and fundamental operations like enabling/disabling, clearing, and checking its state.

```APIDOC
## TreeView Initialization and Basic Operations

### Description
Provides methods for creating a new TreeView and managing its enabled state, as well as clearing its contents and checking if it's empty.

### Methods

#### `new()`
- **Description**: Creates a new, empty `TreeView`.
- **Method**: `pub fn new() -> Self`

#### `disable()`
- **Description**: Disables this view. A disabled view cannot be selected.
- **Method**: `pub fn disable(&mut self)`

#### `enable()`
- **Description**: Re-enables this view.
- **Method**: `pub fn enable(&mut self)`

#### `set_enabled(enabled: bool)`
- **Description**: Enable or disable this view.
- **Method**: `pub fn set_enabled(&mut self, enabled: bool)`

#### `is_enabled()`
- **Description**: Returns `true` if this view is enabled.
- **Method**: `pub fn is_enabled(&self) -> bool`

#### `clear()`
- **Description**: Removes all items from this view.
- **Method**: `pub fn clear(&mut self)`

#### `take_items()`
- **Description**: Removes all items from this view, returning them.
- **Method**: `pub fn take_items(&mut self) -> Vec<T>`

#### `len()`
- **Description**: Returns the number of items in this tree.
- **Method**: `pub fn len(&self) -> usize`

#### `is_empty()`
- **Description**: Returns `true` if this tree has no items.
- **Method**: `pub fn is_empty(&self) -> bool`
```

--------------------------------

### Get the number of items in TreeView in Rust

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/struct.TreeView_search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Returns the total count of items currently stored within the TreeView. This method is useful for determining the size of the tree.

```rust
pub fn len(&self) -> usize
```

--------------------------------

### Resizing Views with Constraints in Rust

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/struct.TreeView

Provides a comprehensive set of methods for applying size constraints to a view. These include setting fixed dimensions, maximum and minimum sizes, and full screen or full width/height. The `resized` method is the primary entry point for applying these constraints, returning a `ResizedView`.

```rust
fn resized( self, width: SizeConstraint, height: SizeConstraint, ) -> ResizedView<Self>

fn fixed_size<S>(self, size: S) -> ResizedView<Self>
where S: Into<XY<usize>>

fn fixed_width(self, width: usize) -> ResizedView<Self>

fn fixed_height(self, height: usize) -> ResizedView<Self>

fn full_screen(self) -> ResizedView<Self>

fn full_width(self) -> ResizedView<Self>

fn full_height(self) -> ResizedView<Self>

fn max_size<S>(self, size: S) -> ResizedView<Self>
where S: Into<XY<usize>>

fn max_width(self, max_width: usize) -> ResizedView<Self>

fn max_height(self, max_height: usize) -> ResizedView<Self>

fn min_size<S>(self, size: S) -> ResizedView<Self>
where S: Into<XY<usize>>

fn min_width(self, min_width: usize) -> ResizedView<Self>

fn min_height(self, min_height: usize) -> ResizedView<Self>
```

--------------------------------

### Get Type ID for Any Trait (Rust)

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/struct.TreeView

Implements the `type_id` method from the `Any` trait, returning the `TypeId` of the implementing type. This is part of Rust's dynamic typing system.

```rust
fn type_id(&self) -> TypeId
```

--------------------------------

### TreeView Initialization and View Trait

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/struct.TreeView_search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

APIs related to initializing a TreeView and its implementation of the View trait for rendering and event handling.

```APIDOC
## POST /default

### Description
Creates a new, empty `TreeView`.

### Method
POST

### Endpoint
`/default`

### Response
#### Success Response (200)
- **TreeView<T>** - A new, empty TreeView instance.

## View Trait Methods

### POST /draw

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

### Method
POST

### Endpoint
`/draw`

### Parameters
#### Request Body
- **printer** (Printer) - Required - The printer to use for drawing.

### POST /required_size

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

### Method
POST

### Endpoint
`/required_size`

### Parameters
#### Request Body
- **req** (Vec2) - Required - The size restrictions.

### Response
#### Success Response (200)
- **Vec2** - The required size.

### POST /layout

### Description
Called once the size for this view has been decided.

### Method
POST

### Endpoint
`/layout`

### Parameters
#### Request Body
- **size** (Vec2) - Required - The decided size for the view.

### POST /take_focus

### Description
Attempt to give this view the focus.

### Method
POST

### Endpoint
`/take_focus`

### Parameters
#### Request Body
- **direction** (Direction) - Required - The direction to attempt focus.

### Response
#### Success Response (200)
- **Result<EventResult, CannotFocus>** - The result of the focus attempt.

### POST /on_event

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

### Method
POST

### Endpoint
`/on_event`

### Parameters
#### Request Body
- **event** (Event) - Required - The event received.

### Response
#### Success Response (200)
- **EventResult** - The result of the event handling.

### GET /important_area

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

### Method
GET

### Endpoint
`/important_area`

### Parameters
#### Query Parameters
- **size** (Vec2) - Required - The size of the view.

### Response
#### Success Response (200)
- **Rect** - The important area.

### GET /needs_relayout

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

### Method
GET

### Endpoint
`/needs_relayout`

### Response
#### Success Response (200)
- **bool** - True if a relayout is needed, false otherwise.

### POST /call_on_any

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

### Method
POST

### Endpoint
`/call_on_any`

### Parameters
#### Request Body
- **selector** (Selector) - Required - The selector for the view.
- **closure** (FnMut) - Required - The closure to run.

### POST /focus_view

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

### Method
POST

### Endpoint
`/focus_view`

### Parameters
#### Request Body
- **selector** (Selector) - Required - The selector for the view.

### Response
#### Success Response (200)
- **Result<EventResult, ViewNotFound>** - The result of the focus attempt.

### GET /type_name

### Description
Returns the type of this view.

### Method
GET

### Endpoint
`/type_name`

### Response
#### Success Response (200)
- **&'static str** - The type name of the view.
```

--------------------------------

### Implement Copy and Eq for Placement Enum in Rust

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/enum.Placement_search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

This Rust code shows the implementation of the `Copy` and `Eq` traits for the `Placement` enum. `Copy` allows for simple bitwise copies of `Placement` values, while `Eq` guarantees that equality comparisons are reflexive, symmetric, and transitive.

```rust
impl Copy for Placement {}

impl Eq for Placement {}
```

--------------------------------

### Get Required Size for Tree View (Rust)

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/struct.TreeView

Implements the `required_size` method from the `View` trait. It calculates the minimum size the tree view needs based on restrictions.

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

--------------------------------

### Get Parent Row in Tree View (Rust)

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/struct.TreeView

Returns the visual row of the parent of the item located at the specified `row`. Returns `None` if the item is not visible or has no parent.

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

--------------------------------

### Get the first column position of an item in TreeView in Rust

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/struct.TreeView_search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Calculates and returns the horizontal position (x-axis) of the first character of an item at a given row. Returns None if the row does not exist visually.

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

--------------------------------

### Implement Blanket Trait Any for T (Rust)

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/enum.Placement_search=std%3A%3Avec

Demonstrates the blanket implementation of the `Any` trait for any type `T` that is `'static` and `?Sized`. This allows for runtime type identification.

```rust
impl<T> Any for T where T: 'static + ?Sized {
    fn type_id(&self) -> TypeId;
}
```

--------------------------------

### Implement StructuralPartialEq for Placement Enum (Rust)

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/enum.Placement_search=std%3A%3Avec

Implements the `StructuralPartialEq` trait for the `Placement` enum, which is used for structural equality comparisons.

```rust
impl StructuralPartialEq for Placement {}
```

--------------------------------

### TryFrom and TryInto Conversions

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/struct.TreeView_search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Implements `TryFrom` and `TryInto` for fallible conversions between types. These traits allow attempting a conversion that might fail, returning a `Result` with either the converted value or an error type.

```rust
type Error = Infallible
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
type Error = <U as TryFrom<T>>::Error
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
```

--------------------------------

### TreeView Item Borrowing

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/struct.TreeView

Offers methods to get immutable or mutable references to items within the TreeView at a specific row index. These methods return `Option<&T>` or `Option<&mut T>` to account for invalid row indices.

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

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

--------------------------------

### Applying Closures to Views in Rust

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/struct.TreeView

Provides methods for applying closures to a view, allowing for in-place modification or transformation. `wrap_with` executes a closure that takes ownership of the view and returns a new value. `with` and `try_with` apply a closure to a mutable reference of the view, with `try_with` allowing for fallible operations. `with_if` conditionally applies a closure.

```rust
fn wrap_with<U, F>(self, f: F) -> U
where F: FnOnce(Self) -> U

fn with<F>(self, f: F) -> Self
where F: FnOnce(&mut Self)

fn try_with<E, F>(self, f: F) -> Result<Self, E>
where F: FnOnce(&mut Self) -> Result<(), E>

fn with_if<F>(self, condition: bool, f: F) -> Self
where F: FnOnce(&mut Self)
```

--------------------------------

### Implement Blanket Trait CloneToUninit for T (Rust)

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/enum.Placement_search=std%3A%3Avec

Presents the experimental, nightly-only blanket implementation of `CloneToUninit` for types `T` that implement `Clone`. This unsafe method performs copy-assignment to uninitialized memory.

```rust
impl<T> CloneToUninit for T where T: Clone {
    unsafe fn clone_to_uninit(&self, dest: *mut u8);
}
```

--------------------------------

### Take Focus for Tree View (Rust)

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/struct.TreeView

Implements the `take_focus` method from the `View` trait, attempting to give focus to the tree view.

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

--------------------------------

### Focus Navigation API

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/struct.TreeView_search=

APIs for navigating focus up and down the tree view.

```APIDOC
## POST /focus_up

### Description
Select item `n` rows up from the one currently selected.

### Method
POST

### Endpoint
/focus_up

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **n** (usize) - Required - The number of rows to move up.

### Request Example
```json
{
  "n": 2
}
```

### Response
#### Success Response (200)
- **()** - Indicates success.

#### Response Example
```json
{
  "status": "success"
}
```

## POST /focus_down

### Description
Select item `n` rows down from the one currently selected.

### Method
POST

### Endpoint
/focus_down

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **n** (usize) - Required - The number of rows to move down.

### Request Example
```json
{
  "n": 1
}
```

### Response
#### Success Response (200)
- **()** - Indicates success.

#### Response Example
```json
{
  "status": "success"
}
```
```

--------------------------------

### Implement Auto Traits for Placement Enum (Rust)

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/enum.Placement_search=std%3A%3Avec

Lists the auto trait implementations for the `Placement` enum, including `Freeze`, `RefUnwindSafe`, `Send`, `Sync`, `Unpin`, and `UnwindSafe`, indicating thread safety and memory safety properties.

```rust
impl Freeze for Placement {}
impl RefUnwindSafe for Placement {}
impl Send for Placement {}
impl Sync for Placement {}
impl Unpin for Placement {}
impl UnwindSafe for Placement {}
```

--------------------------------

### Finding and Calling Callbacks on Views

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/struct.TreeView_search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Provides functionality to find and interact with views based on selectors or names. The `Finder` trait allows executing callbacks on specific views within a hierarchy, enabling targeted manipulation or data retrieval.

```rust
fn call_on_all<V, F>(&mut self, sel: &Selector<'_>, callback: F)
where V: View, F: FnMut(&mut V)
fn call_on<V, F, R>(&mut self, sel: &Selector<'_>, callback: F) -> Option<R>
where V: View, F: FnOnce(&mut V) -> R
fn call_on_name<V, F, R>(&mut self, name: &str, callback: F) -> Option<R>
where V: View, F: FnOnce(&mut V) -> R
fn find_name<V>(&mut self, name: &str) -> Option<ViewRef<V>>
where V: View
```

--------------------------------

### TreeView Callback Methods

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/struct.TreeView_search=

Methods for setting callbacks for various user interactions like submit, select, and collapse.

```APIDOC
## TreeView::set_on_submit()

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

### Method
`set_on_submit<F>(&mut self, cb: F)`

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **cb** (Fn(&mut Cursive, usize) + Send + Sync + 'static) - The callback function. It receives a mutable reference to the Cursive root and the selected row index.

### Response
None (Modifies internal state)

### Response Example
```rust
tree.set_on_submit(|siv: &mut Cursive, row: usize| {
    // Handle submit action
});
```
```

```APIDOC
## TreeView::on_submit()

### Description
Sets a callback to be used when `<Enter>` is pressed while an item is selected. Chainable variant.

### Method
`on_submit<F>(self, cb: F) -> Self`

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **cb** (Fn(&mut Cursive, usize) + Send + Sync + 'static) - The callback function. It receives a mutable reference to the Cursive root and the selected row index.

### Response
#### Success Response (Self)
- **Self** (TreeView) - The TreeView instance for chaining.

### Response Example
```rust
let tree = TreeView::new().on_submit(|siv: &mut Cursive, row: usize| {
    // Handle submit action
});
```
```

```APIDOC
## TreeView::set_on_select()

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

### Method
`set_on_select<F>(&mut self, cb: F)`

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **cb** (Fn(&mut Cursive, usize) + Send + Sync + 'static) - The callback function. It receives a mutable reference to the Cursive root and the selected row index.

### Response
None (Modifies internal state)

### Response Example
```rust
tree.set_on_select(|siv: &mut Cursive, row: usize| {
    // Handle select action
});
```
```

```APIDOC
## TreeView::on_select()

### Description
Sets a callback to be used when an item is selected. Chainable variant.

### Method
`on_select<F>(self, cb: F) -> Self`

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **cb** (Fn(&mut Cursive, usize) + Send + Sync + 'static) - The callback function. It receives a mutable reference to the Cursive root and the selected row index.

### Response
#### Success Response (Self)
- **Self** (TreeView) - The TreeView instance for chaining.

### Response Example
```rust
let tree = TreeView::new().on_select(|siv: &mut Cursive, row: usize| {
    // Handle select action
});
```
```

```APIDOC
## TreeView::set_on_collapse()

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

### Method
`set_on_collapse<F>(&mut self, cb: F)`

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **cb** (Fn(&mut Cursive, usize, bool, usize) + Send + Sync + 'static) - The callback function. It receives a mutable reference to the Cursive root, the row index, a boolean indicating if it's collapsed, and the number of children.

### Response
None (Modifies internal state)

### Response Example
```rust
tree.set_on_collapse(|siv: &mut Cursive, row: usize, is_collapsed: bool, children: usize| {
    // Handle collapse/expand action
});
```
```

```APIDOC
## TreeView::on_collapse()

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

### Method
`on_collapse<F>(self, cb: F) -> Self`

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **cb** (Fn(&mut Cursive, usize, bool, usize) + Send + Sync + 'static) - The callback function. It receives a mutable reference to the Cursive root, the row index, a boolean indicating if it's collapsed, and the number of children.

### Response
#### Success Response (Self)
- **Self** (TreeView) - The TreeView instance for chaining.

### Response Example
```rust
let tree = TreeView::new().on_collapse(|siv: &mut Cursive, row: usize, is_collapsed: bool, children: usize| {
    // Handle collapse/expand action
});
```
```

--------------------------------

### Implement PartialEq for Placement Enum (Rust)

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/enum.Placement_search=u32+-%3E+bool

Provides implementations for the `PartialEq` trait for the `Placement` enum. This enables comparison between `Placement` values to check for equality, useful in conditional logic related to item placement.

```rust
impl PartialEq for Placement {
    fn eq(&self, other: &Placement) -> bool {
        // ... implementation details ...
    }
    fn ne(&self, other: &Rhs) -> bool {
        // ... implementation details ...
    }
}
```

--------------------------------

### Applying Closures with With Trait

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/struct.TreeView_search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

The `With` trait offers flexible ways to apply closures to a value. `wrap_with` executes a closure that takes ownership and returns a new value, while `with` and `try_with` apply closures mutably to the value itself, with `try_with` supporting fallible operations.

```rust
fn wrap_with<U, F>(self, f: F) -> U
where F: FnOnce(Self) -> U
fn with<F>(self, f: F) -> Self
where F: FnOnce(&mut Self)
fn try_with<E, F>(self, f: F) -> Result<Self, E>
where F: FnOnce(&mut Self) -> Result<(), E>
```

--------------------------------

### TreeView Size and State

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/struct.TreeView_search=std%3A%3Avec

Methods for querying the size and state of the TreeView.

```APIDOC
## TreeView::len()

### Description
Returns the number of items in this tree.

### Method
`len(&self) -> usize`

### Returns
- `usize`: The number of items in the tree.

### Example
```rust
let count = tree.len();
```

## TreeView::is_empty()

### Description
Returns `true` if this tree has no items.

### Method
`is_empty(&self) -> bool`

### Returns
- `bool`: `true` if the tree is empty, `false` otherwise.

### Example
```rust
let is_empty = tree.is_empty();
```
```

--------------------------------

### Traversing and Manipulating Views with Selectors in Rust

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/struct.TreeView

Provides methods for finding and operating on views within a hierarchical structure using selectors. `call_on_all` applies a callback to all matching views, `call_on` targets a single view, and `call_on_name` is a convenience for name-based selection. `find_name` retrieves a reference to a named view.

```rust
fn call_on_all<V, F>(&mut self, sel: &Selector<'_>, callback: F)
where V: View, F: FnMut(&mut V)

fn call_on<V, F, R>(&mut self, sel: &Selector<'_>, callback: F) -> Option<R>
where V: View, F: FnOnce(&mut V) -> R

fn call_on_name<V, F, R>(&mut self, name: &str, callback: F) -> Option<R>
where V: View, F: FnOnce(&mut V) -> R

fn find_name<V>(&mut self, name: &str) -> Option<ViewRef<V>>
where V: View
```

--------------------------------

### Implement Copy and Eq for Placement Enum (Rust)

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/enum.Placement_search=u32+-%3E+bool

Implements the `Copy` and `Eq` traits for the `Placement` enum. `Copy` allows for simple bitwise copies of `Placement` values, while `Eq` guarantees that equality is reflexive, symmetric, and transitive.

```rust
impl Copy for Placement {}
impl Eq for Placement {}
```

--------------------------------

### Tree Navigation and Information API

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/struct.TreeView_search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

APIs for navigating the tree structure and retrieving parent information.

```APIDOC
## GET /item_parent

### Description
Returns the position of the parent of the item located in `row`. `None` is returned if `row` is not currently visible or if the item has no ancestors.

### Method
GET

### Endpoint
`/item_parent`

### Parameters
#### Query Parameters
- **row** (usize) - Required - The visual row of the item to find the parent for.

### Response
#### Success Response (200)
- **Option<usize>** - The visual row of the parent item, or None if no parent is found or the row is not visible.
```

--------------------------------

### Any Trait Implementation (Rust)

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/struct.TreeView_search=std%3A%3Avec

Blanket implementation of the Any trait for any type T that is 'static and Send + Sync.

```rust
impl<T> Any for T
where T: 'static + ?Sized,
```

--------------------------------

### Enable TreeView

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/struct.TreeView_search=std%3A%3Avec

Implements the `enable` method for the TreeView. This method re-enables a previously disabled view, allowing it to be selected and interacted with again.

```rust
pub fn enable(&mut self)
```

--------------------------------

### Resizing Views with Constraints

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/struct.TreeView_search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

The `Resizable` trait offers extensive control over view dimensions. It allows setting fixed sizes, maximum and minimum dimensions, and full-screen or full-width/height constraints by wrapping the view in a `ResizedView`.

```rust
fn resized( self, width: SizeConstraint, height: SizeConstraint, ) -> ResizedView<Self>
fn fixed_size<S>(self, size: S) -> ResizedView<Self>
where S: Into<XY<usize>>
fn fixed_width(self, width: usize) -> ResizedView<Self>
fn fixed_height(self, height: usize) -> ResizedView<Self>
fn full_screen(self) -> ResizedView<Self>
fn full_width(self) -> ResizedView<Self>
fn full_height(self) -> ResizedView<Self>
fn max_size<S>(self, size: S) -> ResizedView<Self>
where S: Into<XY<usize>>
fn max_width(self, max_width: usize) -> ResizedView<Self>
fn max_height(self, max_height: usize) -> ResizedView<Self>
fn min_size<S>(self, size: S) -> ResizedView<Self>
where S: Into<XY<usize>>
fn min_width(self, min_width: usize) -> ResizedView<Self>
fn min_height(self, min_height: usize) -> ResizedView<Self>
```

--------------------------------

### Item Collapse/Expand API

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/struct.TreeView_search=

APIs for collapsing, expanding, and setting the collapsed state of items in the tree view.

```APIDOC
## POST /collapse_item

### Description
Collapses the children of the given `row`.

### Method
POST

### Endpoint
/collapse_item

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **row** (usize) - Required - The visual row of the item whose children to collapse.

### Request Example
```json
{
  "row": 0
}
```

### Response
#### Success Response (200)
- **()** - Indicates success.

#### Response Example
```json
{
  "status": "success"
}
```

## POST /expand_item

### Description
Expands the children of the given `row`.

### Method
POST

### Endpoint
/expand_item

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **row** (usize) - Required - The visual row of the item whose children to expand.

### Request Example
```json
{
  "row": 0
}
```

### Response
#### Success Response (200)
- **()** - Indicates success.

#### Response Example
```json
{
  "status": "success"
}
```

## POST /set_collapsed

### Description
Collapses or expands the children of the given `row`.

### Method
POST

### Endpoint
/set_collapsed

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **row** (usize) - Required - The visual row of the item.
- **collapsed** (bool) - Required - True to collapse, false to expand.

### Request Example
```json
{
  "row": 1,
  "collapsed": true
}
```

### Response
#### Success Response (200)
- **()** - Indicates success.

#### Response Example
```json
{
  "status": "success"
}
```

## POST /collapsed (Chained variant)

### Description
Collapses or expands the children of the given `row`. This is a chained variant.

### Method
POST

### Endpoint
/collapsed

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **row** (usize) - Required - The visual row of the item.
- **collapsed** (bool) - Required - True to collapse, false to expand.

### Request Example
```json
{
  "row": 1,
  "collapsed": false
}
```

### Response
#### Success Response (200)
- **Self** - Returns the modified TreeView instance.

#### Response Example
```json
{
  "message": "TreeView modified"
}
```
```

--------------------------------

### TreeView Size and State

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/struct.TreeView_search=

Methods for querying the size and emptiness of the TreeView.

```APIDOC
## TreeView::len()

### Description
Returns the number of items in this tree.

### Method
`len(&self) -> usize`

### Endpoint
N/A

### Parameters
None

### Request Body
None

### Response
#### Success Response (usize)
- **usize** - The total number of items in the tree.

### Response Example
```rust
let count = tree.len();
println!("Number of items: {}", count);
```
```

```APIDOC
## TreeView::is_empty()

### Description
Returns `true` if this tree has no items.

### Method
`is_empty(&self) -> bool`

### Endpoint
N/A

### Parameters
None

### Request Body
None

### Response
#### Success Response (bool)
- **bool** - `true` if the tree is empty, `false` otherwise.

### Response Example
```rust
if tree.is_empty() {
    println!("The tree is empty.");
}
```
```

--------------------------------

### TreeView Size and Emptiness Check

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/struct.TreeView

Offers methods to determine the number of items currently in the TreeView and to check if the TreeView is empty.

```rust
pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool
```

--------------------------------

### TreeView Callback: Submit

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/struct.TreeView_search=u32+-%3E+bool

Methods for setting callbacks to be executed when the Enter key is pressed while an item is selected.

```APIDOC
## TreeView::set_on_submit<F>(cb: F)

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

### Method
`set_on_submit<F>(&mut self, cb: F)`

### Parameters
#### Path Parameters
- **cb** (Fn(&mut Cursive, usize) + Send + Sync + 'static) - Required - The callback function to execute.

### Example
```rust
tree.set_on_submit(|siv: &mut Cursive, row: usize| {

});
```

## TreeView::on_submit<F>(cb: F) -> Self

### Description
Sets a callback to be used when `<Enter>` is pressed while an item is selected. Chainable variant.

### Method
`on_submit<F>(self, cb: F) -> Self`

### Parameters
#### Path Parameters
- **cb** (Fn(&mut Cursive, usize) + Send + Sync + 'static) - Required - The callback function to execute.

### Returns
- `Self` - The `TreeView` instance for chaining.

### Example
```rust
tree.on_submit(|siv: &mut Cursive, row: usize| {

});
```
```

--------------------------------

### Placement Enum Documentation

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/enum.Placement_search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

This section details the Placement enum, which determines how items are inserted into a TreeView. It includes descriptions of each variant and implemented traits.

```APIDOC
## Enum Placement

### Description
Determines how items are inserted into a `TreeView`.

### Variants

*   **After**: The item is inserted as a sibling after the specified row.
*   **Before**: The item is inserted as a sibling before the specified row.
*   **FirstChild**: The item is inserted as a new child of the specified row, placed before all other existing children.
*   **LastChild**: The item is inserted as a new child of the specified row, placed after all other existing children.
*   **Parent**: The item is inserted as the new immediate parent of the specified row.

### Trait Implementations

*   **Clone**: Allows creating a copy of a `Placement` value.
*   **Debug**: Enables the debugging representation of a `Placement` value.
*   **PartialEq**: Allows comparison for equality between `Placement` values.
*   **Copy**: Indicates that `Placement` values can be copied implicitly.
*   **Eq**: A marker trait indicating that equality is reflexive, symmetric, and transitive.
*   **StructuralPartialEq**: Allows structural comparison of types.

### Auto Trait Implementations

*   **Freeze**, **RefUnwindSafe**, **Send**, **Sync**, **Unpin**, **UnwindSafe**: Standard Rust auto traits indicating thread safety and memory safety properties.
```

--------------------------------

### TreeView Size and Emptiness

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/struct.TreeView_search=u32+-%3E+bool

Methods for checking the number of items and whether the TreeView is empty.

```APIDOC
## TreeView::len() -> usize

### Description
Returns the number of items in this tree.

### Method
`len(&self) -> usize`

### Returns
- `usize` - The number of items in the `TreeView`.

## TreeView::is_empty() -> bool

### Description
Returns `true` if this tree has no items.

### Method
`is_empty(&self) -> bool`

### Returns
- `bool` - `true` if the `TreeView` is empty, `false` otherwise.
```

--------------------------------

### Naming Views

Source: https://docs.rs/cursive_tree_view/latest/cursive_tree_view/struct.TreeView_search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Allows assigning a name to a view using the `Nameable` trait. The `with_name` method wraps a view in a `NamedView`, making it identifiable by its name for later retrieval or manipulation.

```rust
fn with_name<S>(self, name: S) -> NamedView<Self>
where S: Into<String>
```
Tokens:
Raw