Options controlling the appearance and behavior of time signatures. More...

#include <Options.h>

Inheritance diagram for musx::dom::options::TimeSignatureOptions:

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

Public Attributes
Evpu	timeUpperLift {}
	"Vertical Adjustment: Top Symbol, Score"

Evpu	timeFront {}
	"Space Before Time Signature, Score"

Evpu	timeBack {}
	"Space After Time Signature, Score"

Evpu	timeFrontParts {}
	"Space Before Time Signature, Parts"

Evpu	timeBackParts {}
	"Space After Time Signature, Parts"

Evpu	timeUpperLiftParts {}
	"Vertical Adjustment: Top Symbol, Parts"

Evpu	timeLowerLiftParts {}
	"Vertical Adjustment: Bottom Symbol, Parts"

Evpu	timeAbrvLiftParts {}
	"Vertical Adjustment: Abbreviated Symbol, Parts"

bool	timeSigDoAbrvCommon {}
	Abbreviate common time.

bool	timeSigDoAbrvCut {}
	Abbreviate cut time.

int	numCompositeDecimalPlaces {}
	"Decimal Places for Composite Meters" (xml node is `<defFloat>`)

bool	cautionaryTimeChanges {}
	"Display Courtesy Time Signature at End of Staff System"

Evpu	timeLowerLift {}
	"Vertical Adjustment: Bottom Symbol, Score"

Evpu	timeAbrvLift {}
	"Vertical Adjustment: Abbreviated Symbol, Score"

Static Public Attributes
static constexpr std::string_view	XmlNodeName = "timeSignatureOptions"
	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 time signatures.

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

Public Member Functions