Options for configuring clefs in a musical context. More...

#include <Options.h>

Inheritance diagram for musx::dom::options::ClefOptions:

Classes
class	ClefDef
	Represents a single clef definition. More...

Public Member Functions
	ClefOptions (const DocumentWeakPtr &document, Cmper partId=0, ShareMode shareMode=ShareMode::All)
	Constructor.

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< ClefOptions > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.

Public Attributes
ClefIndex	defaultClef {}
	Default clef identifier. An index into `clefDefs`.

int	clefChangePercent {}
	Percentage adjustment for end-of-measure clef changes. 100 means no adjustment. (xml node is `<endMeasClefPercent>`)

Evpu	clefChangeOffset {}
	Offset from next barline for end-of-measure clef changes. (xml node is `<endMeasClefPosAdd>`).

Evpu	clefFrontSepar {}
	Spacing before clef. (xml node is `<clefFront>`)

Evpu	clefBackSepar {}
	Spacing after clef. (xml node is `<clefBack>`)

bool	showClefFirstSystemOnly {}
	"Display Clef Only on First System"

Evpu	clefKeySepar {}
	"Extra Space Between Clef and Key Signature" (xml node is `<clefKey>`)

Evpu	clefTimeSepar {}
	"Extra Space Between Clef and Time Signature" (xml node is `<clefTime>`)

bool	cautionaryClefChanges {}
	"Display Courtesy Clef a End of Staff System"

std::vector< std::shared_ptr< ClefDef > >	clefDefs
	Vector of clef definitions (ClefDef).

Static Public Attributes
static constexpr std::string_view	XmlNodeName = "clefOptions"
	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 for configuring clefs in a musical context.

Constructor & Destructor Documentation

musx::dom::options::ClefOptions::ClefOptions	(	const DocumentWeakPtr &	document,
		Cmper	partId = `0`,
		ShareMode	shareMode = `ShareMode::All`
	)

inlineexplicit

Constructor.

Parameters

document	A weak pointer to the document object.
partId	Usually 0. This parameter is needed for the generic factory routine.
shareMode	Usually `ShareMode::All`. This parameter is needed for the generic factory routine.

Constructs a FontOptions object that is associated with the provided document.