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

#include <import_interface.hpp>

Public Member Functions

virtual void set_column_width (col_t col, col_t col_span, double width, orcus::length_unit_t unit)=0
 
virtual void set_column_hidden (col_t col, col_t col_span, bool hidden)=0
 
virtual void set_row_height (row_t row, double height, orcus::length_unit_t unit)=0
 
virtual void set_row_hidden (row_t row, bool hidden)=0
 
virtual void set_merge_cell_range (const range_t &range)=0
 

Detailed Description

Interface for importing sheet properties. Sheet properties include:

These properties are independent of the cell contents of a sheet.

Member Function Documentation

◆ set_column_hidden()

virtual void orcus::spreadsheet::iface::import_sheet_properties::set_column_hidden ( col_t  col,
col_t  col_span,
bool  hidden 
)
pure virtual

Set a column hidden flag to one or more columns.

Parameters
col0-based position of the first column.
col_spannumber of contiguous columns to apply the flag to.
hiddenflag indicating whether or not the columns are hidden.

◆ set_column_width()

virtual void orcus::spreadsheet::iface::import_sheet_properties::set_column_width ( col_t  col,
col_t  col_span,
double  width,
orcus::length_unit_t  unit 
)
pure virtual

Set a column width to one or more columns.

Parameters
col0-based position of the first column.
col_spannumber of contiguous columns to apply the width to.
widthcolumn width to apply.
unitunit of measurement to use for the width value.

◆ set_merge_cell_range()

virtual void orcus::spreadsheet::iface::import_sheet_properties::set_merge_cell_range ( const range_t range)
pure virtual

Set a merged cell range.

Parameters
rangestructure containing the top-left and bottom-right positions of a merged cell range.

◆ set_row_height()

virtual void orcus::spreadsheet::iface::import_sheet_properties::set_row_height ( row_t  row,
double  height,
orcus::length_unit_t  unit 
)
pure virtual

Set a row height to specified row.

Parameters
row0-based position of a row.
heightnew row height value to set.
unitunit of the new row height value.
Todo:
Convert this to take a raw span.

◆ set_row_hidden()

virtual void orcus::spreadsheet::iface::import_sheet_properties::set_row_hidden ( row_t  row,
bool  hidden 
)
pure virtual

Set a row hidden flag to a specified row.

Parameters
row0-based position of a row.
hiddenflag indicating whether or not the row is hidden.
Todo:
Convert this to take a raw span.