import_cond_format_condition
Defined in header: <orcus/spreadsheet/import_interface_cond_format.hpp>
-
class import_cond_format_condition
Interface for importing a condition rule of a conditional format. A condition rule applies a cell format when the condition expressed by its operator and operands is met.
Public Functions
-
virtual ~import_cond_format_condition()
-
virtual void set_operator(cond_format_operator_t op) = 0
Set the operator of the condition.
- Parameters:
op – Operator of the condition.
-
virtual void set_dxf_id(std::size_t dxf) = 0
Set the ID of the differential cell format (dxf) to apply when the condition is met.
- Parameters:
dxf – ID of the differential cell format.
-
virtual void set_rank(std::string_view rank) = 0
Set the rank value. This is only applicable when the operator is one of
top_n,bottom_n,top_percentorbottom_percent.- Parameters:
rank – Rank value.
-
virtual void set_text(std::string_view text) = 0
Set the text value. This is only applicable when the operator is one of the text operators such as
contains,not_contains,begins_withandends_with.- Parameters:
text – Text value.
-
virtual void set_std_dev(std::string_view sd) = 0
Set the number of standard deviations. This is only applicable when the operator is one of the average operators.
- Parameters:
sd – Number of standard deviations.
-
virtual import_cond_format_value *start_value() = 0
Start importing a new operand of the condition.
The implementor should initialize the internal buffer to store the value data when this method is called.
Note
Note that the import_cond_format_condition implementer must return a non-null pointer.
- Returns:
Interface for importing the new value.
-
virtual void commit() = 0
Commit the condition rule to the parent conditional format.
-
virtual ~import_cond_format_condition()