musx::dom::others::Enclosure Class Reference

Represents the enclosure settings for text expressions. More...

#include <CommonClasses.h>

Inheritance diagram for musx::dom::others::Enclosure:

Public Types
enum class	Shape : uint8_t {   NoEnclosure = 0 , Rectangle = 1 , Ellipse = 2 , Triangle = 3 ,   Diamond = 4 , Pentagon = 5 , Hexagon = 6 , Heptagon = 7 ,   Octogon = 8 }
	Enumeration for enclosure shapes. More...
Public Types inherited from musx::dom::Base
enum class	ShareMode { All , Partial , None }
	Describes how this instance is shared between part and score. More...
using	SharedNodes = std::set< std::string >
	The container type for shared nodes.

Public Member Functions
	Enclosure (const DocumentWeakPtr &document, Cmper partId=SCORE_PARTID, ShareMode shareMode=ShareMode::All, Cmper cmper=0)
	Constructs an Enclosure object.
Public Member Functions inherited from musx::dom::OthersBase
	OthersBase (const OthersBase &)=default
	explicit default copy constructor
	OthersBase (OthersBase &&) noexcept=default
	explicit default move constructor
Cmper	getCmper () const
	Gets the cmper key value.
std::optional< Inci >	getInci () const
	Gets the optional array index (inci).
Cmper	getRequestedPartId () const
	If this instance was retrieved from an object pool, it contains the part ID that was used to retrieve it. If this value is different than getSourcePartId, then this instance is a copy of the pool instance.
Public Member Functions inherited from musx::dom::Base
virtual	~Base () noexcept(false)=default
	Virtual destructor for polymorphic behavior.
DocumentPtr	getDocument () const
	Gets a reference to the Document.
Cmper	getSourcePartId () const
	Gets the source partId for this instance. If an instance is fully shared with the score, the source is SCORE_PARTID. If an instance is partially shared or non shared, the source is the ID of the part that sourced it.
ShareMode	getShareMode () const
	Gets the sharing mode for this instance.
const SharedNodes &	getUnlinkedNodes () const
	Gets the unlinked nodes for this instance. (Only populated for ShareMode::Partial)
void	addUnlinkedNode (const std::string &nodeName)
	Adds a shared node for this instance.
virtual void	integrityCheck (const std::shared_ptr< Base > &ptrToThis)
	Allows a class to determine if it has been properly contructed by the factory and fix issues that it can, such as creating default instances of contained classes.
virtual bool	requireAllFields () const
	Specifies if the parser should alert (print or throw) when an unknown xml tag is found for this class.

Static Public Member Functions
static const xml::XmlElementArray< Enclosure > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.

Public Attributes
Evpu	xAdd {}
	Center X offset - offsets text from center (in EVPU).
Evpu	yAdd {}
	Center Y offset - offsets text from center (in EVPU).
Evpu	xMargin {}
	Half width - extra space on left/right sides (in EVPU).
Evpu	yMargin {}
	Half height - extra space on top/bottom sides (in EVPU).
Efix	lineWidth {}
	Line thickness in 64ths of an EVPU (EFIX).
Shape	shape {}
	Enclosure shape (default: NoEnclosure).
Efix	cornerRadius {}
	Corner radius (in EFIX).
bool	fixedSize {}
	Whether the enclosure is fixed size (ignore text bounding box)
bool	equalAspect {}
	"Match Height and Width"
bool	notTall {}
	"Enforce Minimum Width": don't let shape get taller than it is wide
bool	opaque {}
	Whether the enclosure is opaque.
bool	roundCorners {}
	Whether the enclosure has rounded corners.

Additional Inherited Members
Protected Member Functions inherited from musx::dom::OthersBase
	OthersBase (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper, std::optional< Inci > inci=std::nullopt)
	Constructs an OthersBase object.
OthersBase &	operator= (const OthersBase &other)
	Assignment operator delegates to base, preserving OthersBase state.
OthersBase &	operator= (OthersBase &&other) noexcept
	Assignment operator delegates to base, preserving OthersBase state.
Protected Member Functions inherited from musx::dom::Base
	Base (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode)
	Constructs the base class.
	Base (const Base &)=default
	explicit default copy constructor
	Base (Base &&) noexcept=default
	explicit default move constructor
Base &	operator= (const Base &)
	no-op copy assignment operator allows subclasses to copy their values.
Base &	operator= (Base &&) noexcept
	no-op move assignment operator allows subclasses to move their values.

Detailed Description

Represents the enclosure settings for text expressions.

Member Enumeration Documentation

Shape

enum class musx::dom::others::Enclosure::Shape : uint8_t

strong

Enumeration for enclosure shapes.

Enumerator
NoEnclosure	No enclosure.
Rectangle	Rectangle.
Ellipse	Ellipse.
Triangle	Triangle.
Diamond	Diamond.
Pentagon	Pentagon.
Hexagon	Hexagon.
Heptagon	Heptagon.
Octogon	Octogon.

Constructor & Destructor Documentation

Enclosure()

musx::dom::others::Enclosure::Enclosure ( const DocumentWeakPtr &  document, Cmper  partId = SCORE_PARTID, ShareMode  shareMode = ShareMode::All, Cmper  cmper = 0  )

inlineexplicit

Constructs an Enclosure object.

Parameters

document	Shared pointer to the document.
partId	Usually 0. This parameter is needed for the generic factory routine.
shareMode	Usually ShareMode::All. This parameter is needed for the generic factory routine.
cmper	Comperator parameter. This value is zero for enclosures taken from others::MeasureNumberRegion.