Orcus
Public Member Functions | Friends | List of all members
orcus::spreadsheet::sheet Class Reference

#include <sheet.hpp>

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

Public Member Functions

 sheet (document &doc, sheet_t sheet_index, row_t row_size, col_t col_size)
 
iface::import_sheet_propertiesget_sheet_properties ()
 
iface::import_data_tableget_data_table ()
 
iface::import_tableget_table ()
 
iface::import_auto_filterget_auto_filter ()
 
void set_auto (row_t row, col_t col, const char *p, size_t n)
 
void set_string (row_t row, col_t col, size_t sindex)
 
void set_value (row_t row, col_t col, double value)
 
void set_bool (row_t row, col_t col, bool value)
 
void set_date_time (row_t row, col_t col, int year, int month, int day, int hour, int minute, double second)
 
void set_format (row_t row, col_t col, size_t index)
 
void set_format (row_t row_start, col_t col_start, row_t row_end, col_t col_end, size_t index)
 
void set_formula (row_t row, col_t col, formula_grammar_t grammar, const char *p, size_t n)
 
void set_shared_formula (row_t row, col_t col, formula_grammar_t grammar, size_t sindex, const char *p_formula, size_t n_formula, const char *p_range, size_t n_range)
 
void set_shared_formula (row_t row, col_t col, formula_grammar_t grammar, size_t sindex, const char *p_formula, size_t n_formula)
 
void set_shared_formula (row_t row, col_t col, size_t sindex)
 
void set_formula_result (row_t row, col_t col, double value)
 
void set_formula_result (row_t row, col_t col, const char *p, size_t n)
 
void set_array_formula (row_t, col_t, formula_grammar_t, const char *, size_t, row_t, col_t)
 
void set_array_formula (row_t, col_t, formula_grammar_t, const char *, size_t, const char *, size_t)
 
virtual void write_string (std::ostream &os, row_t row, col_t col) const
 
void set_col_width (col_t col, col_width_t width)
 
col_width_t get_col_width (col_t col, col_t *col_start, col_t *col_end) const
 
void set_col_hidden (col_t col, bool hidden)
 
void set_row_height (row_t row, row_height_t height)
 
row_height_t get_row_height (row_t row, row_t *row_start, row_t *row_end) const
 
void set_row_hidden (row_t row, bool hidden)
 
void set_merge_cell_range (const range_t &range)
 
range_t get_merge_cell_range (row_t row, col_t col) const
 
size_t get_string_identifier (row_t row, col_t col) const
 
auto_filter_tget_auto_filter_data ()
 
const auto_filter_tget_auto_filter_data () const
 
void set_auto_filter_data (auto_filter_t *p)
 
ixion::abs_range_t get_data_range () const
 
sheet_range get_sheet_range (row_t row_start, col_t col_start, row_t row_end, col_t col_end) const
 
row_t row_size () const
 
col_t col_size () const
 
sheet_t get_index () const
 
date_time_t get_date_time (row_t row, col_t col) const
 
void finalize ()
 
void dump_flat (std::ostream &os) const
 
void dump_check (std::ostream &os, const pstring &sheet_name) const
 
void dump_html (std::ostream &os) const
 
void dump_json (std::ostream &os) const
 
void dump_csv (std::ostream &os) const
 
size_t get_cell_format (row_t row, col_t col) const
 

Friends

struct sheet_impl
 

Detailed Description

This class represents a single sheet instance in the internal document model.

Member Function Documentation

◆ get_cell_format()

size_t orcus::spreadsheet::sheet::get_cell_format ( row_t  row,
col_t  col 
) const

Get the cell format ID of specified cell.

◆ get_data_range()

ixion::abs_range_t orcus::spreadsheet::sheet::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.

Returns
smallest range that contains all non-empty cells.

◆ get_merge_cell_range()

range_t orcus::spreadsheet::sheet::get_merge_cell_range ( row_t  row,
col_t  col 
) const

Return the size of a merged cell range.

Parameters
rowrow position of the upper-left cell.
colcolumn position of the upper-left cell.
Returns
merged cell range.

◆ get_sheet_range()

sheet_range orcus::spreadsheet::sheet::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.

Parameters
row_startstart row position (0-based).
col_startstart column position (0-based).
row_endend row position (0-based).
col_endend column position (0-based).
Returns
sheet range object.