Struct onenote_parser::contents::RichText

pub struct RichText { /* private fields */ }

A rich text paragraph.

Formatting

Rich-text formatting is represented by storing the paragraph text along with a list of text runs. Each text run specified formatting that is only applied to a substring of the paragraph text.

The text run indices represent where each text run ends. The last text run always ends at the end of the paragraph text. If there are no text run indices, the text run formatting applies to the whole paragraph.

Text runs can be rendered by splitting the paragraph text at the text run indices and then applying each text run formatting to its respective substring.

Implementations

impl RichText

pub fn text(&self) -> &str

The paragraph text content.

pub fn text_run_formatting(&self) -> &[ParagraphStyling]

The formatting of each text run.

See [MS-ONE] 2.3.77.

pub fn text_run_indices(&self) -> &[u32]

The character positions where the text runs end.

See [MS-ONE] 2.3.76.

pub fn paragraph_style(&self) -> &ParagraphStyling

The base paragraph style.

pub fn paragraph_space_before(&self) -> f32

The paragraph’s top margin in half-inch increments.

See [MS-ONE] 2.3.81.

pub fn paragraph_space_after(&self) -> f32

The paragraph’s bottom margin in half-inch increments.

See [MS-ONE] 2.3.82.

pub fn paragraph_line_spacing_exact(&self) -> Option<f32>

The paragraph’s line spacing in half-inch increments.

See [MS-ONE] 2.3.83.

pub fn paragraph_alignment(&self) -> ParagraphAlignment

The paragraph’s text alignment.

See [MS-ONE] 2.3.94.

pub fn layout_alignment_in_parent(&self) -> Option<LayoutAlignment>

The paragraph’s alignment relative to the containing outline element (if present).

See [MS-ONE] 2.3.27.

pub fn layout_alignment_self(&self) -> Option<LayoutAlignment>

The paragraph’s alignment.

See [MS-ONE] 2.3.33.

pub fn note_tags(&self) -> &[NoteTag]

Note tags for this paragraph.

pub fn embedded_objects(&self) -> &[EmbeddedObject]

Objects embedded in this paragraph.

Trait Implementations

impl Clone for RichText

fn clone(&self) -> RichText

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RichText

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

Formats the value using the given formatter.