Struct spreadsheet_ods::format::ValueFormatText

pub struct ValueFormatText { /* private fields */ }

Formatting for Boolean.

Implementations

impl ValueFormatText

pub fn new_empty() -> Self

New, empty.

pub fn new_with_name<S: AsRef<str>>(name: S) -> Self

👎Deprecated

New, with name.

pub fn new_named<S: AsRef<str>>(name: S) -> Self

New, with name.

pub fn new_localized<S: AsRef<str>>(name: S, locale: Locale) -> Self

New, with name.

pub fn set_locale(&mut self, locale: Locale)

The number:language attribute specifies a language code. The country code is used for formatting properties whose evaluation is locale-dependent. If a language code is not specified, either the system settings or the setting for the system’s language are used, depending on the property whose value should be evaluated.

The number:country attribute specifies a country code for a data style. The country code is used for formatting properties whose evaluation is locale-dependent. If a country is not specified, the system settings are used.

The number:script attribute specifies a script code. The script code is used for formatting properties whose evaluation is locale-dependent. The attribute should be used only if necessary according to the rules of §2.2.3 of RFC5646, or its successors.

pub fn locale(&self) -> Option<Locale>

Returns number:language, number:country and number:script as a locale.

pub fn set_title<S: Into<String>>(&mut self, title: S)

The number:title attribute specifies the title of a data style.

pub fn title(&self) -> Option<&str>

The number:title attribute specifies the title of a data style.

pub fn set_transliteration_locale(&mut self, locale: Locale)

The number:transliteration-language attribute specifies a language code in conformance with RFC5646. If no language/country (locale) combination is specified, the locale of the data style is used

The number:transliteration-country attribute specifies a country code in conformance with RFC5646. If no language/country (locale) combination is specified, the locale of the data style is used.

pub fn transliteration_locale(&self) -> Option<Locale>

Returns number:transliteration_language and number:transliteration_country as a locale.

pub fn set_transliteration_format(&mut self, format: char)

The number:transliteration-format attribute specifies which number characters to use.

The value of the number:transliteration-format attribute shall be a decimal “DIGIT ONE” character with numeric value 1 as listed in the Unicode Character Database file UnicodeData.txt with value ‘Nd’ (Numeric decimal digit) in the General_Category/Numeric_Type property field 6 and value ‘1’ in the Numeric_Value fields 7 and 8, respectively as listed in DerivedNumericValues.txt

If no format is specified the default ASCII representation of Latin-Indic digits is used, other transliteration attributes present in that case are ignored.

The default value for this attribute is 1

pub fn transliteration_format(&self) -> Option<char>

Transliteration format.

pub fn set_transliteration_style(&mut self, style: TransliterationStyle)

The number:transliteration-style attribute specifies the transliteration format of a number system.

The semantics of the values of the number:transliteration-style attribute are locale- and implementation-dependent.

The default value for this attribute is short.

pub fn transliteration_style( &self ) -> Result<Option<TransliterationStyle>, OdsError>

Transliteration style.

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

The style:display-name attribute specifies the name of a style as it should appear in the user interface. If this attribute is not present, the display name should be the same as the style name.

pub fn set_volatile(&mut self, volatile: bool)

The style:volatile attribute specifies whether unused style in a document are retained or discarded by consumers. The defined values for the style:volatile attribute are:

• false: consumers should discard the unused styles.
• true: consumers should keep unused styles.

pub fn volatile(&self) -> Option<bool>

Volatile format.

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

The fo:background-color attribute specifies a background color for characters, paragraphs, text sections, frames, page bodies, headers, footers, table cells, table rows and tables. This can be transparent or a color. If the value is set to transparent, it switches off any background image that is specified by a style:background-image 17.3.

If a value for a draw:fill attribute is provided in a style, any background image that is specified by a style:background-image element and any background color that is specified with the fo:background-color attribute are switched off.

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

See §7.17.1 of XSL. In the OpenDocument XSL-compatible namespace, the fo:color attribute does not support the inherit value.

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

The style:font-name attribute specifies a font that is declared by a style:font-face 16.23 element with a style:name 19.502 attribute whose name is the same as that of the style:font-name attribute value.

This attribute is evaluated for any UNICODE character whose script type is latin. 20.358

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

See §7.8.4 of XSL. This attribute is evaluated for any UNICODE character whose script type is latin. 20.358 The value of this attribute is either an absolute length or a percentage as described in §7.8.4 of XSL. In contrast to XSL, percentage values can be used within common styles only and are based on the font height of the parent style rather than to the font height of the attributes neighborhood. Absolute font heights and relative font heights are not supported.

Note: The style:font-size-asian attribute (20.284) is evaluated for UNICODE characters whose type is asian. The style:font-size-complex attribute (20.285) is evaluated for UNICODE characters whose type is complex.

pub fn set_font_size_rel(&mut self, size: FontSize)

The style:font-size-rel attribute specifies a relative font size change. This attribute is evaluated for any UNICODE character whose script type is latin. 20.358 This attribute specifies a relative font size change as a length. It cannot be used within automatic styles. This attribute changes the font size based on the font size of the parent style.

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

See §7.8.7 of XSL. This attribute is evaluated for any UNICODE character whose script type is latin. 20.358

pub fn set_font_italic(&mut self)

Set the font-style to italic.

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

See §7.8.9 of XSL. This attribute is evaluated for any UNICODE character whose script type is latin. 20.358

pub fn set_font_bold(&mut self)

Sets the font-weight to bold. See set_font_weight.

pub fn set_font_variant(&mut self, var: FontVariant)

See §7.8.8 of XSL.

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

Combined font attributes.

pub fn set_locale_asian(&mut self, locale: Locale)

Sets the attributes for fo:language, fo:country and fo:script to the given locale.

These attributes are evaluated for any UNICODE characters whose script type is asian.

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

The style:font-name attribute specifies a font that is declared by a style:font-face 16.23 element with a style:name 19.502 attribute whose name is the same as that of the style:font-name attribute value.

This attribute is evaluated for any UNICODE character whose script type is asian. 20.358

pub fn set_font_size_asian(&mut self, size: FontSize)

See §7.8.4 of XSL. This attribute is evaluated for any UNICODE character whose script type is asian. 20.358 The value of this attribute is either an absolute length or a percentage as described in §7.8.4 of XSL. In contrast to XSL, percentage values can be used within common styles only and are based on the font height of the parent style rather than to the font height of the attributes neighborhood. Absolute font heights and relative font heights are not supported.

Note: The style:font-size-asian attribute (20.284) is evaluated for UNICODE characters whose type is asian. The style:font-sizecomplex attribute (20.285) is evaluated for UNICODE characters whose type is complex.

pub fn set_font_size_rel_asian(&mut self, size: FontSize)

The style:font-size-rel attribute specifies a relative font size change. This attribute is evaluated for any UNICODE character whose script type is asian. 20.358 This attribute specifies a relative font size change as a length. It cannot be used within automatic styles. This attribute changes the font size based on the font size of the parent style.

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

See §7.8.7 of XSL. This attribute is evaluated for any UNICODE character whose script type is asian. 20.358

pub fn set_font_italic_asian(&mut self)

Set the font-style to italic.

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

See §7.8.9 of XSL. This attribute is evaluated for any UNICODE character whose script type is asian. 20.358

pub fn set_font_bold_asian(&mut self)

Sets the font-weight to bold. See set_font_weight.

pub fn set_font_attr_asian(&mut self, size: FontSize, bold: bool, italic: bool)

Combined font attributes.

pub fn set_locale_complex(&mut self, locale: Locale)

Sets the attributes for fo:language, fo:country and fo:script to the given locale.

These attributes are evaluated for any UNICODE characters whose script type is complex.

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

The style:font-name attribute specifies a font that is declared by a style:font-face 16.23 element with a style:name 19.502 attribute whose name is the same as that of the style:font-name attribute value.

This attribute is evaluated for any UNICODE character whose script type is complex. 20.358

pub fn set_font_size_complex(&mut self, size: FontSize)

See §7.8.4 of XSL. This attribute is evaluated for any UNICODE character whose script type is complex. 20.358 The value of this attribute is either an absolute length or a percentage as described in §7.8.4 of XSL. In contrast to XSL, percentage values can be used within common styles only and are based on the font height of the parent style rather than to the font height of the attributes neighborhood. Absolute font heights and relative font heights are not supported.

Note: The style:font-size-asian attribute (20.284) is evaluated for UNICODE characters whose type is asian. The style:font-sizecomplex attribute (20.285) is evaluated for UNICODE characters whose type is complex.

pub fn set_font_size_rel_complex(&mut self, size: FontSize)

The style:font-size-rel attribute specifies a relative font size change. This attribute is evaluated for any UNICODE character whose script type is complex. 20.358 This attribute specifies a relative font size change as a length. It cannot be used within automatic styles. This attribute changes the font size based on the font size of the parent style.

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

See §7.8.7 of XSL. This attribute is evaluated for any UNICODE character whose script type is complex. 20.358

pub fn set_font_italic_complex(&mut self)

Set the font-style to italic. This attribute is evaluated for any UNICODE character whose script type is complex. 20.358

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

See §7.8.9 of XSL. This attribute is evaluated for any UNICODE character whose script type is complex. 20.358

pub fn set_font_bold_complex(&mut self)

Sets the font-weight to bold. See set_font_weight.

pub fn set_font_attr_complex( &mut self, size: FontSize, bold: bool, italic: bool )

Combined font attributes.

pub fn set_hyphenate(&mut self, hyphenate: bool)

See §7.9.4 of XSL.

pub fn set_hyphenation_push_char_count(&mut self, count: u32)

See §7.10.6 of XSL

pub fn set_hyphenation_remain_char_count(&mut self, count: u32)

See §7.10.7 of XSL

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

See §7.16.2 of XSL. Sets the letter spacing.

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

The fo:text-shadow attribute specifies the text shadow style to use.

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

See §7.16.6 of XSL. If fo:text-transform and fo:font-variant 20.192 attributes are used simultaneously and have different values than normal and none, the result is undefined. Note: In consumers, the fo:text-transform and fo:font-variant attributes are mutually exclusive

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

The style:font-relief attribute specifies whether a font should be embossed, engraved, or neither. The defined values for the style:font-relief attribute are:

• embossed: characters are embossed.
• engraved: characters are engraved.
• none: characters are neither embossed or engraved.

pub fn set_text_position(&mut self, pos: TextPosition, scale: Option<Percent>)

The style:text-position attribute specifies whether text is positioned above or below the baseline and to specify the relative font height that is used for this text. This attribute can have one or two values. The first value shall be present and specifies the vertical text position as a percentage of the current font height or it takes one of the values sub or super. Negative percentages or the sub value place the text below the baseline. Positive percentages or the super value place the text above the baseline. If sub or super is specified, the consumer chooses an appropriate text position. The second value may be present and specifies the font height as a percentage of the current font-height. If this value is not specified, an appropriate font height is used.

pub fn set_rotation_angle(&mut self, angle: Angle)

The style:rotation-angle attribute specifies the rotation angle of content.

pub fn set_rotation_scale(&mut self, scale: RotationScale)

The style:text-rotation-scale attribute specifies whether for rotated text the width of the text should be scaled to fit into the current line height or the width of the text should remain fixed, therefore changing the current line height. The defined values for the style:text-rotation-scale attribute are:

• fixed: width of text should remain fixed.
• line-height: width of text should be scaled to fit the current line height.

pub fn set_letter_kerning(&mut self, kerning: bool)

The style:letter-kerning attribute specifies whether kerning between characters is enabled or disabled.

pub fn set_text_combine(&mut self, pos: TextCombine)

The style:text-combine attribute specifies whether to combine characters so that they are displayed within two lines.

The defined values for the style:text-combine attribute are:

• letters: Display text in Kumimoji. Up to five (5) characters are combined within two lines and are displayed with a reduced size in a single wide-cell character. Additional characters are displayed as normal text.
• lines: Displays text in Warichu. All characters with the style:text-combine attribute that immediately follow each other are displayed within two lines of approximately the same length. A line break may occur between any two characters to meet this constraint.
• none: characters should not be combined.

pub fn set_text_combine_start_char(&mut self, c: char)

The style:text-combine-start-char attribute specifies the start character that is displayed before a portion of text whose style:text-combine 20.367 attribute has a value of lines.

pub fn set_text_combine_end_char(&mut self, c: char)

The style:text-combine-end-char attribute specifies the end character that is displayed after a portion of text whose style:text-combine 20.367 attribute has a value of lines.

pub fn set_text_emphasize( &mut self, emphasize: TextEmphasize, position: TextEmphasizePosition )

The style:text-emphasize attribute specifies emphasis in a text composed of UNICODE characters whose script type is asian. 20.358 The value of this attribute consists of two white space-separated values. The first value represents the style to use for emphasis. The second value represents the position of the emphasis and it can be above or below. If the first value is none, the second value can be omitted. The defined values for the style:text-emphasize attribute are:

• accent: calligraphic accent strokes.
• circle: hollow circles.
• disc: filled circles.
• dot: calligraphic dot.
• none: no emphasis marks.

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

The style:text-line-through-color attribute specifies the color that is used for linethrough text. The defined values for the style:text-line-through-color attribute are:

• font-color: current text color is used for underlining.
• a value of type color 18.3.9

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

The style:text-line-through-mode attribute specifies whether lining through is applied to words only or to portions of text. The defined values for the style:text-line-through-mode attribute are:

• continuous: lining is applied to words and separating spaces.
• skip-white-space: lining is not applied to spaces between words.

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

The style:text-line-through-style attribute specifies a style for rendering a line-through text. The defined values for the style:text-line-through-style attribute are:

• none: text has no line through it.
• dash: text has a dashed line through it.
• dot-dash: text has a line whose repeating pattern is a dot followed by a dash through it.
• dot-dot-dash: text has a line whose repeating pattern is two dots followed by a dash through it.
• dotted: text has a dotted line through it.
• long-dash: text has a dashed line whose dashes are longer than the ones from the dashed line for value dash through it.
• solid: text has a solid line through it.
• wave: text has a wavy line through it. Note: The definitions of the values of the style:text-line-through-style attribute are based on the text decoration style ‘text-line-through-style’ from CSS3Text, §9.2.

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

The style:text-line-through-text attribute specifies a text that is used for line-through. The attribute will be evaluated only if the value of style:text-line-through-style 20.373 attribute is different than none. If the attribute value is not empty, the attribute value string is used for line-through instead of the line style that has been specified by the style:text-line-through-style attribute. Consumers that do not support line-through with text should ignore the attribute, and should use the line style specified by the style:text-line-through-style attribute. Consumers that support line-through with single characters only, should use the first character of the value for line-through, if the style:text-line-through-text attribute value has more than one character. Consumers that support line-through with specific characters only (like ”x” or ”/” (U+002F, SOLIDUS) should use one of these characters if the attribute specifies characters that are not supported.

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

The style:text-line-through-text-style specifies a text style that is applied to text-linethrough characters. It is not applied to line-through lines. If the attribute appears in an automatic style, it may reference either an automatic text style or a common style. If the attribute appears in a common style, it may reference a common style only.

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

The style:text-line-through-type attribute specifies whether text is lined through, and if so, whether a single or double line will be used. The defined values for the style:text-line-through-type attribute are:

• double: a double line should be used for a line-through text.
• none: deprecated.
• single: a single line should be used for a line-through text. Every occurrence of the style:text-line-through-type attribute should be accompanied by an occurrence of the style:text-line-through-style 20.373 attribute on the same element. There should not be an occurrence of the style:text-line-through-type attribute if the value of the style:text-line-through-sty

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

The style:text-line-through-width attribute specifies the width of a line-through line. The value bold specifies a line width that is calculated from the font sizes like an auto width, but is wider than an auto width. The defined values for the style:text-line-through-width attribute are:

• auto: the width of a line-through should be calculated from the font size of the text where the line-through will appear.
• bold: the width of a line-through should be calculated from the font size of the text where the line-through will appear but is wider than for the value of auto.
• a value of type percent 18.3.23
• a value of type positiveInteger 18.2
• a value of type positiveLength 18.3.26 The line-through text styles referenced by the values dash, medium, thick and thin, are implementation-defined. Thin shall be smaller width than medium and medium shall be a smaller width than thick.

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

The style:text-outline attribute specifies whether to display an outline of text or the text itself.

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

The style:text-overline-color attribute specifies a color that is used to overline text.

The defined values for the style:text-overline-color attribute are:

• font-color: the current text color is used for overlining.
• a value of type color

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

The style:text-overline-mode attribute specifies whether overlining is applied to words only or to portions of text.

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

The style:text-overline-style attribute specifies a style for rendering a line over text.

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

The style:text-overline-type attribute specifies the type of overlining applied to a text.

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

The style:text-overline-width attribute specifies the width of an overline. The value bold specifies a line width that is calculated from the font sizes like an auto width, but is wider than an auto width.

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

The style:text-underline-color attribute specifies a color that is used to underline text. The defined values for the style:text-underline-color attribute are:

• font-color: the current text color is used for underlining.
• a value of type color: the color to be used for underlining.

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

The style:text-underline-mode attribute specifies whether underlining is applied to words only or to portions of text. If underlining is applied to text portions, the spaces between words and the words are underlined.

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

The style:text-underline-style attribute specifies a style for underlining text

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

The style:text-underline-type attribute specifies the type of underlining applied to a text

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

The style:text-underline-width attribute specifies the width of an underline. The value bold specifies a line width that is calculated from the font sizes like an auto width, but is wider than an auto width.

pub fn set_use_window_font_color(&mut self, window_color: bool)

The style:use-window-font-color attribute specifies whether the window foreground color should be used as the foreground color for a light background color and white for a dark background color. The determination of light or dark color is implementation-defined.

pub fn set_text_condition(&mut self, cond: TextCondition)

The text:condition attribute specifies the display of text. The defined value of the text:condition attribute is none, which means text is hidden.

pub fn set_display(&mut self, cond: TextDisplay)

The text:display attribute specifies whether text is hidden. The defined values for the text:display attribute are:

• condition: text is hidden under the condition specified in the text:condition 20.426 attribute.
• none: text is hidden unconditionally.
• true: text is displayed. This is the default setting

impl ValueFormatText

pub fn part_fill_character(&mut self) -> PartFillCharacterBuilder<'_, Self>

Adds a format part to this format.

The number:fill-character element specifies a Unicode character that is displayed repeatedly at the position where the element occurs. The character specified is repeated as many times as possible, but the total resulting string shall not exceed the given cell content area.

Fill characters may not fill all the available space in a cell. The distribution of the remaining space is implementation-dependent.

Can be used with ValueTypes:

• Currency
• DateTime
• Number
• Percentage
• Text
• TimeDuration

pub fn part_text<S: Into<String>>( &mut self, text: S ) -> PartTextBuilder<'_, Self>

Adds a format part to this format.

The number:text element contains any fixed text for a data style.

Can be used with ValueTypes:

• Boolean
• Currency
• DateTime
• Number
• Percentage
• Text
• TimeDuration

pub fn part_text_content(&mut self) -> PartTextContentBuilder<'_, Self>

Adds a format part to this format.

The number:text-content element marks the position of variable text content of a text style.

Can be used with ValueTypes:

• Text

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

👎Deprecated

Use part_text instead.

pub fn push_text_content(&mut self)

👎Deprecated

Use part_text_content instead.

Trait Implementations

impl Clone for ValueFormatText

fn clone(&self) -> ValueFormatText

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ValueFormatText

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

Formats the value using the given formatter.

impl GetSize for ValueFormatText

fn get_heap_size(&self) -> usize

Determines how many bytes this object occupies inside the heap.

fn get_stack_size() -> usize

Determines how may bytes this object occupies inside the stack.

fn get_size(&self) -> usize

Determines the total size of the object.

impl ValueFormatTrait for ValueFormatText

fn format_ref(&self) -> ValueFormatRef

Returns a reference name for this value format.

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

The style:name attribute specifies names that reference style mechanisms.

fn name(&self) -> &String

The style:name attribute specifies names that reference style mechanisms.

fn value_type(&self) -> ValueType

Returns the value type.

fn set_origin(&mut self, origin: StyleOrigin)

Sets the storage location for this ValueFormat. Either content.xml or styles.xml.

fn origin(&self) -> StyleOrigin

Returns the storage location.

fn set_styleuse(&mut self, styleuse: StyleUse)

How is the style used in the document.

fn styleuse(&self) -> StyleUse

How is the style used in the document.

fn attrmap(&self) -> &AttrMap2

All direct attributes of the number:xxx-style tag.

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

All direct attributes of the number:xxx-style tag.

fn textstyle(&self) -> &AttrMap2

Text style attributes.

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

Text style attributes.

fn push_part(&mut self, part: FormatPart)

Adds a format part.

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

Adds all format parts.

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

Returns the parts.

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

Returns the mutable parts.

fn push_stylemap(&mut self, stylemap: ValueStyleMap)

Adds a stylemap.

fn stylemaps(&self) -> Option<&Vec<ValueStyleMap>>

Returns the stylemaps

fn stylemaps_mut(&mut self) -> &mut Vec<ValueStyleMap>

Returns the mutable stylemap.