Struct rat_widget::text::core::MaskedCore

pub struct MaskedCore { /* private fields */ }

Text editing core.

Implementations

impl MaskedCore

pub fn new() -> MaskedCore

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

Set the decimal separator and other symbols. Only used for rendering and to map user input. The value itself uses “.”

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

where S: AsRef<str>,

Changes the mask. Resets the value to a default.

pub fn mask(&self) -> String

Return the mask.

impl MaskedCore

pub fn set_clipboard(&mut self, clip: Option<Box<dyn Clipboard>>)

Clipboard

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

Clipboard

impl MaskedCore

pub fn set_undo_buffer(&mut self, undo: Option<Box<dyn UndoBuffer>>)

Undo

pub fn set_undo_count(&mut self, n: u32)

Set undo count

pub fn begin_undo_seq(&mut self)

Begin a sequence of changes that should be undone in one go.

pub fn end_undo_seq(&mut self)

End a sequence of changes that should be undone in one go.

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

Undo

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

Undo

pub fn undo(&mut self) -> bool

Undo last.

pub fn redo(&mut self) -> bool

Redo last.

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

Get last replay recording.

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

Replay a recording of changes.

impl MaskedCore

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

Set all styles.

The ranges are byte-ranges. The usize value is the index of the actual style. Those are set with the widget.

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

Add a style for the given byte-range.

The usize value is the index of the actual style. Those are set at the widget.

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

Remove a style for the given byte-range.

Range and style must match to be removed.

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

Finds all styles for 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 MaskedCore

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

Set the cursor position. The value is capped to the number of text lines and the line-width for the given line.

Returns true, if the cursor actually changed.

pub fn section_cursor(&self, cursor: u32) -> Option<u32>

Get the default cursor for the section at the given cursor position, if it is an editable section.

pub fn next_section_cursor(&self, cursor: u32) -> Option<u32>

Get the default cursor position for the next editable section.

pub fn prev_section_cursor(&self, cursor: u32) -> Option<u32>

Get the default cursor position for the next editable section.

pub fn is_section_boundary(&self, pos: u32) -> bool

Is the position at a word boundary?

pub fn section_range(&self, cursor: u32) -> Option<Range<u32>>

Get the range for the section at the given cursor position, if it is an editable section.

pub fn next_section_range(&self, cursor: u32) -> Option<Range<u32>>

Get the default cursor position for the next editable section.

pub fn prev_section_range(&self, cursor: u32) -> Option<Range<u32>>

Get the default cursor position for the next editable section.

pub fn set_default_cursor(&mut self)

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

pub fn cursor(&self) -> u32

Cursor position as grapheme-idx.

pub fn anchor(&self) -> u32

Selection anchor

pub fn has_selection(&self) -> bool

Any text selection.

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

Select text.

pub fn select_all(&mut self) -> bool

Select all text.

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

Returns the selection as TextRange.

pub fn selected_text(&self) -> &str

Selection.

impl MaskedCore

pub fn is_empty(&self) -> bool

Empty.

pub fn byte_at(&self, pos: u32) -> 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<u32>, ) -> Result<Range<usize>, TextError>

Grapheme range to byte range.

pub fn byte_pos(&self, byte: usize) -> Result<u32, TextError>

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

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

Byte range to grapheme range.

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

Text slice as Cow. Uses a byte range.

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

A range of the text as Cow

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

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

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

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

This omits unnecessary white-space.

pub fn grapheme_at(&self, pos: u32) -> Result<Option<Grapheme<'_>>, TextError>

Get the grapheme at the given position.

pub fn text_graphemes( &self, pos: u32, ) -> Result<impl Iterator<Item = Grapheme<'_>> + Cursor, TextError>

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

pub fn graphemes( &self, range: Range<u32>, pos: u32, ) -> Result<impl Iterator<Item = Grapheme<'_>> + Cursor, TextError>

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

pub fn line_width(&self) -> u32

impl MaskedCore

pub fn clear(&mut self)

Reset value but not the mask and width. Resets offset and cursor position too.

pub fn text(&self) -> &str

Copy of the text-value.

pub fn set_text<S>(&mut self, s: S)

where S: Into<String>,

Sets 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 advance_cursor(&mut self, c: char) -> bool

Start at the cursor position and find a valid insert position for the input c. Put the cursor at that position.

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

Insert the char if it matches the cursor mask and the current section is not full.

advance_cursor() must be called before for correct functionality.

Otherwise: your mileage might vary.

pub fn remove_prev(&mut self)

Remove the previous char.

pub fn remove_next(&mut self)

Remove the previous char.

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

Remove the selection

Trait Implementations

impl Clone for MaskedCore

fn clone(&self) -> MaskedCore

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MaskedCore

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

Formats the value using the given formatter.

impl Default for MaskedCore

fn default() -> MaskedCore

Returns the “default value” for a type.