Skip to main content

ColorScheme

Struct ColorScheme 

Source
pub struct ColorScheme {
    pub dark1: String,
    pub light1: String,
    pub dark2: String,
    pub light2: String,
    pub accent1: String,
    pub accent2: String,
    pub accent3: String,
    pub accent4: String,
    pub accent5: String,
    pub accent6: String,
    pub hyperlink: String,
    pub followed_hyperlink: String,
}
Expand description

A theme’s 12-color palette (<a:clrScheme>, CT_ColorScheme): two dark/ light pairs, six accents, and two hyperlink colors — the palette behind Word’s “Theme Colors” swatches and w:themeColor-based direct formatting (CT_Color’s theme-color choice, not modeled on Run/ Style itself, which only ever carry literal RGB colors).

Every slot is stored as a plain 6-digit RGB hex string (no leading #, e.g. "4F81BD"), written as <a:srgbClr val="..">. CT_Color’s other choice, <a:sysClr> (binding a slot to a live Windows system color, with a fallback RGB for non-Windows renderers) — what Word’s own default theme actually uses for dk1/lt1 (bound to windowText/window) — is not modeled for writing; a plain srgbClr is schema-valid in its place and renders identically outside of that live system-color binding, which this crate has no way to honor anyway (a document it writes isn’t tied to any running Windows session). Reading back a real, externally-authored theme that does use <a:sysClr> for a slot still works: its fallback RGB (lastClr) is captured instead of the live binding, which is lost on a round trip — see reader.rs.

Fields§

§dark1: String§light1: String§dark2: String§light2: String§accent1: String§accent2: String§accent3: String§accent4: String§accent5: String§accent6: String§hyperlink: String§followed_hyperlink: String

Implementations§

Source§

impl ColorScheme

Source

pub fn new( dark1: impl Into<String>, light1: impl Into<String>, dark2: impl Into<String>, light2: impl Into<String>, accent1: impl Into<String>, accent2: impl Into<String>, accent3: impl Into<String>, accent4: impl Into<String>, accent5: impl Into<String>, accent6: impl Into<String>, hyperlink: impl Into<String>, followed_hyperlink: impl Into<String>, ) -> ColorScheme

Creates a color scheme from its 12 slots, each a 6-digit RGB hex string (no leading #).

Examples found in repository?
examples/docx_theme.rs (lines 27-30)
14fn main() -> office_toolkit::Result<()> {
15    let default_theme_document = Document::new()
16        .with_theme(Theme::office_default())
17        .with_paragraph(Paragraph::with_text("Office's built-in default theme."))
18        .with_paragraph(Paragraph::with_text(
19            "Cambria for headings, Calibri for body text, the classic Office palette.",
20        ));
21    let default_path = output_path("docx_theme_default.docx");
22    default_theme_document.save_to_file(&default_path)?;
23    println!("Wrote {}", default_path.display());
24
25    // A custom, branded theme: a dark navy/orange palette and a different
26    // heading/body font pairing.
27    let custom_colors = ColorScheme::new(
28        "1B1B1B", "FFFFFF", "0A2540", "F5F5F5", "0A2540", "E8622C", "2E86AB", "6FB98F", "F4A259",
29        "8E4585", "1155CC", "6B3FA0",
30    );
31    let custom_fonts = FontScheme::new("Georgia", "Verdana");
32    let custom_theme_document = Document::new()
33        .with_theme(Theme::new("Custom Brand", custom_colors, custom_fonts))
34        .with_paragraph(Paragraph::with_text("A custom, branded theme."))
35        .with_paragraph(Paragraph::with_text(
36            "Georgia for headings, Verdana for body text, a navy/orange palette.",
37        ));
38    let custom_path = output_path("docx_theme_custom.docx");
39    custom_theme_document.save_to_file(&custom_path)?;
40    println!("Wrote {}", custom_path.display());
41
42    Ok(())
43}
Source

pub fn office_default() -> ColorScheme

Office’s own built-in default 12-color palette (the classic “Office” theme colors: dk1/lt1 as plain black/white rather than Word’s own live sysClr binding — see ColorScheme’s doc comment).

Trait Implementations§

Source§

impl Clone for ColorScheme

Source§

fn clone(&self) -> ColorScheme

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 ColorScheme

Source§

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

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

impl Eq for ColorScheme

Source§

impl PartialEq for ColorScheme

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ColorScheme

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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.