Struct MaskedInputState

pub struct MaskedInputState {
    pub area: Rect,
    pub inner: Rect,
    pub offset: upos_type,
    pub dark_offset: (u16, u16),
    pub value: MaskedCore,
    pub invalid: bool,
    pub overwrite: bool,
    pub on_focus_gained: TextFocusGained,
    pub on_focus_lost: TextFocusLost,
    pub focus: FocusFlag,
    pub mouse: MouseFlags,
    pub non_exhaustive: NonExhaustive,
}

State & event-handling.

Fields

area: Rect

The whole area with block. read only renewed with each render.

inner: Rect

Area inside a possible block. read only renewed with each render.

offset: upos_type

Display offset read+write

dark_offset: (u16, u16)

Dark offset due to clipping. read only secondary offset due to clipping.

value: MaskedCore

Editing core

invalid: bool

Display as invalid. read+write

overwrite: bool

The next user edit clears the text for doing any edit. It will reset this flag. Other interactions may reset this flag too.

on_focus_gained: TextFocusGained

Focus behaviour. read only

on_focus_lost: TextFocusLost

Focus behaviour. read only

focus: FocusFlag

Current focus state. read+write

mouse: MouseFlags

Mouse selection in progress. read+write

non_exhaustive: NonExhaustive

Construct with ..Default::default()

Implementations

impl MaskedInputState

pub fn new() -> Self

pub fn named(name: &str) -> Self

pub fn with_symbols(self, sym: NumberSymbols) -> Self

With localized symbols for number formatting.

pub fn with_mask<S: AsRef<str>>(self, mask: S) -> Result<Self, Error>

With input mask.

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 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.

• 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

• SPACE: separator character 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 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 set_overwrite(&mut self, overwrite: bool)

The next edit operation will overwrite the current content instead of adding text. Any move operations will cancel this overwrite.

pub fn overwrite(&self) -> bool

Will the next edit operation overwrite the content?

impl MaskedInputState

pub fn set_clipboard(&mut self, clip: Option<impl Clipboard + 'static>)

Clipboard used. Default is to use the global_clipboard().

pub fn clipboard(&self) -> Option<&dyn Clipboard>

Clipboard used. Default is to use the global_clipboard().

pub fn copy_to_clip(&mut self) -> bool

Copy to internal buffer

pub fn cut_to_clip(&mut self) -> bool

Cut to internal buffer

pub fn paste_from_clip(&mut self) -> bool

Paste from internal buffer.

impl MaskedInputState

pub fn set_undo_buffer(&mut self, undo: Option<impl UndoBuffer + 'static>)

Set undo buffer.

pub fn undo_buffer(&self) -> Option<&dyn UndoBuffer>

Undo

pub fn undo_buffer_mut(&mut self) -> Option<&mut dyn UndoBuffer>

Undo

pub fn recent_replay_log(&mut self) -> Vec<UndoEntry>

Get all recent replay recordings.

pub fn replay_log(&mut self, replay: &[UndoEntry])

Apply the replay recording.

pub fn undo(&mut self) -> bool

Undo operation

pub fn redo(&mut self) -> bool

Redo operation

impl MaskedInputState

pub fn set_styles(&mut self, styles: Vec<(Range<usize>, usize)>)

Set and replace all styles.

pub fn add_style(&mut self, range: Range<usize>, style: usize)

Add a style for a byte-range. The style-nr refers to one of the styles set with the widget.

pub fn add_range_style( &mut self, range: Range<upos_type>, style: usize, ) -> Result<(), TextError>

Add a style for a Range<upos_type> to denote the cells. The style-nr refers to one of the styles set with the widget.

pub fn remove_style(&mut self, range: Range<usize>, style: usize)

Remove the exact byte-range and style.

pub fn remove_range_style( &mut self, range: Range<upos_type>, style: usize, ) -> Result<(), TextError>

Remove the exact Range<upos_type> and style.

pub fn styles_in( &self, range: Range<usize>, buf: &mut Vec<(Range<usize>, usize)>, )

Find all styles that touch the given range.

pub fn styles_at(&self, byte_pos: usize, buf: &mut Vec<(Range<usize>, usize)>)

All styles active at the given position.

pub fn style_match(&self, byte_pos: usize, style: usize) -> Option<Range<usize>>

Check if the given style applies at the position and return the complete range for the style.

pub fn styles(&self) -> Option<impl Iterator<Item = (Range<usize>, usize)> + '_>

List of all styles.

impl MaskedInputState

pub fn offset(&self) -> upos_type

Offset shown.

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

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

pub fn cursor(&self) -> upos_type

Cursor position.

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

Set the cursor position, reset selection.

pub fn set_default_cursor(&mut self)

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

pub fn anchor(&self) -> upos_type

Selection anchor.

pub fn has_selection(&self) -> bool

Selection.

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

Selection.

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

Selection.

pub fn select_all(&mut self) -> bool

Selection.

pub fn selected_text(&self) -> &str

Selection.

impl MaskedInputState

pub fn is_empty(&self) -> bool

Empty

pub fn text(&self) -> &str

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

pub fn str_slice_byte(&self, range: Range<usize>) -> Cow<'_, str>

Text slice as Cow<str>. Uses a byte range.

pub fn try_str_slice_byte( &self, range: Range<usize>, ) -> Result<Cow<'_, str>, TextError>

Text slice as Cow<str>. Uses a byte range.

pub fn str_slice(&self, range: Range<upos_type>) -> Cow<'_, str>

Text slice as Cow<str>

pub fn try_str_slice( &self, range: Range<upos_type>, ) -> Result<Cow<'_, str>, TextError>

Text slice as Cow<str>

pub fn len(&self) -> upos_type

Length as grapheme count.

pub fn line_width(&self) -> upos_type

Length as grapheme count.

pub fn glyphs( &self, screen_offset: u16, screen_width: u16, ) -> impl Iterator<Item = Glyph<'_>>

Iterator for the glyphs of the lines in range. Glyphs here a grapheme + display length.

pub fn condensed_glyphs( &self, screen_offset: u16, screen_width: u16, ) -> impl Iterator<Item = Glyph<'_>>

Iterator for the glyphs of the lines in range. Glyphs here a grapheme + display length.

pub fn text_graphemes(&self, pos: upos_type) -> impl Cursor<Item = Grapheme<'_>>

Get a cursor over all the text with the current position set at pos.

pub fn try_text_graphemes( &self, pos: upos_type, ) -> Result<impl Cursor<Item = Grapheme<'_>>, TextError>

Get a cursor over all the text with the current position set at pos.

pub fn graphemes( &self, range: Range<upos_type>, pos: upos_type, ) -> impl Cursor<Item = Grapheme<'_>>

Get a cursor over the text-range the current position set at pos.

pub fn try_graphemes( &self, range: Range<upos_type>, pos: upos_type, ) -> Result<impl Cursor<Item = Grapheme<'_>>, TextError>

Get a cursor over the text-range the current position set at pos.

pub fn byte_at(&self, pos: upos_type) -> Range<usize>

Grapheme position to byte position. This is the (start,end) position of the single grapheme after pos.

pub fn try_byte_at(&self, pos: upos_type) -> Result<Range<usize>, TextError>

Grapheme position to byte position. This is the (start,end) position of the single grapheme after pos.

pub fn bytes_at_range(&self, range: Range<upos_type>) -> Range<usize>

Grapheme range to byte range.

pub fn try_bytes_at_range( &self, range: Range<upos_type>, ) -> Result<Range<usize>, TextError>

Grapheme range to byte range.

pub fn byte_pos(&self, byte: usize) -> upos_type

Byte position to grapheme position. Returns the position that contains the given byte index.

pub fn try_byte_pos(&self, byte: usize) -> Result<upos_type, TextError>

Byte position to grapheme position. Returns the position that contains the given byte index.

pub fn byte_range(&self, bytes: Range<usize>) -> Range<upos_type>

Byte range to grapheme range.

pub fn try_byte_range( &self, bytes: Range<usize>, ) -> Result<Range<upos_type>, TextError>

Byte range to grapheme range.

impl MaskedInputState

pub fn clear(&mut self) -> bool

Reset to empty.

pub fn set_text<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 insert_char(&mut self, c: char) -> bool

Insert a char at the current position.

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

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

pub fn try_delete_range( &mut self, range: Range<upos_type>, ) -> Result<bool, TextError>

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

impl MaskedInputState

pub fn delete_next_char(&mut self) -> bool

Delete the char after the cursor.

pub fn delete_prev_char(&mut self) -> bool

Delete the char before the cursor.

pub fn delete_prev_section(&mut self) -> bool

Delete the previous section.

pub fn delete_next_section(&mut self) -> bool

Delete the next section.

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

Move to the next char.

pub fn move_left(&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 move_to_prev_section(&mut self, extend_selection: bool) -> bool

Move to start of previous section.

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

Move to end of previous section.

pub fn select_current_section(&mut self) -> bool

Select next section.

pub fn select_next_section(&mut self) -> bool

Select next section.

pub fn select_prev_section(&mut self) -> bool

Select previous section.

impl MaskedInputState

pub fn screen_to_col(&self, scx: i16) -> upos_type

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

pub fn col_to_screen(&self, pos: upos_type) -> Option<u16>

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

pub fn set_screen_cursor(&mut self, cursor: i16, 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 set_screen_cursor_sections( &mut self, screen_cursor: i16, extend_selection: bool, ) -> bool

Set the cursor position from screen coordinates, rounds the position to the next section bounds.

The cursor positions are relative to the inner rect. They may be negative too, this allows setting the cursor to a position that is currently scrolled away.

pub fn scroll_left(&mut self, delta: upos_type) -> bool

Scrolling

pub fn scroll_right(&mut self, delta: upos_type) -> bool

Scrolling

pub fn scroll_cursor_to_visible(&mut self) -> bool

Change the offset in a way that the cursor is visible.

Trait Implementations

impl Clone for MaskedInputState

fn clone(&self) -> Self

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, 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 HandleEvent<Event, Regular, TextOutcome> for MaskedInputState

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

Handle an event.

impl HasFocus for MaskedInputState

fn build(&self, builder: &mut FocusBuilder)

Build the focus-structure for the container.

fn focus(&self) -> FocusFlag

Access to the flag for the rest.

fn area(&self) -> Rect

Area for mouse focus.

fn navigable(&self) -> Navigation

Declares how the widget interacts with focus.

fn area_z(&self) -> u16

Z value for the area.

fn is_focused(&self) -> bool

Focused?

fn lost_focus(&self) -> bool

Just lost focus.

fn gained_focus(&self) -> bool

Just gained focus.

impl HasScreenCursor for MaskedInputState

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

The current text cursor as an absolute screen position.

impl RelocatableState for MaskedInputState

fn relocate(&mut self, shift: (i16, i16), clip: Rect)

Relocate the areas in this widgets state.