Utilities

Special values

col_width_t orcus::spreadsheet::get_default_column_width()

Get the special column width value that represents the default column width. The value itself is not to be used as an actual width value.

Returns

value that represents the default column width.

row_height_t orcus::spreadsheet::get_default_row_height()

Get the special row height value that represents the default row height. The value itself is not to be used as an actual row height value.

Returns

value that represents the default row height.

Type conversion

totals_row_function_t orcus::spreadsheet::to_totals_row_function_enum(std::string_view s)

Convert a string representation of a totals row function name to its equivalent enum value.

Parameters

s – string value for totals row function name.

Returns

enum value representing the totals row function.

pivot_cache_group_by_t orcus::spreadsheet::to_pivot_cache_group_by_enum(std::string_view s)

Convert a string representation of a pivot cache group-by type to its equivalent enum value.

Parameters

s – string value for pivot cache group-by type.

Returns

enum value representing the pivot cache group-by type.

error_value_t orcus::spreadsheet::to_error_value_enum(std::string_view s)

Convert a string representation of a error value to its equivalent enum value.

Parameters

s – error value string.

Returns

enum value representing the error value.

color_rgb_t orcus::spreadsheet::to_color_rgb(std::string_view s)

Convert a string representation of a RGB value to an equivalent struct value. The string representation is expected to be a 6 digit hexadecimal value string that may or may not be prefixed with a ‘#’.

Parameters

s – string representation of the RGB value.

Returns

struct value representing an RGB value.

address_t orcus::spreadsheet::to_rc_address(const src_address_t &r)

Convert a 3-dimensional cell address to a 2-dimensional counterpart by dropping the sheet index.

range_t orcus::spreadsheet::to_rc_range(const src_range_t &r)

Convert a 3-dimensional cell range address to a 2-dimensional counterpart by dropping the sheet indices.