musx::dom::others::TextRepeatDef Class Reference

Defines text repeat elements with font styling and justification. More...

#include <Others.h>

Inheritance diagram for musx::dom::others::TextRepeatDef:

Public Types
enum class	PoundReplaceOption { Passes , RepeatID , MeasureNumber }
	Enum for poundReplace options. More...
Public Types inherited from musx::dom::EnigmaBase
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
	TextRepeatDef (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper)
	Constructor function.
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::EnigmaBase
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< EnigmaBase > &ptrToThis)
	Performs a final consistency check after population.
virtual bool	requireAllFields () const
	Returns true if all fields are required for valid input.
Public Member Functions inherited from musx::dom::DocumentElement
virtual	~DocumentElement () noexcept(false)=default
	Virtual destructor for polymorphic behavior.
DocumentPtr	getDocument () const
	Gets a reference to the Document.
Cmper	getPartId () const
	Gets the part id associated with this instance.

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

Public Attributes
std::shared_ptr< FontInfo >	font
	The font for this text repeat. (xml nodes <fontID>, <fontSize>, and <efx>)
bool	hasEnclosure {}
	Whether the text repeat has an enclosure. (xml node is <newEnclosure>)
bool	useThisFont {}
	"Use This Font" (for the # substitution)
PoundReplaceOption	poundReplace {}
	"Replace # With" choice.
AlignJustify	justification {}
std::vector< int >	passList
	If this vector contains elements, they define the repeat passes that apply to this instance.

Static Public Attributes
static constexpr std::string_view	XmlNodeName = "textRepeatDef"
	The XML node name for this type.

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::EnigmaBase
	EnigmaBase (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode)
	Constructs the base class.
	EnigmaBase (const EnigmaBase &)=default
	explicit default copy constructor
	EnigmaBase (EnigmaBase &&) noexcept=default
	explicit default move constructor
EnigmaBase &	operator= (const EnigmaBase &)
	no-op copy assignment operator allows subclasses to copy their values.
EnigmaBase &	operator= (EnigmaBase &&) noexcept
	no-op move assignment operator allows subclasses to move their values.
Protected Member Functions inherited from musx::dom::DocumentElement
	DocumentElement (const DocumentWeakPtr &document, Cmper partId)
	Constructs the document element.
	DocumentElement (const DocumentElement &)=default
	explicit default copy constructor
	DocumentElement (DocumentElement &&) noexcept=default
	explicit default move constructor
DocumentElement &	operator= (const DocumentElement &)
	no-op copy assignment operator allows subclasses to copy their values.
DocumentElement &	operator= (DocumentElement &&) noexcept
	no-op move assignment operator allows subclasses to move their values.

Detailed Description

Defines text repeat elements with font styling and justification.

Text repeat elements are indications like "D.S. al Fine", "Segno", or "To Coda" that have playback jumps associated with them.

The cmper is the unique identifier used in the document.

This class is identified by the XML node name "textRepeatDef".

Member Enumeration Documentation

PoundReplaceOption

enum class musx::dom::others::TextRepeatDef::PoundReplaceOption

strong

Enum for poundReplace options.

Enumerator
Passes	"Number of Times Played" (the default: may never appear in xml)
RepeatID	"Text Repeat ID in Target" (xml value is "repeatID")
MeasureNumber	"Measure Number in Target" (xml value is "measNum")

Member Data Documentation

justification

AlignJustify musx::dom::others::TextRepeatDef::justification {}

Although called "justification" in Finale's U.I, this value is used for both the alignment of the text within the measure as well as its justification. (xml node is <justify >)