Struct TableOfContents

pub struct TableOfContents {
    pub instr: InstrToC,
    pub items: Vec<TableOfContentsItem>,
    pub auto: bool,
    pub dirty: bool,
    pub without_sdt: bool,
    pub alias: Option<String>,
    pub page_ref_placeholder: Option<String>,
    pub before_contents: Vec<TocContent>,
    pub after_contents: Vec<TocContent>,
    pub delete: Option<TableOfContentsReviewData>,
}

https://c-rex.net/projects/samples/ooxml/e1/Part4/OOXML_P4_DOCX_TOCTOC_topic_ID0ELZO1.html This struct is only used by writers

Fields

instr: InstrToC

items: Vec<TableOfContentsItem>

auto: bool

dirty: bool

without_sdt: bool

Skip StructuredDataTag rendering

alias: Option<String>

page_ref_placeholder: Option<String>

before_contents: Vec<TocContent>

after_contents: Vec<TocContent>

delete: Option<TableOfContentsReviewData>

Implementations

impl TableOfContents

pub fn new() -> Self

pub fn with_instr_text(s: &str) -> Self

pub fn heading_styles_range(self, start: usize, end: usize) -> Self

pub fn add_style_with_level(self, s: StyleWithLevel) -> Self

pub fn hyperlink(self) -> Self

pub fn alias(self, a: impl Into<String>) -> Self

pub fn delete(self, author: impl Into<String>, date: impl Into<String>) -> Self

pub fn add_item(self, t: TableOfContentsItem) -> Self

pub fn auto(self) -> Self

pub fn dirty(self) -> Self

pub fn add_before_paragraph(self, p: Paragraph) -> Self

pub fn add_after_paragraph(self, p: Paragraph) -> Self

pub fn add_before_table(self, t: Table) -> Self

pub fn add_after_table(self, t: Table) -> Self

pub fn without_sdt(self) -> Self

Trait Implementations

impl Clone for TableOfContents

fn clone(&self) -> TableOfContents

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TableOfContents

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

Formats the value using the given formatter.

impl Default for TableOfContents

fn default() -> TableOfContents

Returns the “default value” for a type.

impl PartialEq for TableOfContents

fn eq(&self, other: &TableOfContents) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for TableOfContents

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TableOfContents