musx::dom::options::RepeatOptions Class Reference

Options controlling the appearance of repeats. More...

#include <Options.h>

Inheritance diagram for musx::dom::options::RepeatOptions:

Public Types
enum class	WingStyle { None , Curved , SingleLine , DoubleLine }
	Wing Styles from Document Options - Repeats.
enum class	BackToBackStyle { Thin , Mixed , Thick }
	Back-to-Back Styles from Document Options - Repeats.
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
	RepeatOptions (const DocumentWeakPtr &document, Cmper partId=0, ShareMode shareMode=ShareMode::All)
	Constructor function.
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< RepeatOptions > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.

Public Attributes
int	maxPasses {}
	Maximum number of passes for repeats.
bool	addPeriod {}
	"Add Period After Number"
Efix	thickLineWidth {}
	Heavy line thickness in Efix.
Efix	thinLineWidth {}
	Thin line thickness in Efix.
Efix	lineSpace {}
	Space between lines in Efix.
BackToBackStyle	backToBackStyle {}
	Back-to-back style.
Evpu	forwardDotHPos {}
	Horizontal separation of forward repeat dots in Evpu.
Evpu	backwardDotHPos {}
	Horizontal separation of backward repeat dots in Evpu.
Evpu	upperDotVPos {}
	Vertical adjustment of the upper dot in Evpu.
Evpu	lowerDotVPos {}
	Vertical adjustment of the lower dot in Evpu.
WingStyle	wingStyle {}
	Wing style.
Evpu	afterClefSpace {}
	Space after clef in Evpu.
Evpu	afterKeySpace {}
	Space after key signature in Evpu.
Evpu	afterTimeSpace {}
	Space after time signature in Evpu.
Evpu	bracketHeight {}
	Height of the bracket in Evpu.
Evpu	bracketHookLen {}
	Length of the bracket hook in Evpu.
Efix	bracketLineWidth {}
	Width of the bracket line in Efix.
Evpu	bracketStartInset {}
	Inset at the start of the bracket in Evpu.
Evpu	bracketEndInset {}
	Inset at the end of the bracket in Evpu.
Evpu	bracketTextHPos {}
	Horizontal position of bracket text in Evpu.
Evpu	bracketTextVPos {}
	Vertical position of bracket text in Evpu.
Evpu	bracketEndHookLen {}
	Length of the hook at the end of the bracket in Evpu.
bool	bracketEndAnchorThinLine {}
	Whether the end of the bracket anchors to a thin line.
bool	showOnTopStaffOnly {}
	"Show On Top Staff Only"
Cmper	showOnStaffListNumber {}
	Staff list number (0 if none). Cmper links to associated "repeatStaffList..." xml nodes.

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

Additional Inherited Members
Protected Member Functions inherited from musx::dom::OptionsBase
	OptionsBase (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode)
	Constructs the OptionsBase and validates XmlNodeName in the derived class.
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

Options controlling the appearance of repeats.

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