Struct cosmic_text::ViEditor

pub struct ViEditor<'syntax_system, 'buffer> { /* private fields */ }

Implementations

impl<'syntax_system, 'buffer> ViEditor<'syntax_system, 'buffer>

pub fn new(editor: SyntaxEditor<'syntax_system, 'buffer>) -> Self

pub fn update_theme(&mut self, theme_name: &str) -> bool

Modifies the theme of the SyntaxEditor, returning false if the theme is missing

pub fn load_text<P: AsRef<Path>>( &mut self, font_system: &mut FontSystem, path: P, attrs: Attrs<'_>, ) -> Result<()>

Load text from a file, and also set syntax to the best option

pub fn background_color(&self) -> Color

Get the default background color

pub fn foreground_color(&self) -> Color

Get the default foreground (text) color

pub fn cursor_color(&self) -> Color

Get the default cursor color

pub fn selection_color(&self) -> Color

Get the default selection color

pub fn theme(&self) -> &SyntaxTheme

Get the current syntect theme

pub fn changed(&self) -> bool

Get changed flag

pub fn set_changed(&mut self, changed: bool)

Set changed flag

pub fn save_point(&mut self)

Set current change as the save (or pivot) point.

A pivot point is the last saved index. Anything before or after the pivot indicates that the editor has been changed or is unsaved.

Undoing changes down to the pivot point sets the editor as unchanged. Redoing changes up to the pivot point sets the editor as unchanged.

Undoing or redoing changes beyond the pivot point sets the editor to changed.

pub fn set_passthrough(&mut self, passthrough: bool)

Set passthrough mode (true will turn off vi features)

pub fn parser(&self) -> &ViParser

Get current vi parser

pub fn redo(&mut self)

Redo a change

pub fn undo(&mut self)

Undo a change

pub fn draw<F>( &self, font_system: &mut FontSystem, cache: &mut SwashCache, f: F, )

where F: FnMut(i32, i32, u32, u32, Color),

Trait Implementations

impl<'syntax_system, 'buffer> Debug for ViEditor<'syntax_system, 'buffer>

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

Formats the value using the given formatter.

impl<'syntax_system, 'buffer> Edit<'buffer> for ViEditor<'syntax_system, 'buffer>

fn buffer_ref(&self) -> &BufferRef<'buffer>

Get the internal BufferRef

fn buffer_ref_mut(&mut self) -> &mut BufferRef<'buffer>

Get the internal BufferRef

fn cursor(&self) -> Cursor

Get the current cursor

fn set_cursor(&mut self, cursor: Cursor)

Set the current cursor

fn selection(&self) -> Selection

Get the current selection position

fn set_selection(&mut self, selection: Selection)

Set the current selection position

fn auto_indent(&self) -> bool

Get the current automatic indentation setting

fn set_auto_indent(&mut self, auto_indent: bool)

Enable or disable automatic indentation

fn tab_width(&self) -> u16

Get the current tab width

fn set_tab_width(&mut self, font_system: &mut FontSystem, tab_width: u16)

Set the current tab width. A tab_width of 0 is not allowed, and will be ignored

fn shape_as_needed(&mut self, font_system: &mut FontSystem, prune: bool)

Shape lines until scroll, after adjusting scroll if the cursor moved

fn delete_range(&mut self, start: Cursor, end: Cursor)

Delete text starting at start Cursor and ending at end Cursor

fn insert_at( &mut self, cursor: Cursor, data: &str, attrs_list: Option<AttrsList>, ) -> Cursor

Insert text at specified cursor with specified attrs_list

fn copy_selection(&self) -> Option<String>

Copy selection

fn delete_selection(&mut self) -> bool

Delete selection, adjusting cursor and returning true if there was a selection

fn apply_change(&mut self, change: &Change) -> bool

Apply a change

fn start_change(&mut self)

Start collecting change

fn finish_change(&mut self) -> Option<Change>

Get completed change

fn action(&mut self, font_system: &mut FontSystem, action: Action)

Perform an Action on the editor

fn cursor_position(&self) -> Option<(i32, i32)>

Get X and Y position of the top left corner of the cursor

fn borrow_with<'font_system>( &'font_system mut self, font_system: &'font_system mut FontSystem, ) -> BorrowedWithFontSystem<'font_system, Self>

where Self: Sized,

Mutably borrows self together with an FontSystem for more convenient methods

fn with_buffer<F: FnOnce(&Buffer) -> T, T>(&self, f: F) -> T

Get the internal Buffer

fn with_buffer_mut<F: FnOnce(&mut Buffer) -> T, T>(&mut self, f: F) -> T

Get the internal Buffer, mutably

fn redraw(&self) -> bool

Get the Buffer redraw flag

fn set_redraw(&mut self, redraw: bool)

Set the Buffer redraw flag

fn selection_bounds(&self) -> Option<(Cursor, Cursor)>

Get the bounds of the current selection

fn insert_string(&mut self, data: &str, attrs_list: Option<AttrsList>)

Insert a string at the current cursor or replacing the current selection with the given attributes, or with the previous character’s attributes if None is given.