FCPageFormatPrefs Class Reference

Class for the "Page Format for Score/Parts" preference data. More...

#include <ff_prefs.h>

Inheritance diagram for FCPageFormatPrefs:

Public Member Functions
const char *	ClassName () const override
	Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child class.
const PDKFRAMEWORK_CLASSID	GetClassID () const override
	Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has problems to resolve the true classes of inherited objects.
	FCPageFormatPrefs ()
	The constructor.
bool	Load (twobyte prefsno=1) override
	Overrides Load to be able to handle data that aren't part of the original EDT data structure.
bool	Save () override
	Overrides Save to be able to handle data that aren't part of the original EDT data structure.
bool	LoadScore ()
	Loads the "Page Format for Score" data to the object.
bool	LoadParts ()
	Loads the "Page Format for Parts" data to the object.
twobyte	GetFirstSystemLeft () const
	Returns the left system margin for the first system.
twobyte	GetFirstSystemTop () const
	Returns the top system margin for the first system.
twobyte	GetSystemLeft () const
	Returns the general left system margin setting.
twobyte	GetSystemRight () const
	Returns the right system margin setting.
twobyte	GetSystemTop () const
	Returns the top system margin setting.
twobyte	GetSystemBottom () const
	Returns the bottom system margin setting.
twobyte	GetSystemDistanceBetween () const
	Returns the distance between systems. This is the negative value compared to what's found in the Finale UI.
bool	GetUseFirstSystemMargins () const
	Returns true if the first system should have special margins.
fourbyte	GetPageWidth () const
	Returns the page width.
fourbyte	GetPageHeight () const
	Returns the page height.
fourbyte	GetPageScaling () const
	Returns the page scaling, in percent.
twobyte	GetLeftPageTopMargin () const
	Returns the top page margin for all/left-side pages.
twobyte	GetLeftPageBottomMargin () const
	Returns the bottom page margin for all/left-side pages.
twobyte	GetLeftPageLeftMargin () const
	Returns the left page margin for all/left-side pages.
twobyte	GetLeftPageRightMargin () const
	Returns the right page margin for all/left-side pages.
bool	GetUseFirstPageTopMargin () const
	Returns true if a different top margin should be used on the first page.
twobyte	GetFirstPageTopMargin () const
	Returns the top page margin for the first page.
bool	GetUseFacingPages () const
	Returns true if the separate settings for right-page margins should be used.
twobyte	GetRightPageTopMargin () const
	Returns the top page margin for right-side pages.
twobyte	GetRightPageBottomMargin () const
	Returns the bottom page margin for right-side pages.
twobyte	GetRightPageLeftMargin () const
	Returns the left page margin for right-side pages.
twobyte	GetRightPageRightMargin () const
	Returns the right page margin for right-side pages.
twobyte	GetSystemStaffHeight () const
	Returns the staff height in a system (in EVPUs * 16).
twobyte	GetSystemScaling () const
	Returns the system scaling in percent.
twobyte	GetFirstSystemDistance () const
	Returns the first system distance to top.
void	SetFirstSystemLeft (twobyte value)
	Sets the left system margin for the first system.
void	SetFirstSystemTop (twobyte value)
	Sets the top system margin for the first system.
void	SetSystemLeft (twobyte value)
	Sets the general left system margin setting.
void	SetSystemRight (twobyte value)
	Sets the right system margin setting.
void	SetSystemTop (twobyte value)
	Sets the top system margin setting.
void	SetSystemBottom (twobyte value)
	Sets the Bottom system margin setting.
void	SetUseFirstSystemMargins (bool value)
	Sets if the first system should have special margins or not.
void	SetPageWidth (fourbyte width)
	Sets the page width.
void	SetPageHeight (fourbyte height)
	Sets the page height.
void	SetPageScaling (twobyte scaling)
	Sets the page scaling, in percent.
void	SetLeftPageTopMargin (twobyte value)
	Sets the top page margin for all/left-side pages.
void	SetLeftPageBottomMargin (twobyte value)
	Sets the bottom page margin for all/left-side pages.
void	SetLeftPageLeftMargin (twobyte value)
	Sets the left page margin for all/left-side pages.
void	SetLeftPageRightMargin (twobyte value)
	Sets the right page margin for all/left-side pages.
void	SetUseFirstPageTopMargin (bool state)
	Sets if a different top margin should be used on the first page.
void	SetFirstPageTopMargin (twobyte value)
	Sets the top page margin for the first page.
void	SetUseFacingPages (bool state)
	Sets if the separate settings for right-page margins should be used, or not.
void	SetRightPageTopMargin (twobyte value)
	Sets the top page margin for right-side pages.
void	SetRightPageBottomMargin (twobyte value)
	Sets the bottom page margin for right-side pages.
void	SetRightPageLeftMargin (twobyte value)
	Sets the left page margin for right-side pages.
void	SetRightPageRightMargin (twobyte value)
	Sets the right page margin for right-side pages.
void	SetSystemStaffHeight (twobyte value)
	Sets the staff height in a system (in EVPUs * 16).
void	SetSystemScaling (twobyte value)
	Returns the system scaling in percent.
void	SetFirstSystemDistance (twobyte value)
	Sets the first system distance to top.
void	SetSystemDistanceBetween (twobyte value)
	Sets the distance between systems. This is the negative value compared to what's found in the Finale UI.
Public Member Functions inherited from __FCPrefsBase
bool	Reload () override
	Overridden version of Reload(), that handles prefs from multiple sources.
bool	LoadFirst () override
	Loads the very first element in the database, if any.
int	GetItemNo () const
	Returns the prefs number for the loaded data.
Public Member Functions inherited from __FCBaseData
EDOCID	GetConnectedDocID () const
	Returns the document ID that was connected to the last load/save of the data.
bool	VerifyConnectedDocID ()
	Checks that the stored document ID for the data object matches the current document's ID.
virtual EVERSION	EnigmaVersion () const
	The Enigma version for save/load/create/delete operations.
virtual int	DataSizeSave () const
	Returns the data size for the data structure that should be saved or created.
void	_CloneFrom (__FCBaseData *pSource)
	For internal use only. Copies object data (except data block) from another object.
const EDataID *	_GetDataID ()
	Intended ONLY for the _CloneFrom implementation.
int	_GetLoadedSize () const
	Intended ONLY for the _CloneFrom implementation.
const void *	GetDataBlock ()
	Intended ONLY for the _CloneFrom implementation.
EXTAG	GetCustomTag () const
	Returns the custom Enigma tag, if any.
void	SetCustomTag (EXTAG tag)
	Sets the custom Enigma tag, for classes that support multiple Enigma tags.
	__FCBaseData ()
	The constructor.
virtual	~__FCBaseData ()
	Virtual destructor.
virtual bool	DeleteData ()
	Deletes the associated data from Finale's database. Be careful when deleting multiple objects.
virtual bool	DeepDeleteData ()
	Deletes data and all data that's connected to the object.
virtual bool	LoadLast ()
	Loads the very last element in the database, if any.
virtual bool	LoadNext ()
	Loads the next element from the database, if any.
virtual bool	LoadPrevious ()
	Loads the previous element in the database, if any.
bool	RelinkToCurrentView ()
	Relinks the contents in the current view so that the score and part(s) match.
bool	RelinkToScore ()
	Relinks all parts to the contents of the score.
__FCBaseData *	CreateClone ()
	Creates an identical copy of an object.
void	DebugDump () override
	Outputs the class data/information for debugging purposes.
void	DebugDataDump () override
	Outputs a memory dump of the data block in the object for debugging purposes.
void	DebugDataByteArrayDump () override
	Outputs a memory dump of the data block in the object for debugging purposes, as a C++ byte array.
void	DebugDataOffsetDump (int offset, int size)
	For debug mode only. Dumps a data memory block at a specific offset and with a specific size.
FCNumbers *	CreateRawDataDump ()
	Creates a byte collection with the raw loaded data block for the object (if the object type supports single data blocks). This method is only intended for debug purposes.
Public Member Functions inherited from __FCBase
virtual	~__FCBase ()
	Virtual destructor, so all inherited classes get the virtual destructor.
void	DebugMsgInt (const char *pszPrefixText, int i)
	Creates a simple Message Box for debug purposes. The text appears with the extra digit (in decimal presentation) appearing afterwards.
void	DebugMsgHex (const char *pszPrefixText, int i)
	Creates a simple Message Box for debug purposes. The text appears with the extra digit (as a hexadecimal number) appearing afterwards.
void	DebugMsgString (const char *pszPrefixText, const char *thestring)
	Creates a simple Message Box for debug purposes. The text appears with the extra string appearing afterwards.
void	DebugMsg (const char *pszMsg)
	Creates a simple Message Box for debug purposes with just one text string.
void	DebugOutMenuInfo (FCUI *pUI, int menuixd_horiz, int menuixd_vert) const
	Outputs the menu command info for debugging purposes.
int	DebugOutFormat (const char *fmt,...)
	Outputs debug text using C style "printf" syntax.
void	Set16BitFlag (FLAG_16 *flag, FLAG_16 flagbits, bool state)
	Sets a 16 bit flag.
void	Set32BitFlag (FLAG_32 *flag, FLAG_32 flagbits, bool state)
	Sets/resets a 32 bit flag, by using a bit mask.
bool	GetBitFlag (FLAG_32 flag, FLAG_32 flagbits) const
	Gets a state from flag bits. Returns true if any bit in the mask is set.
int	GetBitCount (FLAG_32 flag)
	Returns the total number of set bits in a 32-bit unsigned int.
void	SetSpecific32Bit (FLAG_32 *flag, int bitnumber, bool state)
	Sets/resets a single bit in a 32 bit flag, by specifying one specific bit.
void	SetUserData (void *pData)
	Sets the user data attached to the instance of an object.
void	SetUserData2 (void *pData)
	Sets the additional user data attached to the instance of an object.
void *	GetUserData () const
	Gets the user data attached to the instance of an object.
void *	GetUserData2 () const
	Gets the additional user data attached to the instance of an object.
virtual bool	IsIdentical (const __FCBase *pCompareObject) const
	Returns true if the data in the passed object is considered to be identical to the current object, otherwise false.
void	StoreXML_String (tinyxml2::XMLElement *pParentNode, const char *pszElementName, FCString *pStringValue)
	Helper function to store FCString objects in the XML file.
void	StoreXML_Integer (tinyxml2::XMLElement *pParentNode, const char *pszElementName, int value)
	Helper function to store integer objects in the XML file.
void	StoreXML_Bool (tinyxml2::XMLElement *pParentNode, const char *pszElementName, bool value)
	Helper function to store boolean objects in the XML file.
void	StoreXML_StringAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, FCString *pStringValue)
	Helper function to store FCString objects in the XML file, as an attribute to a node.
void	StoreXML_IntegerAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, int value)
	Helper function to store integer objects in the XML file, as an attribute to a node.
void	StoreXML_BoolAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, bool value)
	Helper function to store boolean objects in the XML file, as an attribute to a node.
void	StoreXML_FloatAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, float value)
	Helper function to store floating point objects in the XML file, as an attribute to a node.
virtual void	StoreToXML (tinyxml2::XMLElement *pParentNode)
	Virtual method that is used to store an object's data.
bool	ReadXML_String (tinyxml2::XMLElement *pParentNode, const char *pszElementName, FCString *pStringValue)
	Helper method to read FCString objects from the XML file.
bool	ReadXML_Integer (tinyxml2::XMLElement *pParentNode, const char *pszElementName, int *pValue)
	Helper method to read integer objects from the XML file.
bool	ReadXML_Bool (tinyxml2::XMLElement *pParentNode, const char *pszElementName, bool *pValue)
	Helper method to read boolean objects from the XML file.
bool	ReadXML_StringAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, FCString *pStringValue)
	Helper method to read FCString objects from the XML file, as an attribute to a node.
bool	ReadXML_IntegerAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, int *pValue)
	Helper method to read integer objects from the XML file, as an attribute to a node.
bool	ReadXML_BoolAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, bool *pValue)
	Helper method to read boolean objects from the XML file, as an attribute to a node.
bool	ReadXML_FloatAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, float *pValue)
	Helper method to read floating point objects from the XML file, as an attribute to a node.
virtual bool	ReadFromXML (tinyxml2::XMLElement *pParentNode)
	Virtual method that is used to read object data.

Additional Inherited Members
Public Types inherited from __FCBase
enum	PDKFRAMEWORK_CLASSID {   FCID_UNKNOWN = 0 , FCID_ACCIDENTALMOD , FCID_ACTIVELYRIC , FCID_ALLOTMENT ,   FCID_ARTICULATION , FCID_ARTICULATIONDEF , FCID_BACKWARDREPEAT , FCID_BASELINE ,   FCID_BEAMMOD , FCID_BEATCHARTELEMENT , FCID_BOOKMARK , FCID_BROKENBEAMMOD ,   FCID_CATEGORYDEF , FCID_CELLCLEFCHANGE , FCID_CELLFRAMEHOLD , FCID_CELLGRAPHIC ,   FCID_CELLTEXT , FCID_CENTERSMARTSHAPE , FCID_CHORD , FCID_CHORDPREFS ,   FCID_CHORDSUFFIXELEMENT , FCID_CHORUSSYLLABLE , FCID_CLEFDEF , FCID_COMPOSITETIMESIGBOTTOMELEMENT ,   FCID_COMPOSITETIMESIGTOPELEMENT , FCID_CROSSSTAFFMOD , FCID_CUSTOMSMARTLINEDEF , FCID_CUSTOMSTEMMOD ,   FCID_DISTANCEPREFS , FCID_DOTMOD , FCID_ENCLOSURE , FCID_ENDINGREPEAT ,   FCID_ENIGMATEXTSTYLE , FCID_ENTRYALTERMOD , FCID_EXECUTABLESHAPEDEF , FCID_EXPRESSION ,   FCID_FONTINFO , FCID_FONTPREFS , FCID_FREEZESYSTEM , FCID_FRETBOARDSTYLEDEF ,   FCID_FRETBOARDSTYLEDEFS , FCID_FRETBOARDGROUPDEF , FCID_FRETBOARDGROUPDEFS , FCID_FRETINSTRUMENTDEF ,   FCID_GENERALPREFS , FCID_GRIDSGUIDESPREFS , FCID_GROUP , FCID_GROUPNAMEPOSITIONPREFS ,   FCID_HUMANPLAYBACKPREFS , FCID_INDEPENDENTCELLDETAIL , FCID_INSTRUMENTDEF , FCID_INSTRUMENTPLAYBACKDATA ,   FCID_KEYMODEDEF , FCID_KEYSIGNATURE , FCID_LAYERPREFS , FCID_LYRICSBASELINE ,   FCID_LYRICSPREFS , FCID_MEASURE , FCID_MEASURENUMBERREGION , FCID_METATOOLASSIGNMENT ,   FCID_MIDIEXPRESSION , FCID_MISCDOCPREFS , FCID_MULTIMEASUREREST , FCID_MULTIMEASURERESTPREFS ,   FCID_MULTISTAFFINSTRUMENT , FCID_MULTISTAFFINSTRUMENTS , FCID_MUSICCHARACTERPREFS , FCID_MUSICSPACINGPREFS ,   FCID_NUMBER , FCID_NOTEHEADMOD , FCID_OTHERINCI , FCID_PERCUSSIONLAYOUTNOTE ,   FCID_PERCUSSIONSTAFF , FCID_PERFORMANCEMOD , FCID_PAGE , FCID_PAGEFORMATPREFS ,   FCID_PAGEGRAPHIC , FCID_PAGETEXT , FCID_PART , FCID_PARTEXTRACTPREFS ,   FCID_PARTSCOPEPREFS , FCID_PARTSTAFFVOICING , FCID_PERCUSSIONNOTEMOD , FCID_PIANOBRACEPREFS ,   FCID_PLAYBACKPREFS , FCID_RAWTEXT , FCID_REPEATPREFS , FCID_SECONDARYBEAMBREAKMOD ,   FCID_BEAMEXTENSIONMOD , FCID_SECTIONSYLLABLE , FCID_SEPARATEMEASURENUMBER , FCID_SEPARATEPLACEMENT ,   FCID_SHAPEDEF , FCID_SHAPEEXPRESSIONDEF , FCID_SLURCONTOURPREFS , FCID_SIZEPREFS ,   FCID_SMARTSHAPE , FCID_SMARTSHAPEENTRYMARK , FCID_SMARTSHAPEMEASUREMARK , FCID_SMARTSHAPEPREFS ,   FCID_STAFF , FCID_STAFFLIST , FCID_STAFFNAMEPOSITION , FCID_STAFFNAMEPOSITIONPREFS ,   FCID_STAFFSTYLEASSIGN , FCID_STAFFSTYLEDEF , FCID_STAFFSYSTEM , FCID_STEMCONNECTIONTABLE ,   FCID_STEMMOD , FCID_STRING , FCID_SYLLABLEENTRYMOD , FCID_SYSTEMSTAFF ,   FCID_TABLATURENOTEMOD , FCID_TEMPOELEMENT , FCID_TEXTBLOCK , FCID_TEXTEXPRESSIONDEF ,   FCID_TEXTREPEAT , FCID_TEXTREPEATDEF , FCID_TIEMOD , FCID_TIEPREFS ,   FCID_TIECONTOURPREFS , FCID_TIEPLACEMENTPREFS , FCID_TIMESIGNATURE , FCID_TUPLET ,   FCID_TUPLETPREFS , FCID_VERSESYLLABLE }
	Constants for the GetClassID method. More...
enum	MEASUREMENTUNITS {   MEASUREMENTUNIT_DEFAULT = UNIT_DEFAULT , MEASUREMENTUNIT_EVPUS = UNIT_EVPUS , MEASUREMENTUNIT_INCHES = UNIT_INCHES , MEASUREMENTUNIT_CENTIMETERS = UNIT_CENTS ,   MEASUREMENTUNIT_POINTS = UNIT_POINTS , MEASUREMENTUNIT_PICAS = UNIT_PICAS , MEASUREMENTUNIT_SPACES = UNIT_SPACES , MEASUREMENTUNIT_MILLIMETERS = 100 }
	Constants for Finale's standard measurement units. More...
Static Public Member Functions inherited from __FCBase
static void	DebugOutPtr (const char *pszPrefixText, void *ptr)
	Static method that outputs a line for debugging purposes. The prefix text appears with the extra ptr (in hexadeximal representation) appearing afterwards.
static void	DebugOutInt (const char *pszPrefixText, int i)
	Static method that outputs a line for debugging purposes. The text appears with the extra digit (in decimal presentation) appearing afterwards.
static void	DebugOutFloat (const char *pszPrefixText, double f)
	Static method that outputs a line for debugging purposes. The text appears with the extra float value appearing afterwards.
static void	DebugOutTag (const char *pszPrefixText, EXTAG extag)
	Static method that outputs a line for debugging purposes. The text appears with the EXTAG (in text) appearing afterwards.
static void	DebugOutHex (const char *pszPrefixText, int i)
	Static method that outputs a line for debugging purposes. The text appears with the extra digit (in hexadecimal presentation) appearing afterwards.
static void	DebugOutBin (const char *pszPrefixText, int i)
	Static method that outputs a line for debugging purposes. The text appears with the extra digit (in binary presentation) appearing afterwards.
static void	DebugOutString (const char *pszPrefixText, const char *thestring)
	Static method that outputs a line for debugging purposes (C string version). The text appears with the extra string appearing afterwards.
static void	DebugOutString (const char *pszPrefixText, FCString *pString)
	Static method that outputs a line for debugging purposes (FCString version). The text appears with the extra string appearing afterwards.
static void	DebugOutBool (const char *pszPrefixText, bool state)
	Static method that outputs a line for debugging purposes. The boolean state appears afterwards as either "TRUE" or "FALSE".
static void	DebugOutBlock (const void *pBuffer, int startoffset, int size)
	Static method that outputs a memory block for debugging purposes. Eight bytes per line will appear (as hex digits) until the whole memory block is dumped.
static void	DebugOutByteArrayBlock (const void *pBuffer, int startoffset, int size)
	Static method that outputs a memory block for debugging purposes. Eight bytes per line will appear (as hex digits) as a C++ onebyte array, until the whole memory block is dumped.
static void	DebugOut (const char *pszLine)
	Static method to output a line of text for debugging purposes.
Protected Member Functions inherited from __FCPrefsBase
	__FCPrefsBase ()
	standard constructor
Protected Member Functions inherited from __FCBaseData
virtual void	Deallocate ()
virtual bool	IsDynamicSize ()
bool	LoadDataBlock ()
	Loads the data. If the object is of dynamic size, the old memory block is freed and a new is allocated.
void	ClearData ()
virtual twobyte	CalcLastInci ()
	For internal use only!
bool	DataIsLoaded () const
	Returns true is any data has been loaded into the object.
void	_TagDocumentID ()
	For internal use only.
Protected Member Functions inherited from __FCBase
	__FCBase ()
	The constructor.
Protected Attributes inherited from __FCBaseData
EDOCID	_connecteddocID
	The "connected" document ID., which is the document the where the document was loaded (or last saved). This is for a mechanism to prevent resaving of certain data in other documents.
void *	_datablock
	Pointer to the object's data block, the meaning is implementation-specific for each derived subclass.
bool	_heapdatablock
	Variable that tells if _datablock is dynamically created on the heap (and should be deleted at object destruction).
int	_loadedsize
	Loaded size of the data block for a loaded object, in bytes. Since the datablock is implementation-specific, the _loadedsize should be updated by child classes that create new data.
EDataID	_dataid
	The EdataID for the last loaded/saved object.

Detailed Description

Class for the "Page Format for Score/Parts" preference data.

The data is loaded with LoadScore() and LoadParts()

Constructor & Destructor Documentation

FCPageFormatPrefs()

FCPageFormatPrefs::FCPageFormatPrefs ( )

inline

The constructor.

Lua-supported.

Member Function Documentation

ClassName()

const char * FCPageFormatPrefs::ClassName ( ) const

inlineoverridevirtual

Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child class.

Lua-supported.

Reimplemented from __FCPrefsBase.

GetClassID()

const PDKFRAMEWORK_CLASSID FCPageFormatPrefs::GetClassID ( ) const

inlineoverridevirtual

Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has problems to resolve the true classes of inherited objects.

This method must be overwritten by all child classes.

Lua-supported (also read-only property) (0.55).

Implements __FCBaseData.

GetFirstPageTopMargin()

twobyte FCPageFormatPrefs::GetFirstPageTopMargin ( ) const

inline

Returns the top page margin for the first page.

This value is used when GetUseFirstPageTopMargin() returns true.

GetFirstSystemDistance()

twobyte FCPageFormatPrefs::GetFirstSystemDistance ( ) const

inline

Returns the first system distance to top.

Lua-supported (also as property).

GetFirstSystemLeft()

twobyte FCPageFormatPrefs::GetFirstSystemLeft ( ) const

inline

Returns the left system margin for the first system.

This value is used if GetUseFirstSystemMargins returns true.

Lua-supported (also as property).

GetFirstSystemTop()

twobyte FCPageFormatPrefs::GetFirstSystemTop ( ) const

inline

Returns the top system margin for the first system.

This value is used if GetUseFirstSystemMargins returns true.

Lua-supported (also as property).

GetLeftPageBottomMargin()

twobyte FCPageFormatPrefs::GetLeftPageBottomMargin ( ) const

inline

Returns the bottom page margin for all/left-side pages.

Lua-supported (also as property).

GetLeftPageLeftMargin()

twobyte FCPageFormatPrefs::GetLeftPageLeftMargin ( ) const

inline

Returns the left page margin for all/left-side pages.

Lua-supported (also as property).

GetLeftPageRightMargin()

twobyte FCPageFormatPrefs::GetLeftPageRightMargin ( ) const

inline

Returns the right page margin for all/left-side pages.

Lua-supported (also as property).

GetLeftPageTopMargin()

twobyte FCPageFormatPrefs::GetLeftPageTopMargin ( ) const

inline

Returns the top page margin for all/left-side pages.

Lua-supported (also as property).

GetPageHeight()

fourbyte FCPageFormatPrefs::GetPageHeight ( ) const

inline

Returns the page height.

Lua-supported (also as property).

GetPageScaling()

fourbyte FCPageFormatPrefs::GetPageScaling ( ) const

inline

Returns the page scaling, in percent.

Lua-supported (also as property).

GetPageWidth()

fourbyte FCPageFormatPrefs::GetPageWidth ( ) const

inline

Returns the page width.

Lua-supported (also as property).

GetRightPageBottomMargin()

twobyte FCPageFormatPrefs::GetRightPageBottomMargin ( ) const

inline

Returns the bottom page margin for right-side pages.

This value is only used if GetUseFacingPages() returns true.

Lua-supported (also as property).

GetRightPageLeftMargin()

twobyte FCPageFormatPrefs::GetRightPageLeftMargin ( ) const

inline

Returns the left page margin for right-side pages.

This value is only used if GetUseFacingPages() returns true.

Lua-supported (also as property).

GetRightPageRightMargin()

twobyte FCPageFormatPrefs::GetRightPageRightMargin ( ) const

inline

Returns the right page margin for right-side pages.

This value is only used if GetUseFacingPages() returns true.

Lua-supported (also as property).

GetRightPageTopMargin()

twobyte FCPageFormatPrefs::GetRightPageTopMargin ( ) const

inline

Returns the top page margin for right-side pages.

This value is only used if GetUseFacingPages() returns true.

Lua-supported (also as property).

GetSystemBottom()

twobyte FCPageFormatPrefs::GetSystemBottom ( ) const

inline

Returns the bottom system margin setting.

Lua-supported (also as property).

GetSystemDistanceBetween()

twobyte FCPageFormatPrefs::GetSystemDistanceBetween ( ) const

inline

Returns the distance between systems. This is the negative value compared to what's found in the Finale UI.

Lua-supported (also as property).

GetSystemLeft()

twobyte FCPageFormatPrefs::GetSystemLeft ( ) const

inline

Returns the general left system margin setting.

Lua-supported (also as property).

GetSystemRight()

twobyte FCPageFormatPrefs::GetSystemRight ( ) const

inline

Returns the right system margin setting.

Lua-supported (also as property).

GetSystemScaling()

twobyte FCPageFormatPrefs::GetSystemScaling ( ) const

inline

Returns the system scaling in percent.

Lua-supported (also as property).

GetSystemStaffHeight()

twobyte FCPageFormatPrefs::GetSystemStaffHeight ( ) const

inline

Returns the staff height in a system (in EVPUs * 16).

Lua-supported (also as property).

GetSystemTop()

twobyte FCPageFormatPrefs::GetSystemTop ( ) const

inline

Returns the top system margin setting.

Lua-supported (also as property).

GetUseFacingPages()

bool FCPageFormatPrefs::GetUseFacingPages ( ) const

inline

Returns true if the separate settings for right-page margins should be used.

Lua-supported (also as property).

GetUseFirstPageTopMargin()

bool FCPageFormatPrefs::GetUseFirstPageTopMargin ( ) const

inline

Returns true if a different top margin should be used on the first page.

Lua-supported (also as property).

GetUseFirstSystemMargins()

bool FCPageFormatPrefs::GetUseFirstSystemMargins ( ) const

inline

Returns true if the first system should have special margins.

Lua-supported (also as property).

Load()

bool FCPageFormatPrefs::Load ( twobyte prefsno = 1 )

overridevirtual

Overrides Load to be able to handle data that aren't part of the original EDT data structure.

Use LoadScore and LoadParts for this class!

Reimplemented from __FCPrefsBase.

LoadParts()

bool FCPageFormatPrefs::LoadParts ( )

inline

Loads the "Page Format for Parts" data to the object.

This method should be used rather than the Load() method directly.

Lua-supported.

LoadScore()

bool FCPageFormatPrefs::LoadScore ( )

inline

Loads the "Page Format for Score" data to the object.

This method should be used rather than the Load() method directly.

Lua-supported.

Save()

bool FCPageFormatPrefs::Save ( )

overridevirtual

Overrides Save to be able to handle data that aren't part of the original EDT data structure.

Reimplemented from __FCPrefsBase.

SetFirstPageTopMargin()

void FCPageFormatPrefs::SetFirstPageTopMargin ( twobyte value )

inline

Sets the top page margin for the first page.

This value is used when GetUseFirstPageTopMargin returns true.

SetFirstSystemDistance()

void FCPageFormatPrefs::SetFirstSystemDistance ( twobyte value )

inline

Sets the first system distance to top.

Lua-supported (also as property).

SetFirstSystemLeft()

void FCPageFormatPrefs::SetFirstSystemLeft ( twobyte value )

inline

Sets the left system margin for the first system.

This value is used if GetUseFirstSystemMargins() returns true.

Lua-supported (also as property).

SetFirstSystemTop()

void FCPageFormatPrefs::SetFirstSystemTop ( twobyte value )

inline

Sets the top system margin for the first system.

This value is used if GetUseFirstSystemMargins() returns true.

Lua-supported (also as property).

SetLeftPageBottomMargin()

void FCPageFormatPrefs::SetLeftPageBottomMargin ( twobyte value )

inline

Sets the bottom page margin for all/left-side pages.

Lua-supported (also as property).

SetLeftPageLeftMargin()

void FCPageFormatPrefs::SetLeftPageLeftMargin ( twobyte value )

inline

Sets the left page margin for all/left-side pages.

Lua-supported (also as property).

SetLeftPageRightMargin()

void FCPageFormatPrefs::SetLeftPageRightMargin ( twobyte value )

inline

Sets the right page margin for all/left-side pages.

Lua-supported (also as property).

SetLeftPageTopMargin()

void FCPageFormatPrefs::SetLeftPageTopMargin ( twobyte value )

inline

Sets the top page margin for all/left-side pages.

Lua-supported (also as property).

SetPageHeight()

void FCPageFormatPrefs::SetPageHeight ( fourbyte height )

inline

Sets the page height.

Lua-supported (also as property).

SetPageScaling()

void FCPageFormatPrefs::SetPageScaling ( twobyte scaling )

inline

Sets the page scaling, in percent.

Lua-supported (also as property).

SetPageWidth()

void FCPageFormatPrefs::SetPageWidth ( fourbyte width )

inline

Sets the page width.

Lua-supported (also as property).

SetRightPageBottomMargin()

void FCPageFormatPrefs::SetRightPageBottomMargin ( twobyte value )

inline

Sets the bottom page margin for right-side pages.

This value is only used if GetUseFacingPages returns true.

Lua-supported (also as property).

SetRightPageLeftMargin()

void FCPageFormatPrefs::SetRightPageLeftMargin ( twobyte value )

inline

Sets the left page margin for right-side pages.

This value is only used if GetUseFacingPages returns true.

Lua-supported (also as property).

SetRightPageRightMargin()

void FCPageFormatPrefs::SetRightPageRightMargin ( twobyte value )

inline

Sets the right page margin for right-side pages.

This value is only used if GetUseFacingPages returns true.

Lua-supported (also as property).

SetRightPageTopMargin()

void FCPageFormatPrefs::SetRightPageTopMargin ( twobyte value )

inline

Sets the top page margin for right-side pages.

This value is only used if GetUseFacingPages returns true.

Lua-supported (also as property).

SetSystemBottom()

void FCPageFormatPrefs::SetSystemBottom ( twobyte value )

inline

Sets the Bottom system margin setting.

Lua-supported (also as property).

SetSystemDistanceBetween()

void FCPageFormatPrefs::SetSystemDistanceBetween ( twobyte value )

inline

Sets the distance between systems. This is the negative value compared to what's found in the Finale UI.

Lua-supported (also as property).

SetSystemLeft()

void FCPageFormatPrefs::SetSystemLeft ( twobyte value )

inline

Sets the general left system margin setting.

Lua-supported (also as property).

SetSystemRight()

void FCPageFormatPrefs::SetSystemRight ( twobyte value )

inline

Sets the right system margin setting.

Lua-supported (also as property).

SetSystemScaling()

void FCPageFormatPrefs::SetSystemScaling ( twobyte value )

inline

Returns the system scaling in percent.

Lua-supported (also as property).

SetSystemStaffHeight()

void FCPageFormatPrefs::SetSystemStaffHeight ( twobyte value )

inline

Sets the staff height in a system (in EVPUs * 16).

Lua-supported (also as property).

SetSystemTop()

void FCPageFormatPrefs::SetSystemTop ( twobyte value )

inline

Sets the top system margin setting.

Lua-supported (also as property).

SetUseFacingPages()

void FCPageFormatPrefs::SetUseFacingPages ( bool state )

inline

Sets if the separate settings for right-page margins should be used, or not.

Lua-supported (also as property).

SetUseFirstPageTopMargin()

void FCPageFormatPrefs::SetUseFirstPageTopMargin ( bool state )

inline

Sets if a different top margin should be used on the first page.

Lua-supported (also as property).

SetUseFirstSystemMargins()

void FCPageFormatPrefs::SetUseFirstSystemMargins ( bool value )

inline

Sets if the first system should have special margins or not.

Lua-supported (also as property).