musx::dom::options::ClefOptions::ClefDef Class Reference

Represents a single clef definition. More...

#include <Options.h>

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

Public Member Functions
	ClefDef (const DocumentWeakPtr &document)
	the 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.
virtual Cmper	getPartId () const
	Gets the partId for this instance (or SCORE_PARTID for score)
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< ClefDef > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.

Public Attributes
int	middleCPos {}
	Staff position of middle-C for this clef (from top staffline). (xml node is <adjust>.)
char32_t	clefChar {}
	UTF-32 character code for the clef symbol.
int	staffPositon {}
	Staff position of the clef symbol's baseline, from reference staffline (usually the top). (xml node is <clefYDisp>)
Efix	baselineAdjust {}
	Additional baseline adjustment in Efix. (xml node is <baseAdjust>)
Cmper	shapeId {}
	Shape ID if the clef is represented as a shape. (xml node is <shapeID>)
bool	isShape {}
	Indicates if the clef is a shape.
bool	scaleToStaffHeight {}
	Indicates if the shape should scale to staff height.
bool	useOwnFont {}
	Indicates if the clef has its own font.
std::shared_ptr< FontInfo >	font
	When useOwnFont is true, this is the clef's font. Otherwise nullptr.

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::Base
	Base (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode)
	Constructs the base class.
	Base (const Base &)=default
	explicit default copy constructor
	Base (Base &&) noexcept=default
	explicit default move constructor
Base &	operator= (const Base &)
	no-op copy assignment operator allows subclasses to copy their values.
Base &	operator= (Base &&) noexcept
	no-op move assignment operator allows subclasses to move their values.

Detailed Description

Represents a single clef definition.