Struct unsegen::widget::builtin::lineedit::LineEdit

pub struct LineEdit { /* fields omitted */ }

A user-editable line of text.

In addition to the current text, the LineEdit has a concept of a cursor whose position can change, but is always on a grapheme cluster in the current text.

Implementations

impl LineEdit

pub fn new() -> Self

Create with default cursor style: Underline position when inactive and invert on blink.

pub fn with_cursor_styles(
    active_blink_on: StyleModifier,
    active_blink_off: StyleModifier,
    inactive: StyleModifier
) -> Self

Create with the specified style for the cursor.

Three styles have to be specified for the three possible states (in terms of rendering) of the cursor:

1. Active, and during an "on"-blink cycle.
2. Active, and during an "off"-blink cycle.
3. Inactive.

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());

Trait Implementations

impl Editable for LineEdit

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 Navigatable for LineEdit

Note that there is no concept of moving up or down for a LineEdit.

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 Widget for LineEdit

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.

impl Writable for LineEdit

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