Struct spreadsheet_ods::style::CellStyle

source ·

pub struct CellStyle { /* private fields */ }

Expand description

Describes the style information for a cell.

use spreadsheet_ods::{pt, Length, CellStyle, WorkBook, Sheet, CellStyleRef};
use spreadsheet_ods::defaultstyles::DefaultFormat;
use spreadsheet_ods::color::Rgb;
use icu_locid::locale;

let mut book = WorkBook::new(locale!("en_US"));

let mut st_header = CellStyle::new("header", &DefaultFormat::default());
st_header.set_font_bold();
st_header.set_color(Rgb::new(255,255,0));
st_header.set_font_size(pt!(18));
let ref_header = book.add_cellstyle(st_header);

let mut sheet0 = Sheet::new("sheet 1");
sheet0.set_styled_value(0,0, "title", &ref_header);

// use a style defined later or elsewhere:
let ref_some = CellStyleRef::from("some_else");
sheet0.set_styled_value(1,0, "some", &ref_some);

Implementations§

source §

impl CellStyle

source

pub fn origin(&self) -> StyleOrigin

Origin of the style, either styles.xml oder content.xml

source

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

Changes the origin.

source

pub fn styleuse(&self) -> StyleUse

Usage for the style.

source

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

Usage for the style.

source

pub fn name(&self) -> &str

Stylename

source

pub fn set_name<S: AsRef<str>>(&mut self, name: S)

Stylename

source

pub fn style_ref(&self) -> CellStyleRef

Returns the name as a style reference.

source

pub fn set_auto_update(&mut self, auto: bool)

The style:auto-update attribute specifies whether styles are automatically updated when the formatting properties of an object that has the style assigned to it are changed. The defined values for the style:auto-update attribute are:

false: a change to a formatting property is applied for the object where the change was made. If necessary, a new automatic style will be created which is applied to the object where the change was made.
true: a change to a formatting property results in the updating of the common style that is applied to an object. The formatting change is applied to all objects subject to the common style where the change was made. The default value for this attribute is false.

source

pub fn set_class(&mut self, class: &str)

The style:class attribute specifies a style class name. A style may belong to an arbitrary class of styles. The style class name is an arbitrary string. The style class name has no meaning within the file format itself, but it can for instance be evaluated by user interfaces to show a list of styles where the styles are grouped by its name.

source

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.

source

pub fn set_parent_style(&mut self, name: &CellStyleRef)

The style:parent-style-name attribute specifies the name of a parent style. The parent style cannot be an automatic style and shall exist. If a parent style is not specified, the default style which has the same style:family 19.480 attribute value as the current style is used.

source §

impl CellStyle

source

pub fn new_empty() -> Self

Creates an empty style.

source

pub fn new<S: AsRef<str>>(name: S, value_format: &ValueFormatRef) -> Self

Creates an empty style with the given name and a reference to a value format.

source

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

Reference to the value format.

source

pub fn set_value_format(&mut self, name: &ValueFormatRef)

Reference to the value format.

source

pub fn attrmap(&self) -> &AttrMap2

Allows access to all attributes of the style itself.

source

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

Allows access to all attributes of the style itself.

source

pub fn cellstyle(&self) -> &AttrMap2

Allows access to all cell-style like attributes.

source

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

Allows access to all cell-style like attributes.

source

pub fn paragraphstyle(&self) -> &AttrMap2

Allows access to all paragraph-style like attributes.

source

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

Allows access to all paragraph-style like attributes.

source

pub fn textstyle(&self) -> &AttrMap2

Allows access to all text-style like attributes.

source

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

Allows access to all text-style like attributes.

source

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

Adds a stylemap.

source

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

Returns the stylemaps

source

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

Returns the mutable stylemap.

source

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.

source

pub fn set_border(&mut self, width: Length, border: Border, color: Rgb<u8>)

Border style all four sides. See §7.29.3 of XSL.

source

pub fn set_border_bottom( &mut self, width: Length, border: Border, color: Rgb<u8> )

Border style. See §7.29.4 of XSL

source

pub fn set_border_left(&mut self, width: Length, border: Border, color: Rgb<u8>)

Border style. See §7.29.6 of XSL.

source

pub fn set_border_right( &mut self, width: Length, border: Border, color: Rgb<u8> )

Border style. See §7.29.7 of XSL.

source

pub fn set_border_top(&mut self, width: Length, border: Border, color: Rgb<u8>)

Border style. See §7.29.10 of XSL.

source

pub fn set_padding(&mut self, padding: Length)

Padding for all sides. See §7.29.15 of XSL.

The fo:padding attribute is usable with the following elements: style:graphicproperties 17.21, style:header-footer-properties 17.5, style:pagelayout-properties 17.2, style:paragraph-properties 17.6 and style:tablecell-properties 17.18.

source

pub fn set_padding_bottom(&mut self, padding: Length)

Padding. See §7.7.36 of XSL.

The fo:padding-bottom attribute is usable with the following elements: style:graphicproperties 17.21, style:header-footer-properties 17.5, style:pagelayout-properties 17.2, style:paragraph-properties 17.6 and style:tablecell-properties 17.18.

source

pub fn set_padding_left(&mut self, padding: Length)

Padding. See §7.7.37 of XSL.

The fo:padding-left attribute is usable with the following elements: style:graphicproperties 17.21, style:header-footer-properties 17.5, style:pagelayout-properties 17.2, style:paragraph-properties 17.6 and style:tablecell-properties 17.18.

source

pub fn set_padding_right(&mut self, padding: Length)

Padding. See §7.7.38 of XSL.

The fo:padding-right attribute is usable with the following elements: style:graphicproperties 17.21, style:header-footer-properties 17.5, style:pagelayout-properties 17.2, style:paragraph-properties 17.6 and style:tablecell-properties 17.18.

source

pub fn set_padding_top(&mut self, padding: Length)

Padding. See §7.7.35 of XSL.

The fo:padding-top attribute is usable with the following elements: style:graphicproperties 17.21, style:header-footer-properties 17.5, style:pagelayout-properties 17.2, style:paragraph-properties 17.6 and style:tablecell-properties 17.18.

source

pub fn set_wrap_option(&mut self, wrap: WrapOption)

See §7.15.13 of XSL. If wrapping is disabled, it is implementation-defined whether the overflow text is visible or hidden. If the text is hidden consumers may support a scrolling to access the text.

source

pub fn set_border_line_width( &mut self, inner: Length, spacing: Length, outer: Length )

The style:border-line-width attribute specifies the widths of borders defined by the FO border properties (see 20.183) for borders where the value of these properties is double. The value of the style:border-line-width attribute is a list of three white space-separated lengths, as follows:

The first value specifies the width of the inner line
The second value specifies the distance between the two lines
The third value specifies the width of the outer line