OpenXLSX::XLShape Class Reference

#include <XLDrawing.hpp>

Public Member Functions
	XLShape ()
	XLShape (const XMLNode &node)
	Constructor. New items should only be created through an XLStyles object.
	XLShape (const XLShape &other)=default
	Copy Constructor.
	XLShape (XLShape &&other) noexcept=default
	Move Constructor.
	~XLShape ()=default
XLShape &	operator= (const XLShape &other)
	Copy assignment operator.
XLShape &	operator= (XLShape &&other) noexcept=default
	Move assignment operator.
std::string	shapeId () const
	Component Data Accessors.
std::string	fillColor () const
bool	stroked () const
std::string	type () const
bool	allowInCell () const
XLShapeStyle	style ()
XLShapeClientData	clientData ()
bool	setFillColor (std::string_view newFillColor)
	Setter functions.
bool	setStroked (bool set)
bool	setType (std::string_view newType)
bool	setAllowInCell (bool set)
bool	setStyle (std::string_view newStyle)
bool	setStyle (XLShapeStyle const &newStyle)

Friends
class	XLVmlDrawing
class	XLComments

Constructor & Destructor Documentation

XLShape() [1/4]

XLShape::XLShape

(

)

XLShape() [2/4]

XLShape::XLShape ( const XMLNode &  node )

explicit

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

Parameters

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

XLShape() [3/4]

OpenXLSX::XLShape::XLShape ( const XLShape &  other )

default

Copy Constructor.

Parameters

other

Object to be copied.

XLShape() [4/4]

OpenXLSX::XLShape::XLShape ( XLShape &&  other )

defaultnoexcept

Move Constructor.

Parameters

other

Object to be moved.

~XLShape()

OpenXLSX::XLShape::~XLShape ( )

default

Member Function Documentation

allowInCell()

bool XLShape::allowInCell

(

)

const

clientData()

XLShapeClientData XLShape::clientData

(

)

fillColor()

std::string XLShape::fillColor

(

)

const

operator=() [1/2]

XLShape & OpenXLSX::XLShape::operator=

(

const XLShape &

other

)

Copy assignment operator.

Parameters

other

Right hand side of assignment operation.

Returns

A reference to the lhs object.

operator=() [2/2]

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

defaultnoexcept

Move assignment operator.

Parameters

other

Right hand side of assignment operation.

Returns

A reference to lhs object.

setAllowInCell()

bool XLShape::setAllowInCell

(

bool

set

)

setFillColor()

bool XLShape::setFillColor

(

std::string_view

newFillColor

)

Setter functions.

Parameters

value

that shall be set

Returns

true for success, false for failure

setStroked()

bool XLShape::setStroked

(

bool

set

)

setStyle() [1/2]

bool XLShape::setStyle

(

std::string_view

newStyle

)

setStyle() [2/2]

bool XLShape::setStyle

(

XLShapeStyle const &

newStyle

)

setType()

bool XLShape::setType

(

std::string_view

newType

)

shapeId()

std::string XLShape::shapeId

(

)

const

Component Data Accessors.

stroked()

bool XLShape::stroked

(

)

const

style()

XLShapeStyle XLShape::style

(

)

type()

std::string XLShape::type

(

)

const

Friends And Related Symbol Documentation

XLComments

friend class XLComments

friend

XLVmlDrawing

friend class XLVmlDrawing

friend

---

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