OpenXLSX::XLShapeClientData Class Reference

An encapsulation of a shape client data element x:ClientData. More...

#include <XLDrawing.hpp>

Public Member Functions
	XLShapeClientData ()
	XLShapeClientData (const XMLNode &node)
	Constructor. New items should only be created through an XLShape object.
	XLShapeClientData (const XLShapeClientData &other)=default
	Copy Constructor.
	XLShapeClientData (XLShapeClientData &&other) noexcept=default
	Move Constructor.
	~XLShapeClientData ()=default
XLShapeClientData &	operator= (const XLShapeClientData &other)=default
	Copy assignment operator.
XLShapeClientData &	operator= (XLShapeClientData &&other) noexcept=default
	Move assignment operator.
std::string	objectType () const
	Component Data Accessors.
bool	moveWithCells () const
bool	sizeWithCells () const
std::string	anchor () const
bool	autoFill () const
XLShapeTextVAlign	textVAlign () const
XLShapeTextHAlign	textHAlign () const
uint32_t	row () const
uint16_t	column () const
bool	setObjectType (std::string_view newObjectType)
	Component Data Mutators.
bool	setMoveWithCells (bool set=true)
bool	setSizeWithCells (bool set=true)
bool	setAnchor (std::string_view newAnchor)
bool	setAutoFill (bool set=true)
bool	setTextVAlign (XLShapeTextVAlign newTextVAlign)
bool	setTextHAlign (XLShapeTextHAlign newTextHAlign)
bool	setRow (uint32_t newRow)
bool	setColumn (uint16_t newColumn)

Detailed Description

An encapsulation of a shape client data element x:ClientData.

Constructor & Destructor Documentation

XLShapeClientData() [1/4]

XLShapeClientData::XLShapeClientData

(

)

XLShapeClientData() [2/4]

XLShapeClientData::XLShapeClientData ( const XMLNode &  node )

explicit

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

Parameters

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

XLShapeClientData() [3/4]

OpenXLSX::XLShapeClientData::XLShapeClientData ( const XLShapeClientData &  other )

default

Copy Constructor.

Parameters

other

Object to be copied.

XLShapeClientData() [4/4]

OpenXLSX::XLShapeClientData::XLShapeClientData ( XLShapeClientData &&  other )

defaultnoexcept

Move Constructor.

Parameters

other

Object to be moved.

~XLShapeClientData()

OpenXLSX::XLShapeClientData::~XLShapeClientData ( )

default

Member Function Documentation

anchor()

std::string XLShapeClientData::anchor

(

)

const

autoFill()

bool XLShapeClientData::autoFill

(

)

const

column()

uint16_t XLShapeClientData::column

(

)

const

moveWithCells()

bool XLShapeClientData::moveWithCells

(

)

const

objectType()

std::string XLShapeClientData::objectType

(

)

const

Component Data Accessors.

operator=() [1/2]

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

default

Copy assignment operator.

Parameters

other

Right hand side of assignment operation.

Returns

A reference to the lhs object.

operator=() [2/2]

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

defaultnoexcept

Move assignment operator.

Parameters

other

Right hand side of assignment operation.

Returns

A reference to lhs object.

row()

uint32_t XLShapeClientData::row

(

)

const

setAnchor()

bool XLShapeClientData::setAnchor

(

std::string_view

newAnchor

)

setAutoFill()

bool XLShapeClientData::setAutoFill

(

bool

set = true

)

setColumn()

bool XLShapeClientData::setColumn

(

uint16_t

newColumn

)

setMoveWithCells()

bool XLShapeClientData::setMoveWithCells

(

bool

set = true

)

setObjectType()

bool XLShapeClientData::setObjectType

(

std::string_view

newObjectType

)

Component Data Mutators.

setRow()

bool XLShapeClientData::setRow

(

uint32_t

newRow

)

setSizeWithCells()

bool XLShapeClientData::setSizeWithCells

(

bool

set = true

)

setTextHAlign()

bool XLShapeClientData::setTextHAlign

(

XLShapeTextHAlign

newTextHAlign

)

setTextVAlign()

bool XLShapeClientData::setTextVAlign

(

XLShapeTextVAlign

newTextVAlign

)

sizeWithCells()

bool XLShapeClientData::sizeWithCells

(

)

const

textHAlign()

XLShapeTextHAlign XLShapeClientData::textHAlign

(

)

const

textVAlign()

XLShapeTextVAlign XLShapeClientData::textVAlign

(

)

const

---

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

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