OpenXLSX::XLDxfs Class Reference

An encapsulation of the XLSX differential cell formats (dxfs) More...

#include <XLStyles.hpp>

Public Member Functions
	XLDxfs ()
	Default constructor.
	XLDxfs (const XMLNode &node)
	Constructor. New items should only be created through an XLStyles object.
	XLDxfs (const XLDxfs &other)
	Copy Constructor.
	XLDxfs (XLDxfs &&other)
	Move Constructor.
	~XLDxfs ()
	Destructor.
XLDxfs &	operator= (const XLDxfs &other)
	Copy assignment operator.
XLDxfs &	operator= (XLDxfs &&other) noexcept
	Move assignment operator.
size_t	count () const
	Get the count of differential cell formats.
XLDxf	dxfByIndex (XLStyleIndex index) const
	Get the differential cell format identified by index.
XLDxf	operator[] (XLStyleIndex index) const
	Operator overload: allow [] as shortcut access to dxfByIndex.
XLStyleIndex	create (XLDxf copyFrom=XLDxf{}, std::string_view styleEntriesPrefix=XLDefaultStyleEntriesPrefix)
	Append a new XLDxf, based on copyFrom, and return its index in dxfs node.

Detailed Description

An encapsulation of the XLSX differential cell formats (dxfs)

Constructor & Destructor Documentation

XLDxfs() [1/4]

XLDxfs::XLDxfs

(

)

Default constructor.

XLDxfs() [2/4]

XLDxfs::XLDxfs ( const XMLNode &  node )

explicit

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

Parameters

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

XLDxfs() [3/4]

XLDxfs::XLDxfs

(

const XLDxfs &

other

)

Copy Constructor.

Parameters

other

Object to be copied.

XLDxfs() [4/4]

XLDxfs::XLDxfs

(

XLDxfs &&

other

)

Move Constructor.

Parameters

other

Object to be moved.

~XLDxfs()

XLDxfs::~XLDxfs

(

)

Destructor.

Member Function Documentation

count()

size_t XLDxfs::count

(

)

const

Get the count of differential cell formats.

Returns

The amount of entries in the differential cell formats

create()

XLStyleIndex XLDxfs::create	(	XLDxf	copyFrom = XLDxf{},
		std::string_view	styleEntriesPrefix = XLDefaultStyleEntriesPrefix
	)

Append a new XLDxf, based on copyFrom, and return its index in dxfs node.

Parameters

copyFrom	Can provide an XLDxf to use as template for the new style
styleEntriesPrefix	Prefix the newly created cell style XMLNode with this pugi::node_pcdata text

Returns

The index of the new differential cell format as used by operator[]

dxfByIndex()

XLDxf XLDxfs::dxfByIndex

(

XLStyleIndex

index

)

const

Get the differential cell format identified by index.

Returns

An XLDxf object

operator=() [1/2]

XLDxfs & XLDxfs::operator=

(

const XLDxfs &

other

)

Copy assignment operator.

Parameters

other

Right hand side of assignment operation.

Returns

A reference to the lhs object.

operator=() [2/2]

XLDxfs & XLDxfs::operator= ( XLDxfs &&  other )

noexcept

Move assignment operator.

Parameters

other

Right hand side of assignment operation.

Returns

A reference to lhs object.

operator[]()

XLDxf OpenXLSX::XLDxfs::operator[] ( XLStyleIndex  index ) const

inline

Operator overload: allow [] as shortcut access to dxfByIndex.

Parameters

index

The index within the XML sequence

Returns

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