Struct unsegen::widget::builtin::promptline::PromptLine

pub struct PromptLine {
    pub line: LineEdit,
    // some fields omitted
}

A widget implementing "readline"-like functionality.

Basically a more sophisticated version of LineEdit with history.

Fields

line: LineEdit

Methods

impl PromptLine

pub fn with_prompt(prompt: String) -> Self

Construct a PromptLine with the given symbol that will be displayed left of the LineEdit for user interaction.

pub fn set_prompt(&mut self, prompt: String)

Change the symbol left of the user editable section.

pub fn previous_line(&self, n: usize) -> Option<&str>

Get the n'th line from the history.

pub fn active_line(&self) -> &str

Get the current content of the LineEdit

pub fn finish_line(&mut self) -> &str

Mark the current content as "accepted", e.g., if the user has entered and submitted a command.

This adds the current line to the front of the history buffer.

Trait Implementations

impl Scrollable for PromptLine

fn scroll_forwards(&mut self) -> OperationResult

fn scroll_backwards(&mut self) -> OperationResult

fn scroll_to_beginning(&mut self) -> OperationResult

fn scroll_to_end(&mut self) -> OperationResult

impl Writable for PromptLine

fn write(&mut self, c: char) -> OperationResult

impl Navigatable for PromptLine

fn move_up(&mut self) -> OperationResult

fn move_down(&mut self) -> OperationResult

fn move_left(&mut self) -> OperationResult

fn move_right(&mut self) -> OperationResult

impl Editable for PromptLine

fn delete_forwards(&mut self) -> OperationResult

In the sense of pressing the "Delete" key.

fn delete_backwards(&mut self) -> OperationResult

In the sense of pressing the "Backspace" key.

fn go_to_beginning_of_line(&mut self) -> OperationResult

In the sense of pressing the "Home" key.

fn go_to_end_of_line(&mut self) -> OperationResult

In the sense of pressing the "End" key.

fn clear(&mut self) -> OperationResult

impl Widget for PromptLine

fn space_demand(&self) -> Demand2D

Return the current demand for (rectangular) screen estate.

fn draw(&self, window: Window, hints: RenderingHints)

Draw the widget to the given window.