OpenXLSX::XLBorder Class Reference

An encapsulation of a border item. More...

#include <XLStyles.hpp>

Public Member Functions
	XLBorder ()
	XLBorder (const XMLNode &node)
	Constructor. New items should only be created through an XLStyles object.
	XLBorder (const XLBorder &other)
	Copy Constructor.
	XLBorder (XLBorder &&other) noexcept=default
	Move Constructor.
	~XLBorder ()
XLBorder &	operator= (const XLBorder &other)
	Copy assignment operator.
XLBorder &	operator= (XLBorder &&other) noexcept=default
	Move assignment operator.
bool	diagonalUp () const
	Get the diagonal up property.
bool	diagonalDown () const
	Get the diagonal down property.
bool	outline () const
	Get the outline property.
XLLine	left () const
	Get the left line property.
XLLine	right () const
	Get the left line property.
XLLine	top () const
	Get the left line property.
XLLine	bottom () const
	Get the bottom line property.
XLLine	diagonal () const
	Get the diagonal line property.
XLLine	vertical () const
	Get the vertical line property.
XLLine	horizontal () const
	Get the horizontal line property.
XLBorder &	setDiagonalUp (bool set=true)
	Setter functions for style parameters.
XLBorder &	setDiagonalDown (bool set=true)
XLBorder &	setOutline (bool set=true)
bool	setLine (XLLineType lineType, XLLineStyle lineStyle, XLColor lineColor, double lineTint=0.0)
bool	setLeft (XLLineStyle lineStyle, XLColor lineColor, double lineTint=0.0)
bool	setRight (XLLineStyle lineStyle, XLColor lineColor, double lineTint=0.0)
bool	setTop (XLLineStyle lineStyle, XLColor lineColor, double lineTint=0.0)
bool	setBottom (XLLineStyle lineStyle, XLColor lineColor, double lineTint=0.0)
bool	setDiagonal (XLLineStyle lineStyle, XLColor lineColor, double lineTint=0.0)
bool	setVertical (XLLineStyle lineStyle, XLColor lineColor, double lineTint=0.0)
bool	setHorizontal (XLLineStyle lineStyle, XLColor lineColor, double lineTint=0.0)
std::string	summary () const
	Return a string summary of the font properties.

Friends
class	XLBorders

Detailed Description

An encapsulation of a border item.

Constructor & Destructor Documentation

XLBorder() [1/4]

XLBorder::XLBorder

(

)

XLBorder() [2/4]

XLBorder::XLBorder ( const XMLNode &  node )

explicit

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

Parameters

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

XLBorder() [3/4]

XLBorder::XLBorder

(

const XLBorder &

other

)

Copy Constructor.

Parameters

other

Object to be copied.

XLBorder() [4/4]

OpenXLSX::XLBorder::XLBorder ( XLBorder &&  other )

defaultnoexcept

Move Constructor.

Parameters

other

Object to be moved.

~XLBorder()

XLBorder::~XLBorder ( )

default

Member Function Documentation

bottom()

XLLine XLBorder::bottom

(

)

const

Get the bottom line property.

Returns

An XLLine object

diagonal()

XLLine XLBorder::diagonal

(

)

const

Get the diagonal line property.

Returns

An XLLine object

diagonalDown()

bool XLBorder::diagonalDown

(

)

const

Get the diagonal down property.

Returns

true if set, otherwise false

diagonalUp()

bool XLBorder::diagonalUp

(

)

const

Get the diagonal up property.

Returns

true if set, otherwise false

horizontal()

XLLine XLBorder::horizontal

(

)

const

Get the horizontal line property.

Returns

An XLLine object

left()

XLLine XLBorder::left

(

)

const

Get the left line property.

Returns

An XLLine object

operator=() [1/2]

XLBorder & XLBorder::operator=

(

const XLBorder &

other

)

Copy assignment operator.

Parameters

other

Right hand side of assignment operation.

Returns

A reference to the lhs object.

operator=() [2/2]

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

defaultnoexcept

Move assignment operator.

Parameters

other

Right hand side of assignment operation.

Returns

A reference to lhs object.

outline()

bool XLBorder::outline

(

)

const

Get the outline property.

Returns

true if set, otherwise false

right()

XLLine XLBorder::right

(

)

const

Get the left line property.

Returns

An XLLine object

setBottom()

bool XLBorder::setBottom	(	XLLineStyle	lineStyle,
		XLColor	lineColor,
		double	lineTint = 0.0
	)

setDiagonal()

bool XLBorder::setDiagonal	(	XLLineStyle	lineStyle,
		XLColor	lineColor,
		double	lineTint = 0.0
	)

setDiagonalDown()

XLBorder & XLBorder::setDiagonalDown

(

bool

set = true

)

setDiagonalUp()

XLBorder & XLBorder::setDiagonalUp

(

bool

set = true

)

Setter functions for style parameters.

Parameters

value	that shall be set
value2	(optional) that shall be set

Returns

true for success, false for failure

setHorizontal()

bool XLBorder::setHorizontal	(	XLLineStyle	lineStyle,
		XLColor	lineColor,
		double	lineTint = 0.0
	)

setLeft()

bool XLBorder::setLeft	(	XLLineStyle	lineStyle,
		XLColor	lineColor,
		double	lineTint = 0.0
	)

setLine()

bool XLBorder::setLine	(	XLLineType	lineType,
		XLLineStyle	lineStyle,
		XLColor	lineColor,
		double	lineTint = 0.0
	)

setOutline()

XLBorder & XLBorder::setOutline

(

bool

set = true

)

setRight()

bool XLBorder::setRight	(	XLLineStyle	lineStyle,
		XLColor	lineColor,
		double	lineTint = 0.0
	)

setTop()

bool XLBorder::setTop	(	XLLineStyle	lineStyle,
		XLColor	lineColor,
		double	lineTint = 0.0
	)

setVertical()

bool XLBorder::setVertical	(	XLLineStyle	lineStyle,
		XLColor	lineColor,
		double	lineTint = 0.0
	)

summary()

std::string XLBorder::summary

(

)

const

Return a string summary of the font properties.

Returns

string with info about the font object

top()

XLLine XLBorder::top

(

)

const

Get the left line property.

Returns

An XLLine object

vertical()

XLLine XLBorder::vertical

(

)

const

Get the vertical line property.

Returns

An XLLine object

Friends And Related Symbol Documentation

XLBorders

friend class XLBorders

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_Borders.cpp