Enum WidgetEvent 

pub enum WidgetEvent {
    None,
    Selected {
        path: Vec<usize>,
    },
    Toggled {
        path: Vec<usize>,
        expanded: bool,
    },
    Scrolled {
        offset: usize,
        direction: i32,
    },
    FilterModeChanged {
        active: bool,
        filter: String,
    },
    FilterModeExited {
        path: Vec<usize>,
    },
    MenuSelected {
        index: usize,
        action: Option<Box<dyn FnOnce() + Send>>,
    },
}

Available on crate feature widget-event only.

Common events emitted by interactive widgets.

This enum provides a standardized way for widgets to communicate actions to the parent application, reducing boilerplate in event handling loops.

Example

use crate::primitives::widget_event::WidgetEvent;

fn handle_widget_event(event: WidgetEvent) {
    match event {
        WidgetEvent::None => {}
        WidgetEvent::Selected { path } => println!("Selected: {:?}", path),
        WidgetEvent::Toggled { path, expanded } => println!("Toggled: {:?} = {}", path, expanded),
        WidgetEvent::Scrolled { offset, direction } => println!("Scrolled to {}", offset),
        WidgetEvent::FilterModeChanged { active, filter } => {
            println!("Filter {}: {}", if active { "on" } else { "off" }, filter);
        }
        WidgetEvent::FilterModeExited { path } => println!("Filter exited, focus: {:?}", path),
        WidgetEvent::MenuSelected { index, action: _ } => println!("Menu item {} selected", index),
    }
}

Variants

None

No event occurred.

Selected

A node/item was selected.

Fields

path: Vec<usize>

Path indices from root to the selected item.

Toggled

An expandable item was toggled (expanded/collapsed).

Fields

path: Vec<usize>

Path indices from root to the toggled item.

expanded: bool

Whether the item is now expanded (true) or collapsed (false).

Scrolled

Content was scrolled.

Fields

offset: usize

The new scroll offset.

direction: i32

Direction of scroll (positive = down, negative = up).

FilterModeChanged

Filter mode changed (entered, text changed, or exited with Esc).

Fields

active: bool

Whether filter mode is active.

filter: String

Current filter text.

FilterModeExited

Filter mode exited via Enter (focuses the selected item).

Fields

path: Vec<usize>

Path indices of the item that was focused when filter mode was exited.

MenuSelected

A menu item was selected.

Fields

index: usize

Index of the selected menu item.

action: Option<Box<dyn FnOnce() + Send>>

Optional action to execute when the menu item is selected. The action is consumed to ensure it is only executed once.

Trait Implementations

impl Debug for WidgetEvent

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

Formats the value using the given formatter.

impl Default for WidgetEvent

fn default() -> WidgetEvent

Returns the “default value” for a type.