musx::dom::options::MultimeasureRestOptions Class Reference

Options controlling the appearance and behavior of multimeasure rests. More...

#include <Options.h>

Inheritance diagram for musx::dom::options::MultimeasureRestOptions:

Public Member Functions
	MultimeasureRestOptions (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< MultimeasureRestOptions > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.

Public Attributes
Evpu	measWidth {}
	Space allocated per measure in multimeasure rest in Evpu. (xml node is <meaSpace>)
Evpu	numAdjY {}
	Vertical adjustment for number in Evpu. The Finale UI reverses the sign of this value. (xml node is <numdec>)
Cmper	shapeDef {}
	Cmper of shape for multimeasure rest H-bar.
int	numStart {}
	Value for "Start Number At".
int	useSymsThreshold {}
	Numbers of bars rest below this number use symbols if useSymbols is checked. (xml node is <threshold>)
Evpu	symSpacing {}
	Spacing between symbols in Evpu if useSymbols is checkd. (xml node is <spacing>)
Evpu	numAdjX {}
	Horizontal adjustment for number in Evpu.
Evpu	startAdjust {}
	Start point adjustment for H-bar shape in Evpu.
Evpu	endAdjust {}
	End point adjustment for H-bar shape in Evpu.
bool	useSymbols {}
	Use character style for rests. (xml node is <useCharRestStyle>)
bool	noHorizontalStretch {}
	Inverse of "Stretch Horizontally" option.
bool	autoUpdateMmRests {}
	Automatically update multimeasure rests when the user changes these options.

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

Additional Inherited Members
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.
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 and behavior of multimeasure rests.

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