Skip to main content

Font

Struct Font 

Source
pub struct Font {
    pub name: Option<String>,
    pub size: Option<f64>,
    pub bold: Option<bool>,
    pub italic: Option<bool>,
    pub underline: Option<MsoTextUnderlineType>,
    pub color: Option<RgbColor>,
    pub strikethrough: Option<bool>,
    pub subscript: Option<bool>,
    pub superscript: Option<bool>,
    pub language_id: Option<String>,
    pub fill: Option<FillFormat>,
    pub hyperlink: Option<Hyperlink>,
}
Expand description

Character formatting properties for a text run.

Corresponds to the <a:rPr> element in OOXML. None values indicate that the property should be inherited from the style hierarchy.

Fields§

§name: Option<String>

Typeface name (e.g. "Calibri").

§size: Option<f64>

Font size in points (e.g. 18.0 for 18pt).

§bold: Option<bool>

Bold flag.

§italic: Option<bool>

Italic flag.

§underline: Option<MsoTextUnderlineType>

Underline type. None means inherited; Some(MsoTextUnderlineType::None) means explicitly no underline; Some(MsoTextUnderlineType::SingleLine) for single, etc.

§color: Option<RgbColor>

Font color.

§strikethrough: Option<bool>

Strikethrough flag. When true, a single strike line is rendered.

§subscript: Option<bool>

Subscript flag. When true, text is rendered as subscript (baseline -25000).

§superscript: Option<bool>

Superscript flag. When true, text is rendered as superscript (baseline +30000).

§language_id: Option<String>

Language identifier (e.g. "en-US", "ja-JP").

§fill: Option<FillFormat>

Fill format for the font (e.g. solid fill for text color via fill).

§hyperlink: Option<Hyperlink>

Hyperlink associated with this font (alternative to Run-level hyperlink).

Implementations§

Source§

impl Font

Source

pub fn new() -> Self

Create a new Font with all properties set to None (inherited).

Source

pub fn set_size(&mut self, size: f64) -> Result<(), PptxError>

Set the font size in points.

size must be greater than 0.0.

§Errors

Returns Err(PptxError::InvalidValue) if the size is not positive.

Source

pub fn color_type(&self) -> Option<MsoColorType>

Return the color type of this font, if a color or fill with a solid color is set.

When fill is a SolidFill, the color type is derived from its ColorFormat. When only a simple color (RGB) is set, returns MsoColorType::Rgb. Returns None if no color information is present.

Source

pub fn write_xml<W: Write>(&self, w: &mut W) -> Result

Write the <a:rPr> XML element into the given writer.

§Errors

Returns Err if the writer fails.

Source

pub fn to_xml_string(&self) -> String

Generate the <a:rPr> XML element string.

If no properties are set, produces <a:rPr lang="en-US" dirty="0"/>.

§Panics

Panics if writing to a String fails (should never happen).

Trait Implementations§

Source§

impl Clone for Font

Source§

fn clone(&self) -> Font

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Font

Source§

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

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

impl Default for Font

Source§

fn default() -> Font

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

impl PartialEq for Font

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl StructuralPartialEq for Font

Auto Trait Implementations§

§

impl Freeze for Font

§

impl RefUnwindSafe for Font

§

impl Send for Font

§

impl Sync for Font

§

impl Unpin for Font

§

impl UnsafeUnpin for Font

§

impl UnwindSafe for Font

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> 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.