Struct State

pub struct State {
    pub tracked_value: Value,
    pub value: Plain<<Renderer as Renderer>::Paragraph>,
    pub placeholder: Plain<<Renderer as Renderer>::Paragraph>,
    pub label: Plain<<Renderer as Renderer>::Paragraph>,
    pub helper_text: Plain<<Renderer as Renderer>::Paragraph>,
    pub dirty: bool,
    pub is_secure: bool,
    pub is_read_only: bool,
    pub emit_unfocus: bool,
    /* private fields */
}

The state of a TextInput.

Fields

tracked_value: Value

value: Plain<<Renderer as Renderer>::Paragraph>

placeholder: Plain<<Renderer as Renderer>::Paragraph>

label: Plain<<Renderer as Renderer>::Paragraph>

helper_text: Plain<<Renderer as Renderer>::Paragraph>

dirty: bool

is_secure: bool

is_read_only: bool

emit_unfocus: bool

Implementations

impl State

pub fn new( is_secure: bool, is_read_only: bool, always_active: bool, select_on_focus: bool, ) -> Self

Creates a new State, representing an unfocused TextInput.

pub fn selected_text(&self, text: &str) -> Option<String>

Returns the current value of the selected text in the TextInput.

pub fn focused(is_secure: bool, is_read_only: bool) -> Self

Creates a new State, representing a focused TextInput.

pub fn is_focused(&self) -> bool

Returns whether the TextInput is currently focused or not.

pub fn cursor(&self) -> Cursor

Returns the Cursor of the TextInput.

pub fn focus(&mut self)

Focuses the TextInput.

pub fn move_cursor_to_front(&mut self)

Moves the Cursor of the TextInput to the front of the input text.

pub fn move_cursor_to_end(&mut self)

Moves the Cursor of the TextInput to the end of the input text.

pub fn move_cursor_to(&mut self, position: usize)

Moves the Cursor of the TextInput to an arbitrary location.

pub fn select_all(&mut self)

Selects all the content of the TextInput.

Trait Implementations

impl Clone for State

fn clone(&self) -> State

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for State

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for State

fn default() -> State

Returns the “default value” for a type.

impl Focusable for State

fn is_focused(&self) -> bool

Returns whether the widget is focused or not.

fn focus(&mut self)

Focuses the widget.

fn unfocus(&mut self)

Unfocuses the widget.

impl TextInput for State

fn move_cursor_to_front(&mut self)

Moves the cursor of the text input to the front of the input text.

fn move_cursor_to_end(&mut self)

Moves the cursor of the text input to the end of the input text.

fn move_cursor_to(&mut self, position: usize)

Moves the cursor of the text input to an arbitrary location.

fn select_all(&mut self)

Selects all the content of the text input.