Orcus
Public Member Functions | List of all members
orcus::spreadsheet::iface::import_table Class Referenceabstract

#include <import_interface.hpp>

Public Member Functions

virtual import_auto_filterget_auto_filter ()
 
virtual void set_identifier (size_t id)=0
 
virtual void set_range (const range_t &range)=0
 
virtual void set_totals_row_count (size_t row_count)=0
 
virtual void set_name (std::string_view name)=0
 
virtual void set_display_name (std::string_view name)=0
 
virtual void set_column_count (size_t n)=0
 
virtual void set_column_identifier (size_t id)=0
 
virtual void set_column_name (std::string_view name)=0
 
virtual void set_column_totals_row_label (std::string_view label)=0
 
virtual void set_column_totals_row_function (totals_row_function_t func)=0
 
virtual void commit_column ()=0
 
virtual void set_style_name (std::string_view name)=0
 
virtual void set_style_show_first_column (bool b)=0
 
virtual void set_style_show_last_column (bool b)=0
 
virtual void set_style_show_row_stripes (bool b)=0
 
virtual void set_style_show_column_stripes (bool b)=0
 
virtual void commit ()=0
 

Detailed Description

Interface for table. A table is a range of cells within a sheet that consists of one or more data columns with a header row that contains their labels.

Member Function Documentation

◆ commit()

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

Push the data stored in the table buffer into the document store.

◆ commit_column()

virtual void orcus::spreadsheet::iface::import_table::commit_column ( )
pure virtual

Push and append the column data stored in the current column data buffer into the table buffer.

◆ get_auto_filter()

virtual import_auto_filter* orcus::spreadsheet::iface::import_table::get_auto_filter ( )
virtual

Get an optional interface for importing auto filter data stored as part of a table.

The implementor should initialize the internal state of the temporary auto filter object when this method is called.

Returns
pointer to the auto filter interface object, or a nullptr if the implementor doesn't support it.

◆ set_column_count()

virtual void orcus::spreadsheet::iface::import_table::set_column_count ( size_t  n)
pure virtual

Set the number of columns the table contains.

Parameters
nnumber of columns in the table.
Note
This method gets called before the column data gets imported. The implementor can use this call to initialize the buffer for storing the column data.

◆ set_column_identifier()

virtual void orcus::spreadsheet::iface::import_table::set_column_identifier ( size_t  id)
pure virtual

Set an integral identifier for a column.

Parameters
idintegral identifier for a column.

◆ set_column_name()

virtual void orcus::spreadsheet::iface::import_table::set_column_name ( std::string_view  name)
pure virtual

Set a name of a column.

Parameters
namename of a column.

◆ set_column_totals_row_function()

virtual void orcus::spreadsheet::iface::import_table::set_column_totals_row_function ( totals_row_function_t  func)
pure virtual

Set the totals row function for a column.

Parameters
functotals row function for a column.

◆ set_column_totals_row_label()

virtual void orcus::spreadsheet::iface::import_table::set_column_totals_row_label ( std::string_view  label)
pure virtual

Set the totals row label for a column.

Parameters
labelrow label for a column.

◆ set_display_name()

virtual void orcus::spreadsheet::iface::import_table::set_display_name ( std::string_view  name)
pure virtual

Set the displayed name of the table.

Parameters
namedisplayed name of the table.

◆ set_identifier()

virtual void orcus::spreadsheet::iface::import_table::set_identifier ( size_t  id)
pure virtual

Set an integral identifier unique to the table.

Parameters
ididentifier associated with the table.

◆ set_name()

virtual void orcus::spreadsheet::iface::import_table::set_name ( std::string_view  name)
pure virtual

Set the internal name of the table.

Parameters
namename of the table.

◆ set_range()

virtual void orcus::spreadsheet::iface::import_table::set_range ( const range_t range)
pure virtual

Set a 2-dimensional cell range associated with the table.

Parameters
rangecell range associated with the table.

◆ set_style_name()

virtual void orcus::spreadsheet::iface::import_table::set_style_name ( std::string_view  name)
pure virtual

Set the name of a style to apply to the table.

Parameters
namename of a style to apply to the table.

◆ set_style_show_column_stripes()

virtual void orcus::spreadsheet::iface::import_table::set_style_show_column_stripes ( bool  b)
pure virtual

Specify whether or not column stripe formatting is applied.

Parameters
bwhether or not column stripe formatting is applied.

◆ set_style_show_first_column()

virtual void orcus::spreadsheet::iface::import_table::set_style_show_first_column ( bool  b)
pure virtual

Specify whether or not the first column in the table should have the style applied.

Parameters
bwhether or not the first column in the table should have the style applied.

◆ set_style_show_last_column()

virtual void orcus::spreadsheet::iface::import_table::set_style_show_last_column ( bool  b)
pure virtual

Specify whether or not the last column in the table should have the style applied.

Parameters
bwhether or not the last column in the table should have the style applied.

◆ set_style_show_row_stripes()

virtual void orcus::spreadsheet::iface::import_table::set_style_show_row_stripes ( bool  b)
pure virtual

Specify whether or not row stripe formatting is applied.

Parameters
bwhether or not row stripe formatting is applied.

◆ set_totals_row_count()

virtual void orcus::spreadsheet::iface::import_table::set_totals_row_count ( size_t  row_count)
pure virtual

Set the number of totals rows.

Parameters
row_countnumber of totals rows.