MUSX Document Model
All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
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::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

 TextRepeatDef (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper)
 Constructor function.
 
- Public Member Functions inherited from musx::dom::OthersBase
Cmper getCmper () const
 Gets the cmper key value.
 
std::optional< IncigetInci () const
 Gets the optional array index (inci).
 
- 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 getPartId () const
 Gets the partId for this instance (or 0 for score)
 
std::shared_ptr< others::PartDefinitiongetPartDefinition () const
 Gets the others::PartDefinition corresponding to getPartId.
 
ShareMode getShareMode () const
 Gets the sharing mode for this instance.
 
const SharedNodesgetUnlinkedNodes () 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 ()
 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< TextRepeatDef > & xmlMappingArray ()
 Required for musx::factory::FieldPopulator.
 

Public Attributes

std::shared_ptr< FontInfofont
 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.
 
HorizontalTextJustification 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.
 
- Protected Member Functions inherited from musx::dom::Base
 Base (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode)
 Constructs the base class and enforces the static constexpr XmlNodeName.
 
Baseoperator= (const Base &)
 assignment constructor: m_unlinkedNodes is intentionally omitted
 

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 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

HorizontalTextJustification 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 >)