document
: public orcus::iface::document_dumper¶Internal document representation used only for testing the filters. It uses ixion’s model_context implementation to store raw cell values.
Public Functions
document
()¶~document
()¶get_styles
()¶get_styles
() const¶get_pivot_collection
()¶get_pivot_collection
() const¶calc_formulas
()¶clear
()¶Clear document content, to make it empty.
dump_flat
(const std::string &outdir) const¶Dump document content to specified output directory.
dump_html
(const std::string &outdir) const¶File name should not contain an extension. The final name will be [filename] + _ + [sheet name] + .html.
filename
: base file name dump_json
(const std::string &outdir) const¶dump_csv
(const std::string &outdir) const¶dump_check
(std::ostream &os) const¶Dump document content to stdout in the special format used for content verification during unit test.
sheet_size
() const¶set_origin_date
(int year, int month, int day)¶get_origin_date
() const¶set_formula_grammar
(formula_grammar_t grammar)¶get_formula_grammar
() const¶get_formula_name_resolver
() const¶get_model_context
()¶get_model_context
() const¶get_config
() const¶set_config
(const document_config &cfg)¶get_string_pool
()¶insert_table
(table_t *p)¶Insert a new table object into the document. The document will take ownership of the inserted object after the call. The object will get inserted only when there is no pre-existing table object of the same name. The object not being inserted will be deleted.
p
: table object to insert. finalize
()¶sheet
¶This class represents a single sheet instance in the internal document model.
Public Functions
~sheet
()¶set_date_time
(row_t row, col_t col, int year, int month, int day, int hour, int minute, double second)¶set_grouped_formula
(const range_t range, ixion::formula_tokens_t tokens)¶set_col_width
(col_t col, col_width_t width)¶get_col_width
(col_t col, col_t *col_start, col_t *col_end) const¶set_row_height
(row_t row, row_height_t height)¶get_row_height
(row_t row, row_t *row_start, row_t *row_end) const¶set_merge_cell_range
(const range_t &range)¶get_merge_cell_range
(row_t row, col_t col) const¶Return the size of a merged cell range.
row
: row position of the upper-left cell. col
: column position of the upper-left cell.get_auto_filter_data
()¶get_auto_filter_data
() const¶set_auto_filter_data
(auto_filter_t *p)¶get_data_range
() const¶Return the smallest range that contains all non-empty cells in this sheet. The top-left corner of the returned range is always column 0 and row 0.
get_sheet_range
(row_t row_start, col_t col_start, row_t row_end, col_t col_end) const¶Return a sheet range object that represents a sub-range within the sheet.
row_start
: start row position (0-based). col_start
: start column position (0-based). row_end
: end row position (0-based). col_end
: end column position (0-based).get_date_time
(row_t row, col_t col) const¶finalize
()¶dump_flat
(std::ostream &os) const¶dump_html
(std::ostream &os) const¶dump_json
(std::ostream &os) const¶dump_csv
(std::ostream &os) const¶import_factory
: public orcus::spreadsheet::iface::import_factory¶Public Functions
~import_factory
()¶get_global_settings
()¶get_styles
()¶get_named_expression
()¶get_reference_resolver
()¶create_pivot_cache_definition
(orcus::spreadsheet::pivot_cache_id_t cache_id)¶Create an interface for pivot cache definition import for a specified cache ID. In case a pivot cache alrady exists for the passed ID, the client app should overwrite the existing cache with a brand-new cache instance.
cache_id
: numeric ID associated with the pivot cache.create_pivot_cache_records
(orcus::spreadsheet::pivot_cache_id_t cache_id)¶Create an interface for pivot cache records import for a specified cache ID.
cache_id
: numeric ID associated with the pivot cache.append_sheet
(sheet_t sheet_index, const char *sheet_name, size_t sheet_name_length)¶Append a sheet with specified sheet position index and name.
sheet_index
: position index of the sheet to be appended. It is 0-based i.e. the first sheet to be appended will have an index value of 0. sheet_name
: pointer to the first character in the buffer where the sheet name is stored. sheet_name_length
: length of the sheet name.get_sheet
(const char *sheet_name, size_t sheet_name_length)¶get_sheet
(sheet_t sheet_index)¶Retrieve sheet instance by specified numerical sheet index.
sheet_index
: sheet indexfinalize
()¶This method is called at the end of import, to give the implementor a chance to perform post-processing if necessary.
set_character_set
(character_set_t charset)¶get_character_set
() const¶