Struct InputState 

pub struct InputState {
    pub lsp: Lsp,
    /* private fields */
}

InputState to keep editing state of the super::TextInput.

Fields

lsp: Lsp

Implementations

impl InputState

pub fn handle_action_for_context_menu( &mut self, action: Box<dyn Action>, window: &mut Window, cx: &mut Context<'_, Self>, ) -> bool

Handles an action for the completion menu, if it exists.

Return true if the action was handled, otherwise false.

pub fn apply_lsp_edits( &mut self, text_edits: &Vec<TextEdit>, window: &mut Window, cx: &mut Context<'_, Self>, )

Apply a list of lsp_types::TextEdit to mutate the text.

impl InputState

pub fn new(window: &mut Window, cx: &mut Context<'_, Self>) -> Self

Create a Input state with default [InputMode::SingleLine] mode.

See also: Self::multi_line, Self::auto_grow to set other mode.

pub fn multi_line(self) -> Self

Set Input to use [InputMode::MultiLine] mode.

Default rows is 2.

pub fn auto_grow(self, min_rows: usize, max_rows: usize) -> Self

Set Input to use [InputMode::AutoGrow] mode with min, max rows limit.

pub fn code_editor(self, language: impl Into<SharedString>) -> Self

Set Input to use [InputMode::CodeEditor] mode.

Default options:

• line_number: true
• tab_size: 2
• hard_tabs: false
• height: full

If highlighter is None, will use the default highlighter.

Code Editor aim for help used to simple code editing or display, not a full-featured code editor.

Features

• Syntax Highlighting
• Auto Indent
• Line Number
• Large Text support, up to 50K lines.

pub fn searchable(self, searchable: bool) -> Self

Set this input is searchable, default is false (Default true for Code Editor).

pub fn placeholder(self, placeholder: impl Into<SharedString>) -> Self

Set placeholder

pub fn line_number(self, line_number: bool) -> Self

Set enable/disable line number, only for [InputMode::CodeEditor] mode.

pub fn set_line_number( &mut self, line_number: bool, _: &mut Window, cx: &mut Context<'_, Self>, )

Set line number, only for [InputMode::CodeEditor] mode.

pub fn tab_size(self, tab: TabSize) -> Self

Set the tab size for the input.

Only for [InputMode::MultiLine] and [InputMode::CodeEditor] mode.

pub fn rows(self, rows: usize) -> Self

Set the number of rows for the multi-line Textarea.

This is only used when multi_line is set to true.

default: 2

pub fn set_highlighter( &mut self, new_language: impl Into<SharedString>, cx: &mut Context<'_, Self>, )

Set highlighter language for for [InputMode::CodeEditor] mode.

pub fn diagnostics(&self) -> Option<&DiagnosticSet>

pub fn diagnostics_mut(&mut self) -> Option<&mut DiagnosticSet>

pub fn set_placeholder( &mut self, placeholder: impl Into<SharedString>, _: &mut Window, cx: &mut Context<'_, Self>, )

Set placeholder

pub fn set_value( &mut self, value: impl Into<SharedString>, window: &mut Window, cx: &mut Context<'_, Self>, )

Set the text of the input field.

And the selection_range will be reset to 0..0.

pub fn insert( &mut self, text: impl Into<SharedString>, window: &mut Window, cx: &mut Context<'_, Self>, )

Insert text at the current cursor position.

And the cursor will be moved to the end of inserted text.

pub fn replace( &mut self, text: impl Into<SharedString>, window: &mut Window, cx: &mut Context<'_, Self>, )

Replace text at the current cursor position.

And the cursor will be moved to the end of replaced text.

pub fn masked(self, masked: bool) -> Self

Set with password masked state.

Only for [InputMode::SingleLine] mode.

pub fn set_masked( &mut self, masked: bool, _: &mut Window, cx: &mut Context<'_, Self>, )

Set the password masked state of the input field.

Only for [InputMode::SingleLine] mode.

pub fn clean_on_escape(self) -> Self

Set true to clear the input by pressing Escape key.

pub fn soft_wrap(self, wrap: bool) -> Self

Set the soft wrap mode for multi-line input, default is true.

pub fn set_soft_wrap( &mut self, wrap: bool, _: &mut Window, cx: &mut Context<'_, Self>, )

Update the soft wrap mode for multi-line input, default is true.

pub fn pattern(self, pattern: Regex) -> Self

Set the regular expression pattern of the input field.

Only for [InputMode::SingleLine] mode.

pub fn set_pattern( &mut self, pattern: Regex, _window: &mut Window, _cx: &mut Context<'_, Self>, )

Set the regular expression pattern of the input field with reference.

Only for [InputMode::SingleLine] mode.

pub fn validate( self, f: impl Fn(&str, &mut Context<'_, Self>) -> bool + 'static, ) -> Self

Set the validation function of the input field.

Only for [InputMode::SingleLine] mode.

pub fn set_loading( &mut self, loading: bool, _: &mut Window, cx: &mut Context<'_, Self>, )

Set true to show indicator at the input right.

Only for [InputMode::SingleLine] mode.

pub fn default_value(self, value: impl Into<SharedString>) -> Self

Set the default value of the input field.

pub fn value(&self) -> SharedString

Return the value of the input field.

pub fn unmask_value(&self) -> SharedString

Return the value without mask.

pub fn text(&self) -> &Rope

Return the text Rope of the input field.

pub fn cursor_position(&self) -> Position

Return the (0-based) Position of the cursor.

pub fn set_cursor_position( &mut self, position: impl Into<Position>, window: &mut Window, cx: &mut Context<'_, Self>, )

Set (0-based) Position of the cursor.

This will move the cursor to the specified line and column, and update the selection range.

pub fn focus(&self, window: &mut Window, cx: &mut Context<'_, Self>)

Focus the input field.

pub fn cursor(&self) -> usize

Get byte offset of the cursor.

The offset is the UTF-8 offset.

pub fn unselect(&mut self, _: &mut Window, cx: &mut Context<'_, Self>)

Unselects the currently selected text.

pub fn mask_pattern(self, pattern: impl Into<MaskPattern>) -> Self

Set the mask pattern for formatting the input text.

The pattern can contain:

• 9: Any digit or dot
• A: Any letter
• *: Any character
• Other characters will be treated as literal mask characters

Example: “(999)999-999” for phone numbers

pub fn set_mask_pattern( &mut self, pattern: impl Into<MaskPattern>, _: &mut Window, cx: &mut Context<'_, Self>, )

Trait Implementations

impl EntityInputHandler for InputState

fn replace_text_in_range( &mut self, range_utf16: Option<Range<usize>>, new_text: &str, window: &mut Window, cx: &mut Context<'_, Self>, )

Replace text in range.

• If the new text is invalid, it will not be replaced.
• If range_utf16 is not provided, the current selected range will be used.

fn replace_and_mark_text_in_range( &mut self, range_utf16: Option<Range<usize>>, new_text: &str, new_selected_range_utf16: Option<Range<usize>>, window: &mut Window, cx: &mut Context<'_, Self>, )

Mark text is the IME temporary insert on typing.

fn bounds_for_range( &mut self, range_utf16: Range<usize>, bounds: Bounds<Pixels>, _window: &mut Window, _cx: &mut Context<'_, Self>, ) -> Option<Bounds<Pixels>>

Used to position IME candidates.

fn text_for_range( &mut self, range_utf16: Range<usize>, adjusted_range: &mut Option<Range<usize>>, _window: &mut Window, _cx: &mut Context<'_, Self>, ) -> Option<String>

See InputHandler::text_for_range for details

fn selected_text_range( &mut self, _ignore_disabled_input: bool, _window: &mut Window, _cx: &mut Context<'_, Self>, ) -> Option<UTF16Selection>

See InputHandler::selected_text_range for details

fn marked_text_range( &self, _window: &mut Window, _cx: &mut Context<'_, Self>, ) -> Option<Range<usize>>

See InputHandler::marked_text_range for details

fn unmark_text(&mut self, _window: &mut Window, _cx: &mut Context<'_, Self>)

See InputHandler::unmark_text for details

fn character_index_for_point( &mut self, point: Point<Pixels>, _window: &mut Window, _cx: &mut Context<'_, Self>, ) -> Option<usize>

See InputHandler::character_index_for_point for details

impl Focusable for InputState

fn focus_handle(&self, _cx: &App) -> FocusHandle

Returns the focus handle associated with this view.

impl Render for InputState

fn render( &mut self, window: &mut Window, cx: &mut Context<'_, Self>, ) -> impl IntoElement

Render this view into an element tree.

impl EventEmitter<InputEvent> for InputState

impl EventEmitter<NumberInputEvent> for InputState