Orcus
Loading...
Searching...
No Matches
orcus::spreadsheet::iface::import_cell_style Class Referenceabstract

#include <import_interface_styles.hpp>

Public Member Functions

virtual void set_name (std::string_view s)=0
virtual void set_display_name (std::string_view s)=0
virtual void set_xf (size_t index)=0
virtual void set_builtin (size_t index)=0
virtual void set_parent_name (std::string_view s)=0
virtual void commit ()=0

Detailed Description

This interface is used to import named cell style records.

Note
The actual cell format data for named cell styles are imported through import_xf, and this interface references its index through the import_cell_style::set_xf() method.

Member Function Documentation

◆ commit()

virtual void orcus::spreadsheet::iface::import_cell_style::commit ( )
pure virtual

Commit the cell style format in the current buffer to the storage.

Note
This method does not return an index.

◆ set_builtin()

virtual void orcus::spreadsheet::iface::import_cell_style::set_builtin ( size_t index)
pure virtual

Set the index into the built-in cell style record.

Note
This is Excel-specific, and unclear whether it's useful outside of Excel's implementation. Built-in styles are not stored in file, and Excel likely has its own internal styles stored in the application itself.
Parameters
indexindex into the built-in cell style record.

◆ set_display_name()

virtual void orcus::spreadsheet::iface::import_cell_style::set_display_name ( std::string_view s)
pure virtual

Set the name associated with the named cell style intended for display purposes.

Parameters
sname to use for display purposes.
Note
Not all supported formats make use of this property. Also, the style may not always have this property even if the format supports it. ODF uses this property when the original name contains characters that cannot be used in internal symbols.

◆ set_name()

virtual void orcus::spreadsheet::iface::import_cell_style::set_name ( std::string_view s)
pure virtual

Set the name associated with the named cell style.

Parameters
sname of the named cell style.

◆ set_parent_name()

virtual void orcus::spreadsheet::iface::import_cell_style::set_parent_name ( std::string_view s)
pure virtual

Set the name of the parent cell style it uses as its basis.

Note
ODF uses this but Excel does not use this value.
Parameters
sname of the parent cell style.

◆ set_xf()

virtual void orcus::spreadsheet::iface::import_cell_style::set_xf ( size_t index)
pure virtual

Set the index into the cell format record. The named cell style applies the format referenced by this index.

Parameters
indexindex into the cell format record.