Skip to main content

DocxHeadingStyle

Struct DocxHeadingStyle 

Source
pub struct DocxHeadingStyle {
    pub size_half_points: Option<usize>,
    pub bold: bool,
    pub italic: bool,
    pub alignment: Option<Alignment>,
    pub space_before_twips: Option<i32>,
    pub space_after_twips: Option<i32>,
    pub keep_with_next: bool,
    pub page_break_before: bool,
}
Expand description

How one HeadingN paragraph style is defined in the output.

Paragraphs carrying a heading level reference a style id (Heading1Heading6), and a referenced-but-undefined id is not an error in OOXML — the reader silently substitutes its own built-in. That is why an export could ask for a 24 pt centred chapter title and open as whatever Word felt like: nothing in the file ever said what Heading1 is.

Fields§

§size_half_points: Option<usize>

Size in half-points (24 = 12 pt). None ⇒ the document’s body size.

§bold: bool§italic: bool§alignment: Option<Alignment>

Paragraph alignment. None ⇒ inherit (left, or right in an RTL paragraph).

§space_before_twips: Option<i32>

Space above, in twips (pt × 20).

§space_after_twips: Option<i32>

Space below, in twips.

§keep_with_next: bool

Keep the heading on the same page as what follows it, so a chapter title can never be left stranded alone at the foot of a page.

§page_break_before: bool

Start the heading on a new page. This is the style-level rule (“every heading at this level opens a page”); a single block can also ask for it through Block::fmt_page_break_before, and either one is enough.

Implementations§

Source§

impl DocxHeadingStyle

Source

pub fn default_ramp(body_half_points: usize) -> Vec<Self>

The conventional six-level ramp, scaled off body_half_points: each level a little smaller than the one above, bold, opening with space and never orphaned from its text. Deliberately close to what a reader’s own built-in headings look like, because this exists to make the file say what it was already silently relying on.

Trait Implementations§

Source§

impl Clone for DocxHeadingStyle

Source§

fn clone(&self) -> DocxHeadingStyle

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DocxHeadingStyle

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for DocxHeadingStyle

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for DocxHeadingStyle

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for DocxHeadingStyle

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for DocxHeadingStyle

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for DocxHeadingStyle

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.