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

Implementations

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 (for editing, search and scrolling).

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

Change the symbol left of the user editable section (only for edit operations).

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

Change the symbol left of the user editable section (only while searching).

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

Change the symbol left of the user editable section (only while scrolling).

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.

pub fn enter_search(&mut self)

Switch state to “searching”.

This means that that character inputs will instead be consumed for the search pattern and up/down naviation will cycle through matching items from the history.

pub fn as_widget<'a>(&'a self) -> impl Widget + 'a

Prepare for drawing as a Widget.

Methods from Deref<Target = LineEdit>

pub fn get(&self) -> &str

Get the current content.

pub fn set(&mut self, text: impl Into<String>)

Set (and overwrite) the current content. The cursor will be placed at the very end of the line.

pub fn move_cursor_to_end_of_line(&mut self)

Move the cursor to the end, i.e., behind the last grapheme cluster.

pub fn move_cursor_to_beginning_of_line(&mut self)

Move the cursor to the beginning, i.e., onto the first grapheme cluster.

pub fn move_cursor_right(&mut self) -> Result<(), ()>

Move the cursor one grapheme cluster to the right if possible.

pub fn move_cursor_left(&mut self) -> Result<(), ()>

Move the cursor one grapheme cluster to the left if possible.

pub fn insert(&mut self, text: &str)

Insert text directly before the current cursor position

pub fn cursor_pos(&self) -> usize

Returns the byte position of the cursor in the current text (obtainable by get)

pub fn set_cursor_pos(&mut self, pos: usize) -> Result<(), ()>

Set the cursor by specifying its position as the byte position in the displayed string.

If the byte position does not correspond to (the start of) a grapheme cluster in the string or the end of the string, an error is returned and the cursor position is left unchanged.

Examples:

use unsegen::widget::builtin::LineEdit;

let mut l = LineEdit::new();
l.set("löl");
assert!(l.set_cursor_pos(0).is_ok()); // |löl
assert!(l.set_cursor_pos(1).is_ok()); // l|öl
assert!(l.set_cursor_pos(2).is_err());
assert!(l.set_cursor_pos(3).is_ok()); // lö|l
assert!(l.set_cursor_pos(4).is_ok()); // löl|
assert!(l.set_cursor_pos(5).is_err());

pub fn as_widget<'a>(&'a self) -> LineEditWidget<'a>

Prepare for drawing as a Widget.

Trait Implementations

impl Deref for PromptLine

type Target = LineEdit

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for PromptLine

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

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

Remove all content.

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 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

Process the provided char and report if it was processed successfully.