Struct EditCommandComponent

pub struct EditCommandComponent { /* private fields */ }

A component for creating or editing a Command

Implementations

impl EditCommandComponent

pub fn new( service: IntelliShellService, theme: Theme, inline: bool, new_version: Option<Version>, command: Command, mode: EditCommandComponentMode, ) -> Self

Creates a new EditCommandComponent

Trait Implementations

impl Component for EditCommandComponent

fn name(&self) -> &'static str

Retrieves the component name, for debugging purposes

fn min_inline_height(&self) -> u16

Calculates the minimum height required by this component to be rendered correctly when inline (in rows)

fn render(&mut self, frame: &mut Frame<'_>, area: Rect)

Renders the component’s UI within the given area of the frame

fn tick(&mut self) -> Result<Action>

Processes time-based logic, internal state updates, or background tasks for the component.

fn exit(&mut self) -> Result<Option<ProcessOutput>>

Finalizes the component’s current operation and returns its output with the current state.

fn move_up(&mut self) -> Result<Action>

Handles a request to move the selection or focus upwards within the component.

fn move_down(&mut self) -> Result<Action>

Handles a request to move the selection or focus downwards within the component.

fn move_left(&mut self, word: bool) -> Result<Action>

Handles a request to move the selection or focus to the left within the component.

fn move_right(&mut self, word: bool) -> Result<Action>

Handles a request to move the selection or focus to the right within the component.

fn move_prev(&mut self) -> Result<Action>

Handles a request to move the selection to the previous logical item or element.

fn move_next(&mut self) -> Result<Action>

Handles a request to move the selection to the next logical item or element.

fn move_home(&mut self, absolute: bool) -> Result<Action>

Handles a request to move the selection to the beginning (e.g., “Home” key).

fn move_end(&mut self, absolute: bool) -> Result<Action>

Handles a request to move the selection to the end (e.g., “End” key).

fn undo(&mut self) -> Result<Action>

Handles a request to undo the last action performed in the component.

fn redo(&mut self) -> Result<Action>

Handles a request to redo the last undone action in the component.

fn insert_text(&mut self, text: String) -> Result<Action>

Handles the insertion of a block of text into the component.

fn insert_char(&mut self, c: char) -> Result<Action>

Handles the insertion of a single character into the component.

fn insert_newline(&mut self) -> Result<Action>

Handles a request to insert a newline character into the component.

fn delete(&mut self, backspace: bool, word: bool) -> Result<Action>

Handles the deletion key from the component, typically from a focused input field.

fn selection_confirm<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<Action>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Handles a request to confirm the currently selected item or element.

fn selection_execute<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<Action>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Handles a request to execute the primary action associated with the currently selected item or element within the component.

fn init<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Allows the component to initialize any internal state or resources it needs before being used.

fn peek<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<Action>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Peeks into the component before rendering, for examplle to give a straight result, switch component or continue with the TUI

fn process_paste_event(&mut self, content: String) -> Result<Action>

Processes a paste event, typically from clipboard paste into the terminal.

fn process_key_event<'life0, 'life1, 'async_trait>( &'life0 mut self, keybindings: &'life1 KeyBindingsConfig, key: KeyEvent, ) -> Pin<Box<dyn Future<Output = Result<Action>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Processes a key press event.

fn default_process_key_event<'life0, 'life1, 'async_trait>( &'life0 mut self, keybindings: &'life1 KeyBindingsConfig, key: KeyEvent, ) -> Pin<Box<dyn Future<Output = Result<Option<Action>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

The default behavior for process_key_event with a baseline set of key mappings by matching against the event. It calls other granular methods of this trait (e.g., move_up, insert_char).

fn process_mouse_event(&mut self, mouse: MouseEvent) -> Result<Action>

Processes a mouse event.

fn focus_gained(&mut self) -> Result<Action>

Called when the component gains focus within the application.

fn focus_lost(&mut self) -> Result<Action>

Called when the component loses focus within the application.

fn resize(&mut self, width: u16, height: u16) -> Result<Action>

Handles a terminal resize event, informing the component of the new global terminal dimensions.

fn selection_delete<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<Action>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Handles a request to delete the currently selected item or element within the component.

fn selection_update<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<Action>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Handles a request to update or modify the currently selected item or element.

fn toggle_search_mode(&mut self) -> Result<Action>

For the search command only, toggle the search mode

fn toggle_search_user_only(&mut self) -> Result<Action>

For the search command only, toggle the user-only mode