Struct rat_widget::masked_input::MaskedInputState

pub struct MaskedInputState {
    pub focus: FocusFlag,
    pub invalid: bool,
    pub area: Rect,
    pub inner: Rect,
    pub mouse: MouseFlags,
    pub value: InputMaskCore,
    pub non_exhaustive: NonExhaustive,
}

State of the input-mask.

Fields

focus: FocusFlag

Current focus state.

invalid: bool

Display as invalid.

area: Rect

Area with block

inner: Rect

Area

mouse: MouseFlags

Mouse selection in progress.

value: InputMaskCore

Editing core.

non_exhaustive: NonExhaustive

Construct with ..Default::default()

Implementations

impl MaskedInputState

pub fn new() -> Self

pub fn new_with_symbols(sym: NumberSymbols) -> Self

Uses localized symbols for number formatting.

pub fn set_invalid(&mut self, invalid: bool)

Renders the widget in invalid style.

pub fn get_invalid(&self) -> bool

Renders the widget in invalid style.

pub fn clear(&mut self) -> bool

Reset to empty.

pub fn offset(&self) -> usize

Offset shown.

pub fn set_offset(&mut self, offset: usize)

Offset shown. This is corrected if the cursor wouldn’t be visible.

pub fn cursor(&self) -> usize

Cursor position

pub fn set_cursor(&mut self, cursor: usize, extend_selection: bool) -> bool

Set the cursor position, reset selection.

pub fn set_default_cursor(&mut self)

Place cursor at decimal separator, if any. 0 otherwise.

pub fn anchor(&self) -> usize

Selection anchor.

pub fn set_display_mask<S: Into<String>>(&mut self, s: S)

Set the display mask. This text is used for parts that have no valid input yet. Part means consecutive characters of the input mask with the same mask type.

There is a default representation for each mask type if this is not set.

If the length differs from the mask, the difference will be ignored / filled with defaults.

pub fn display_mask(&self) -> String

Display mask.

pub fn set_mask<S: AsRef<str>>(&mut self, s: S) -> Result<(), Error>

Set the input mask. This overwrites the display mask and the value with a default representation of the mask.

The result value contains all punctuation and the value given as ‘display’ below. See compact_value().

• 0: can enter digit, display as 0

• 9: can enter digit, display as space

• #: digit, plus or minus sign, display as space

• +: sign. display ‘+’ for positive

• -: sign. display ’ ’ for positive

• . and ,: decimal and grouping separators

• H: must enter a hex digit, display as 0

• h: can enter a hex digit, display as space

• O: must enter an octal digit, display as 0

• o: can enter an octal digit, display as space

• D: must enter a decimal digit, display as 0

• d: can enter a decimal digit, display as space

• l: can enter letter, display as space

• a: can enter letter or digit, display as space

• c: can enter character or space, display as space

• _: anything, display as space

• : ; - /: separator characters move the cursor when entered.

• \: escapes the following character and uses it as a separator.

• all other ascii characters a reserved.

Inspired by https://support.microsoft.com/en-gb/office/control-data-entry-formats-with-input-masks-e125997a-7791-49e5-8672-4a47832de8da

pub fn mask(&self) -> String

Display mask.

pub fn debug_mask(&self) -> String

Mask with some debug information.

pub fn set_num_symbols(&mut self, sym: NumberSymbols)

Set symbols for number display.

These are only used for rendering and to map user input. The value itself uses “.”, “,” and “-”.

pub fn default_value(&self) -> String

Create a default value according to the mask.

pub fn set_value<S: Into<String>>(&mut self, s: S)

Set the value.

No checks if the value conforms to the mask. If the value is too short it will be filled with space. if the value is too long it will be truncated.

pub fn value(&self) -> &str

Value with all punctuation and default values according to the mask type.

pub fn value_parts(&self) -> Vec<String>

Value split along any separators

pub fn compact_value(&self) -> String

Value without optional whitespace and grouping separators. Might be easier to parse.

pub fn is_empty(&self) -> bool

Empty

pub fn len(&self) -> usize

Length in grapheme count.

pub fn has_selection(&self) -> bool

Selection

pub fn selection(&self) -> Range<usize>

Selection

pub fn set_selection(&mut self, anchor: usize, cursor: usize) -> bool

Selection

pub fn select_all(&mut self) -> bool

Selection

pub fn selected_value(&self) -> &str

Selection

pub fn insert_char(&mut self, c: char) -> bool

Insert a char at the current position.

pub fn delete_range(&mut self, range: Range<usize>) -> bool

Remove the selected range. The text will be replaced with the default value as defined by the mask.

pub fn delete_next_word(&mut self) -> bool

Deletes the next word.

pub fn delete_prev_word(&mut self) -> bool

Deletes the given range.

pub fn delete_prev_char(&mut self) -> bool

Delete the char before the cursor.

pub fn delete_next_char(&mut self) -> bool

Delete the char after the cursor.

pub fn move_to_next_word(&mut self, extend_selection: bool) -> bool

pub fn move_to_prev_word(&mut self, extend_selection: bool) -> bool

pub fn move_to_next(&mut self, extend_selection: bool) -> bool

Move to the next char.

pub fn move_to_prev(&mut self, extend_selection: bool) -> bool

Move to the previous char.

pub fn move_to_line_start(&mut self, extend_selection: bool) -> bool

Start of line

pub fn move_to_line_end(&mut self, extend_selection: bool) -> bool

End of line

pub fn to_screen_col(&self, pos: usize) -> Option<u16>

Converts a grapheme based position to a screen position relative to the widget area.

pub fn from_screen_col(&self, x: usize) -> Option<usize>

Converts from a widget relative screen coordinate to a grapheme index. x is the relative screen position.

pub fn set_screen_cursor( &mut self, cursor: isize, extend_selection: bool, ) -> bool

Set the cursor position from a screen position relative to the origin of the widget. This value can be negative, which selects a currently not visible position and scrolls to it.

pub fn screen_cursor(&self) -> Option<(u16, u16)>

The current text cursor as an absolute screen position.

Trait Implementations

impl Clone for MaskedInputState

fn clone(&self) -> MaskedInputState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MaskedInputState

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

Formats the value using the given formatter.

impl Default for MaskedInputState

fn default() -> Self

Returns the “default value” for a type.

impl HandleEvent<Event, FocusKeys, TextOutcome> for MaskedInputState

fn handle(&mut self, event: &Event, _keymap: FocusKeys) -> TextOutcome

Handle an event.

impl HandleEvent<Event, MouseOnly, TextOutcome> for MaskedInputState

fn handle(&mut self, event: &Event, _keymap: MouseOnly) -> TextOutcome

Handle an event.

impl HandleEvent<Event, ReadOnly, TextOutcome> for MaskedInputState

fn handle(&mut self, event: &Event, _keymap: ReadOnly) -> TextOutcome

Handle an event.

impl HasFocusFlag for MaskedInputState

fn focus(&self) -> &FocusFlag

Access to the flag for the rest.

fn area(&self) -> Rect

Access the area for mouse focus.

fn z_areas(&self) -> &[ZRect]

The widget might have several disjointed areas. This is the case if it is showing a popup, but there might be other causes.

fn navigable(&self) -> bool

If the widget is focusable, but doesn’t want to partake in keyboard navigation it returns false here.

fn is_focused(&self) -> bool

Focused?

fn lost_focus(&self) -> bool

Just lost focus.

fn gained_focus(&self) -> bool

Just gained focus.