OpenXLSX::XLGradientStop Class Reference

An encapsulation of an fill::gradientFill::stop item. More...

#include <XLStyles.hpp>

Public Member Functions
	XLGradientStop ()
	XLGradientStop (const XMLNode &node)
	Constructor. New items should only be created through an XLGradientStops object.
	XLGradientStop (const XLGradientStop &other)
	Copy Constructor.
	XLGradientStop (XLGradientStop &&other) noexcept=default
	Move Constructor.
	~XLGradientStop ()=default
XLGradientStop &	operator= (const XLGradientStop &other)
	Copy assignment operator.
XLGradientStop &	operator= (XLGradientStop &&other) noexcept=default
	Move assignment operator.
XLDataBarColor	color () const
	Getter functions.
double	position () const
bool	setPosition (double newPosition)
	Setter functions.
std::string	summary () const
	Return a string summary of the stop properties.

Friends
class	XLGradientStops

Detailed Description

An encapsulation of an fill::gradientFill::stop item.

Constructor & Destructor Documentation

XLGradientStop() [1/4]

XLGradientStop::XLGradientStop

(

)

XLGradientStop() [2/4]

XLGradientStop::XLGradientStop ( const XMLNode &  node )

explicit

Constructor. New items should only be created through an XLGradientStops object.

Parameters

node	An XMLNode object with the gradient stop XMLNode. If no input is provided, a null node is used.

XLGradientStop() [3/4]

XLGradientStop::XLGradientStop

(

const XLGradientStop &

other

)

Copy Constructor.

Parameters

other

Object to be copied.

XLGradientStop() [4/4]

OpenXLSX::XLGradientStop::XLGradientStop ( XLGradientStop &&  other )

defaultnoexcept

Move Constructor.

Parameters

other

Object to be moved.

~XLGradientStop()

OpenXLSX::XLGradientStop::~XLGradientStop ( )

default

Member Function Documentation

color()

XLDataBarColor XLGradientStop::color

(

)

const

Getter functions.

Returns

The requested gradient stop property

operator=() [1/2]

XLGradientStop & XLGradientStop::operator=

(

const XLGradientStop &

other

)

Copy assignment operator.

Parameters

other

Right hand side of assignment operation.

Returns

A reference to the lhs object.

operator=() [2/2]

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

defaultnoexcept

Move assignment operator.

Parameters

other

Right hand side of assignment operation.

Returns

A reference to lhs object.

position()

double XLGradientStop::position

(

)

const

setPosition()

bool XLGradientStop::setPosition

(

double

newPosition

)

Setter functions.

Parameters

value

that shall be set

Returns

true for success, false for failure

Note

for color setters, use the color() getter with the XLDataBarColor setter functions

summary()

std::string XLGradientStop::summary

(

)

const

Return a string summary of the stop properties.

Returns

string with info about the stop object

Friends And Related Symbol Documentation

XLGradientStops

friend class XLGradientStops

friend

---

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