OpenXLSX::XLDxf Class Reference

An encapsulation of a differential cell format item (DXF) More...

#include <XLStyles.hpp>

Public Member Functions
	XLDxf ()
	Default constructor. Initializes an empty XLDxf object with a temporary XML document.
	XLDxf (const XMLNode &node)
	Constructor. New items should only be created through an XLStyles object.
	XLDxf (const XLDxf &other)
	Copy Constructor.
	XLDxf (XLDxf &&other) noexcept
	Move Constructor.
	~XLDxf ()
	Destructor.
XLDxf &	operator= (const XLDxf &other)
	Copy assignment operator.
XLDxf &	operator= (XLDxf &&other) noexcept
	Move assignment operator.
bool	empty () const
	Test if this is an empty node.
XLFont	font () const
	Getter functions, will create empty object on access and can be used to manipulate underlying setters. These are "ensure-and-get" style getters consistent with the rest of the library.
XLNumberFormat	numFmt () const
XLFill	fill () const
XLAlignment	alignment () const
XLBorder	border () const
bool	hasFont () const
	Check if specific components are present in the DXF.
bool	hasNumFmt () const
bool	hasFill () const
bool	hasAlignment () const
bool	hasBorder () const
void	clearFont ()
	Clear specific components from the DXF.
void	clearNumFmt ()
void	clearFill ()
void	clearAlignment ()
void	clearBorder ()
XLUnsupportedElement	extLst () const
	Unsupported getter.
bool	setExtLst (XLUnsupportedElement const &newExtLst)
	Unsupported setter.
std::string	summary () const
	Return a string summary of the differential cell format properties.
XMLNode	node () const
	Access the underlying XML node.

Friends
class	XLDxfs

Detailed Description

An encapsulation of a differential cell format item (DXF)

Constructor & Destructor Documentation

XLDxf() [1/4]

XLDxf::XLDxf

(

)

Default constructor. Initializes an empty XLDxf object with a temporary XML document.

XLDxf() [2/4]

XLDxf::XLDxf ( const XMLNode &  node )

explicit

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

Parameters

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

XLDxf() [3/4]

XLDxf::XLDxf

(

const XLDxf &

other

)

Copy Constructor.

Parameters

other

Object to be copied.

XLDxf() [4/4]

XLDxf::XLDxf ( XLDxf &&  other )

noexcept

Move Constructor.

Parameters

other

Object to be moved.

~XLDxf()

XLDxf::~XLDxf ( )

default

Destructor.

Member Function Documentation

alignment()

XLAlignment XLDxf::alignment

(

)

const

border()

XLBorder XLDxf::border

(

)

const

clearAlignment()

void XLDxf::clearAlignment

(

)

clearBorder()

void XLDxf::clearBorder

(

)

clearFill()

void XLDxf::clearFill

(

)

clearFont()

void XLDxf::clearFont

(

)

Clear specific components from the DXF.

clearNumFmt()

void XLDxf::clearNumFmt

(

)

empty()

bool XLDxf::empty

(

)

const

Test if this is an empty node.

Returns

true if underlying XMLNode is empty

extLst()

XLUnsupportedElement OpenXLSX::XLDxf::extLst ( ) const

inline

Unsupported getter.

fill()

XLFill XLDxf::fill

(

)

const

font()

XLFont XLDxf::font

(

)

const

Getter functions, will create empty object on access and can be used to manipulate underlying setters. These are "ensure-and-get" style getters consistent with the rest of the library.

hasAlignment()

bool XLDxf::hasAlignment

(

)

const

hasBorder()

bool XLDxf::hasBorder

(

)

const

hasFill()

bool XLDxf::hasFill

(

)

const

hasFont()

bool XLDxf::hasFont

(

)

const

Check if specific components are present in the DXF.

hasNumFmt()

bool XLDxf::hasNumFmt

(

)

const

node()

XMLNode OpenXLSX::XLDxf::node ( ) const

inline

Access the underlying XML node.

numFmt()

XLNumberFormat XLDxf::numFmt

(

)

const

operator=() [1/2]

XLDxf & XLDxf::operator=

(

const XLDxf &

other

)

Copy assignment operator.

Parameters

other

Right hand side of assignment operation.

Returns

A reference to the lhs object.

operator=() [2/2]

XLDxf & XLDxf::operator= ( XLDxf &&  other )

noexcept

Move assignment operator.

Parameters

other

Right hand side of assignment operation.

Returns

A reference to lhs object.

setExtLst()

bool XLDxf::setExtLst

(

XLUnsupportedElement const &

newExtLst

)

Unsupported setter.

Unsupported setter function.

summary()

std::string XLDxf::summary

(

)

const

Return a string summary of the differential cell format properties.

Returns

string with info about the differential cell format object

Friends And Related Symbol Documentation

XLDxfs

friend class XLDxfs

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