musx::dom::others::NamePositioning Class Reference

Contains horizontal and vertical offsets, alignment, and expansion settings for name positioning. More...

#include <CommonClasses.h>

Inheritance diagram for musx::dom::others::NamePositioning:

Public Types
enum class	AlignJustify { Left , Right , Center }
	Alignment and justification options for staff and group names. 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
	NamePositioning (const DocumentWeakPtr &document, Cmper partId=SCORE_PARTID, ShareMode shareMode=ShareMode::All, Cmper cmper=0)
	Constructs an NamePositioning 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< NamePositioning > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.

Public Attributes
Evpu	horzOff {}
	Horizontal distance from staff in Evpu.
Evpu	vertOff {}
	Vertical offset from staff in Evpu.
AlignJustify	justify {}
	Justification for the name text.
bool	indivPos {}
	Indicates that this positioning overrides the default positioning. (Not used by options::StaffOptions.)
AlignJustify	hAlign {}
	Horizontal alignment for the name text. (xml node is <halign>)
bool	expand {}
	"Expand Single Word"

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

Contains horizontal and vertical offsets, alignment, and expansion settings for name positioning.

This class is used both for default names as well as name positioning Staff, StaffStyle, and details::StaffGroup.

Member Enumeration Documentation

AlignJustify

enum class musx::dom::others::NamePositioning::AlignJustify

strong

Alignment and justification options for staff and group names.

Enumerator
Left	Left alignment or justification (the default value.)
Right	Right alignment.
Center	Center alignment.

Constructor & Destructor Documentation

NamePositioning()

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

inlineexplicit

Constructs an NamePositioning object.

Parameters

document	Shared pointer to the document.
partId	The part ID if this name positioning is unlinked.
shareMode	The share mode if this name positioning is unlinked.
cmper	Comperator parameter. This value is zero for name positioning taken from options::StaffOptions.