musx::dom::others::ClefList Class Reference

Represents an element in multimeasure clef list with its positioning and percentage values. More...

#include <Others.h>

Inheritance diagram for musx::dom::others::ClefList:

Public Member Functions
	ClefList (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper, Inci inci)
	Constructor function.
Public Member Functions inherited from musx::dom::OthersBase
Cmper	getCmper () const
	Gets the cmper key value.
std::optional< Inci >	getInci () const
	Gets the optional array index (inci).
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< ClefList > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.

Public Attributes
ClefIndex	clefIndex {}
	The 0-based clef index from the <clef> element.
Edu	xEduPos {}
	The xEduPos value from the <xEduPos> element.
Evpu	yEvpuPos {}
	The yEvpuPos value from the <yEvpuPos> element.
int	percent {}
	The percentage value from the <percent> element.
int	xEvpuOffset {}
	The xEvpuOffset value from the <xEvpuOffset> element.
ShowClefMode	clefMode {}
	The clef mode from the <clefMode> element.
bool	unlockVert {}
	"Allow Vertical Drag"
bool	afterBarline {}
	"Place Clef After Barline"

Static Public Attributes
static constexpr std::string_view	XmlNodeName = "clefEnum"
	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::OthersBase
	OthersBase (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper, std::optional< Inci > inci=std::nullopt)
	Constructs an OthersBase object.
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

Represents an element in multimeasure clef list with its positioning and percentage values.

The cmper is obtained from the details::GFrameHold instance for the staff and measure. Inci 0 is the initial clef at the barline.

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