LibreOffice Module sc (master): oox::xls::CondFormatRuleModel Struct Reference

LibreOffice Module sc (master) 1

Model for a single rule in a conditional formatting. More...

#include <condformatbuffer.hxx>

Public Types
typedef ::std::vector< ApiTokenSequence >	ApiTokenSequenceVector

Public Member Functions
	CondFormatRuleModel ()
	In average rules: True = include average, false = exclude. More...

void	setBiffOperator (sal_Int32 nOperator)
	Sets the passed BIFF operator for condition type cellIs. More...

void	setBiff12TextType (sal_Int32 nOperator)
	Sets the passed BIFF12 text comparison type and operator. More...

Public Attributes
ApiTokenSequenceVector	maFormulas

OUString	maText
	Formulas for rule conditions. More...

sal_Int32	mnPriority
	Text for 'contains' rules. More...

sal_Int32	mnType
	Priority of this rule. More...

sal_Int32	mnOperator
	Type of the rule. More...

sal_Int32	mnTimePeriod
	In cell-is rules: Comparison operator. More...

sal_Int32	mnRank
	In time-period rules: Type of time period. More...

sal_Int32	mnStdDev
	In top-10 rules: True = bottom, false = top. More...

sal_Int32	mnDxfId
	In average rules: Number of std deviations. More...

bool	mbStopIfTrue
	Differential formatting identifier. More...

bool	mbBottom
	True = stop evaluating rules, if this rule is true. More...

bool	mbPercent
	In top-10 rules: True = bottom, false = top. More...

bool	mbAboveAverage
	In top-10 rules: True = percent, false = rank. More...

bool	mbEqualAverage
	In average rules: True = above average, false = below. More...

Detailed Description

Model for a single rule in a conditional formatting.

Definition at line 44 of file condformatbuffer.hxx.

Member Typedef Documentation

◆ ApiTokenSequenceVector

typedef ::std::vector< ApiTokenSequence > oox::xls::CondFormatRuleModel::ApiTokenSequenceVector

Definition at line 46 of file condformatbuffer.hxx.

Constructor & Destructor Documentation

◆ CondFormatRuleModel()

oox::xls::CondFormatRuleModel::CondFormatRuleModel ( )

explicit

In average rules: True = include average, false = exclude.

Definition at line 473 of file condformatbuffer.cxx.

References mnPriority, and XML_TOKEN_INVALID.

Member Function Documentation

◆ setBiff12TextType()

void oox::xls::CondFormatRuleModel::setBiff12TextType ( sal_Int32 nOperator )

Sets the passed BIFF12 text comparison type and operator.

Definition at line 497 of file condformatbuffer.cxx.

References mnOperator, mnType, STATIC_ARRAY_SELECT, and XML_TOKEN_INVALID.

Referenced by oox::xls::CondFormatRule::importCfRule().

◆ setBiffOperator()

void oox::xls::CondFormatRuleModel::setBiffOperator ( sal_Int32 nOperator )

Sets the passed BIFF operator for condition type cellIs.

Definition at line 489 of file condformatbuffer.cxx.

References mnOperator, STATIC_ARRAY_SELECT, and XML_TOKEN_INVALID.

Referenced by oox::xls::CondFormatRule::importCfRule().

Member Data Documentation

◆ maFormulas

ApiTokenSequenceVector oox::xls::CondFormatRuleModel::maFormulas

Definition at line 48 of file condformatbuffer.hxx.

Referenced by oox::xls::CondFormatRule::appendFormula(), oox::xls::CondFormatRule::finalizeImport(), and oox::xls::CondFormatRule::importCfRule().

◆ maText

OUString oox::xls::CondFormatRuleModel::maText

Formulas for rule conditions.

Definition at line 49 of file condformatbuffer.hxx.

Referenced by oox::xls::CondFormatRule::finalizeImport(), and oox::xls::CondFormatRule::importCfRule().

◆ mbAboveAverage

bool oox::xls::CondFormatRuleModel::mbAboveAverage

In top-10 rules: True = percent, false = rank.

Definition at line 60 of file condformatbuffer.hxx.

Referenced by oox::xls::CondFormatRule::finalizeImport(), and oox::xls::CondFormatRule::importCfRule().

◆ mbBottom

bool oox::xls::CondFormatRuleModel::mbBottom

True = stop evaluating rules, if this rule is true.

Definition at line 58 of file condformatbuffer.hxx.

Referenced by oox::xls::CondFormatRule::finalizeImport(), and oox::xls::CondFormatRule::importCfRule().

◆ mbEqualAverage

bool oox::xls::CondFormatRuleModel::mbEqualAverage

In average rules: True = above average, false = below.

Definition at line 61 of file condformatbuffer.hxx.

Referenced by oox::xls::CondFormatRule::finalizeImport(), and oox::xls::CondFormatRule::importCfRule().

◆ mbPercent

bool oox::xls::CondFormatRuleModel::mbPercent

In top-10 rules: True = bottom, false = top.

Definition at line 59 of file condformatbuffer.hxx.

Referenced by oox::xls::CondFormatRule::finalizeImport(), and oox::xls::CondFormatRule::importCfRule().

◆ mbStopIfTrue

bool oox::xls::CondFormatRuleModel::mbStopIfTrue

Differential formatting identifier.

Definition at line 57 of file condformatbuffer.hxx.

Referenced by oox::xls::CondFormatRule::importCfRule().

◆ mnDxfId

sal_Int32 oox::xls::CondFormatRuleModel::mnDxfId

In average rules: Number of std deviations.

Definition at line 56 of file condformatbuffer.hxx.

Referenced by oox::xls::CondFormatRule::finalizeImport(), and oox::xls::CondFormatRule::importCfRule().

◆ mnOperator

sal_Int32 oox::xls::CondFormatRuleModel::mnOperator

Type of the rule.

Definition at line 52 of file condformatbuffer.hxx.

Referenced by oox::xls::CondFormatRule::finalizeImport(), oox::xls::CondFormatRule::importCfRule(), setBiff12TextType(), and setBiffOperator().

◆ mnPriority

sal_Int32 oox::xls::CondFormatRuleModel::mnPriority

Text for 'contains' rules.

Definition at line 50 of file condformatbuffer.hxx.

Referenced by oox::xls::CondFormatRule::getPriority(), oox::xls::CondFormatRule::importCfRule(), and oox::xls::CondFormatRule::setFormatEntry().

◆ mnRank

sal_Int32 oox::xls::CondFormatRuleModel::mnRank

In time-period rules: Type of time period.

Definition at line 54 of file condformatbuffer.hxx.

Referenced by oox::xls::CondFormatRule::finalizeImport(), and oox::xls::CondFormatRule::importCfRule().

◆ mnStdDev

sal_Int32 oox::xls::CondFormatRuleModel::mnStdDev

In top-10 rules: True = bottom, false = top.

Definition at line 55 of file condformatbuffer.hxx.

Referenced by oox::xls::CondFormatRule::finalizeImport(), and oox::xls::CondFormatRule::importCfRule().

◆ mnTimePeriod

sal_Int32 oox::xls::CondFormatRuleModel::mnTimePeriod

In cell-is rules: Comparison operator.

Definition at line 53 of file condformatbuffer.hxx.

Referenced by oox::xls::CondFormatRule::finalizeImport(), and oox::xls::CondFormatRule::importCfRule().

◆ mnType

sal_Int32 oox::xls::CondFormatRuleModel::mnType

Priority of this rule.

Definition at line 51 of file condformatbuffer.hxx.

Referenced by oox::xls::CondFormatRule::finalizeImport(), oox::xls::CondFormatRule::importCfRule(), and setBiff12TextType().

The documentation for this struct was generated from the following files: