Struct RichDoc 

pub struct RichDoc {
    pub font: String,
    pub size: u16,
    /* private fields */
}

the document of ui.richtext (see the module header)

Fields

font: String

the document’s font family (“”: the UI font)

size: u16

the document’s size in tenths of a point (0: 11 pt)

Implementations

impl RichDoc

pub fn new() -> RichDoc

one empty paragraph

pub fn from_paras(paras: Vec<Para>) -> RichDoc

paragraphs (an empty list: one empty paragraph); the caret at the start

pub fn from_plain(s: &str) -> RichDoc

unformatted text: a paragraph per line

pub fn paras(&self) -> &[Para]

the content (no history)

pub fn para(&self, i: usize) -> &Para

paragraph i (clamped to the last one)

pub fn para_count(&self) -> usize

the number of paragraphs (at least 1)

pub fn revision(&self) -> u64

counts the changes of the content (edits, undo, redo; not the selection)

pub fn selection(&self) -> TextSel

the selection (the caret: anchor == caret)

pub fn set_selection(&mut self, sel: TextSel)

move the selection (clamped to the text, not undoable)

pub fn clamp(&self, p: TextPos) -> TextPos

p inside the document, on a character boundary

pub fn end(&self) -> TextPos

the end of the document

pub fn text(&self) -> String

the text: the paragraphs joined by ‘\n’ (no list markers)

pub fn flat(&self, p: TextPos) -> usize

the byte offset of p in text()

pub fn unflat(&self, f: usize) -> TextPos

the position of byte offset f of text()

pub fn text_range(&self, a: TextPos, b: TextPos) -> String

the text between a and b (paragraphs joined by ‘\n’)

pub fn paras_range(&self, a: TextPos, b: TextPos) -> Vec<Para>

the paragraphs between a and b (the first and the last cut there), with attributes

pub fn selected_text(&self) -> String

the selected text

pub fn selected_paras(&self) -> Vec<Para>

the selected paragraphs (a fragment for the clipboard)

pub fn current_para(&self) -> &Para

the paragraph with the caret

pub fn current_fmt(&self) -> Fmt

the format typing takes now (a format chosen without a selection, else the text’s at the caret); with a selection: its first character’s, the flags all of it has

pub fn link_at(&self, p: TextPos) -> Option<&str>

the link target at p (None: no link there)

pub fn can_undo(&self) -> bool

there is a step to undo

pub fn can_redo(&self) -> bool

there is a step to redo

pub fn undo_label(&self) -> Option<&str>

the label of the step undo takes back (“Fett”, “Schreiben” …)

pub fn redo_label(&self) -> Option<&str>

the label of the step redo does again

pub fn undo(&mut self) -> bool

take the last step back -> false: nothing to undo

pub fn redo(&mut self) -> bool

do the last undone step again -> false: nothing to redo

pub fn is_dirty(&self) -> bool

the content differs from the state of the last mark_saved

pub fn mark_saved(&mut self)

the content is saved now (is_dirty false until the next change)

pub fn clear_history(&mut self)

forget the undo steps

pub fn group_begin(&mut self, label: &str)

the next edits are one undo step (until group_end)

pub fn group_end(&mut self)

close the step of group_begin

pub fn insert_text(&mut self, s: &str) -> bool

replace the selection by text (a paragraph per line) in the current format

pub fn insert_paras(&mut self, frag: &[Para]) -> bool

replace the selection by paragraphs (a paste): several keep their attributes, one is inserted into the paragraph at the caret

pub fn delete_selection(&mut self) -> bool

remove the selection

pub fn delete(&mut self, a: TextPos, b: TextPos) -> bool

remove a..b (the caret goes to a)

pub fn split(&mut self) -> bool

Enter: split the paragraph at the caret (the selection is replaced). In an empty list item the list ends instead (a nested one moves out a level); after a heading the new paragraph is body text.

pub fn toggle(&mut self, flag: u8) -> bool

RF_BOLD / RF_ITALIC / RF_UNDER / RF_STRIKE on (when not all of the selection has it) or off

pub fn set_flags(&mut self, flags: u8, on: bool) -> bool

set (on) or clear flags

pub fn set_color(&mut self, argb: u32) -> bool

the text colour (0: the theme’s)

pub fn set_bg(&mut self, argb: u32) -> bool

the highlight colour (0: none)

pub fn set_size(&mut self, tenths: u16) -> bool

the size in tenths of a point (0: the document’s)

pub fn set_font(&mut self, family: &str) -> bool

the font family (“”: the document’s)

pub fn set_link(&mut self, url: &str) -> bool

a link on the selection (without one: on the link at the caret); “” removes it. A collapsed caret outside a link inserts the url as linked text.

pub fn clear_format(&mut self) -> bool

back to the default format (links stay)

pub fn set_align(&mut self, align: u8) -> bool

RA_* for the selected paragraphs

pub fn toggle_list(&mut self, kind: u8) -> bool

LS_BULLET / LS_NUMBER: the selected paragraphs become such list items, or plain paragraphs when all of them already are

pub fn set_list(&mut self, kind: u8) -> bool

LS_* without toggling

pub fn indent(&mut self, delta: i32) -> bool

one level deeper (delta 1) or out (-1), 0..LEVEL_MAX

pub fn set_style(&mut self, style: u8) -> bool

PS_* for the selected paragraphs

pub fn set_paras(&mut self, paras: Vec<Para>) -> bool

replace the whole content (one undo step)

pub fn to_json(&self) -> String

the document as JSON (see the module header)

pub fn from_json(s: &str) -> Option<RichDoc>

a document from to_json’s JSON (None: not such a document)

pub fn to_plain(&self) -> String

the text with list markers (“• “, “1. “) and two blanks of indent per level

impl RichDoc

pub fn to_html(&self) -> String

the document as an HTML fragment (see rich_html.rs)

pub fn from_html(s: &str) -> RichDoc

a document from HTML (see rich_html.rs); a fragment of a richtext’s clipboard is taken exactly

Trait Implementations

impl Clone for RichDoc

fn clone(&self) -> RichDoc

the content and the selection (not the undo history)

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

Performs copy-assignment from source.

impl Default for RichDoc

fn default() -> RichDoc

Returns the “default value” for a type.