OpenXLSX::XLLine Class Reference

An encapsulation of a line item. More...

#include <XLStyles.hpp>

Public Member Functions
	XLLine ()
	XLLine (const XMLNode &node)
	Constructor. New items should only be created through an XLBorder object.
	XLLine (const XLLine &other)
	Copy Constructor.
	XLLine (XLLine &&other) noexcept=default
	Move Constructor.
	~XLLine ()
XLLine &	operator= (const XLLine &other)
	Copy assignment operator.
XLLine &	operator= (XLLine &&other) noexcept=default
	Move assignment operator.
XLLineStyle	style () const
	Get the line style.
	operator bool () const
	Evaluate XLLine as bool.
XLDataBarColor	color () const
std::string	summary () const
	Return a string summary of the line properties.

Detailed Description

An encapsulation of a line item.

Constructor & Destructor Documentation

XLLine() [1/4]

XLLine::XLLine

(

)

XLLine() [2/4]

XLLine::XLLine ( const XMLNode &  node )

explicit

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

Parameters

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

XLLine() [3/4]

XLLine::XLLine

(

const XLLine &

other

)

Copy Constructor.

Parameters

other

Object to be copied.

XLLine() [4/4]

OpenXLSX::XLLine::XLLine ( XLLine &&  other )

defaultnoexcept

Move Constructor.

Parameters

other

Object to be moved.

~XLLine()

XLLine::~XLLine ( )

default

Member Function Documentation

color()

XLDataBarColor XLLine::color

(

)

const

operator bool()

XLLine::operator bool ( ) const

explicit

Evaluate XLLine as bool.

Returns

true if line is set, false if not

operator=() [1/2]

XLLine & XLLine::operator=

(

const XLLine &

other

)

Copy assignment operator.

Parameters

other

Right hand side of assignment operation.

Returns

A reference to the lhs object.

operator=() [2/2]

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

defaultnoexcept

Move assignment operator.

Parameters

other

Right hand side of assignment operation.

Returns

A reference to lhs object.

style()

XLLineStyle XLLine::style

(

)

const

Get the line style.

Returns

An XLLineStyle enum

summary()

std::string XLLine::summary

(

)

const

Return a string summary of the line properties.

Note

Regarding setter functions for style parameters:

Please refer to XLBorder setLine / setLeft / setRight / setTop / setBottom / setDiagonal

and XLDataBarColor setter functions that can be invoked via color()

Returns

string with info about the line object

---

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