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

#include <import_interface.hpp>

Public Member Functions

virtual void set_position (row_t row, col_t col)=0
 
virtual void set_formula (formula_grammar_t grammar, std::string_view formula)=0
 
virtual void set_shared_formula_index (size_t index)=0
 
virtual void set_result_string (std::string_view value)=0
 
virtual void set_result_value (double value)=0
 
virtual void set_result_bool (bool value)=0
 
virtual void set_result_empty ()=0
 
virtual void commit ()=0
 

Detailed Description

Interface for importing the properties of a single formula cell. A formula cell contains a formula expression that can be computed, and optionally a cached result of the last computation performed on the expression.

Member Function Documentation

◆ commit()

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

Commit all the formula data to the specified cell.

◆ set_formula()

virtual void orcus::spreadsheet::iface::import_formula::set_formula ( formula_grammar_t  grammar,
std::string_view  formula 
)
pure virtual

Set formula string to a cell.

Parameters
grammargrammar to use to compile the formula string into tokens.
formulaformula expression to store.

◆ set_position()

virtual void orcus::spreadsheet::iface::import_formula::set_position ( row_t  row,
col_t  col 
)
pure virtual

Set the position of a cell.

Parameters
rowrow position.
colcolumn position.

◆ set_result_bool()

virtual void orcus::spreadsheet::iface::import_formula::set_result_bool ( bool  value)
pure virtual

Set cached result of boolean type.

Parameters
valueboolean value to set as a cached result.

◆ set_result_empty()

virtual void orcus::spreadsheet::iface::import_formula::set_result_empty ( )
pure virtual

Set empty value as a cached result.

◆ set_result_string()

virtual void orcus::spreadsheet::iface::import_formula::set_result_string ( std::string_view  value)
pure virtual

Set cached result of string type.

Parameters
valuestring result value.

◆ set_result_value()

virtual void orcus::spreadsheet::iface::import_formula::set_result_value ( double  value)
pure virtual

Set cached result of numeric type.

Parameters
valuenumeric value to set as a cached result.

◆ set_shared_formula_index()

virtual void orcus::spreadsheet::iface::import_formula::set_shared_formula_index ( size_t  index)
pure virtual

Register the formula stored in a cell as a shared formula to be shared with other cells, if the cell contains a formula string.

If a cell references a shared formula stored in another cell, only specify the index of that shared formula without specifying a formula string of its own. In that case, it is expected that another formula cell registers its formula string for that index.

Parameters
indexshared string index to register the formula with.