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

#include <import_interface_pivot_table_def.hpp>

Public Member Functions

virtual void set_repeat_items (std::size_t repeat)=0
virtual void set_item_type (pivot_field_item_t type)=0
virtual void set_data_item (std::size_t index)=0
virtual void append_index (std::size_t index)=0
virtual void commit ()=0

Detailed Description

Interface for importing a single row or column item.

A single row or column item consists of a series of labels displayed in a pivot table output. The labels are represented by their respective indexes into the corresponding shared items in pivot cache definition. The number of indexes stored in one item is equal to the number of the corresponding row or column fields.

Member Function Documentation

◆ append_index()

virtual void orcus::spreadsheet::iface::import_pivot_rc_item::append_index ( std::size_t index)
pure virtual

Append the index of an item of a field.

Parameters
indexIndex of a label.

◆ set_data_item()

virtual void orcus::spreadsheet::iface::import_pivot_rc_item::set_data_item ( std::size_t index)
pure virtual

Set the index of a data item in a data field with multiple data items.

Parameters
indexIndex of a referenced data item.

◆ set_item_type()

virtual void orcus::spreadsheet::iface::import_pivot_rc_item::set_item_type ( pivot_field_item_t type)
pure virtual

Set the type of items in the current row or column of items.

Parameters
typeItem type in the current row or column of items.

◆ set_repeat_items()

virtual void orcus::spreadsheet::iface::import_pivot_rc_item::set_repeat_items ( std::size_t repeat)
pure virtual

Set the number of items to be repeated from the previous row or column of items. This typically corresponds with the number of empty cells to fill before the first non-empty item label to appear.

Parameters
repeatNumber of items to repeat from the previous row or column, which typically is the number of empty cells to fill.