Struct unsegen::widget::builtin::lineedit::LineEdit [−][src]
pub struct LineEdit { /* fields omitted */ }
Expand description
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
[src]
impl LineEdit
[src]pub fn set(&mut self, text: impl Into<String>)
[src]
pub fn set(&mut self, text: impl Into<String>)
[src]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)
[src]
pub fn move_cursor_to_end_of_line(&mut self)
[src]Move the cursor to the end, i.e., behind the last grapheme cluster.
pub fn move_cursor_to_beginning_of_line(&mut self)
[src]
pub fn move_cursor_to_beginning_of_line(&mut self)
[src]Move the cursor to the beginning, i.e., onto the first grapheme cluster.
pub fn move_cursor_right(&mut self) -> Result<(), ()>
[src]
pub fn move_cursor_right(&mut self) -> Result<(), ()>
[src]Move the cursor one grapheme cluster to the right if possible.
pub fn move_cursor_left(&mut self) -> Result<(), ()>
[src]
pub fn move_cursor_left(&mut self) -> Result<(), ()>
[src]Move the cursor one grapheme cluster to the left if possible.
pub fn cursor_pos(&self) -> usize
[src]
pub fn cursor_pos(&self) -> usize
[src]Returns the byte position of the cursor in the current text (obtainable by get
)
pub fn set_cursor_pos(&mut self, pos: usize) -> Result<(), ()>
[src]
pub fn set_cursor_pos(&mut self, pos: usize) -> Result<(), ()>
[src]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>
[src]
pub fn as_widget<'a>(&'a self) -> LineEditWidget<'a>
[src]Prepare for drawing as a Widget
.
Trait Implementations
impl Editable for LineEdit
[src]
impl Editable for LineEdit
[src]fn delete_forwards(&mut self) -> OperationResult
[src]
fn delete_forwards(&mut self) -> OperationResult
[src]In the sense of pressing the “Delete” key.
fn delete_backwards(&mut self) -> OperationResult
[src]
fn delete_backwards(&mut self) -> OperationResult
[src]In the sense of pressing the “Backspace” key.
fn go_to_beginning_of_line(&mut self) -> OperationResult
[src]
fn go_to_beginning_of_line(&mut self) -> OperationResult
[src]In the sense of pressing the “Home” key.
fn go_to_end_of_line(&mut self) -> OperationResult
[src]
fn go_to_end_of_line(&mut self) -> OperationResult
[src]In the sense of pressing the “End” key.
fn clear(&mut self) -> OperationResult
[src]
fn clear(&mut self) -> OperationResult
[src]Remove all content.
impl Navigatable for LineEdit
[src]
impl Navigatable for LineEdit
[src]Note that there is no concept of moving up or down for a LineEdit
.