musx::dom::options::FlagOptions Class Reference

Options controlling the appearance and adjustments of flags. More...

#include <Options.h>

Inheritance diagram for musx::dom::options::FlagOptions:

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

Public Attributes
bool	straightFlags {}
	Whether to use straight flags.
Efix	upHAdj {}
	Horizontal adjustment for upward flags in Efix.
Efix	downHAdj {}
	Horizontal adjustment for downward flags in Efix.
Efix	upHAdj2 {}
	Horizontal adjustment for secondary upward flags in Efix.
Efix	downHAdj2 {}
	Horizontal adjustment for secondary downward flags in Efix.
Efix	upHAdj16 {}
	Horizontal adjustment for sixteenth upward flags in Efix.
Efix	downHAdj16 {}
	Horizontal adjustment for sixteenth downward flags in Efix.
Efix	eighthFlagHoist {}
	Hoist value for eighth note flags in Efix. (This value is not on Finale's UI page for Flag Options.)
Efix	stUpHAdj {}
	Horizontal adjustment for straight upward flags in Efix.
Efix	stDownHAdj {}
	Horizontal adjustment for straight downward flags in Efix.
Efix	upVAdj {}
	Vertical adjustment for upward flags in Efix.
Efix	downVAdj {}
	Vertical adjustment for downward flags in Efix.
Efix	upVAdj2 {}
	Vertical adjustment for secondary upward flags in Efix. (xml node is <upVadj2>: this is probably a type somewhere in Finale)
Efix	downVAdj2 {}
	Vertical adjustment for secondary downward flags in Efix.
Efix	upVAdj16 {}
	Vertical adjustment for sixteenth upward flags in Efix.
Efix	downVAdj16 {}
	Vertical adjustment for sixteenth downward flags in Efix.
Efix	stUpVAdj {}
	Vertical adjustment for straight upward flags in Efix.
Efix	stDownVAdj {}
	Vertical adjustment for straight downward flags in Efix.
Evpu	flagSpacing {}
	"Flag Spacing" in Evpu. (xml node is <separ>)
Evpu	secondaryGroupAdj {}
	"Secondary Group Adjust" in Evpu. (xml node is <extra>)

Static Public Attributes
static constexpr std::string_view	XmlNodeName = "flagOptions"
	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 adjustments of flags.

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