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

#include <import_interface_pivot.hpp>

Public Member Functions

virtual void link_base_to_group_items (size_t group_item_index)=0
 
virtual void set_field_item_string (std::string_view value)=0
 
virtual void set_field_item_numeric (double v)=0
 
virtual void commit_field_item ()=0
 
virtual void set_range_grouping_type (pivot_cache_group_by_t group_by)=0
 
virtual void set_range_auto_start (bool b)=0
 
virtual void set_range_auto_end (bool b)=0
 
virtual void set_range_start_number (double v)=0
 
virtual void set_range_end_number (double v)=0
 
virtual void set_range_start_date (const date_time_t &dt)=0
 
virtual void set_range_end_date (const date_time_t &dt)=0
 
virtual void set_range_interval (double v)=0
 
virtual void commit ()=0
 

Detailed Description

Interface for importing group field settings in a pivot cache.

Member Function Documentation

◆ commit()

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

Commit the current field group data to the parent field.

◆ commit_field_item()

virtual void orcus::spreadsheet::iface::import_pivot_cache_field_group::commit_field_item ( )
pure virtual

Commit the current internal field item buffer to the group.

◆ link_base_to_group_items()

virtual void orcus::spreadsheet::iface::import_pivot_cache_field_group::link_base_to_group_items ( size_t  group_item_index)
pure virtual

Establish a linkage between a base item to a group item.

The index to corresponding base item is inferred from the order of this method being called; the first call to this method implies a base item index of 0, the second call implies an index of 1, and so on.

This method is called only for a non-range group field; a group field where parent-to-child item relationships are manually defined.

Parameters
group_item_index0-based index for the group item.

◆ set_field_item_numeric()

virtual void orcus::spreadsheet::iface::import_pivot_cache_field_group::set_field_item_numeric ( double  v)
pure virtual

Set an individual field item value that is of numeric type to the current internal buffer.

This method can be called either for a range group field or a non-range one.

Parameters
vfield item value.

◆ set_field_item_string()

virtual void orcus::spreadsheet::iface::import_pivot_cache_field_group::set_field_item_string ( std::string_view  value)
pure virtual

Set an individual field item value that is of string type to the current internal buffer.

This method can be called either for a range group field or a non-range one.

Parameters
valuefield item value.

◆ set_range_auto_end()

virtual void orcus::spreadsheet::iface::import_pivot_cache_field_group::set_range_auto_end ( bool  b)
pure virtual

Set whether the current range group field has an automatic end position.

The current group field implicitly becomes a range group field when this method is called.

Parameters
bwhether or not the current range group field has an automatic end position.

◆ set_range_auto_start()

virtual void orcus::spreadsheet::iface::import_pivot_cache_field_group::set_range_auto_start ( bool  b)
pure virtual

Set whether the current range group field has an automatic start position.

The current group field implicitly becomes a range group field when this method is called.

Parameters
bwhether or not the current range group field has an automatic start position.

◆ set_range_end_date()

virtual void orcus::spreadsheet::iface::import_pivot_cache_field_group::set_range_end_date ( const date_time_t dt)
pure virtual

Set the end date of the current range group field.

The current group field implicitly becomes a range group field when this method is called.

Parameters
dtend date of the current range group field.

◆ set_range_end_number()

virtual void orcus::spreadsheet::iface::import_pivot_cache_field_group::set_range_end_number ( double  v)
pure virtual

Set the end number of the current range group field.

The current group field implicitly becomes a range group field when this method is called.

Parameters
vend number of the current range group field.

◆ set_range_grouping_type()

virtual void orcus::spreadsheet::iface::import_pivot_cache_field_group::set_range_grouping_type ( pivot_cache_group_by_t  group_by)
pure virtual

Set the range grouping type.

The current group field implicitly becomes a range group field when this method is called.

Parameters
group_bytype of range grouping.

◆ set_range_interval()

virtual void orcus::spreadsheet::iface::import_pivot_cache_field_group::set_range_interval ( double  v)
pure virtual

Set the interval of the current range group field. If the current range is a date range, the value represents the number of days.

Parameters
vinterval of the current range group field.

◆ set_range_start_date()

virtual void orcus::spreadsheet::iface::import_pivot_cache_field_group::set_range_start_date ( const date_time_t dt)
pure virtual

Set the start date of the current range group field.

The current group field implicitly becomes a range group field when this method is called.

Parameters
dtstart date of the current range group field.

◆ set_range_start_number()

virtual void orcus::spreadsheet::iface::import_pivot_cache_field_group::set_range_start_number ( double  v)
pure virtual

Set the start number of the current range group field.

The current group field implicitly becomes a range group field when this method is called.

Parameters
vstart number of the current range group field.