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

#include <Options.h>

Inheritance diagram for musx::dom::options::KeySignatureOptions:

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

Public Attributes
bool	doKeyCancel {}
	"Cancel Outgoing Key Signature"

bool	doCStart {}
	"In C, Display Naturals at Start of Staff System"

bool	redisplayOnModeChange {}
	"Redisplay Key Signature If Only Mode is Changing" (xml node is `<doBankDiff>`)

Evpu	keyFront {}
	"Space Before Key Signature"

Evpu	keyMid {}
	"Space After Cancelled Key"

Evpu	keyBack {}
	"Space After Key Signature"

Evpu	acciAdd {}
	"Space Between Key Signature Accidentals"

bool	showKeyFirstSystemOnly {}
	"Show Key Signature Only on First System"

Evpu	keyTimeSepar {}
	"Extra Space Between Key & Time Signatures" (xml node is `<keyTime>`)

bool	simplifyKeyHoldOctave {}
	"Preserve Octave When Simplifying Keys"

bool	cautionaryKeyChanges {}
	"Display Courtesy Key Signature at End of Staff System"

bool	doKeyCancelBetweenSharpsFlats {}
	"When Switching Between Sharps and Flats"

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

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

Public Member Functions