OpenXLSX::XLPersons Class Reference

A class encapsulating modern Excel persons metadata (persons.xml) More...

#include <XLThreadedComments.hpp>

Inheritance diagram for OpenXLSX::XLPersons:

Public Member Functions
	XLPersons ()
	XLPersons (gsl::not_null< XLXmlData * > xmlData)
	~XLPersons ()=default
	XLPersons (const XLPersons &other)=default
	XLPersons (XLPersons &&other)=default
XLPersons &	operator= (const XLPersons &other)=default
XLPersons &	operator= (XLPersons &&other)=default
XLPerson	person (const std::string &id) const
	Retrieve a person entity by their unique personId.
std::string	addPerson (const std::string &displayName)
	Add a person by their display name, generating a new ID if it doesn't exist.
Public Member Functions inherited from OpenXLSX::XLXmlFile
	XLXmlFile ()=default
	Default constructor.
std::string	xmlData (XLXmlSavingDeclaration savingDeclaration=XLXmlSavingDeclaration{}) const
	Method for getting the XML data represented by the object.
	XLXmlFile (XLXmlData *xmlData)
	Constructor. Creates an object based on the xmlData input.
	XLXmlFile (const XLXmlFile &other)=default
	Copy constructor. Default implementation used.
	XLXmlFile (XLXmlFile &&other) noexcept=default
	Move constructor. Default implementation used.
	~XLXmlFile ()=default
	Destructor. Default implementation used.
bool	valid () const
	check whether class is linked to a valid XML file
XLXmlFile &	operator= (const XLXmlFile &other)=default
	The copy assignment operator. The default implementation has been used.
XLXmlFile &	operator= (XLXmlFile &&other) noexcept=default
	The move assignment operator. The default implementation has been used.
XLDocument &	parentDoc ()
	This function provides access to the parent XLDocument object.
const XLDocument &	parentDoc () const
	This function provides access to the parent XLDocument object.
XMLDocument &	xmlDocument ()
	This function provides access to the underlying XMLDocument object.
const XMLDocument &	xmlDocument () const
	This function provides access to the underlying XMLDocument object.
std::string	getXmlPath () const
	Retrieve the path of the XML data in the .xlsx zip archive via m_xmlData->getXmlPath.

Additional Inherited Members
Protected Member Functions inherited from OpenXLSX::XLXmlFile
void	setXmlData (std::string_view xmlData)
	Provide the XML data represented by the object.
std::string	relationshipID () const
	This function returns the relationship ID (the ID used in the XLRelationships objects) for the object.
Protected Attributes inherited from OpenXLSX::XLXmlFile
XLXmlData *	m_xmlData {nullptr}

Detailed Description

A class encapsulating modern Excel persons metadata (persons.xml)

Constructor & Destructor Documentation

XLPersons() [1/4]

OpenXLSX::XLPersons::XLPersons ( )

inline

XLPersons() [2/4]

OpenXLSX::XLPersons::XLPersons ( gsl::not_null< XLXmlData * >  xmlData )

inlineexplicit

~XLPersons()

OpenXLSX::XLPersons::~XLPersons ( )

default

XLPersons() [3/4]

OpenXLSX::XLPersons::XLPersons ( const XLPersons &  other )

default

XLPersons() [4/4]

OpenXLSX::XLPersons::XLPersons ( XLPersons &&  other )

default

Member Function Documentation

addPerson()

std::string XLPersons::addPerson

(

const std::string &

displayName

)

Add a person by their display name, generating a new ID if it doesn't exist.

Returns

The unique personId.

operator=() [1/2]

XLPersons & OpenXLSX::XLPersons::operator= ( const XLPersons &  other )

default

operator=() [2/2]

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

default

person()

XLPerson XLPersons::person

(

const std::string &

id

)

const

Retrieve a person entity by their unique personId.

---

The documentation for this class was generated from the following files:

• /home/runner/work/OpenXLSX-NX/OpenXLSX-NX/OpenXLSX/headers/XLThreadedComments.hpp
• /home/runner/work/OpenXLSX-NX/OpenXLSX-NX/OpenXLSX/sources/XLThreadedComments.cpp