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

#include <import_interface.hpp>

Inheritance diagram for orcus::spreadsheet::iface::import_sheet:
orcus::spreadsheet::sheet

Public Member Functions

virtual import_sheet_propertiesget_sheet_properties ()
 
virtual import_data_tableget_data_table ()
 
virtual import_auto_filterget_auto_filter ()
 
virtual import_tableget_table ()
 
virtual import_conditional_formatget_conditional_format ()
 
virtual void set_auto (orcus::spreadsheet::row_t row, orcus::spreadsheet::col_t col, const char *p, size_t n)=0
 
virtual void set_string (orcus::spreadsheet::row_t row, orcus::spreadsheet::col_t col, size_t sindex)=0
 
virtual void set_value (orcus::spreadsheet::row_t row, orcus::spreadsheet::col_t col, double value)=0
 
virtual void set_bool (orcus::spreadsheet::row_t row, orcus::spreadsheet::col_t col, bool value)=0
 
virtual void set_date_time (orcus::spreadsheet::row_t row, orcus::spreadsheet::col_t col, int year, int month, int day, int hour, int minute, double second)=0
 
virtual void set_format (orcus::spreadsheet::row_t row, orcus::spreadsheet::col_t col, size_t xf_index)=0
 
virtual void set_format (orcus::spreadsheet::row_t row_start, orcus::spreadsheet::col_t col_start, orcus::spreadsheet::row_t row_end, orcus::spreadsheet::col_t col_end, size_t xf_index)=0
 
virtual void set_formula (orcus::spreadsheet::row_t row, orcus::spreadsheet::col_t col, orcus::spreadsheet::formula_grammar_t grammar, const char *p, size_t n)=0
 
virtual void set_shared_formula (orcus::spreadsheet::row_t row, orcus::spreadsheet::col_t col, orcus::spreadsheet::formula_grammar_t grammar, size_t sindex, const char *p_formula, size_t n_formula, const char *p_range, size_t n_range)=0
 
virtual void set_shared_formula (orcus::spreadsheet::row_t row, orcus::spreadsheet::col_t col, orcus::spreadsheet::formula_grammar_t grammar, size_t sindex, const char *p_formula, size_t n_formula)=0
 
virtual void set_shared_formula (orcus::spreadsheet::row_t row, orcus::spreadsheet::col_t col, size_t sindex)=0
 
virtual void set_formula_result (orcus::spreadsheet::row_t row, orcus::spreadsheet::col_t col, double value)=0
 
virtual void set_formula_result (orcus::spreadsheet::row_t row, orcus::spreadsheet::col_t col, const char *p, size_t n)=0
 
virtual void set_array_formula (orcus::spreadsheet::row_t row, orcus::spreadsheet::col_t col, orcus::spreadsheet::formula_grammar_t grammar, const char *p, size_t n, orcus::spreadsheet::row_t array_rows, orcus::spreadsheet::col_t array_cols)=0
 
virtual void set_array_formula (orcus::spreadsheet::row_t row, orcus::spreadsheet::col_t col, orcus::spreadsheet::formula_grammar_t grammar, const char *p, size_t n, const char *p_range, size_t n_range)=0
 

Detailed Description

Interface for sheet.

Member Function Documentation

virtual import_auto_filter* orcus::spreadsheet::iface::import_sheet::get_auto_filter ( )
virtual

Get an interface for importing auto filter ranges.

The implementor should also initialize the internal state of the temporary auto filter object when this method is called.

Returns
pointer to the auto filter interface object.

Reimplemented in orcus::spreadsheet::sheet.

virtual import_conditional_format* orcus::spreadsheet::iface::import_sheet::get_conditional_format ( )
virtual

get an interface for importing conditional formats. The implementer is responsible for managing the life cycle of the returned interface object.

Returns
pointer to the conditional format interface object, or NULL if the implementer doesn't support importing conditional formats.
virtual import_data_table* orcus::spreadsheet::iface::import_sheet::get_data_table ( )
virtual

Get an interface for importing data tables. Note that the implementer may decide not to support this feature in which case this method returns NULL. The implementer is responsible for managing the life cycle of the returned interface object.

The implementor should also initialize the internal state of the temporary data table object when this method is called.

Returns
pointer to the data table interface object.

Reimplemented in orcus::spreadsheet::sheet.

virtual import_table* orcus::spreadsheet::iface::import_sheet::get_table ( )
virtual

Get an interface for importing tables. The implementer is responsible for managing the life cycle of the returned interface object.

The implementor should also initialize the internal state of the temporary table object when this method is called.

Returns
pointer to the table interface object, or NULL if the implementer doesn't support importing of tables.

Reimplemented in orcus::spreadsheet::sheet.

virtual void orcus::spreadsheet::iface::import_sheet::set_array_formula ( orcus::spreadsheet::row_t  row,
orcus::spreadsheet::col_t  col,
orcus::spreadsheet::formula_grammar_t  grammar,
const char *  p,
size_t  n,
orcus::spreadsheet::row_t  array_rows,
orcus::spreadsheet::col_t  array_cols 
)
pure virtual

Set a array formula to the specified cells. The formula covers an area specified by array_rows and array_cols beginning from the base cell.

Parameters
rowrow ID
colcolumn ID
grammargrammar used in the formula expression
ppointer to the first character of the raw formula expression string.
nsize of the raw formula expression string
array_rowsnumber of rows the array formula covers
array_colsnumber of columns the array formula covers

Implemented in orcus::spreadsheet::sheet.

virtual void orcus::spreadsheet::iface::import_sheet::set_array_formula ( orcus::spreadsheet::row_t  row,
orcus::spreadsheet::col_t  col,
orcus::spreadsheet::formula_grammar_t  grammar,
const char *  p,
size_t  n,
const char *  p_range,
size_t  n_range 
)
pure virtual

Set a array formula to the specified cells. The formula covers an area specified by the range string.

Parameters
rowrow ID
colcolumn ID
grammargrammar used in the formula expression
ppointer to the first character of the raw formula expression string.
nsize of the raw formula expression string
p_rangepointer to the first character of the range string
n_rangeisze of the range string

Implemented in orcus::spreadsheet::sheet.

virtual void orcus::spreadsheet::iface::import_sheet::set_auto ( orcus::spreadsheet::row_t  row,
orcus::spreadsheet::col_t  col,
const char *  p,
size_t  n 
)
pure virtual

Set raw string value to a cell and have the implementation auto-recognize its data type.

Parameters
rowrow ID
colcolumn ID
ppointer to the first character of the raw string value.
nsize of the raw string value.

Implemented in orcus::spreadsheet::sheet.

virtual void orcus::spreadsheet::iface::import_sheet::set_bool ( orcus::spreadsheet::row_t  row,
orcus::spreadsheet::col_t  col,
bool  value 
)
pure virtual

Set a boolean value to a cell.

Parameters
rowrow ID
colcol ID
valueboolean value being assigned to the cell

Implemented in orcus::spreadsheet::sheet.

virtual void orcus::spreadsheet::iface::import_sheet::set_date_time ( orcus::spreadsheet::row_t  row,
orcus::spreadsheet::col_t  col,
int  year,
int  month,
int  day,
int  hour,
int  minute,
double  second 
)
pure virtual

Set date and time value to a cell.

Parameters
rowrow ID
colcolumn ID

Implemented in orcus::spreadsheet::sheet.

virtual void orcus::spreadsheet::iface::import_sheet::set_format ( orcus::spreadsheet::row_t  row,
orcus::spreadsheet::col_t  col,
size_t  xf_index 
)
pure virtual

Set cell format to specified cell. The cell format is referred to by the xf (cell format) index in the styles table.

Parameters
rowrow ID
colcolumn ID
index0-based xf (cell format) index

Implemented in orcus::spreadsheet::sheet.

virtual void orcus::spreadsheet::iface::import_sheet::set_format ( orcus::spreadsheet::row_t  row_start,
orcus::spreadsheet::col_t  col_start,
orcus::spreadsheet::row_t  row_end,
orcus::spreadsheet::col_t  col_end,
size_t  xf_index 
)
pure virtual

Set cell format to specified cell range. The cell format is referred to by the xf (cell format) index in the styles table.

Parameters
row_startstart row ID
col_startstart column ID
row_endend row ID
col_endend column ID
index0-based xf (cell format) index

Implemented in orcus::spreadsheet::sheet.

virtual void orcus::spreadsheet::iface::import_sheet::set_formula ( orcus::spreadsheet::row_t  row,
orcus::spreadsheet::col_t  col,
orcus::spreadsheet::formula_grammar_t  grammar,
const char *  p,
size_t  n 
)
pure virtual

Set normal, non-shared formula expression to specified cell.

Parameters
rowrow ID
colcolumn ID
grammargrammar used in the formula expression
ppointer to the first character of the raw formula expression string.
nsize of the raw formula expression string.

Implemented in orcus::spreadsheet::sheet.

virtual void orcus::spreadsheet::iface::import_sheet::set_shared_formula ( orcus::spreadsheet::row_t  row,
orcus::spreadsheet::col_t  col,
orcus::spreadsheet::formula_grammar_t  grammar,
size_t  sindex,
const char *  p_formula,
size_t  n_formula,
const char *  p_range,
size_t  n_range 
)
pure virtual

Set shared formula expression to specified cell. This call also registers the formula expression to a common formula expression pool to allow it to be looked up by the specified index later.

Parameters
rowrow ID
colcolumn ID
grammargrammar used in the formula expression
sindexshared formula index (0-based)
p_formulapointer to the first character of the raw formula expression string.
n_formulasize of the raw formula expression string.
p_rangepointer to the first character of the range string
n_rangesize of the raw range string

Implemented in orcus::spreadsheet::sheet.

virtual void orcus::spreadsheet::iface::import_sheet::set_shared_formula ( orcus::spreadsheet::row_t  row,
orcus::spreadsheet::col_t  col,
orcus::spreadsheet::formula_grammar_t  grammar,
size_t  sindex,
const char *  p_formula,
size_t  n_formula 
)
pure virtual

Set shared formula expression to specified cell. This call also registers the formula expression to a common formula expression pool to allow it to be looked up by the specified index later.

Parameters
rowrow ID
colcolumn ID
grammargrammar used in the formula expression
sindexshared formula index (0-based)
p_formulapointer to the first character of the raw formula expression string.
n_formulasize of the raw formula expression string.

Implemented in orcus::spreadsheet::sheet.

virtual void orcus::spreadsheet::iface::import_sheet::set_shared_formula ( orcus::spreadsheet::row_t  row,
orcus::spreadsheet::col_t  col,
size_t  sindex 
)
pure virtual

Set shared formula to specified cell by shared formula index. The formula expression itself associated with the index must be defined.

Parameters
rowrow ID
colcolumn ID
grammargrammar used in the formula expression
sindexshared formula index (0-based)
ppointer to the first character of the raw formula expression string.
nsize of the raw formula expression string.

Implemented in orcus::spreadsheet::sheet.

virtual void orcus::spreadsheet::iface::import_sheet::set_string ( orcus::spreadsheet::row_t  row,
orcus::spreadsheet::col_t  col,
size_t  sindex 
)
pure virtual

Set string value to a cell.

Parameters
rowrow ID
colcolumn ID
sindex0-based string index in the shared string table.

Implemented in orcus::spreadsheet::sheet.

virtual void orcus::spreadsheet::iface::import_sheet::set_value ( orcus::spreadsheet::row_t  row,
orcus::spreadsheet::col_t  col,
double  value 
)
pure virtual

Set numerical value to a cell.

Parameters
rowrow ID
colcolumn ID
valuevalue being assigned to the cell.

Implemented in orcus::spreadsheet::sheet.