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

#include <import_interface.hpp>

Public Member Functions

virtual void set_origin_date (int year, int month, int day)=0
 
virtual void set_default_formula_grammar (formula_grammar_t grammar)=0
 
virtual formula_grammar_t get_default_formula_grammar () const =0
 
virtual void set_character_set (character_set_t charset)=0
 

Detailed Description

Interface for specifying global settings that may affect how the implementor should process certain values and properties.

Member Function Documentation

◆ get_default_formula_grammar()

virtual formula_grammar_t orcus::spreadsheet::iface::import_global_settings::get_default_formula_grammar ( ) const
pure virtual

Get current global formula grammar. The import filter may use this method to query the current global formula grammar.

Returns
current default formula grammar.

◆ set_character_set()

virtual void orcus::spreadsheet::iface::import_global_settings::set_character_set ( character_set_t  charset)
pure virtual

Set the character set to use when parsing encoded string values.

Parameters
charsetcharacter set to use when parsing encoded string values.

◆ set_default_formula_grammar()

virtual void orcus::spreadsheet::iface::import_global_settings::set_default_formula_grammar ( formula_grammar_t  grammar)
pure virtual

Set the formula grammar to be used globally when parsing formulas if the grammar is not specified. This grammar should also be used when parsing range strings associated with shared formula ranges, array formula ranges, autofilter ranges etc.

Note that the import filter may specify what formula grammar to use locally when importing formula expressions for cells via import_formula::set_formula(), in which case the implementor should honor that one instead.

Parameters
grammardefault formula grammar to use globally unless otherwise specified.

◆ set_origin_date()

virtual void orcus::spreadsheet::iface::import_global_settings::set_origin_date ( int  year,
int  month,
int  day 
)
pure virtual

Set the date that is to be represented by a value of 0. All date values should be represented relative to this date. This may affect, for instance, values imported via import_sheet::set_date_time().

Parameters
year1-based value representing year
month1-based value representing month, varying from 1 through 12.
day1-based value representing day, varying from 1 through 31.