MUSX Document Model
Loading...
Searching...
No Matches
musx::dom::others::MeasureNumberRegion::ScorePartData Class Reference

Measure number data that can differ in score or part. More...

#include <Others.h>

+ Inheritance diagram for musx::dom::others::MeasureNumberRegion::ScorePartData:

Public Member Functions

 ScorePartData (const DocumentWeakPtr &document)
 Constructor.
 
- 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< ScorePartData > & xmlMappingArray ()
 Required for musx::factory::FieldPopulator.
 

Public Attributes

std::shared_ptr< FontInfostartFont
 The font used for numbers at start of system.
 
std::shared_ptr< FontInfomultipleFont
 The font used for mid-system numbers.
 
std::shared_ptr< FontInfommRestFont
 The font used for multi-measure rest ranges.
 
std::shared_ptr< EnclosurestartEnclosure
 Enclosure settings for numbers at start of system.
 
std::shared_ptr< EnclosuremultipleEnclosure
 Enclosure settings for mid-system numbers.
 
Evpu startXdisp {}
 Horizontal offset for numbers at start of system.
 
Evpu startYdisp {}
 Vertical offset for numbers at start of system.
 
Evpu multipleXdisp {}
 Horizontal offset for mid-system numbers.
 
Evpu multipleYdisp {}
 Vertical offset for mid-system numbers.
 
Evpu mmRestXdisp {}
 Horizontal offset for multi-measure rest ranges.
 
Evpu mmRestYdisp {}
 Vertical offset for multi-measure rest ranges.
 
char32_t leftMmBracketChar {}
 UTF-32 code for the left bracket of multi-measure rest ranges.
 
char32_t rightMmBracketChar {}
 UTF-32 code for the right bracket of multi-measure rest ranges.
 
int startWith {}
 "Beginning with" value. (This value is 0-based. The Finale UI adds 1 for user display.)
 
int incidence {}
 "Show on Every" value.
 
AlignJustify startAlign {}
 Alignment of numbers at the start of system.
 
AlignJustify multipleAlign {}
 Alignment for mid-system numbers.
 
AlignJustify mmRestAlign {}
 Alignment for multi-measure ranges.
 
bool showOnStart {}
 "Show On Start of Staff System" (xml node is <startOfLine>)
 
bool showOnEvery {}
 "Show on Every" activates mid-system numbers. (xml node is <multipleOf>)
 
bool hideFirstMeasure {}
 "Hide First Measure Number in Region." (xml node is <exceptFirstMeas>)
 
bool showMmRange {}
 "Show Measure Ranges on Multimeasure Rests" (xml node is <mmRestRange>)
 
bool showOnMmRest {}
 "Show on Multimeasure Rests" (xml node is <mmRestRangeForce>)
 
bool useStartEncl {}
 Use enclosure for start-of-system settings.
 
bool useMultipleEncl {}
 Use enclosure for mid-system settings.
 
bool showOnTop {}
 Show measure numbers on the top staff.
 
bool showOnBottom {}
 Show measure numbers on the bottom staff.
 
bool excludeOthers {}
 Exclude other staves.
 
bool breakMmRest {}
 Mid-system numbers break multimeasure rests.
 
AlignJustify startJustify {}
 Justification for numbers at the start of system.
 
AlignJustify multipleJustify {}
 Justification for mid-system numbers.
 
AlignJustify mmRestJustify {}
 Justification for multi-measure rest ranges.
 

Additional Inherited Members

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

Measure number data that can differ in score or part.