musx::dom::others::Page Class Reference

Represents the attributes of a page in the page layout. More...

#include <Others.h>

Inheritance diagram for musx::dom::others::Page:

Public Member Functions
	Page (const DocumentWeakPtr &document, PageCmper pageId, ShareMode shareMode, Cmper cmper)
	Constructor function.
bool	isBlank () const
	is this a blank page
util::Fraction	calcPageScaling () const
	Calculate the effect page scaling.
Public Member Functions inherited from musx::dom::OthersBase
	OthersBase (const OthersBase &)=default
	explicit default copy constructor
	OthersBase (OthersBase &&) noexcept=default
	explicit default move constructor
Cmper	getCmper () const
	Gets the cmper 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::Base
virtual	~Base () noexcept(false)=default
	Virtual destructor for polymorphic behavior.
DocumentPtr	getDocument () const
	Gets a reference to the Document.
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.
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 (const std::shared_ptr< Base > &ptrToThis)
	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 void	calcSystemInfo (const DocumentPtr &document)
	Resolver function used by factory to compute system and measure information for all pages.
static const xml::XmlElementArray< Page > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.

Public Attributes
Evpu	height {}
	Page height in Evpu.
Evpu	width {}
	Page width in Evpu.
int	percent {}
	Percent value (scaling factor).
SystemCmper	firstSystemId {}
	First system on the page (-1 if page is blank). See StaffSystem. (xml node is <firstSystem>)
bool	holdMargins {}
	"Hold Margins" (xml node is <scaleContentOnly>)
Evpu	margTop {}
	Top margin in Evpu. (Sign reversed in Finale UI.)
Evpu	margLeft {}
	Left margin in Evpu.
Evpu	margBottom {}
	Bottom margin in Evpu.
Evpu	margRight {}
	Right margin in Evpu. (Sign reversed in Finale UI.)
std::optional< SystemCmper >	lastSystemId
	Computed by the Resolver function calcSystemInfo. This value is not in the xml.
std::optional< MeasCmper >	firstMeasureId
	Computed by the Resolver function calcSystemInfo. This value is not in the xml.
std::optional< MeasCmper >	lastMeasureId
	Computed by the Resolver function calcSystemInfo. This value is not in the xml.

Static Public Attributes
static constexpr std::string_view	XmlNodeName = "pageSpec"
	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.
OthersBase &	operator= (const OthersBase &other)
	Assignment operator delegates to base, preserving OthersBase state.
OthersBase &	operator= (OthersBase &&other) noexcept
	Assignment operator delegates to base, preserving OthersBase state.
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 the attributes of a page in the page layout.

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