Struct spreadsheet_ods::format::ValueFormat

pub struct ValueFormat { /* fields omitted */ }

Actual textual formatting of values.

Implementations

impl ValueFormat

pub fn new() -> Self

New, empty.

pub fn new_with_name<S: Into<String>>(name: S, value_type: ValueType) -> Self

New, with name.

pub fn format_ref(&self) -> ValueFormatRef

Returns a reference name for this value format.

pub fn set_name<S: Into<String>>(&mut self, name: S)

Sets the name.

pub fn name(&self) -> &String

Returns the name.

pub fn set_country<S: Into<String>>(&mut self, country: S)

Sets the country.

pub fn country(&self) -> Option<&String>

Country

pub fn set_language<S: Into<String>>(&mut self, language: S)

Sets the language.

pub fn language(&self) -> Option<&String>

Language

pub fn set_script<S: Into<String>>(&mut self, script: S)

Sets the Script.

pub fn script(&self) -> Option<&String>

Script

pub fn set_value_type(&mut self, value_type: ValueType)

Sets the value type.

pub fn value_type(&self) -> ValueType

Returns the value type.

pub fn set_origin(&mut self, origin: StyleOrigin)

Sets the origin.

pub fn origin(&self) -> StyleOrigin

Returns the origin.

pub fn set_styleuse(&mut self, styleuse: StyleUse)

Style usage.

pub fn styleuse(&self) -> StyleUse

Returns the usage.

pub fn textstyle(&self) -> &AttrMap2

Text style attributes.

pub fn textstyle_mut(&mut self) -> &mut AttrMap2

Text style attributes.

pub fn set_color(&mut self, color: Rgb<u8>)

Text color

pub fn set_font_name<S: Into<String>>(&mut self, name: S)

Text font.

pub fn set_font_attr(&mut self, size: Length, bold: bool, italic: bool)

Combined font attributes.

pub fn set_font_size(&mut self, size: Length)

Font size.

pub fn set_font_size_percent(&mut self, size: f64)

Font size as a percentage.

pub fn set_font_italic(&mut self)

Set to italic.

pub fn set_font_style(&mut self, style: FontStyle)

Set font style.

pub fn set_font_bold(&mut self)

Set to bold.

pub fn set_font_weight(&mut self, weight: FontWeight)

Sets the font weight.

pub fn set_letter_spacing(&mut self, spacing: Length)

Sets the letter spacing.

pub fn set_letter_spacing_normal(&mut self)

Sets the letter spacing to normal.

pub fn set_text_shadow(
    &mut self,
    x_offset: Length,
    y_offset: Length,
    blur: Option<Length>,
    color: Rgb<u8>
)

Text shadow.

pub fn set_text_position(&mut self, pos: TextPosition)

Text positioning.

pub fn set_text_transform(&mut self, trans: TextTransform)

Transforms on the text.

pub fn set_font_relief(&mut self, relief: TextRelief)

Font style relief.

pub fn set_font_line_through_color(&mut self, color: Rgb<u8>)

Color

pub fn set_font_line_through_style(&mut self, lstyle: LineStyle)

Line through

pub fn set_font_line_through_mode(&mut self, lmode: LineMode)

Line through

pub fn set_font_line_through_type(&mut self, ltype: LineType)

Line through

pub fn set_font_line_through_text<S: Into<String>>(&mut self, text: S)

Line through

pub fn set_font_line_through_text_style(&mut self, style_ref: TextStyleRef)

References a text-style.

pub fn set_font_line_through_width(&mut self, lwidth: LineWidth)

Line through

pub fn set_font_text_outline(&mut self, outline: bool)

Outline

pub fn set_font_underline_color(&mut self, color: Rgb<u8>)

Underlining

pub fn set_font_underline_style(&mut self, lstyle: LineStyle)

Underlining

pub fn set_font_underline_type(&mut self, ltype: LineType)

Underlining

pub fn set_font_underline_mode(&mut self, lmode: LineMode)

Underlining

pub fn set_font_underline_width(&mut self, lwidth: LineWidth)

Underlining

pub fn set_font_overline_color(&mut self, color: Rgb<u8>)

Overlining

pub fn set_font_overline_style(&mut self, lstyle: LineStyle)

Overlining

pub fn set_font_overline_type(&mut self, ltype: LineType)

Overlining

pub fn set_font_overline_mode(&mut self, lmode: LineMode)

Overlining

pub fn set_font_overline_width(&mut self, lwidth: LineWidth)

Overlining

pub fn push_boolean(&mut self)

Appends a format part.

pub fn push_number(&mut self, decimal: u8, grouping: bool)

Appends a format part.

pub fn push_number_fix(&mut self, decimal: u8, grouping: bool)

Appends a format part.

pub fn push_fraction(
    &mut self,
    denominator: u32,
    min_den_digits: u8,
    min_int_digits: u8,
    min_num_digits: u8,
    grouping: bool
)

Appends a format part.

pub fn push_scientific(&mut self, dec_places: u8)

Appends a format part.

pub fn push_currency<S1, S2, S3>(
    &mut self,
    country: S1,
    language: S2,
    symbol: S3
) where
    S1: Into<String>,
    S2: Into<String>,
    S3: Into<String>, 

Appends a format part.

pub fn push_day(&mut self, number: FormatNumberStyle)

Appends a format part.

pub fn push_month(&mut self, number: FormatNumberStyle, text: bool)

Appends a format part.

pub fn push_year(&mut self, number: FormatNumberStyle)

Appends a format part.

pub fn push_era(
    &mut self,
    number: FormatNumberStyle,
    calendar: FormatCalendarStyle
)

Appends a format part.

pub fn push_day_of_week(
    &mut self,
    number: FormatNumberStyle,
    calendar: FormatCalendarStyle
)

Appends a format part.

pub fn push_week_of_year(&mut self, calendar: FormatCalendarStyle)

Appends a format part.

pub fn push_quarter(
    &mut self,
    number: FormatNumberStyle,
    calendar: FormatCalendarStyle
)

Appends a format part.

pub fn push_hours(&mut self, number: FormatNumberStyle)

Appends a format part.

pub fn push_minutes(&mut self, number: FormatNumberStyle)

Appends a format part.

pub fn push_seconds(&mut self, number: FormatNumberStyle)

Appends a format part.

pub fn push_am_pm(&mut self)

Appends a format part.

pub fn push_embedded_text(&mut self, position: u8)

Appends a format part.

pub fn push_text<S: Into<String>>(&mut self, text: S)

Appends a format part.

pub fn push_text_content(&mut self)

Appends a format part.

pub fn push_part(&mut self, part: FormatPart)

Adds a format part.

pub fn push_parts(&mut self, partvec: &mut Vec<FormatPart>)

Adds all format parts.

pub fn parts(&self) -> &Vec<FormatPart>

Returns the parts.

pub fn parts_mut(&mut self) -> &mut Vec<FormatPart>

Returns the mutable parts.

pub fn push_stylemap(&mut self, stylemap: StyleMap)

Adds a stylemap.

pub fn stylemaps(&self) -> Option<&Vec<StyleMap>>

Returns the stylemaps

pub fn stylemaps_mut(&mut self) -> &mut Vec<StyleMap>

Returns the mutable stylemap.

pub fn format_boolean(&self, b: bool) -> String

Tries to format. If there are no matching parts, does nothing.

pub fn format_float(&self, f: f64) -> String

Tries to format. If there are no matching parts, does nothing.

pub fn format_str<'a, S: Into<&'a str>>(&self, s: S) -> String

Tries to format. If there are no matching parts, does nothing.

pub fn format_datetime(&self, d: &NaiveDateTime) -> String

Tries to format. If there are no matching parts, does nothing. Should work reasonably. Don’t ask me about other calenders.

pub fn format_time_duration(&self, d: &Duration) -> String

Tries to format. Should work reasonably. If there are no matching parts, does nothing.

Trait Implementations

impl AttrMap2Trait for ValueFormat

fn attrmap(&self) -> &AttrMap2

Reference to the map of actual attributes.

fn attrmap_mut(&mut self) -> &mut AttrMap2

Reference to the map of actual attributes.

fn is_empty(&self) -> bool

Are there any attributes?

fn add_all(&mut self, data: &[(&str, String)])

Add from Vec

fn set_attr(&mut self, name: &str, value: String)

Adds an attribute.

fn clear_attr(&mut self, name: &str) -> Option<String>

Removes an attribute.

fn attr(&self, name: &str) -> Option<&String>

Returns the attribute.

impl Clone for ValueFormat

fn clone(&self) -> ValueFormat

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ValueFormat

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

Formats the value using the given formatter.

impl Default for ValueFormat

fn default() -> ValueFormat

Returns the “default value” for a type.