Struct NumberInputState 

pub struct NumberInputState {
    pub area: Rect,
    pub inner: Rect,
    pub widget: MaskedInputState,
    pub non_exhaustive: NonExhaustive,
    /* private fields */
}

State & event handling.

Fields

area: Rect

Area of the widget. read only renewed with each render.

inner: Rect

Area inside the block. read only renewed with each render.

widget: MaskedInputState

non_exhaustive: NonExhaustive

Implementations

impl NumberInputState

pub fn new() -> NumberInputState

pub fn new_pattern<S>(pattern: S) -> Result<NumberInputState, NumberFmtError>

where S: AsRef<str>,

pub fn new_loc_pattern<S>( pattern: S, locale: Locale, ) -> Result<NumberInputState, NumberFmtError>

where S: AsRef<str>,

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

pub fn with_pattern<S>( self, pattern: S, ) -> Result<NumberInputState, NumberFmtError>

where S: AsRef<str>,

pub fn with_loc_pattern<S>( self, pattern: S, locale: Locale, ) -> Result<NumberInputState, NumberFmtError>

where S: AsRef<str>,

pub fn format(&self) -> &str

format_num_pattern format string.

pub fn locale(&self) -> Locale

chrono locale.

pub fn set_format<S>(&mut self, pattern: S) -> Result<(), NumberFmtError>

where S: AsRef<str>,

Set format.

pub fn set_format_loc<S>( &mut self, pattern: S, locale: Locale, ) -> Result<(), NumberFmtError>

where S: AsRef<str>,

Set format and locale.

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 NumberInputState

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 NumberInputState

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 NumberInputState

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 byter-range. The style-nr refers to one of the styles set with the widget.

pub fn add_range_style( &mut self, range: Range<u32>, 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 TextRange and style.

pub fn remove_range_style( &mut self, range: Range<u32>, 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 NumberInputState

pub fn offset(&self) -> u32

Offset shown.

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

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

pub fn cursor(&self) -> u32

Cursor position

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

Set the cursor position, reset selection.

pub fn set_default_cursor(&mut self)

Place cursor at some sensible position according to the mask.

pub fn anchor(&self) -> u32

Selection anchor.

pub fn has_selection(&self) -> bool

Selection

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

Selection

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

Selection

pub fn select_all(&mut self)

Select all text.

pub fn selected_text(&self) -> &str

Selection

impl NumberInputState

pub fn is_empty(&self) -> bool

Empty

pub fn value_opt<T>(&self) -> Result<Option<T>, NumberFmtError>

where T: FromStr,

Parses the text as the desired value type. If the text content is empty returns None.

pub fn value<T>(&self) -> Result<T, NumberFmtError>

where T: FromStr,

Parses the text as the desired value type.

pub fn len(&self) -> u32

Length in grapheme count.

pub fn line_width(&self) -> u32

Length as grapheme count.

impl NumberInputState

pub fn clear(&mut self)

Reset to empty.

pub fn set_value<T>(&mut self, number: T) -> Result<(), NumberFmtError>

where T: LowerExp + Display + Debug,

Sets the numeric value.

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

Insert a char at the current position.

pub fn delete_range(&mut self, range: Range<u32>) -> 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<u32>) -> Result<bool, TextError>

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

impl NumberInputState

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

impl NumberInputState

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

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

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

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

Trait Implementations

impl Clone for NumberInputState

fn clone(&self) -> NumberInputState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NumberInputState

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

Formats the value using the given formatter.

impl Default for NumberInputState

fn default() -> NumberInputState

Returns the “default value” for a type.

impl HandleEvent<Event, MouseOnly, TextOutcome> for NumberInputState

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

Handle an event.

impl HandleEvent<Event, ReadOnly, TextOutcome> for NumberInputState

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

Handle an event.

impl HandleEvent<Event, Regular, TextOutcome> for NumberInputState

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

Handle an event.

impl HasFocus for NumberInputState

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 id(&self) -> usize

Provide a unique id for the widget.

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 NumberInputState

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

The current text cursor as an absolute screen position.

impl RelocatableState for NumberInputState

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

Relocate the areas in this widgets state.

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

Relocate only popup areas. As rendering the popups is a separate render, this has to be separate too.

fn relocate_popup_hidden(&mut self)

Relocate all popup areas to a clip-rect (0,0+0x0).

fn relocate_hidden(&mut self)

Relocate all areas to a clip-rect (0,0+0x0).