Struct rat_input::masked_input::MaskedInputState

pub struct MaskedInputState {
    pub cursor: Position,
    pub area: Rect,
    pub mouse: MouseFlags,
    pub value: InputMaskCore,
    pub non_exhaustive: NonExhaustive,
}

State of the input-mask.

Fields

cursor: Position

The position of the cursor in screen coordinates. Can be directly used for [Frame::set_cursor()]

area: 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

pub fn reset(&mut self)

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 set_cursor(&mut self, cursor: usize, extend_selection: 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 cursor(&self) -> usize

Cursor position

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 as_str(&self) -> &str

Value.

pub fn is_empty(&self) -> bool

pub fn len(&self) -> usize

Length in grapheme count.

pub fn has_selection(&self) -> bool

Selection

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

Selection

pub fn select_all(&mut self)

Selection

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

Selection

pub fn selection_str(&self) -> &str

Selection

pub fn set_offset_relative_cursor( &mut self, rpos: isize, extend_selection: bool )

Set the cursor position from a visual position relative to the origin.

pub fn visual_cursor(&self) -> Position

The current text cursor as a absolute screen position.

pub fn prev_word_boundary(&self) -> usize

Previous word boundary.

pub fn next_word_boundary(&self) -> usize

Next word boundary.

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

Move to the next char.

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

Move to the previous char.

pub fn insert_char(&mut self, c: char) -> Result<(), Error>

Insert a char at the current position.

pub fn remove_selection(&mut self, selection: Range<usize>) -> Result<(), Error>

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

pub fn delete_prev_char(&mut self) -> Result<(), Error>

Delete the char before the cursor.

pub fn delete_next_char(&mut self) -> Result<(), Error>

Delete the char after the cursor.

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, Result<Outcome, Error>> for MaskedInputState

fn handle( &mut self, event: &Event, _keymap: FocusKeys ) -> Result<Outcome, Error>

Handle an event.

impl HandleEvent<Event, MouseOnly, Result<Outcome, Error>> for MaskedInputState

fn handle( &mut self, event: &Event, _keymap: MouseOnly ) -> Result<Outcome, Error>

Handle an event.