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

#include <import_interface_styles.hpp>

Public Member Functions

virtual void set_font (size_t index)=0
 
virtual void set_fill (size_t index)=0
 
virtual void set_border (size_t index)=0
 
virtual void set_protection (size_t index)=0
 
virtual void set_number_format (size_t index)=0
 
virtual void set_style_xf (size_t index)=0
 
virtual void set_apply_alignment (bool b)=0
 
virtual void set_horizontal_alignment (hor_alignment_t align)=0
 
virtual void set_vertical_alignment (ver_alignment_t align)=0
 
virtual void set_wrap_text (bool b)=0
 
virtual void set_shrink_to_fit (bool b)=0
 
virtual size_t commit ()=0
 

Detailed Description

This interface is used to import cell format records for direct cell formats, named cell style formats, and differential cell formats.

The following cell format types:

use indices to reference their records in their respective record pools.

The horizontal and vertical alignments are specified directly.

Member Function Documentation

◆ commit()

virtual size_t orcus::spreadsheet::iface::import_xf::commit ( )
pure virtual

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

Returns
index of the cell format data in the storage. This index may be passed to the import_cell_style::set_xf() method.

◆ set_apply_alignment()

virtual void orcus::spreadsheet::iface::import_xf::set_apply_alignment ( bool b)
pure virtual

Set the flag indicating whether or not to apply the alignment attribute.

Parameters
bflag indicating whether or not to apply the alignment attribute.
Note
This is specific to Excel format.

◆ set_border()

virtual void orcus::spreadsheet::iface::import_xf::set_border ( size_t index)
pure virtual

Set the index of the border record, as returned from the import_border_style::commit() method.

Parameters
indexindex of the border record to reference.

◆ set_fill()

virtual void orcus::spreadsheet::iface::import_xf::set_fill ( size_t index)
pure virtual

Set the index of the fill record, as returned from the import_fill_style::commit() method.

Parameters
indexindex of the fill record to reference.

◆ set_font()

virtual void orcus::spreadsheet::iface::import_xf::set_font ( size_t index)
pure virtual

Set the index of the font record, as returned from the import_font_style::commit() method.

Parameters
indexindex of the font record to reference.

◆ set_horizontal_alignment()

virtual void orcus::spreadsheet::iface::import_xf::set_horizontal_alignment ( hor_alignment_t align)
pure virtual

Set the horizontal alignment of a style.

Parameters
alignhorizontal alignment of a style.

◆ set_number_format()

virtual void orcus::spreadsheet::iface::import_xf::set_number_format ( size_t index)
pure virtual

Set the index of the number format record, as returned from the import_number_format::commit() method.

Parameters
indexindex of the number format record to reference.

◆ set_protection()

virtual void orcus::spreadsheet::iface::import_xf::set_protection ( size_t index)
pure virtual

Set the index of the cell protection record, as returned from the import_cell_protection::commit() method.

Parameters
indexindex of the cell protection record to reference.

◆ set_shrink_to_fit()

virtual void orcus::spreadsheet::iface::import_xf::set_shrink_to_fit ( bool b)
pure virtual

Specify whether or not to shrink the text within cell until it fits inside the cell.

Parameters
bwhether or not to shrink the text.

◆ set_style_xf()

virtual void orcus::spreadsheet::iface::import_xf::set_style_xf ( size_t index)
pure virtual

Set the index into the cell style record to specify a named cell style it uses as its base format in case the cell has an underlying style applied. This can be used for a direct cell format i.e. when the xf category is xf_category_t::cell or for a cell style format i.e. the xf category is xf_category_t::cell_style. In a cell style format, this can be used to reference a parent style.

Parameters
indexindex into the cell style record it uses as its basis.

◆ set_vertical_alignment()

virtual void orcus::spreadsheet::iface::import_xf::set_vertical_alignment ( ver_alignment_t align)
pure virtual

Set the vertical alignment of a style.

Parameters
alignvertical alignment of a style.

◆ set_wrap_text()

virtual void orcus::spreadsheet::iface::import_xf::set_wrap_text ( bool b)
pure virtual

Specify whether or not to wrap text when the text spills over the cell region.

Parameters
bwhether or not to wrap text when the text spills over the cell region.