Per-staff/per-measure overrides for the position and appearance of a measure number. More...

#include <Details.h>

Inheritance diagram for musx::dom::details::MeasureNumberIndividualPositioning:

Public Types
enum class	ForceVisibility { None , Show , Hide }
	Force-visibility options for the measure number at this location. More...

Public Types inherited from musx::dom::EnigmaBase
enum class	ShareMode { All , Partial , None }
	Describes how this instance is shared between part and score. More...

Public Member Functions
	MeasureNumberIndividualPositioning (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper staffId, Cmper meas, Inci inci)
	Constructor.

Public Member Functions inherited from musx::dom::DetailsBase
	DetailsBase (const DetailsBase &)=default
	explicit default copy constructor

	DetailsBase (DetailsBase &&) noexcept=default
	explicit default move constructor

Cmper	getCmper1 () const
	Gets the `cmper1` key value.

Cmper	getCmper2 () const
	Gets the `cmper2` key value.

std::optional< Inci >	getInci () const
	Gets the optional array index (`inci`).

Cmper	getRequestedPartId () const
	If this instance was retrieved from an object pool, it contains the part ID that was used to retrieve it. If this value is different than getSourcePartId, then this instance is a copy of the pool instance.

Public Member Functions inherited from musx::dom::EnigmaBase
Cmper	getSourcePartId () const
	Gets the source partId for this instance. If an instance is fully shared with the score, the source is SCORE_PARTID. If an instance is partially shared or non shared, the source is the ID of the part that sourced it.

ShareMode	getShareMode () const
	Gets the sharing mode for this instance.

virtual void	integrityCheck (const std::shared_ptr< EnigmaBase > &ptrToThis)
	Performs a final consistency check after population.

virtual bool	requireAllFields () const
	Returns true if all fields are required for valid input.

Public Member Functions inherited from musx::dom::DocumentElement
virtual	~DocumentElement () noexcept(false)=default
	Virtual destructor for polymorphic behavior.

DocumentPtr	getDocument () const
	Gets a reference to the Document.

Cmper	getPartId () const
	Gets the part id associated with this instance.

Static Public Member Functions
static const xml::XmlElementArray< MeasureNumberIndividualPositioning > &	xmlMappingArray ()
	Required for musx::

Public Attributes
Cmper	measNumRegion {}
	The Cmper of the others::MeasureNumberRegion that this override applies to. (xml node is `<region>`)

Evpu	xOffset {}
	Horizontal offset for the measure number. (xml node is `<x1add>`)

Evpu	yOffset {}
	Vertical offset for the measure number. (xml node is `<y1add>`)

Evpu	xOffset2 {}
	Horizontal offset for the measure number range under a multimeasure rest (Page View only). (xml node is `<x2add>`)

ForceVisibility	forceVisibility {}
	Force-visibility behavior. (xml node is `<forceHide>`)

bool	isAlternateNumber {}
	Whether this is an alternate number, such as a boxed number. (xml node is `<isAltNum>`)

bool	useEnclosure {}
	Whether to use an enclosure for this number. (xml node is `<useEncl>`)

std::shared_ptr< others::Enclosure >	enclosure
	Optional enclosure settings. (xml node is `<encl>`)

Static Public Attributes
static constexpr std::string_view	XmlNodeName = "measNumbIndivPos"
	The XML node name for this type.

Additional Inherited Members
Protected Member Functions inherited from musx::dom::DetailsBase
	DetailsBase (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper1, Cmper cmper2, std::optional< Inci > inci=std::nullopt)
	Constructs a DetailsBase object.

DetailsBase &	operator= (const DetailsBase &other)
	Assignment operator delegates to base, preserving OthersBase state.

DetailsBase &	operator= (DetailsBase &&other) noexcept
	Assignment operator delegates to base, preserving OthersBase state.

Protected Member Functions inherited from musx::dom::EnigmaBase
	EnigmaBase (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode)
	Constructs the base class.

	EnigmaBase (const EnigmaBase &)=default
	explicit default copy constructor

	EnigmaBase (EnigmaBase &&) noexcept=default
	explicit default move constructor

EnigmaBase &	operator= (const EnigmaBase &)
	no-op copy assignment operator allows subclasses to copy their values.

EnigmaBase &	operator= (EnigmaBase &&) noexcept
	no-op move assignment operator allows subclasses to move their values.

Protected Member Functions inherited from musx::dom::DocumentElement
	DocumentElement (const DocumentWeakPtr &document, Cmper partId)
	Constructs the document element.

	DocumentElement (const DocumentElement &)=default
	explicit default copy constructor

	DocumentElement (DocumentElement &&) noexcept=default
	explicit default move constructor

DocumentElement &	operator= (const DocumentElement &)
	no-op copy assignment operator allows subclasses to copy their values.

DocumentElement &	operator= (DocumentElement &&) noexcept
	no-op move assignment operator allows subclasses to move their values.

Detailed Description

Per-staff/per-measure overrides for the position and appearance of a measure number.

Cmper1 is the staff (staffId) Cmper and Cmper2 is the measure Cmper. This class is identified by the XML node name "measNumbIndivPos".

Member Enumeration Documentation

◆ ForceVisibility

enum class musx::dom::details::MeasureNumberIndividualPositioning::ForceVisibility

strong

Force-visibility options for the measure number at this location.

Enumerator
None	No override (default; node may be omitted in XML)
Show	Force the number to display (xml text value: "force")
Hide	Force the number to be hidden (xml text value: "hide")

Constructor & Destructor Documentation

◆ MeasureNumberIndividualPositioning()

musx::dom::details::MeasureNumberIndividualPositioning::MeasureNumberIndividualPositioning	(	const DocumentWeakPtr &	document,
		Cmper	partId,
		ShareMode	shareMode,
		Cmper	staffId,
		Cmper	meas,
		Inci	inci
	)

inlineexplicit

Constructor.

Parameters

document	A weak pointer to the associated document.
partId	The source part for this instance.
shareMode	The sharing mode for this MeasureNumberIndividualPositioning.
staffId	The staff ID for this instance.
meas	The measure ID for this instance.
inci	The 0-based incident.

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ForceVisibility

Constructor & Destructor Documentation

◆ MeasureNumberIndividualPositioning()