musx::dom::options::PageFormatOptions::PageFormat Class Reference

Represents the format settings for a page. More...

#include <Options.h>

Public Member Functions
util::Fraction	calcPageScaling () const
	Calculates the page scaling as a musx::util::Fraction where 1/1 means no scaling.
util::Fraction	calcSystemScaling () const
	Calculates the system scaling as a musx::util::Fraction where 1/1 means no scaling.
util::Fraction	calcCombinedSystemScaling () const
	Calculates the combined system & page scaling as a musx::util::Fraction where 1/1 means no scaling.
	PageFormat ()=default
	Default constructor for PageFormat.

Static Public Member Functions
static const xml::XmlElementArray< PageFormat > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.

Public Attributes
Evpu	pageHeight {}
	Height of the page.
Evpu	pageWidth {}
	Width of the page.
int	pagePercent {}
	Page scaling percentage (a value of 100 means no scaling).
int	sysPercent {}
	System scaling percentage (a value of 100 means no scaling).
Evpu16ths	rawStaffHeight {}
	Raw staff height (in 1/16 Evpu units). Note that this is different units than others::StaffSystem::staffHeight.
Evpu	leftPageMarginTop {}
	Top margin for the left page. (Sign reversed in Finale UI.)
Evpu	leftPageMarginLeft {}
	Left margin for the left page.
Evpu	leftPageMarginBottom {}
	Bottom margin for the left page.
Evpu	leftPageMarginRight {}
	Right margin for the left page. (Sign reversed in Finale UI.)
Evpu	rightPageMarginTop {}
	Top margin for the right page. (Sign reversed in Finale UI.)
Evpu	rightPageMarginLeft {}
	Left margin for the right page.
Evpu	rightPageMarginBottom {}
	Bottom margin for the right page.
Evpu	rightPageMarginRight {}
	Right margin for the right page. (Sign reversed in Finale UI.)
Evpu	sysMarginTop {}
	System top margin. (Sign reversed in Finale UI.)
Evpu	sysMarginLeft {}
	System left margin.
Evpu	sysMarginBottom {}
Evpu	sysMarginRight {}
	System bottom margin. (Sign reversed in Finale UI.)
Evpu	sysDistanceBetween {}
	Distance between systems. (Sign reversed in Finale UI.)
Evpu	firstPageMarginTop {}
	Top margin for the first page. (Sign reversed in Finale UI.)
Evpu	firstSysMarginTop {}
	Top margin for the first system. (Sign reversed in Finale UI.)
Evpu	firstSysMarginLeft {}
	Left margin for the first system.
Evpu	firstSysMarginDistance {}
	Distance between the first systems. (Sign reversed in Finale UI.)
bool	facingPages {}
	Whether to use the right page margin values.
bool	differentFirstSysMargin {}
	Whether to use the first system values.
bool	differentFirstPageMargin {}
	Whether to use the firstPageMarginTop value.

Detailed Description

Represents the format settings for a page.

Member Data Documentation

sysMarginBottom

Evpu musx::dom::options::PageFormatOptions::PageFormat::sysMarginBottom {}

System bottom margin. This value is 96 (i.e., 1 5-line staff thickness) less than the U.I. value. That means if you enter 0 in the Finale UI, this value is -96. The U.I. value is also sign reversed.