Struct EditorState 

pub struct EditorState { /* private fields */ }

The editor state. Keep one per editor in your application.

Implementations

impl EditorState

pub fn new() -> Self

An empty document.

pub fn with_markdown(markdown_text: &str) -> Self

A document parsed from CommonMark (with the GFM extensions strikethrough, task lists and tables; see Self::features).

pub fn style(self, style: EditorStyle) -> Self

Builder: sets the style.

pub fn paper(self, paper: Paper) -> Self

Builder: sets the paper.

pub fn zoom_settings(self, settings: ZoomSettings) -> Self

Builder: sets the zoom settings.

pub fn zoom(self, zoom: f32) -> Self

Builder: sets the initial zoom.

pub fn tab_width(self, spaces: usize) -> Self

Builder: number of spaces the Tab key inserts (0 = Tab not handled).

pub fn highlighter(self, highlighter: impl CodeHighlighter) -> Self

Builder: installs a code highlighting plugin.

pub fn features(self, features: Features) -> Self

Builder: enables or disables optional Markdown features. The document is read again with the new features.

pub fn language(self, language: Language) -> Self

Builder: sets the language of the toolbar, link bar and status bar.

pub fn block_renderer(self, renderer: impl BlockRenderer) -> Self

Builder: adds a renderer for fenced code blocks of some languages. Call it once per renderer; the first one listing a language wins.

pub fn images(self, settings: ImageSettings) -> Self

Builder: what happens with pasted, dropped and inserted images.

pub fn image_base(self, folder: impl Into<PathBuf>) -> Self

Builder: folder for relative image URLs (desktop display).

pub fn image_loader( self, loader: impl Fn(&str) -> Option<Vec<u8>> + Send + Sync + 'static, ) -> Self

Builder: loads image bytes for display by URL.

pub fn mode(self, mode: Mode) -> Self

Builder: sets the mode.

pub fn markdown(&self) -> String

The document as Markdown, without image placeholders and with full data: URLs. Builds the whole text: call it on changes, not in view.

pub fn plain_text(&self) -> String

The document as plain text.

pub fn selected_text(&self) -> Option<String>

The selected text, if any.

pub fn word_count(&self) -> usize

pub fn current_mode(&self) -> Mode

pub fn current_style(&self) -> &EditorStyle

pub fn current_paper(&self) -> &Paper

pub fn current_zoom(&self) -> f32

Current zoom factor (1.0 = 100 %).

pub fn current_zoom_settings(&self) -> &ZoomSettings

pub fn current_tab_width(&self) -> usize

Spaces per Tab (0 = Tab not handled).

pub fn current_image_settings(&self) -> &ImageSettings

pub fn pending_images(&self) -> usize

Images handed to the application and not answered yet.

pub fn has_highlighter(&self) -> bool

pub fn current_features(&self) -> Features

pub fn current_language(&self) -> Language

pub fn rendered_languages(&self) -> Vec<String>

Languages drawn by block renderers.

pub fn code_languages(&self) -> Vec<String>

Languages offered for code blocks: from the highlighter (or a common list) and the block renderers.

pub fn task_progress(&self) -> (usize, usize)

(checked, total) task list items.

pub fn page_count(&self) -> usize

Number of pages (1 in full-width mode).

pub fn current_page(&self) -> usize

Page (1-based) that contains the caret.

pub fn is_focused(&self) -> bool

pub fn is_dirty(&self) -> bool

true when the content changed since the last load or save.

pub fn can_undo(&self) -> bool

pub fn can_redo(&self) -> bool

pub fn formatting(&self) -> Formatting

Formatting at the caret (or at the start of the selection).

pub fn set_markdown(&mut self, markdown_text: &str)

Replaces the whole document. Clears history, pending images and the dirty flag.

pub fn mark_saved(&mut self)

Clears the dirty flag (call after saving).

pub fn set_style(&mut self, style: EditorStyle)

pub fn set_paper(&mut self, paper: Paper)

pub fn set_zoom_settings(&mut self, settings: ZoomSettings)

pub fn set_zoom(&mut self, zoom: f32)

Sets the zoom factor (1.0 = 100 %), also when zoom is disabled.

pub fn set_tab_width(&mut self, spaces: usize)

Spaces per Tab; 0 leaves Tab to the application.

pub fn set_highlighter(&mut self, highlighter: Option<Arc<dyn CodeHighlighter>>)

pub fn set_language(&mut self, language: Language)

Sets the language of the toolbar, link bar and status bar. The document is not changed.

pub fn set_features(&mut self, features: Features)

Enables or disables optional Markdown features. In WYSIWYG mode the document is read again, as if it had been loaded with the new features; the undo history starts again.

pub fn set_block_renderers(&mut self, renderers: Vec<Arc<dyn BlockRenderer>>)

Replaces the block renderers. The first renderer listing a language draws it.

pub fn set_image_settings(&mut self, settings: ImageSettings)

pub fn set_image_base(&mut self, folder: Option<PathBuf>)

pub fn set_image_loader(&mut self, loader: Option<ImageLoader>)

pub fn reload_images(&mut self)

Forgets loaded images and loads them again.

pub fn set_mode(&mut self, mode: Mode)

Switches between WYSIWYG and source mode. The undo history starts again after a switch.

pub fn execute(&mut self, command: Command) -> Output

Runs a command and reports what happened.

pub fn update(&mut self, action: Action) -> Output

Handles an Action produced by the widget.

pub fn subscription(&self) -> Subscription<Action>

Caret blinking and dropped image files: state.subscription().map(Message::Editor).

Trait Implementations

impl Default for EditorState

fn default() -> Self

Returns the “default value” for a type.