Orcus
Public Member Functions | List of all members
orcus::spreadsheet::iface::import_conditional_format Class Referenceabstract

#include <import_interface.hpp>

Public Member Functions

virtual void set_color (color_elem_t alpha, color_elem_t red, color_elem_t green, color_elem_t blue)=0
 
virtual void set_formula (const char *p, size_t n)=0
 
virtual void set_condition_type (orcus::spreadsheet::condition_type_t type)=0
 
virtual void set_date (orcus::spreadsheet::condition_date_t date)=0
 
virtual void commit_condition ()=0
 
virtual void set_icon_name (const char *p, size_t n)=0
 
virtual void set_databar_gradient (bool gradient)=0
 
virtual void set_databar_axis (orcus::spreadsheet::databar_axis_t axis)=0
 
virtual void set_databar_color_positive (color_elem_t alpha, color_elem_t red, color_elem_t green, color_elem_t blue)=0
 
virtual void set_databar_color_negative (color_elem_t alpha, color_elem_t red, color_elem_t green, color_elem_t blue)=0
 
virtual void set_min_databar_length (double length)=0
 
virtual void set_max_databar_length (double length)=0
 
virtual void set_show_value (bool show)=0
 
virtual void set_iconset_reverse (bool reverse)=0
 
virtual void set_xf_id (size_t xf)=0
 
virtual void set_operator (orcus::spreadsheet::condition_operator_t condition_type)=0
 
virtual void set_type (orcus::spreadsheet::conditional_format_t type)=0
 
virtual void commit_entry ()=0
 
virtual void set_range (const char *p, size_t n)=0
 
virtual void set_range (orcus::spreadsheet::row_t row_start, orcus::spreadsheet::col_t col_start, orcus::spreadsheet::row_t row_end, orcus::spreadsheet::col_t col_end)=0
 
virtual void commit_format ()=0
 

Detailed Description

This is an optional interface to import conditional formatting.

A conditional format consists of:

Each entry consists of:

Each condition consists of:

Member Function Documentation

virtual void orcus::spreadsheet::iface::import_conditional_format::commit_condition ( )
pure virtual

commits the current condition to the current entry.

virtual void orcus::spreadsheet::iface::import_conditional_format::set_color ( color_elem_t  alpha,
color_elem_t  red,
color_elem_t  green,
color_elem_t  blue 
)
pure virtual

Sets the color of the current condition. only valid for type == databar or type == colorscale.

virtual void orcus::spreadsheet::iface::import_conditional_format::set_condition_type ( orcus::spreadsheet::condition_type_t  type)
pure virtual

Sets the type for the formula, value or string of the current condition. Only valid for type = iconset, databar or colorscale.

virtual void orcus::spreadsheet::iface::import_conditional_format::set_databar_axis ( orcus::spreadsheet::databar_axis_t  axis)
pure virtual

Position of the 0 axis in the current entry. only valid for type == databar.

virtual void orcus::spreadsheet::iface::import_conditional_format::set_databar_color_negative ( color_elem_t  alpha,
color_elem_t  red,
color_elem_t  green,
color_elem_t  blue 
)
pure virtual

Databar color for negative values. only valid for type == databar.

virtual void orcus::spreadsheet::iface::import_conditional_format::set_databar_color_positive ( color_elem_t  alpha,
color_elem_t  red,
color_elem_t  green,
color_elem_t  blue 
)
pure virtual

Databar color for positive values. only valid for type == databar.

virtual void orcus::spreadsheet::iface::import_conditional_format::set_databar_gradient ( bool  gradient)
pure virtual

Use a gradient for the current entry. only valid for type == databar

virtual void orcus::spreadsheet::iface::import_conditional_format::set_date ( orcus::spreadsheet::condition_date_t  date)
pure virtual

Only valid for type = date.

virtual void orcus::spreadsheet::iface::import_conditional_format::set_formula ( const char *  p,
size_t  n 
)
pure virtual

Sets the formula, value or string of the current condition.

virtual void orcus::spreadsheet::iface::import_conditional_format::set_icon_name ( const char *  p,
size_t  n 
)
pure virtual

Name of the icons to use in the current entry. only valid for type = iconset

virtual void orcus::spreadsheet::iface::import_conditional_format::set_iconset_reverse ( bool  reverse)
pure virtual

Use the icons in reverse order. only valid for type == iconset.

virtual void orcus::spreadsheet::iface::import_conditional_format::set_max_databar_length ( double  length)
pure virtual

Sets the maximum length for a databar. only valid for type == databar.

virtual void orcus::spreadsheet::iface::import_conditional_format::set_min_databar_length ( double  length)
pure virtual

Sets the minimum length for a databar. only valid for type == databar.

virtual void orcus::spreadsheet::iface::import_conditional_format::set_operator ( orcus::spreadsheet::condition_operator_t  condition_type)
pure virtual

Sets the current operation used for the current entry. only valid for type == condition

virtual void orcus::spreadsheet::iface::import_conditional_format::set_show_value ( bool  show)
pure virtual

Don't show the value in the cell. only valid for type = databar, iconset, colorscale.

virtual void orcus::spreadsheet::iface::import_conditional_format::set_xf_id ( size_t  xf)
pure virtual

TODO: In OOXML the style is stored as dxf and in ODF as named style.