Orcus
Loading...
Searching...
No Matches
Public Member Functions | List of all members
orcus::spreadsheet::iface::import_styles Class Referenceabstract

#include <import_interface_styles.hpp>

Inheritance diagram for orcus::spreadsheet::iface::import_styles:
orcus::spreadsheet::import_styles

Public Member Functions

virtual import_font_stylestart_font_style ()=0
 
virtual import_fill_stylestart_fill_style ()=0
 
virtual import_border_stylestart_border_style ()=0
 
virtual import_cell_protectionstart_cell_protection ()=0
 
virtual import_number_formatstart_number_format ()=0
 
virtual import_xfstart_xf (xf_category_t cat)=0
 
virtual import_cell_stylestart_cell_style ()=0
 
virtual void set_font_count (size_t n)=0
 
virtual void set_fill_count (size_t n)=0
 
virtual void set_border_count (size_t n)=0
 
virtual void set_number_format_count (size_t n)=0
 
virtual void set_xf_count (xf_category_t cat, size_t n)=0
 
virtual void set_cell_style_count (size_t n)=0
 

Detailed Description

Interface for importing styles. This one acts as an entry point and provides other interfaces for the style categories.

The styles are to be stored in a flyweight fashion where each style category maintains an array of stored style items, which are referenced by their indices. Each time a style item is pushed through the interface, it returns an index representing the item. The indices are to be assigned sequentially starting with 0 in each style category, and the default style must get an index of 0. Because of this, the import filter imports the default styles first before importing other non-default styles.

The appreviation xf stands for cell format, and is used throughout the styles API. Similarly, the dxf stands for differential cell format, and stores partial format properties that are to be applied on top of the base format properties.

Note
The implementor of this interface must implement all interfaces for all the style categories that this interface returns.

Member Function Documentation

◆ set_border_count()

virtual void orcus::spreadsheet::iface::import_styles::set_border_count ( size_t n)
pure virtual

Set the total number of border styles. This may be called before importing any of the border styles. This will give the implementer a chance to allocate storage. Note that it may not always be called.

Parameters
nnumber of border styles.

Implemented in orcus::spreadsheet::import_styles.

◆ set_cell_style_count()

virtual void orcus::spreadsheet::iface::import_styles::set_cell_style_count ( size_t n)
pure virtual

Set the total number of named cell styles. This may be called before importing any cell styles to give the implementer a chance to allocate storage. Note that it may not always be called.

Parameters
nnumber of named cell styles.

Implemented in orcus::spreadsheet::import_styles.

◆ set_fill_count()

virtual void orcus::spreadsheet::iface::import_styles::set_fill_count ( size_t n)
pure virtual

Set the total number of fill styles. This may be called before importing any of the fill styles. This will give the implementer a chance to allocate storage. Note that it may not always be called.

Parameters
nnumber of fill styles.

Implemented in orcus::spreadsheet::import_styles.

◆ set_font_count()

virtual void orcus::spreadsheet::iface::import_styles::set_font_count ( size_t n)
pure virtual

Set the total number of font styles. This may be called before importing any of the font styles. This will give the implementer a chance to allocate storage. Note that it may not always be called.

Parameters
nnumber of font styles.

Implemented in orcus::spreadsheet::import_styles.

◆ set_number_format_count()

virtual void orcus::spreadsheet::iface::import_styles::set_number_format_count ( size_t n)
pure virtual

Set the total number of number format styles. This may be called before importing any of the number format styles. This will give the implementer a chance to allocate storage. Note that it may not always be called.

Parameters
nnumber of number format styles.

Implemented in orcus::spreadsheet::import_styles.

◆ set_xf_count()

virtual void orcus::spreadsheet::iface::import_styles::set_xf_count ( xf_category_t cat,
size_t n )
pure virtual

Set the total number of cell format styles for a specified cell format category. This may be called before importing any of the cell format styles for the specified category. This will give the implementer a chance to allocate storage. Note that it may not always be called.

Parameters
catcell format category.
nnumber of cell formats styles for the specified cell format category.

Implemented in orcus::spreadsheet::import_styles.

◆ start_border_style()

virtual import_border_style * orcus::spreadsheet::iface::import_styles::start_border_style ( )
pure virtual

Signal the start of the import of border style attributes, and return a pointer to the interface instance for importing the attributes.

Note
Note that the import_styles implementer must return a non-null pointer.
Returns
pointer to the interface instance for importing border style attributes.

Implemented in orcus::spreadsheet::import_styles.

◆ start_cell_protection()

virtual import_cell_protection * orcus::spreadsheet::iface::import_styles::start_cell_protection ( )
pure virtual

Signal the start of the import of cell protection attributes, and return a pointer to the interface instance for importing the attributes.

Note
Note that the import_styles implementer must return a non-null pointer.
Returns
pointer to the interface instance for importing cell protection attributes.

Implemented in orcus::spreadsheet::import_styles.

◆ start_cell_style()

virtual import_cell_style * orcus::spreadsheet::iface::import_styles::start_cell_style ( )
pure virtual

Signal the start of the import of named cell style information, and return a pointer to the interface instance for importing the information.

Note
Note that the import_styles implementer must return a non-null pointer.
Returns
pointer to the interface instance for importing named cell style information.

Implemented in orcus::spreadsheet::import_styles.

◆ start_fill_style()

virtual import_fill_style * orcus::spreadsheet::iface::import_styles::start_fill_style ( )
pure virtual

Signal the start of the import of fill style attributes, and return a pointer to the interface instance for importing the attributes.

Note
Note that the import_styles implementer must return a non-null pointer.
Returns
pointer to the interface instance for importing fill style attributes.

Implemented in orcus::spreadsheet::import_styles.

◆ start_font_style()

virtual import_font_style * orcus::spreadsheet::iface::import_styles::start_font_style ( )
pure virtual

Signal the start of the import of font style attributes, and return a pointer to the interface instance for importing the attributes.

Note
Note that the import_styles implementer must return a non-null pointer.
Returns
pointer to the interface instance for importing font style attributes.

Implemented in orcus::spreadsheet::import_styles.

◆ start_number_format()

virtual import_number_format * orcus::spreadsheet::iface::import_styles::start_number_format ( )
pure virtual

Signal the start of the import of number format attributes and return a pointer to the interface instance for importing the attributes.

Note
Note that the import_styles implementer must return a non-null pointer.
Returns
pointer to the interface instance for importing number format attributes.

Implemented in orcus::spreadsheet::import_styles.

◆ start_xf()

virtual import_xf * orcus::spreadsheet::iface::import_styles::start_xf ( xf_category_t cat)
pure virtual

Signal the start of the import of cell format (xf) indices that each reference different format attributes in their respective pools, and return a pointer to the interface instance for importing the indices.

Note
Note that the import_styles implementer must return a non-null pointer.
Returns
pointer to the interface instance for importing cell format (xf) indices.

Implemented in orcus::spreadsheet::import_styles.