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::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::PartDefinition >	getPartDefinition () const
	Gets the others::PartDefinition corresponding to getPartId.
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 ()
	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< 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	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::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::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::Base
	Base (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode)
	Constructs the base class and enforces the static constexpr XmlNodeName.
Base &	operator= (const Base &)
	assignment constructor: m_unlinkedNodes is intentionally omitted

Detailed Description

Options controlling the appearance and behavior of multimeasure rests.

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