import_sheet_properties

Defined in header: <orcus/spreadsheet/import_interface.hpp>

class import_sheet_properties

Interface for importing sheet properties. Sheet properties include:

• column widths and row heights,

• hidden flags for columns and rows, and

• merged cell ranges.

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

Public Functions

virtual ~import_sheet_properties()

virtual void set_column_width(col_t col, col_t col_span, double width, orcus::length_unit_t unit) = 0

Set a column width to one or more columns.

Parameters:

• col – 0-based position of the first column.

• col_span – number of contiguous columns to apply the width to.

• width – column width to apply.

• unit – unit of measurement to use for the width value.

virtual void set_column_hidden(col_t col, col_t col_span, bool hidden) = 0

Set a column hidden flag to one or more columns.

Parameters:

• col – 0-based position of the first column.

• col_span – number of contiguous columns to apply the flag to.

• hidden – flag indicating whether or not the columns are hidden.

virtual void set_row_height(row_t row, row_t row_span, double height, orcus::length_unit_t unit) = 0

Set a row height to specified row.

Todo:

Convert this to take a raw span.

Parameters:

• row – 0-based position of a row.

• row_span – number of contiguous rows to apply the height to.

• height – new row height value to set.

• unit – unit of the new row height value.

virtual void set_row_hidden(row_t row, row_t row_span, bool hidden) = 0

Set a row hidden flag to a specified row.

Todo:

Convert this to take a raw span.

Parameters:

• row – 0-based position of a row.

• row_span – number of contiguous rows to apply the flag to.

• hidden – flag indicating whether or not the row is hidden.

virtual void set_merge_cell_range(const range_t &range) = 0

Set a merged cell range.

Parameters:

range – structure containing the top-left and bottom-right positions of a merged cell range.