Options that affects Music (Note) Spacing in the document. More...

#include <ff_prefs.h>

Inheritance diagram for FCMusicSpacingPrefs:

Public Types
enum	GRACENOTE_SPACINGMODE { GRACESPMODE_RESETTOOFFSET = 0 , GRACESPMODE_KEEPCURRENT = 1 , GRACESPMODE_AUTOMATIC = 2 }
	The grace note spacing constants used by GetGraceNoteSpacingMode. More...

enum	MANUAL_POSITIONING { MANUALPOS_CLEAR = 0 , MANUALPOS_INCORPORATE = 1 , MANUALPOS_IGNORE = 2 }
	The constants used by GetManualPositioning. More...

enum	UNISONS_MODE { UNISSPACE_NONE = 0 , UNISSPACE_DIFFERENTNOTEHEADS = 1 , UNISSPACE_ALLNOTEHEADS = 2 }
	The constants used by GetUnisonsMode. These represent the three possible values for "Avoid Collision of Unisons" in the Document Options - Music Spacing dialog and control whether note spacing avoids collisions of unisons in different voices or layers. More...

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...

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.

	FCMusicSpacingPrefs ()
	The constructor.

int	GetScalingValue () const
	Returns the scaling factor, multiplied with 10000.

double	GetScalingFactor () const
	Returns the scaling ratio, in the same way the Finale UI displays it.

Evpu16	GetMinimumItemDistance () const
	Returns the minimum distance between items, in EVPUs.

twobyte	GetMinimumDistanceWithTies () const
	Returns the minimum distance between notes with ties.

twobyte	GetMaxMeasureWidth () const
	Returns the maximum measure width.

twobyte	GetMinMeasureWidth () const
	Returns the minimum measure width.

bool	GetAvoidArticulations () const
	Returns true if Avoid Articulations is used.

bool	GetAvoidChords () const
	Returns true if Avoid Chords is used.

bool	GetAvoidClefs () const
	Returns true if Avoid Clefs is used.

bool	GetAvoidHiddenNotes () const
	Returns true if Avoid Hidden Notes is used.

bool	GetAvoidLedgerLines () const
	Returns true if Avoid Ledger Lines is used.

bool	GetAvoidLyrics () const
	Returns true if Avoid Lyrics is used.

bool	GetAvoidNoteAndAccidentals () const
	Returns true if Avoid Note and Accidentals is used.

bool	GetAvoidSeconds () const
	Returns true if Avoid Seconds is used.

bool	GetInterpolateAllotments () const
	Returns if allotment should be interpolated if the duration wasn't found in the table (the "Use default width if duration not in table" option).

GRACENOTE_SPACINGMODE	GetGraceNoteSpacingMode () const
	Returns the grace note spacing mode.

twobyte	GetGraceNoteMinDistance () const
	Returns the minimum distance between grace notes.

MANUAL_POSITIONING	GetManualPositioning () const
	Returns the options for how to treat manual positioned notes.

UNISONS_MODE	GetUnisonsMode () const
	Returns the mode for how to treat unisons.

twobyte	GetAccidentalsGutter () const
	Returns the adjustment before accidental directly after barline (which affects music spacing).

twobyte	GetTiesGutter () const
	Returns the adjustment before ties directly after a system break (which affects the beat chart).

bool	GetUsePrinterMetrics () const
	Returns if printer font metrics should be used instead of screen. Windows only.

bool	GetUseAllotmentMode () const
	Returns if the spacing is set to allotment mode.

twobyte	GetScalingReferenceDuration () const
	Returns the reference duration for scaling.

twobyte	GetScalingReferenceWidth () const
	Returns the reference width for scaling.

void	SetScalingValue (int value)
	Sets the scaling factor, multiplied with 10000.

void	SetScalingFactor (double ratio)
	Sets the scaling ratio, using the same type of preentation as in the Finale user interface.

void	SetMinimumItemDistance (Evpu16 value)
	Sets the minimum distance between items, in EVPUs.

void	SetMinimumDistanceWithTies (twobyte value)
	Sets the minimum distance between notes with ties.

void	SetMaxMeasureWidth (twobyte value)
	Sets the maximum measure width.

void	SetMinMeasureWidth (twobyte value)
	Sets the minimum measure width.

void	SetAvoidArticulations (bool state)
	Sets if Avoid Articulations is used or not.

void	SetAvoidChords (bool state)
	Sets if Avoid Chords is used or not.

void	SetAvoidClefs (bool state)
	Sets if Avoid Clefs is used or not.

void	SetAvoidHiddenNotes (bool state)
	Sets if Avoid Hidden Notes is used or not.

void	SetAvoidLedgerLines (bool state)
	Sets if Avoid Ledger Lines is used or not.

void	SetAvoidLyrics (bool state)
	Sets if Avoid Lyrics is used or not.

void	SetAvoidNoteAndAccidentals (bool state)
	Sets if Avoid Note and Accidentals is used or not.

void	SetAvoidSeconds (bool state)
	Sets if Avoid Seconds is used or not.

void	SetInterpolateAllotments (bool state)
	Sets if allotment should be interpolated if the duration wasn't found in the table (the "Use default width if duration not in table" option).

void	SetGraceNoteSpacingMode (GRACENOTE_SPACINGMODE value)
	Sets the grace note spacing mode.

void	SetGraceNoteMinDistance (twobyte value)
	Sets the minimum distance between grace notes.

void	SetManualPositioning (MANUAL_POSITIONING value)
	Sets the options for how to treat manual positioned notes.

void	SetUnisonsMode (UNISONS_MODE value)
	Sets the mode for how to treat unisons.

void	SetAccidentalsGutter (twobyte value)
	Sets the adjustment before accidental directly after barline (which is changed after music spacing).

void	SetTiesGutter (twobyte value)
	Sets the adjustment before ties directly after a system break (which affects the beat chart).

void	SetUsePrinterMetrics (bool WINCODE(state))
	Sets if printer font metrics should be used instead of screen. Windows only.

void	SetUseAllotmentMode (bool allotmenttable)
	Sets the spacing to allotment table mode.

void	SetScalingReferenceDuration (fourbyte duration)
	Sets the reference duration for scaling.

void	SetScalingReferenceWidth (fourbyte width)
	Sets the reference width for scaling.

Public Member Functions inherited from __FCPrefsBase
bool	Reload () override
	Overridden version of Reload(), that handles prefs from multiple sources.

virtual bool	Load (twobyte prefsno=1)
	The default Load method for preference data. All preference data loading must go through here at some point.

bool	Save () override
	Saves the currently loaded to its current location.

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
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

Options that affects Music (Note) Spacing in the document.

Member Enumeration Documentation

◆ GRACENOTE_SPACINGMODE

enum FCMusicSpacingPrefs::GRACENOTE_SPACINGMODE

The grace note spacing constants used by GetGraceNoteSpacingMode.

Lua-supported.

◆ MANUAL_POSITIONING

enum FCMusicSpacingPrefs::MANUAL_POSITIONING

The constants used by GetManualPositioning.

Lua-supported.

◆ UNISONS_MODE

enum FCMusicSpacingPrefs::UNISONS_MODE

The constants used by GetUnisonsMode. These represent the three possible values for "Avoid Collision of Unisons" in the Document Options - Music Spacing dialog and control whether note spacing avoids collisions of unisons in different voices or layers.

Lua-supported.

Enumerator
UNISSPACE_NONE	Do not avoid collisions of unisions.
UNISSPACE_DIFFERENTNOTEHEADS	Avoid collisions if the noteheads are of a different type (e.g., quarter-note vs. half-note or whole-note).
UNISSPACE_ALLNOTEHEADS	Avoid collisions on any unisons regardless of notehead type.

Constructor & Destructor Documentation

◆ FCMusicSpacingPrefs()

FCMusicSpacingPrefs::FCMusicSpacingPrefs ( )

inline

The constructor.

Lua-supported.

Member Function Documentation

◆ ClassName()

const char * FCMusicSpacingPrefs::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.

◆ GetAccidentalsGutter()

twobyte FCMusicSpacingPrefs::GetAccidentalsGutter ( ) const

inline

Returns the adjustment before accidental directly after barline (which affects music spacing).

Lua-supported (also as property).

◆ GetAvoidArticulations()

bool FCMusicSpacingPrefs::GetAvoidArticulations ( ) const

inline

Returns true if Avoid Articulations is used.

Lua-supported (also as property).

◆ GetAvoidChords()

bool FCMusicSpacingPrefs::GetAvoidChords ( ) const

inline

Returns true if Avoid Chords is used.

Lua-supported (also as property).

◆ GetAvoidClefs()

bool FCMusicSpacingPrefs::GetAvoidClefs ( ) const

inline

Returns true if Avoid Clefs is used.

Lua-supported (also as property).

◆ GetAvoidHiddenNotes()

bool FCMusicSpacingPrefs::GetAvoidHiddenNotes ( ) const

inline

Returns true if Avoid Hidden Notes is used.

Lua-supported (also as property).

◆ GetAvoidLedgerLines()

bool FCMusicSpacingPrefs::GetAvoidLedgerLines ( ) const

inline

Returns true if Avoid Ledger Lines is used.

Lua-supported (also as property).

◆ GetAvoidLyrics()

bool FCMusicSpacingPrefs::GetAvoidLyrics ( ) const

inline

Returns true if Avoid Lyrics is used.

Lua-supported (also as property).

◆ GetAvoidNoteAndAccidentals()

bool FCMusicSpacingPrefs::GetAvoidNoteAndAccidentals ( ) const

inline

Returns true if Avoid Note and Accidentals is used.

Lua-supported (also as property).

◆ GetAvoidSeconds()

bool FCMusicSpacingPrefs::GetAvoidSeconds ( ) const

inline

Returns true if Avoid Seconds is used.

Lua-supported (also as property).

◆ GetClassID()

const PDKFRAMEWORK_CLASSID FCMusicSpacingPrefs::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.

◆ GetGraceNoteMinDistance()

twobyte FCMusicSpacingPrefs::GetGraceNoteMinDistance ( ) const

inline

Returns the minimum distance between grace notes.

Lua-supported (also as property).

◆ GetGraceNoteSpacingMode()

GRACENOTE_SPACINGMODE FCMusicSpacingPrefs::GetGraceNoteSpacingMode ( ) const

inline

Returns the grace note spacing mode.

Lua-supported (also as property).

Returns: Any of the GRACESPMODE_ constants.

◆ GetInterpolateAllotments()

bool FCMusicSpacingPrefs::GetInterpolateAllotments ( ) const

inline

Returns if allotment should be interpolated if the duration wasn't found in the table (the "Use default width if duration not in table" option).

Lua-supported (also as property).

◆ GetManualPositioning()

MANUAL_POSITIONING FCMusicSpacingPrefs::GetManualPositioning ( ) const

inline

Returns the options for how to treat manual positioned notes.

Lua-supported (also as property).

Returns: Any of the MANUALPOS_ constants.

◆ GetMaxMeasureWidth()

twobyte FCMusicSpacingPrefs::GetMaxMeasureWidth ( ) const

inline

Returns the maximum measure width.

Lua-supported (also as property).

◆ GetMinimumDistanceWithTies()

twobyte FCMusicSpacingPrefs::GetMinimumDistanceWithTies ( ) const

inline

Returns the minimum distance between notes with ties.

Lua-supported (also as property).

◆ GetMinimumItemDistance()

Evpu16 FCMusicSpacingPrefs::GetMinimumItemDistance ( ) const

inline

Returns the minimum distance between items, in EVPUs.

Lua-supported (also as property).

◆ GetMinMeasureWidth()

twobyte FCMusicSpacingPrefs::GetMinMeasureWidth ( ) const

inline

Returns the minimum measure width.

Lua-supported (also as property).

◆ GetScalingFactor()

double FCMusicSpacingPrefs::GetScalingFactor ( ) const

inline

Returns the scaling ratio, in the same way the Finale UI displays it.

This method recerences the same data as GetScalingValue.

Lua-supported (also as property).

Returns: A floating point (double) value, such as 1.61

◆ GetScalingReferenceDuration()

twobyte FCMusicSpacingPrefs::GetScalingReferenceDuration ( ) const

inline

Returns the reference duration for scaling.

Lua-supported (also as property).

◆ GetScalingReferenceWidth()

twobyte FCMusicSpacingPrefs::GetScalingReferenceWidth ( ) const

inline

Returns the reference width for scaling.

Lua-supported (also as property).

◆ GetScalingValue()

int FCMusicSpacingPrefs::GetScalingValue ( ) const

inline

Returns the scaling factor, multiplied with 10000.

This method references the same data as GetScalingFactor, but this method assures that no rounding errors appear when converting to floating point.

Lua-supported (also as property).

Returns: The scaling ratio multiplied with 10000.

◆ GetTiesGutter()

twobyte FCMusicSpacingPrefs::GetTiesGutter ( ) const

inline

Returns the adjustment before ties directly after a system break (which affects the beat chart).

Deprecated: use FCTiePrefs::GetExtraSystemStartSpace instead.

Lua-supported (also as property).

◆ GetUnisonsMode()

UNISONS_MODE FCMusicSpacingPrefs::GetUnisonsMode ( ) const

inline

Returns the mode for how to treat unisons.

Lua-supported (also as property).

Returns: Any of the UNISSPACE_ contants.

◆ GetUseAllotmentMode()

bool FCMusicSpacingPrefs::GetUseAllotmentMode ( ) const

inline

Returns if the spacing is set to allotment mode.

Lua-supported (also as property).

Returns: true - Use allotment tables. false - Use scaling value.

◆ GetUsePrinterMetrics()

bool FCMusicSpacingPrefs::GetUsePrinterMetrics ( ) const

inline

Returns if printer font metrics should be used instead of screen. Windows only.

On Mac, this always returns false.

Lua-supported (also as property).

◆ SetAccidentalsGutter()

void FCMusicSpacingPrefs::SetAccidentalsGutter ( twobyte value )

inline

Sets the adjustment before accidental directly after barline (which is changed after music spacing).

Lua-supported (also as property).

◆ SetAvoidArticulations()

void FCMusicSpacingPrefs::SetAvoidArticulations ( bool state )

inline

Sets if Avoid Articulations is used or not.

Lua-supported (also as property).

◆ SetAvoidChords()

void FCMusicSpacingPrefs::SetAvoidChords ( bool state )

inline

Sets if Avoid Chords is used or not.

Lua-supported (also as property).

◆ SetAvoidClefs()

void FCMusicSpacingPrefs::SetAvoidClefs ( bool state )

inline

Sets if Avoid Clefs is used or not.

Lua-supported (also as property).

◆ SetAvoidHiddenNotes()

void FCMusicSpacingPrefs::SetAvoidHiddenNotes ( bool state )

inline

Sets if Avoid Hidden Notes is used or not.

Lua-supported (also as property).

◆ SetAvoidLedgerLines()

void FCMusicSpacingPrefs::SetAvoidLedgerLines ( bool state )

inline

Sets if Avoid Ledger Lines is used or not.

Lua-supported (also as property).

◆ SetAvoidLyrics()

void FCMusicSpacingPrefs::SetAvoidLyrics ( bool state )

inline

Sets if Avoid Lyrics is used or not.

Lua-supported (also as property).

◆ SetAvoidNoteAndAccidentals()

void FCMusicSpacingPrefs::SetAvoidNoteAndAccidentals ( bool state )

inline

Sets if Avoid Note and Accidentals is used or not.

Lua-supported (also as property).

◆ SetAvoidSeconds()

void FCMusicSpacingPrefs::SetAvoidSeconds ( bool state )

inline

Sets if Avoid Seconds is used or not.

Lua-supported (also as property).

◆ SetGraceNoteMinDistance()

void FCMusicSpacingPrefs::SetGraceNoteMinDistance ( twobyte value )

inline

Sets the minimum distance between grace notes.

Lua-supported (also as property).

◆ SetGraceNoteSpacingMode()

void FCMusicSpacingPrefs::SetGraceNoteSpacingMode ( GRACENOTE_SPACINGMODE value )

inline

Sets the grace note spacing mode.

Lua-supported (also as property).

Parameters

value Any of the GRACESPMODE_ constants.

◆ SetInterpolateAllotments()

void FCMusicSpacingPrefs::SetInterpolateAllotments ( bool state )

inline

Sets if allotment should be interpolated if the duration wasn't found in the table (the "Use default width if duration not in table" option).

Lua-supported (also as property).

◆ SetManualPositioning()

void FCMusicSpacingPrefs::SetManualPositioning ( MANUAL_POSITIONING value )

inline

Sets the options for how to treat manual positioned notes.

Lua-supported (also as property).

Parameters

value Any of the MANUALPOS_ constants.

◆ SetMaxMeasureWidth()

void FCMusicSpacingPrefs::SetMaxMeasureWidth ( twobyte value )

inline

Sets the maximum measure width.

Lua-supported (also as property).

◆ SetMinimumDistanceWithTies()

void FCMusicSpacingPrefs::SetMinimumDistanceWithTies ( twobyte value )

inline

Sets the minimum distance between notes with ties.

Lua-supported (also as property).

◆ SetMinimumItemDistance()

void FCMusicSpacingPrefs::SetMinimumItemDistance ( Evpu16 value )

inline

Sets the minimum distance between items, in EVPUs.

Lua-supported (also as property).

◆ SetMinMeasureWidth()

void FCMusicSpacingPrefs::SetMinMeasureWidth ( twobyte value )

inline

Sets the minimum measure width.

Lua-supported (also as property).

◆ SetScalingFactor()

void FCMusicSpacingPrefs::SetScalingFactor ( double ratio )

inline

Sets the scaling ratio, using the same type of preentation as in the Finale user interface.

This affects the same value as SetScalingValue.

Lua-supported (also as property).

Parameters

ratio A floating point (double) value, such as 1.61

◆ SetScalingReferenceDuration()

void FCMusicSpacingPrefs::SetScalingReferenceDuration ( fourbyte duration )

inline

Sets the reference duration for scaling.

Lua-supported (also as property).

◆ SetScalingReferenceWidth()

void FCMusicSpacingPrefs::SetScalingReferenceWidth ( fourbyte width )

inline

Sets the reference width for scaling.

Lua-supported (also as property).

◆ SetScalingValue()

void FCMusicSpacingPrefs::SetScalingValue ( int value )

inline

Sets the scaling factor, multiplied with 10000.

This affects the same value as SetScalingFactor, but this method assures no rounding errors occur.

Lua-supported (also as property).

◆ SetTiesGutter()

void FCMusicSpacingPrefs::SetTiesGutter ( twobyte value )

inline

Sets the adjustment before ties directly after a system break (which affects the beat chart).

Deprecated: use FCTiePrefs::SetExtraSystemStartSpace instead.

Lua-supported (also as property).

◆ SetUnisonsMode()

void FCMusicSpacingPrefs::SetUnisonsMode ( UNISONS_MODE value )

inline

Sets the mode for how to treat unisons.

Lua-supported (also as property).

Parameters

value Any of the UNISSPACE_ contants.

◆ SetUseAllotmentMode()

void FCMusicSpacingPrefs::SetUseAllotmentMode ( bool allotmenttable )

inline

Sets the spacing to allotment table mode.

Lua-supported (also as property).

Parameters

allotmenttable true - Use allotment tables. false - Use scaling value.

◆ SetUsePrinterMetrics()

void FCMusicSpacingPrefs::SetUsePrinterMetrics ( bool WINCODEstate )

inline

Sets if printer font metrics should be used instead of screen. Windows only.

On Mac, this method doesn't do anything.

Lua-supported (also as property).

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ GRACENOTE_SPACINGMODE

◆ MANUAL_POSITIONING

◆ UNISONS_MODE

Constructor & Destructor Documentation

◆ FCMusicSpacingPrefs()

Member Function Documentation

◆ ClassName()

◆ GetAccidentalsGutter()

◆ GetAvoidArticulations()

◆ GetAvoidChords()

◆ GetAvoidClefs()

◆ GetAvoidHiddenNotes()

◆ GetAvoidLedgerLines()

◆ GetAvoidLyrics()

◆ GetAvoidNoteAndAccidentals()

◆ GetAvoidSeconds()

◆ GetClassID()

◆ GetGraceNoteMinDistance()

◆ GetGraceNoteSpacingMode()

◆ GetInterpolateAllotments()

◆ GetManualPositioning()

◆ GetMaxMeasureWidth()

◆ GetMinimumDistanceWithTies()

◆ GetMinimumItemDistance()

◆ GetMinMeasureWidth()

◆ GetScalingFactor()

◆ GetScalingReferenceDuration()

◆ GetScalingReferenceWidth()

◆ GetScalingValue()

◆ GetTiesGutter()

◆ GetUnisonsMode()

◆ GetUseAllotmentMode()

◆ GetUsePrinterMetrics()

◆ SetAccidentalsGutter()

◆ SetAvoidArticulations()

◆ SetAvoidChords()

◆ SetAvoidClefs()

◆ SetAvoidHiddenNotes()

◆ SetAvoidLedgerLines()

◆ SetAvoidLyrics()

◆ SetAvoidNoteAndAccidentals()

◆ SetAvoidSeconds()

◆ SetGraceNoteMinDistance()

◆ SetGraceNoteSpacingMode()

◆ SetInterpolateAllotments()

◆ SetManualPositioning()

◆ SetMaxMeasureWidth()

◆ SetMinimumDistanceWithTies()

◆ SetMinimumItemDistance()

◆ SetMinMeasureWidth()

◆ SetScalingFactor()

◆ SetScalingReferenceDuration()

◆ SetScalingReferenceWidth()

◆ SetScalingValue()

◆ SetTiesGutter()

◆ SetUnisonsMode()

◆ SetUseAllotmentMode()

◆ SetUsePrinterMetrics()