musx::dom::options::MiscOptions Class Reference

Options controlling miscellaneous settings. More...

#include <Options.h>

Inheritance diagram for musx::dom::options::MiscOptions:

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

Public Attributes
bool	showRepeatsForParts {}
	"Show Repeats for Parts"
Edu	pickupValue {}
bool	keepWrittenOctaveInConcertPitch {}
	"Keep Octave Transposition in Concert Pitch" (xml node is <retainOctaveTransInConcertPitch>)
bool	showActiveLayerOnly {}
	"Show Active Layer Only" (xml node is <showCurrentLayerOnly>)
bool	consolidateRestsAcrossLayers {}
	"Consolidate Rests Across Layers" (xml node is <combineRestsAcrossLayers>)
Evpu	shapeDesignerDashLength {}
	Shape Designer dash length in Evpu. (xml node is <sdDashOn>)
Evpu	shapeDesignerDashSpace {}
	Shape Designer dash space in Evpu. (xml node is <sdDashOff>)
Evpu	restWidthAdjust {}
	Purpose unknown.
Evpu	dblWholeVertAdjust {}
	Purpose unknown.
bool	alignMeasureNumbersWithBarlines {}
	"Align Measure Numbers With Barlines" (xml node is <drawMeasureNumbersOverBarlines>)

Static Public Attributes
static constexpr std::string_view	XmlNodeName = "miscOptions"
	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 miscellaneous settings.

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

Member Data Documentation

pickupValue

Edu musx::dom::options::MiscOptions::pickupValue {}

The length of a pickup note on the first bar. This value is populated if you used the "Document->Pickup Measure" menu to create the pickup. If the pickup was created in a legacy version of Finale, the value is probably not populated. The pickup itself is implemented with a spacer, but pickupValue specifies the default rest value for empty staves in the pickup measure. See others::Frame for more information.