Struct Editor 

pub struct Editor { /* private fields */ }

Editor component

Implementations

impl Editor

API for use by EditGuard implementations

pub fn id_ref(&self) -> &Id

Get a reference to the widget’s identifier

pub fn id(&self) -> Id

Get the widget’s identifier

pub fn as_str(&self) -> &str

Get text contents

pub fn clone_string(&self) -> String

Get the text contents as a String

pub fn pre_commit(&mut self)

Commit outstanding changes to the undo history

Call this before changing the text with set_str or set_string to commit changes to the undo history.

pub fn clear(&mut self, cx: &mut EventState)

Clear text contents and undo history

This method does not call any EditGuard actions; consider also calling EditField::call_guard_edit.

pub fn set_str(&mut self, cx: &mut EventState, text: &str) -> bool

Set text contents from a str

This does not interact with undo history; see also Self::clear, Self::pre_commit.

This method does not call any EditGuard actions; consider also calling EditField::call_guard_edit.

Returns true if the text may have changed.

pub fn set_string(&mut self, cx: &mut EventState, string: String) -> bool

Set text contents from a String

This does not interact with undo history or call action handlers on the guard.

This method clears the error state but does not call any EditGuard actions; consider also calling EditField::call_guard_edit.

Returns true if the text is ready and may have changed.

pub fn replace_selected_text(&mut self, cx: &mut EventState, text: &str) -> bool

Replace selected text

This does not interact with undo history or call action handlers on the guard.

This method clears the error state but does not call any EditGuard actions; consider also calling EditField::call_guard_edit.

Returns true if the text is ready and may have changed.

pub fn cursor_range(&self) -> CursorRange

Access the cursor index / selection range

pub fn set_cursor_range(&mut self, range: impl Into<CursorRange>)

Set the cursor index / range

This does not interact with undo history or call action handlers on the guard.

pub fn is_editable(&self) -> bool

Get whether this EditField is editable

pub fn set_editable(&mut self, editable: bool)

Set whether this EditField is editable

pub fn multi_line(&self) -> bool

True if the editor uses multi-line mode

pub fn class(&self) -> TextClass

Get the text class used

pub fn has_input_focus(&self) -> bool

Get whether the widget has input focus

This is true when the widget is has keyboard or IME focus.

pub fn has_error(&self) -> bool

Get whether the input state is erroneous

pub fn set_error( &mut self, cx: &mut EventState, message: Option<Cow<'static, str>>, )

Mark the input as erroneous with an optional message

This state should be set from EditGuard::edit when appropriate. The state is cleared immediately before calling EditGuard::edit and also in case a text is directly assigned (e.g. using Self::set_string).

When set, the input field’s background is drawn red. If a message is supplied, then a tooltip will be available on mouse-hover.

Trait Implementations

impl Debug for Editor

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

Formats the value using the given formatter.