XLConditionalFormatting.hpp File Reference

#include "OpenXLSX-Exports.hpp"
#include "XLColor.hpp"
#include "XLStyles.hpp"
#include "XLXmlParser.hpp"
#include <cstdint>
#include <memory>
#include <string>
#include <string_view>
#include <vector>

Go to the source code of this file.

Data Structures
class	OpenXLSX::XLCfvo
class	OpenXLSX::XLCfColorScale
class	OpenXLSX::XLCfDataBar
class	OpenXLSX::XLCfIconSet
class	OpenXLSX::XLCfRule
class	OpenXLSX::XLCfRules
class	OpenXLSX::XLConditionalFormat
class	OpenXLSX::XLConditionalFormats

Namespaces
namespace	OpenXLSX

Enumerations
enum class	OpenXLSX::XLCfType : uint8_t {   OpenXLSX::Expression = 0 , OpenXLSX::CellIs = 1 , OpenXLSX::ColorScale = 2 , OpenXLSX::DataBar = 3 ,   OpenXLSX::IconSet = 4 , OpenXLSX::Top10 = 5 , OpenXLSX::UniqueValues = 6 , OpenXLSX::DuplicateValues = 7 ,   OpenXLSX::ContainsText = 8 , OpenXLSX::NotContainsText = 9 , OpenXLSX::BeginsWith = 10 , OpenXLSX::EndsWith = 11 ,   OpenXLSX::ContainsBlanks = 12 , OpenXLSX::NotContainsBlanks = 13 , OpenXLSX::ContainsErrors = 14 , OpenXLSX::NotContainsErrors = 15 ,   OpenXLSX::TimePeriod = 16 , OpenXLSX::AboveAverage = 17 , OpenXLSX::Invalid = 255 }
enum class	OpenXLSX::XLCfOperator : uint8_t {   OpenXLSX::LessThan = 0 , OpenXLSX::LessThanOrEqual = 1 , OpenXLSX::Equal = 2 , OpenXLSX::NotEqual = 3 ,   OpenXLSX::GreaterThanOrEqual = 4 , OpenXLSX::GreaterThan = 5 , OpenXLSX::Between = 6 , OpenXLSX::NotBetween = 7 ,   OpenXLSX::ContainsText = 8 , OpenXLSX::NotContains = 9 , OpenXLSX::BeginsWith = 10 , OpenXLSX::EndsWith = 11 ,   OpenXLSX::Invalid = 255 }
enum class	OpenXLSX::XLCfTimePeriod : uint8_t {   OpenXLSX::Today = 0 , OpenXLSX::Yesterday = 1 , OpenXLSX::Tomorrow = 2 , OpenXLSX::Last7Days = 3 ,   OpenXLSX::ThisMonth = 4 , OpenXLSX::LastMonth = 5 , OpenXLSX::NextMonth = 6 , OpenXLSX::ThisWeek = 7 ,   OpenXLSX::LastWeek = 8 , OpenXLSX::NextWeek = 9 , OpenXLSX::Invalid = 255 }
enum class	OpenXLSX::XLCfvoType : uint8_t {   OpenXLSX::Min = 0 , OpenXLSX::Max = 1 , OpenXLSX::Number = 2 , OpenXLSX::Percent = 3 ,   OpenXLSX::Formula = 4 , OpenXLSX::Percentile = 5 , OpenXLSX::Invalid = 255 }
enum class	OpenXLSX::XLDataBarDirection : uint8_t { OpenXLSX::Context = 0 , OpenXLSX::LeftToRight = 1 , OpenXLSX::RightToLeft = 2 }
enum class	OpenXLSX::XLDataBarAxisPosition : uint8_t { OpenXLSX::Automatic = 0 , OpenXLSX::Middle = 1 , OpenXLSX::None = 2 }

Functions
OPENXLSX_EXPORT XLCfType	OpenXLSX::XLCfTypeFromString (std::string const &typeString)
	get the correct XLCfType from the OOXML cfRule type attribute string
OPENXLSX_EXPORT std::string	OpenXLSX::XLCfTypeToString (XLCfType cfType)
	inverse of XLCfTypeFromString
OPENXLSX_EXPORT XLCfOperator	OpenXLSX::XLCfOperatorFromString (std::string const &operatorString)
	get the correct XLCfOperator from the OOXML cfRule operator attribute string
OPENXLSX_EXPORT std::string	OpenXLSX::XLCfOperatorToString (XLCfOperator cfOperator)
	inverse of XLCfOperatorFromString
OPENXLSX_EXPORT XLCfTimePeriod	OpenXLSX::XLCfTimePeriodFromString (std::string const &timePeriodString)
	get the correct XLCfTimePeriod from the OOXML cfRule timePeriod attribute string
OPENXLSX_EXPORT std::string	OpenXLSX::XLCfTimePeriodToString (XLCfTimePeriod cfTimePeriod)
	inverse of XLCfTimePeriodFromString
OPENXLSX_EXPORT XLCfvoType	OpenXLSX::XLCfvoTypeFromString (std::string const &cfvoTypeString)
OPENXLSX_EXPORT std::string	OpenXLSX::XLCfvoTypeToString (XLCfvoType cfvoType)
OPENXLSX_EXPORT XLDataBarDirection	OpenXLSX::XLDataBarDirectionFromString (std::string const &directionString)
OPENXLSX_EXPORT std::string	OpenXLSX::XLDataBarDirectionToString (XLDataBarDirection direction)
OPENXLSX_EXPORT XLDataBarAxisPosition	OpenXLSX::XLDataBarAxisPositionFromString (std::string const &positionString)
OPENXLSX_EXPORT std::string	OpenXLSX::XLDataBarAxisPositionToString (XLDataBarAxisPosition position)
OPENXLSX_EXPORT XLCfRule	OpenXLSX::XLColorScaleRule (const XLColor &minColor, const XLColor &maxColor)
OPENXLSX_EXPORT XLCfRule	OpenXLSX::XLColorScaleRule (const XLColor &minColor, const XLColor &midColor, const XLColor &maxColor)
OPENXLSX_EXPORT XLCfRule	OpenXLSX::XLDataBarRule (const XLColor &color, bool showValue=true)
OPENXLSX_EXPORT XLCfRule	OpenXLSX::XLCellIsRule (XLCfOperator op, const std::string &value)
OPENXLSX_EXPORT XLCfRule	OpenXLSX::XLCellIsRule (const std::string &op, const std::string &value)
OPENXLSX_EXPORT XLCfRule	OpenXLSX::XLFormulaRule (const std::string &formula)
OPENXLSX_EXPORT XLCfRule	OpenXLSX::XLIconSetRule (const std::string &iconSetName="3TrafficLights1", bool showValue=true, bool reverse=false)
OPENXLSX_EXPORT XLCfRule	OpenXLSX::XLTop10Rule (uint16_t rank=10, bool percent=false, bool bottom=false)
OPENXLSX_EXPORT XLCfRule	OpenXLSX::XLAboveAverageRule (bool aboveAverage=true, bool equalAverage=false, int16_t stdDev=0)
OPENXLSX_EXPORT XLCfRule	OpenXLSX::XLDuplicateValuesRule (bool unique=false)
OPENXLSX_EXPORT XLCfRule	OpenXLSX::XLContainsTextRule (const std::string &text)
OPENXLSX_EXPORT XLCfRule	OpenXLSX::XLNotContainsTextRule (const std::string &text)
OPENXLSX_EXPORT XLCfRule	OpenXLSX::XLContainsBlanksRule ()
OPENXLSX_EXPORT XLCfRule	OpenXLSX::XLNotContainsBlanksRule ()
OPENXLSX_EXPORT XLCfRule	OpenXLSX::XLContainsErrorsRule ()
OPENXLSX_EXPORT XLCfRule	OpenXLSX::XLNotContainsErrorsRule ()

Variables
constexpr const uint16_t	OpenXLSX::XLPriorityNotSet = 0
constexpr const char *	OpenXLSX::XLDefaultCfRulePrefix = "\n\t\t"
constexpr const char *	OpenXLSX::XLDefaultConditionalFormattingPrefix = "\n\t"