Struct TypingWidget 

pub struct TypingWidget<C> {
    pub size_and_position: SizeAndPosition,
    pub render_function: Option<Box<dyn Fn((u16, u16), (u16, u16), &[&str; 2], bool) -> Option<Vec<Span>>>>,
    pub typed_text: String,
    pub selected: bool,
    pub cursor_pos: usize,
    /* private fields */
}

A widget that renders static content using a provided closure (i.e. a title box or description). Suitable for content that doesn’t change frequently or in response to events. TypingWidgetBuilder is the associated builder for creating instances of this widget. The generic parameter C represents the application data type, which can be any type defined by the user.

Fields

size_and_position: SizeAndPosition

Configuration for the widget’s size and position, supporting both static and dynamic layouts.

render_function: Option<Box<dyn Fn((u16, u16), (u16, u16), &[&str; 2], bool) -> Option<Vec<Span>>>>

Optional closure that generates the widget’s rendered content based on size and position.

typed_text: String

The text that has been typed into the widget so far.

selected: bool

Indicates whether the widget is currently selected (focused for input).

cursor_pos: usize

Implementations

impl<C> TypingWidget<C>

pub fn new( name: String, size_and_position: SizeAndPosition, render_function: Option<Box<dyn Fn((u16, u16), (u16, u16), &[&str; 2], bool) -> Option<Vec<Span>>>>, depth: u16, display_area: &Rect, ) -> Result<(TypingWidget<C>, Window), WidgetErr>

Creates a new TypingWidget and its associated window.

Arguments

• name - Unique identifier for the widget
• size_and_position - Configuration for size and positioning
• render_function - Optional closure that renders content given size and position
• depth - Z-index for rendering order
• display_area - Current terminal area for initial size/position calculation

Returns

Result containing the widget and window, or error if dimensions are invalid

When possible, an implementation of WidgetBuilder should be used instead, both for safety, simplicity, and consistency.

Trait Implementations

impl<C> Widget<C> for TypingWidget<C>

Implementation of the methods for TypingWidget

fn get_window_ref(&self) -> String

Returns the widget’s name as an identifier. The rendering backend relies on String names instead of widgets.

fn update_with_events( &mut self, data: &mut C, app: &mut App<C>, scene: &mut Scene<C>, )

Handles event updates. However, compared to the other widgets, this one doesn’t directly act to modify the widget, but rather to respond to changes in text input.

fn update_render(&mut self, window: &mut Window, area: &Rect) -> bool

Updates the widget’s rendering based on current size and position. Called automatically during render passes. If Some(render_closure) is provided, that closure will be called. If the closure returns Some(Vec<Span>), then the rendered content will be set as such.

fn get_children_indexes(&self) -> Vec<usize>

Returns the indices of child widgets in the scene graph.

fn add_child_index(&mut self, index: usize)

Adds a child widget index to this widget.

fn remove_child_index(&mut self, index: usize)

Removes a child widget index from this widget

fn clear_children_indexes(&mut self)

Clears all child widget indices from this widget

fn get_parent_index(&self) -> Option<usize>

Returns the parent widget index if one exists, otherwise None.

fn set_parent_index(&mut self, index: Option<usize>)

Sets the parent widget index for this widget, or None for a root node.

fn is_collided(&self, position: (u16, u16)) -> bool

Determines if a given position collides with the widget’s area.