OpenXLSX::XLDataBarColor Class Reference

An encapsulation of an XLSX Data Bar Color (CT_Color) item. More...

#include <XLStyles.hpp>

Public Member Functions
	XLDataBarColor ()
	XLDataBarColor (const XMLNode &node)
	Constructor. New items should only be created through an XLGradientStop or XLLine object.
	XLDataBarColor (const XLDataBarColor &other)
	Copy Constructor.
	XLDataBarColor (XLDataBarColor &&other) noexcept=default
	Move Constructor.
	~XLDataBarColor ()=default
XLDataBarColor &	operator= (const XLDataBarColor &other)
	Copy assignment operator.
XLDataBarColor &	operator= (XLDataBarColor &&other) noexcept=default
	Move assignment operator.
XLColor	rgb () const
	Get the line color from the rgb attribute.
double	tint () const
	Get the line color tint.
bool	automatic () const
	currently unsupported getter stubs
uint32_t	indexed () const
uint32_t	theme () const
bool	setRgb (XLColor newColor)
	Setter functions for data bar color parameters.
bool	set (XLColor newColor)
bool	setTint (double newTint)
bool	setAutomatic (bool set=true)
bool	setIndexed (uint32_t newIndex)
bool	setTheme (uint32_t newTheme)
std::string	summary () const
	Return a string summary of the color properties.

Detailed Description

An encapsulation of an XLSX Data Bar Color (CT_Color) item.

Constructor & Destructor Documentation

XLDataBarColor() [1/4]

XLDataBarColor::XLDataBarColor

(

)

XLDataBarColor() [2/4]

XLDataBarColor::XLDataBarColor ( const XMLNode &  node )

explicit

Constructor. New items should only be created through an XLGradientStop or XLLine object.

Parameters

node	An XMLNode object with a data bar color XMLNode. If no input is provided, a null node is used.

XLDataBarColor() [3/4]

XLDataBarColor::XLDataBarColor

(

const XLDataBarColor &

other

)

Copy Constructor.

Parameters

other

Object to be copied.

XLDataBarColor() [4/4]

OpenXLSX::XLDataBarColor::XLDataBarColor ( XLDataBarColor &&  other )

defaultnoexcept

Move Constructor.

Parameters

other

Object to be moved.

~XLDataBarColor()

OpenXLSX::XLDataBarColor::~XLDataBarColor ( )

default

Member Function Documentation

automatic()

bool XLDataBarColor::automatic

(

)

const

currently unsupported getter stubs

indexed()

uint32_t XLDataBarColor::indexed

(

)

const

operator=() [1/2]

XLDataBarColor & XLDataBarColor::operator=

(

const XLDataBarColor &

other

)

Copy assignment operator.

Parameters

other

Right hand side of assignment operation.

Returns

A reference to the lhs object.

operator=() [2/2]

XLDataBarColor & OpenXLSX::XLDataBarColor::operator= ( XLDataBarColor &&  other )

defaultnoexcept

Move assignment operator.

Parameters

other

Right hand side of assignment operation.

Returns

A reference to lhs object.

rgb()

XLColor XLDataBarColor::rgb

(

)

const

Get the line color from the rgb attribute.

Returns

An XLColor object

set()

bool OpenXLSX::XLDataBarColor::set ( XLColor  newColor )

inline

setAutomatic()

bool XLDataBarColor::setAutomatic

(

bool

set = true

)

setIndexed()

bool XLDataBarColor::setIndexed

(

uint32_t

newIndex

)

setRgb()

bool XLDataBarColor::setRgb

(

XLColor

newColor

)

Setter functions for data bar color parameters.

Parameters

value

that shall be set

Returns

true for success, false for failure

setTheme()

bool XLDataBarColor::setTheme

(

uint32_t

newTheme

)

setTint()

bool XLDataBarColor::setTint

(

double

newTint

)

summary()

std::string XLDataBarColor::summary

(

)

const

Return a string summary of the color properties.

Returns

string with info about the color object

theme()

uint32_t XLDataBarColor::theme

(

)

const

tint()

double XLDataBarColor::tint

(

)

const

Get the line color tint.

Returns

A double value as stored in the "tint" attribute (should be between [-1.0;+1.0]), 0.0 if attribute does not exist

---

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

• /home/runner/work/OpenXLSX-NX/OpenXLSX-NX/OpenXLSX/headers/XLStyles.hpp
• /home/runner/work/OpenXLSX-NX/OpenXLSX-NX/OpenXLSX/sources/XLStyles_Fills.cpp