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, Cmper pageId, ShareMode shareMode, Cmper cmper)
	Constructor function.
bool	isBlank () const
	is this a blank page
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< 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	firstSystem {}
	First system on the page (-1 if page is blank). See StaffSystem.
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 >	lastSystem
	Computed by the Resolver function. 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.
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 the attributes of a page in the page layout.

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