Finale PDK Framework  0.54
Public Types | Public Member Functions | List of all members
FCMusicSpacingPrefs Class Reference

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

#include <ff_prefs.h>

Inheritance diagram for FCMusicSpacingPrefs:
__FCPrefsBase __FCBaseData __FCBase

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. More...
 
- Public Types inherited from __FCBase
enum  PDKFRAMEWORK_CLASSID {
  FCID_UNKNOWN = 0, FCID_ACCIDENTALMOD, FCID_ALLOTMENT, FCID_ARTICULATION,
  FCID_ARTICULATIONDEF, FCID_BACKWARDREPEAT, FCID_BASELINE, FCID_BEAMMOD,
  FCID_BEATCHARTELEMENT, 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_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_KEYSIGNATURE, FCID_LAYERPREFS, 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_PERCUSSIONNOTEMOD, FCID_PIANOBRACEPREFS, FCID_PLAYBACKPREFS, FCID_RAWTEXT,
  FCID_REPEATPREFS, FCID_SECONDARYBEAMBREAKMOD, 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

virtual const char * ClassName ()
 Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child class. More...
 
virtual const PDKFRAMEWORK_CLASSID GetClassID ()
 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. More...
 
 FCMusicSpacingPrefs ()
 The constructor. More...
 
int GetScalingValue () const
 Returns the scaling factor, multiplied with 10000. More...
 
double GetScalingFactor () const
 Returns the scaling ratio, in the same way the Finale UI displays it. More...
 
Evpu16 GetMinimumItemDistance () const
 Returns the minimum distance between items, in EVPUs. More...
 
twobyte GetMinimumDistanceWithTies () const
 Returns the minimum distance between notes with ties. More...
 
twobyte GetMaxMeasureWidth () const
 Returns the maximum measure width. More...
 
twobyte GetMinMeasureWidth () const
 Returns the minimum measure width. More...
 
bool GetAvoidArticulations () const
 Returns true if Avoid Articulations is used. More...
 
bool GetAvoidChords () const
 Returns true if Avoid Chords is used. More...
 
bool GetAvoidClefs () const
 Returns true if Avoid Clefs is used. More...
 
bool GetAvoidHiddenNotes () const
 Returns true if Avoid Hidden Notes is used. More...
 
bool GetAvoidLedgerLines () const
 Returns true if Avoid Ledger Lines is used. More...
 
bool GetAvoidLyrics () const
 Returns true if Avoid Lyrics is used. More...
 
bool GetAvoidNoteAndAccidentals () const
 Returns true if Avoid Note and Accidentals is used. More...
 
bool GetAvoidSeconds () const
 Returns true if Avoid Seconds is used. More...
 
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). More...
 
GRACENOTE_SPACINGMODE GetGraceNoteSpacingMode () const
 Returns the grace note spacing mode. More...
 
twobyte GetGraceNoteMinDistance () const
 Returns the minimum distance between grace notes. More...
 
MANUAL_POSITIONING GetManualPositioning () const
 Returns the options for how to treat manual positioned notes. More...
 
UNISONS_MODE GetUnisonsMode () const
 Returns the mode for how to treat unisons. More...
 
twobyte GetAccidentalsGutter () const
 Returns the adjustment before accidental directly after barline (which affects music spacing). More...
 
twobyte GetTiesGutter () const
 Returns the adjustment before ties directly after a system break (which affects the beat chart). More...
 
bool GetUsePrinterMetrics () const
 Returns if printer font metrics should be used instead of screen. Windows only. More...
 
bool GetUseAllotmentMode () const
 Returns if the spacing is set to allotment mode. More...
 
twobyte GetScalingReferenceDuration () const
 Returns the reference duration for scaling. More...
 
twobyte GetScalingReferenceWidth () const
 Returns the reference width for scaling. More...
 
void SetScalingValue (int value)
 Sets the scaling factor, multiplied with 10000. More...
 
void SetScalingFactor (double ratio)
 Sets the scaling ratio, using the same type of preentation as in the Finale user interface. More...
 
void SetMinimumItemDistance (Evpu16 value)
 Sets the minimum distance between items, in EVPUs. More...
 
void SetMinimumDistanceWithTies (twobyte value)
 Sets the minimum distance between notes with ties. More...
 
void SetMaxMeasureWidth (twobyte value)
 Sets the maximum measure width. More...
 
void SetMinMeasureWidth (twobyte value)
 Sets the minimum measure width. More...
 
void SetAvoidArticulations (bool state)
 Sets if Avoid Articulations is used or not. More...
 
void SetAvoidChords (bool state)
 Sets if Avoid Chords is used or not. More...
 
void SetAvoidClefs (bool state)
 Sets if Avoid Clefs is used or not. More...
 
void SetAvoidHiddenNotes (bool state)
 Sets if Avoid Hidden Notes is used or not. More...
 
void SetAvoidLedgerLines (bool state)
 Sets if Avoid Ledger Lines is used or not. More...
 
void SetAvoidLyrics (bool state)
 Sets if Avoid Lyrics is used or not. More...
 
void SetAvoidNoteAndAccidentals (bool state)
 Sets if Avoid Note and Accidentals is used or not. More...
 
void SetAvoidSeconds (bool state)
 Sets if Avoid Seconds is used or not. More...
 
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). More...
 
void SetGraceNoteSpacingMode (GRACENOTE_SPACINGMODE value)
 Sets the grace note spacing mode. More...
 
void SetGraceNoteMinDistance (twobyte value)
 Sets the minimum distance between grace notes. More...
 
void SetManualPositioning (MANUAL_POSITIONING value)
 Sets the options for how to treat manual positioned notes. More...
 
void SetUnisonsMode (UNISONS_MODE value)
 Sets the mode for how to treat unisons. More...
 
void SetAccidentalsGutter (twobyte value)
 Sets the adjustment before accidental directly after barline (which is changed after music spacing). More...
 
void SetTiesGutter (twobyte value)
 Sets the adjustment before ties directly after a system break (which affects the beat chart). More...
 
void SetUsePrinterMetrics (bool state)
 Sets if printer font metrics should be used instead of screen. Windows only. More...
 
void SetUseAllotmentMode (bool allotmenttable)
 Sets the spacing to allotment table mode. More...
 
void SetScalingReferenceDuration (fourbyte duration)
 Sets the reference duration for scaling. More...
 
void SetScalingReferenceWidth (fourbyte width)
 Sets the reference width for scaling. More...
 
- Public Member Functions inherited from __FCPrefsBase
virtual bool Reload ()
 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. More...
 
virtual bool Save ()
 Saves the currently loaded to its current location. More...
 
virtual bool LoadFirst ()
 Loads the very first element in the database, if any. More...
 
int GetItemNo () const
 Returns the prefs number for the loaded data. More...
 
- Public Member Functions inherited from __FCBaseData
EDOCID GetConnectedDocID () const
 Returns the document ID that was connected to the last load/save of the data. More...
 
bool VerifyConnectedDocID ()
 Checks that the stored document ID for the data object matches the current document's ID. More...
 
virtual EVERSION EnigmaVersion ()
 The Enigma version for save/load/create/delete operations. More...
 
virtual int DataSizeSave ()
 Returns the data size for the data structure that should be saved or created. More...
 
void _CloneFrom (__FCBaseData *pSource)
 For internal use only. Copies object data (except data block) from another object. More...
 
const EDataID * _GetDataID ()
 Intended ONLY for the _CloneFrom implementation. More...
 
int _GetLoadedSize () const
 Intended ONLY for the _CloneFrom implementation. More...
 
const void * GetDataBlock ()
 Intended ONLY for the _CloneFrom implementation. More...
 
EXTAG GetCustomTag ()
 Returns the custom Enigma tag, if any. More...
 
void SetCustomTag (EXTAG tag)
 Sets the custom Enigma tag, for classes that support multiple Enigma tags. More...
 
 __FCBaseData ()
 The constructor.
 
virtual ~__FCBaseData ()
 Virtual destructor.
 
virtual bool DeleteData ()
 Deletes the associated data from Finale's database. Be careful when deleting multiple objects. More...
 
virtual bool DeepDeleteData ()
 Deletes data and all data that's connected to the object. More...
 
virtual bool LoadLast ()
 Loads the very last element in the database, if any. More...
 
virtual bool LoadNext ()
 Loads the next element from the database, if any. More...
 
virtual bool LoadPrevious ()
 Loads the previous element in the database, if any. More...
 
__FCBaseDataCreateClone ()
 Creates an identical copy of an object. More...
 
virtual void DebugDump ()
 Outputs the class data/information for debugging purposes. More...
 
virtual void DebugDataDump ()
 Outputs a memory dump of the data block in the object for debugging purposes. More...
 
virtual void DebugDataByteArrayDump ()
 Outputs a memory dump of the data block in the object for debugging purposes, as a C++ byte array. More...
 
void DebugDataOffsetDump (int offset, int size)
 For debug mode only. Dumps a data memory block at a specific offset and with a specific size.
 
FCNumbersCreateRawDataDump ()
 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. More...
 
- Public Member Functions inherited from __FCBase
 __FCBase ()
 The constructor.
 
virtual ~__FCBase ()
 Virtual destructor, so all inherited classes get the virtual destructor. More...
 
void DebugMsgDigit (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. More...
 
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. More...
 
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. More...
 
void DebugMsg (const char *pszMsg)
 Creates a simple Message Box for debug purposes with just one text string. More...
 
void DebugOutMenuInfo (FCUI *pUI, int menuixd_horiz, int menuixd_vert) const
 Outputs the menu command info for debugging purposes. More...
 
int DebugOutFormat (const char *fmt,...)
 Outputs debug text using C style "printf" syntax. More...
 
void Set16BitFlag (FLAG_16 *flag, FLAG_16 flagbits, bool state)
 Sets a 16 bit flag in the data block. More...
 
void Set32BitFlag (FLAG_32 *flag, FLAG_32 flagbits, bool state)
 Sets a 32 bit flag in the data block. More...
 
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. More...
 
void SetUserData (void *pData)
 Sets the user data attached to the instance of an object. More...
 
void SetUserData2 (void *pData)
 Sets the additional user data attached to the instance of an object. More...
 
void * GetUserData () const
 Gets the user data attached to the instance of an object. More...
 
void * GetUserData2 () const
 Gets the additional user data attached to the instance of an object. More...
 
virtual bool IsIdentical (__FCBase *pCompareObject)
 Returns true if the data in the passed object is considered to be identical to the current object, otherwise false. More...
 
void StoreXML_String (tinyxml2::XMLElement *pParentNode, const char *pszElementName, FCString *pStringValue)
 Helper function to store FCString objects in the XML file. More...
 
void StoreXML_Integer (tinyxml2::XMLElement *pParentNode, const char *pszElementName, int value)
 Helper function to store integer objects in the XML file. More...
 
void StoreXML_Bool (tinyxml2::XMLElement *pParentNode, const char *pszElementName, bool value)
 Helper function to store boolean objects in the XML file. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
virtual void StoreToXML (tinyxml2::XMLElement *pParentNode)
 Virtual method that is used to store an object's data. More...
 
bool ReadXML_String (tinyxml2::XMLElement *pParentNode, const char *pszElementName, FCString *pStringValue)
 Helper method to read FCString objects from the XML file. More...
 
bool ReadXML_Integer (tinyxml2::XMLElement *pParentNode, const char *pszElementName, int *pValue)
 Helper method to read integer objects from the XML file. More...
 
bool ReadXML_Bool (tinyxml2::XMLElement *pParentNode, const char *pszElementName, bool *pValue)
 Helper method to read boolean objects from the XML file. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
virtual bool ReadFromXML (tinyxml2::XMLElement *pParentNode)
 Virtual method that is used to read object data. More...
 

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. More...
 
static void DebugOutDigit (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. More...
 
static void DebugOutFloat (const char *pszPrefixText, float f)
 Static method that outputs a line for debugging purposes. The text appears with the extra float value appearing afterwards. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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". More...
 
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. More...
 
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. More...
 
static void DebugOut (const char *pszLine)
 Static method to output a line of text for debugging purposes. More...
 
- 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! More...
 
bool DataIsLoaded () const
 Returns true is any data has been loaded into the object. More...
 
void _TagDocumentID ()
 For internal use only. More...
 
- 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. More...
 
EDataID _dataid
 The EdataID for the last loaded/saved object.
 

Detailed Description

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

Member Enumeration Documentation

The grace note spacing constants used by GetGraceNoteSpacingMode.

Lua-supported.

The constants used by GetManualPositioning.

Lua-supported.

The constants used by GetUnisonsMode.

Lua-supported.

Constructor & Destructor Documentation

FCMusicSpacingPrefs::FCMusicSpacingPrefs ( )
inline

The constructor.

Lua-supported.

Member Function Documentation

virtual const char* FCMusicSpacingPrefs::ClassName ( )
inlinevirtual

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

Lua-supported.

Reimplemented from __FCBaseData.

twobyte FCMusicSpacingPrefs::GetAccidentalsGutter ( ) const
inline

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

Lua-supported (also as property).

bool FCMusicSpacingPrefs::GetAvoidArticulations ( ) const
inline

Returns true if Avoid Articulations is used.

Lua-supported (also as property).

bool FCMusicSpacingPrefs::GetAvoidChords ( ) const
inline

Returns true if Avoid Chords is used.

Lua-supported (also as property).

bool FCMusicSpacingPrefs::GetAvoidClefs ( ) const
inline

Returns true if Avoid Clefs is used.

Lua-supported (also as property).

bool FCMusicSpacingPrefs::GetAvoidHiddenNotes ( ) const
inline

Returns true if Avoid Hidden Notes is used.

Lua-supported (also as property).

bool FCMusicSpacingPrefs::GetAvoidLedgerLines ( ) const
inline

Returns true if Avoid Ledger Lines is used.

Lua-supported (also as property).

bool FCMusicSpacingPrefs::GetAvoidLyrics ( ) const
inline

Returns true if Avoid Lyrics is used.

Lua-supported (also as property).

bool FCMusicSpacingPrefs::GetAvoidNoteAndAccidentals ( ) const
inline

Returns true if Avoid Note and Accidentals is used.

Lua-supported (also as property).

bool FCMusicSpacingPrefs::GetAvoidSeconds ( ) const
inline

Returns true if Avoid Seconds is used.

Lua-supported (also as property).

virtual const PDKFRAMEWORK_CLASSID FCMusicSpacingPrefs::GetClassID ( )
inlinevirtual

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.

Implements __FCBaseData.

twobyte FCMusicSpacingPrefs::GetGraceNoteMinDistance ( ) const
inline

Returns the minimum distance between grace notes.

Lua-supported (also as property).

GRACENOTE_SPACINGMODE FCMusicSpacingPrefs::GetGraceNoteSpacingMode ( ) const
inline

Returns the grace note spacing mode.

Lua-supported (also as property).

Returns
Any of the GRACESPMODE_ constants.
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).

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.
twobyte FCMusicSpacingPrefs::GetMaxMeasureWidth ( ) const
inline

Returns the maximum measure width.

Lua-supported (also as property).

twobyte FCMusicSpacingPrefs::GetMinimumDistanceWithTies ( ) const
inline

Returns the minimum distance between notes with ties.

Lua-supported (also as property).

Evpu16 FCMusicSpacingPrefs::GetMinimumItemDistance ( ) const
inline

Returns the minimum distance between items, in EVPUs.

Lua-supported (also as property).

twobyte FCMusicSpacingPrefs::GetMinMeasureWidth ( ) const
inline

Returns the minimum measure width.

Lua-supported (also as property).

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
twobyte FCMusicSpacingPrefs::GetScalingReferenceDuration ( ) const
inline

Returns the reference duration for scaling.

Lua-supported (also as property).

twobyte FCMusicSpacingPrefs::GetScalingReferenceWidth ( ) const
inline

Returns the reference width for scaling.

Lua-supported (also as property).

int FCMusicSpacingPrefs::GetScalingValue ( ) const
inline

Returns the scaling factor, multiplied with 10000.

This method recerences 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.
twobyte FCMusicSpacingPrefs::GetTiesGutter ( ) const
inline

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

Lua-supported (also as property).

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

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

void FCMusicSpacingPrefs::SetAvoidArticulations ( bool  state)
inline

Sets if Avoid Articulations is used or not.

Lua-supported (also as property).

void FCMusicSpacingPrefs::SetAvoidChords ( bool  state)
inline

Sets if Avoid Chords is used or not.

Lua-supported (also as property).

void FCMusicSpacingPrefs::SetAvoidClefs ( bool  state)
inline

Sets if Avoid Clefs is used or not.

Lua-supported (also as property).

void FCMusicSpacingPrefs::SetAvoidHiddenNotes ( bool  state)
inline

Sets if Avoid Hidden Notes is used or not.

Lua-supported (also as property).

void FCMusicSpacingPrefs::SetAvoidLedgerLines ( bool  state)
inline

Sets if Avoid Ledger Lines is used or not.

Lua-supported (also as property).

void FCMusicSpacingPrefs::SetAvoidLyrics ( bool  state)
inline

Sets if Avoid Lyrics is used or not.

Lua-supported (also as property).

void FCMusicSpacingPrefs::SetAvoidNoteAndAccidentals ( bool  state)
inline

Sets if Avoid Note and Accidentals is used or not.

Lua-supported (also as property).

void FCMusicSpacingPrefs::SetAvoidSeconds ( bool  state)
inline

Sets if Avoid Seconds is used or not.

Lua-supported (also as property).

void FCMusicSpacingPrefs::SetGraceNoteMinDistance ( twobyte  value)
inline

Sets the minimum distance between grace notes.

Lua-supported (also as property).

void FCMusicSpacingPrefs::SetGraceNoteSpacingMode ( GRACENOTE_SPACINGMODE  value)
inline

Sets the grace note spacing mode.

Lua-supported (also as property).

Parameters
valueAny of the GRACESPMODE_ constants.
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).

void FCMusicSpacingPrefs::SetManualPositioning ( MANUAL_POSITIONING  value)
inline

Sets the options for how to treat manual positioned notes.

Lua-supported (also as property).

Parameters
valueAny of the MANUALPOS_ constants.
void FCMusicSpacingPrefs::SetMaxMeasureWidth ( twobyte  value)
inline

Sets the maximum measure width.

Lua-supported (also as property).

void FCMusicSpacingPrefs::SetMinimumDistanceWithTies ( twobyte  value)
inline

Sets the minimum distance between notes with ties.

Lua-supported (also as property).

void FCMusicSpacingPrefs::SetMinimumItemDistance ( Evpu16  value)
inline

Sets the minimum distance between items, in EVPUs.

Lua-supported (also as property).

void FCMusicSpacingPrefs::SetMinMeasureWidth ( twobyte  value)
inline

Sets the minimum measure width.

Lua-supported (also as property).

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
ratioA floating point (double) value, such as 1.61
void FCMusicSpacingPrefs::SetScalingReferenceDuration ( fourbyte  duration)
inline

Sets the reference duration for scaling.

Lua-supported (also as property).

void FCMusicSpacingPrefs::SetScalingReferenceWidth ( fourbyte  width)
inline

Sets the reference width for scaling.

Lua-supported (also as property).

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).
void FCMusicSpacingPrefs::SetTiesGutter ( twobyte  value)
inline

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

Lua-supported (also as property).

void FCMusicSpacingPrefs::SetUnisonsMode ( UNISONS_MODE  value)
inline

Sets the mode for how to treat unisons.

Lua-supported (also as property).

Parameters
valueAny of the UNISSPACE_ contants.
void FCMusicSpacingPrefs::SetUseAllotmentMode ( bool  allotmenttable)
inline

Sets the spacing to allotment table mode.

Lua-supported (also as property).

Parameters
allotmenttabletrue - Use allotment tables. false - Use scaling value.
void FCMusicSpacingPrefs::SetUsePrinterMetrics ( bool  state)
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).