import_table

Defined in header: <orcus/spreadsheet/import_interface.hpp>

class import_table

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.

Public Functions

virtual ~import_table()

virtual import_auto_filter *start_auto_filter(const range_t &range)

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

The implementor should initialize the internal buffer to store the auto filter data when this method is called.

Parameters:

range – Filtered range.

Returns:

Pointer to an auto filter interface object, or a nullptr if the implementor doesn’t support it.

virtual void set_identifier(size_t id) = 0

Set an integral identifier unique to the table.

Parameters:

id – identifier associated with the table.

virtual void set_range(const range_t &range) = 0

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

Parameters:

range – cell range associated with the table.

virtual void set_totals_row_count(size_t row_count) = 0

Set the number of totals rows.

Parameters:

row_count – number of totals rows.

virtual void set_name(std::string_view name) = 0

Set the internal name of the table.

Parameters:

name – name of the table.

virtual void set_display_name(std::string_view name) = 0

Set the displayed name of the table.

Parameters:

name – displayed name of the table.

virtual void set_column_count(size_t n) = 0

Set the number of columns the table contains.

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.

Parameters:

n – number of columns in the table.

virtual void set_column_identifier(size_t id) = 0

Set an integral identifier for a column.

Parameters:

id – integral identifier for a column.

virtual void set_column_name(std::string_view name) = 0

Set a name of a column.

Parameters:

name – name of a column.

virtual void set_column_totals_row_label(std::string_view label) = 0

Set the totals row label for a column.

Parameters:

label – row label for a column.

virtual void set_column_totals_row_function(totals_row_function_t func) = 0

Set the totals row function for a column.

Parameters:

func – totals row function for a column.

virtual void commit_column() = 0

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

virtual void set_style_name(std::string_view name) = 0

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

Parameters:

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

virtual void set_style_show_first_column(bool b) = 0

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

Parameters:

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

virtual void set_style_show_last_column(bool b) = 0

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

Parameters:

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

virtual void set_style_show_row_stripes(bool b) = 0

Specify whether or not row stripe formatting is applied.

Parameters:

b – whether or not row stripe formatting is applied.

virtual void set_style_show_column_stripes(bool b) = 0

Specify whether or not column stripe formatting is applied.

Parameters:

b – whether or not column stripe formatting is applied.

virtual void commit() = 0

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