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

Class for preferences values that controls distances (between objects, etc) More...

#include <ff_prefs.h>

Inheritance diagram for FCDistancePrefs:
__FCPrefsBase __FCBaseData __FCBase

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...
 
 FCDistancePrefs ()
 The constructor. More...
 
twobyte GetSpaceBefore () const
 Returns the document setting for extra space before the music in a measure. More...
 
twobyte GetSpaceAfter () const
 Returns the document setting for extra space after the music in a measure. More...
 
twobyte GetAugmentationDotSpace () const
 Returns the space between each augmentation dot. More...
 
twobyte GetAugmentationDotNoteSpace () const
 Returns the default horizontal space between augmentation dot and note. More...
 
twobyte GetAugmentationDotVerticalAdjust () const
 Returns the default vertical offset for an augmentation dot. More...
 
twobyte GetAugmentationDotUpstemAdjust () const
 Returns the default horizontal adjustment for augmentation dots attached to upstem flags. More...
 
twobyte GetClefChangeOffset () const
 Returns the space after a clef change and the barline, as a positive value. More...
 
twobyte GetSecondaryBeamSpace () const
 Returns the space between each secondary beam, in EVPUs. More...
 
Evpu16 GetTimeSigTopVertical () const
 Returns the vertical adjustment of top time sig symbol from top staff line, for the score. More...
 
Evpu16 GetTimeSigPartsTopVertical () const
 Returns the vertical adjustment of top time sig symbol from top staff line, for the parts. More...
 
Evpu16 GetTimeSigBottomVertical () const
 Returns the vertical adjustment of bottom time sig symbol from bottom staff line, for the score. More...
 
Evpu16 GetTimeSigPartsBottomVertical () const
 Returns the vertical adjustment of bottom time sig symbol from bottom staff line, for the parts. More...
 
Efix16 GetBarlineDoubleSpace () const
 Returns the space between double barlines, in EFIXes. More...
 
Efix16 GetBarlineFinalSpace () const
 Returns the space between final barlines, in EFIXes. More...
 
Evpu32 GetBarlineDashSpace () const
 Returns the barline dash space, in EVPUs. More...
 
Evpu16 GetKeySpaceBefore () const
 Returns the space before key signature, in EVPUs. More...
 
Evpu16 GetKeySpaceAfter () const
 Returns the space after key signature, in EVPUs. More...
 
Evpu16 GetKeySpaceAfterCancel () const
 Returns the space after a canceled key signature, in EVPUs. More...
 
Evpu16 GetKeySpaceBetweenAccidentals () const
 Returns the space between key signature accidentals, in EVPUs. More...
 
Evpu16 GetClefSpaceBefore () const
 Returns the space before clef, in EVPUs. More...
 
Evpu16 GetClefSpaceAfter () const
 Returns the space after clef, in EVPUs. More...
 
Efix32 GetStemVerticalNoteheadOffset () const
 Returns the vertical stem offset for noteheads, in EFIXes. More...
 
Evpu16 GetTimeSigAbbreviatedVertical () const
 Returns the vertical adjustment of abbreviated time signature, in EVPUs, for the score. More...
 
Evpu16 GetTimeSigPartsAbbreviatedVertical () const
 Returns the vertical adjustment of abbreviated time signature, in EVPUs, for the parts. More...
 
Evpu16 GetTimeSigSpaceBefore () const
 Returns the space before the time signature, in EVPUs, for the score. More...
 
Evpu16 GetTimeSigPartsSpaceBefore () const
 Returns the space before the time signature, in EVPUs, for the parts. More...
 
Evpu16 GetTimeSigSpaceAfter () const
 Returns the space after the time signature, in EVPUs, for the score. More...
 
Evpu16 GetTimeSigPartsSpaceAfter () const
 Returns the space after the time signature, in EVPUs, for the parts. More...
 
twobyte GetAccidentalVertical () const
 Returns the vertical spacing between accidentals, in spaces. More...
 
Evpu16 GetAccidentalMultiCharSpace () const
 Returns the space within multi-character accidentals, in EVPUs. More...
 
Evpu16 GetAccidentalNoteSpace () const
 Returns the space between accidental and note, in EVPUs. More...
 
Evpu16 GetAccidentalMultiSpace () const
 Returns the space between accidentals on note, in EVPUs. More...
 
twobyte GetAlternateHalfDiamondVertical () const
 Returns the value for Alternate Notation: Rhythmic Notation Vertical Positioning - Half Note Diamond Baseline Adjust. More...
 
twobyte GetAlternateWholeDiamondVertical () const
 Returns the value for Alternate Notation: Rhythmic Notation Vertical Positioning - Whole Note Diamond Baseline Adjust. More...
 
twobyte GetAlternateBrevisDiamondVertical () const
 Returns the value for Alternate Notation: Rhythmic Notation Vertical Positioning - Double Whole Note Diamond Baseline Adjust. More...
 
twobyte GetBeamMaxDistance () const
 Returns the Max Distance from Middle Staff Line, in spaces. More...
 
Evpu16 GetGraceNoteSpacing () const
 Returns the horizontal grace note spacing, in EVPUs. More...
 
Evpu16 GetGroupBracketDefaultDistance () const
 Returns the default horizontal distance for group brackets from the edge of the staff. More...
 
Evpu16 GetKeyTimeExtraSpace () const
 Returns the extra space between key and time signature. More...
 
Evpu16 GetClefKeyExtraSpace () const
 Returns the extra space between clef and key signature. More...
 
Evpu16 GetClefTimeExtraSpace () const
 Returns the extra space between clef and time signature. More...
 
void SetSpaceBefore (twobyte value)
 Sets the document setting for extra space before the music in a measure. More...
 
void SetSpaceAfter (twobyte value)
 Sets the document setting for extra space after the music in a measure. More...
 
void SetAugmentationDotSpace (twobyte value)
 Sets the default space between each augmentation dot. More...
 
void SetAugmentationDotNoteSpace (twobyte value)
 Sets the default horizontal space between augmentation dot and note. More...
 
void SetAugmentationDotVerticalAdjust (twobyte value)
 Sets the default vertical offset for an augmentation dot. More...
 
void SetAugmentationDotUpstemAdjust (twobyte value)
 Sets the default horizontal adjustment for augmentation dots attached to upstem flags. More...
 
void SetClefChangeOffset (twobyte value)
 Sets the space after a clef change and the barline, as a positive value. More...
 
void SetSecondaryBeamSpace (twobyte value)
 Sets the space between each secondary beam. More...
 
void SetTimeSigTopVertical (Evpu16 value)
 Sets the vertical adjustment of top time sig symbol from top staff line, for the score. More...
 
void SetTimeSigPartsTopVertical (Evpu16 value)
 Sets the vertical adjustment of top time sig symbol from top staff line, for the parts. More...
 
void SetTimeSigBottomVertical (Evpu16 value)
 Sets the vertical adjustment of bottom time sig symbol from bottom staff line, for the score. More...
 
void SetTimeSigPartsBottomVertical (Evpu16 value)
 Sets the vertical adjustment of bottom time sig symbol from bottom staff line, for the parts. More...
 
void SetBarlineDoubleSpace (Efix16 value)
 Sets the space between double barlines, in EFIXes. More...
 
void SetBarlineFinalSpace (Efix16 value)
 Sets the space between final barlines, in EFIXes. More...
 
void SetBarlineDashSpace (Evpu32 value)
 Sets the barline dash space, in EVPUs. More...
 
void SetKeySpaceBefore (Evpu16 value)
 Sets the space before key signature, in EVPUs. More...
 
void SetKeySpaceAfter (Evpu16 value)
 Sets the space after key signature, in EVPUs. More...
 
void SetKeySpaceAfterCancel (Evpu16 value)
 Sets the space after a canceled key signature, in EVPUs. More...
 
void SetKeySpaceBetweenAccidentals (Evpu16 value)
 Sets the space between key signature accidentals, in EVPUs. More...
 
void SetClefSpaceBefore (Evpu16 value)
 Sets the space before clef, in EVPUs. More...
 
void SetClefSpaceAfter (Evpu16 value)
 Sets the space after clef, in EVPUs. More...
 
void SetStemVerticalNoteheadOffset (Efix32 value)
 Sets the vertical stem offset for noteheads, in EFIXes. More...
 
void SetTimeSigAbbreviatedVertical (Evpu16 value)
 Sets the vertical adjustment of abbreviated time signature, in EVPUs, for the score. More...
 
void SetTimeSigPartsAbbreviatedVertical (Evpu16 value)
 Sets the vertical adjustment of abbreviated time signature, in EVPUs, for the parts. More...
 
void SetTimeSigSpaceBefore (Evpu16 value)
 Sets the space before the time signature, in EVPUs, for the score. More...
 
void SetTimeSigPartsSpaceBefore (Evpu16 value)
 Sets the space before the time signature, in EVPUs, for the parts. More...
 
void SetTimeSigSpaceAfter (Evpu16 value)
 Sets the space after the time signature, in EVPUs, for the score. More...
 
void SetTimeSigPartsSpaceAfter (Evpu16 value)
 Sets the space after the time signature, in EVPUs, for the parts. More...
 
void SetAccidentalVertical (twobyte value)
 Sets the vertical spacing between accidentals, in spaces. More...
 
void SetAccidentalMultiCharSpace (Evpu16 value)
 Sets the space within multi-character accidentals, in EVPUs. More...
 
void SetAccidentalNoteSpace (Evpu16 value)
 Sets the space between accidental and note, in EVPUs. More...
 
void SetAccidentalMultiSpace (Evpu16 value)
 Sets the space between accidentals on note, in EVPUs. More...
 
void SetAlternateHalfDiamondVertical (twobyte value)
 Sets the value for Alternate Notation: Rhythmic Notation Vertical Positioning - Half Note Diamond Baseline Adjust. More...
 
void SetAlternateWholeDiamondVertical (twobyte value)
 Sets the value for Alternate Notation: Rhythmic Notation Vertical Positioning - Whole Note Diamond Baseline Adjust. More...
 
void SetAlternateBrevisDiamondVertical (twobyte value)
 Sets the value for Alternate Notation: Rhythmic Notation Vertical Positioning - Double Whole Note Diamond Baseline Adjust. More...
 
void SetBeamMaxDistance (twobyte value)
 Sets the Max Distance from Middle Staff Line, in spaces. More...
 
void SetGraceNoteSpacing (Evpu16 value)
 Sets the horizontal grace note spacing, in EVPUs. More...
 
void SetGroupBracketDefaultDistance (Evpu16 value)
 Sets the default horizontal distance for group brackets from the edge of the staff. More...
 
void SetKeyTimeExtraSpace (Evpu16 value)
 Sets the extra space between key and time signature. More...
 
void SetClefKeyExtraSpace (Evpu16 value)
 Sets the extra space between clef and key signature. More...
 
void SetClefTimeExtraSpace (Evpu16 value)
 Sets the extra space between clef and time signature. 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

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

Class for preferences values that controls distances (between objects, etc)

Constructor & Destructor Documentation

FCDistancePrefs::FCDistancePrefs ( )
inline

The constructor.

Lua-supported.

Member Function Documentation

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

Evpu16 FCDistancePrefs::GetAccidentalMultiCharSpace ( ) const
inline

Returns the space within multi-character accidentals, in EVPUs.

Lua-supported (also as property).

Evpu16 FCDistancePrefs::GetAccidentalMultiSpace ( ) const
inline

Returns the space between accidentals on note, in EVPUs.

Lua-supported (also as property).

Evpu16 FCDistancePrefs::GetAccidentalNoteSpace ( ) const
inline

Returns the space between accidental and note, in EVPUs.

Lua-supported (also as property).

twobyte FCDistancePrefs::GetAccidentalVertical ( ) const
inline

Returns the vertical spacing between accidentals, in spaces.

Lua-supported (also as property).

twobyte FCDistancePrefs::GetAlternateBrevisDiamondVertical ( ) const
inline

Returns the value for Alternate Notation: Rhythmic Notation Vertical Positioning - Double Whole Note Diamond Baseline Adjust.

Lua-supported (also as property).

twobyte FCDistancePrefs::GetAlternateHalfDiamondVertical ( ) const
inline

Returns the value for Alternate Notation: Rhythmic Notation Vertical Positioning - Half Note Diamond Baseline Adjust.

Lua-supported (also as property).

twobyte FCDistancePrefs::GetAlternateWholeDiamondVertical ( ) const
inline

Returns the value for Alternate Notation: Rhythmic Notation Vertical Positioning - Whole Note Diamond Baseline Adjust.

Lua-supported (also as property).

twobyte FCDistancePrefs::GetAugmentationDotNoteSpace ( ) const
inline

Returns the default horizontal space between augmentation dot and note.

Lua-supported (also as property).

twobyte FCDistancePrefs::GetAugmentationDotSpace ( ) const
inline

Returns the space between each augmentation dot.

Lua-supported (also as property).

twobyte FCDistancePrefs::GetAugmentationDotUpstemAdjust ( ) const
inline

Returns the default horizontal adjustment for augmentation dots attached to upstem flags.

Lua-supported (also as property).

twobyte FCDistancePrefs::GetAugmentationDotVerticalAdjust ( ) const
inline

Returns the default vertical offset for an augmentation dot.

Lua-supported (also as property).

Evpu32 FCDistancePrefs::GetBarlineDashSpace ( ) const
inline

Returns the barline dash space, in EVPUs.

Lua-supported (also as property).

Efix16 FCDistancePrefs::GetBarlineDoubleSpace ( ) const
inline

Returns the space between double barlines, in EFIXes.

Lua-supported (also as property).

Efix16 FCDistancePrefs::GetBarlineFinalSpace ( ) const
inline

Returns the space between final barlines, in EFIXes.

Lua-supported (also as property).

twobyte FCDistancePrefs::GetBeamMaxDistance ( ) const
inline

Returns the Max Distance from Middle Staff Line, in spaces.

Lua-supported (also as property).

virtual const PDKFRAMEWORK_CLASSID FCDistancePrefs::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 FCDistancePrefs::GetClefChangeOffset ( ) const
inline

Returns the space after a clef change and the barline, as a positive value.

Lua-supported (also as property).

Evpu16 FCDistancePrefs::GetClefKeyExtraSpace ( ) const
inline

Returns the extra space between clef and key signature.

Lua-supported (also as property).

Evpu16 FCDistancePrefs::GetClefSpaceAfter ( ) const
inline

Returns the space after clef, in EVPUs.

Lua-supported (also as property).

Evpu16 FCDistancePrefs::GetClefSpaceBefore ( ) const
inline

Returns the space before clef, in EVPUs.

Lua-supported (also as property).

Evpu16 FCDistancePrefs::GetClefTimeExtraSpace ( ) const
inline

Returns the extra space between clef and time signature.

Lua-supported (also as property).

Evpu16 FCDistancePrefs::GetGraceNoteSpacing ( ) const
inline

Returns the horizontal grace note spacing, in EVPUs.

Lua-supported (also as property).

Evpu16 FCDistancePrefs::GetGroupBracketDefaultDistance ( ) const
inline

Returns the default horizontal distance for group brackets from the edge of the staff.

Lua-supported (also as property).

Evpu16 FCDistancePrefs::GetKeySpaceAfter ( ) const
inline

Returns the space after key signature, in EVPUs.

Lua-supported (also as property).

Evpu16 FCDistancePrefs::GetKeySpaceAfterCancel ( ) const
inline

Returns the space after a canceled key signature, in EVPUs.

Lua-supported (also as property).

Evpu16 FCDistancePrefs::GetKeySpaceBefore ( ) const
inline

Returns the space before key signature, in EVPUs.

Lua-supported (also as property).

Evpu16 FCDistancePrefs::GetKeySpaceBetweenAccidentals ( ) const
inline

Returns the space between key signature accidentals, in EVPUs.

Lua-supported (also as property).

Evpu16 FCDistancePrefs::GetKeyTimeExtraSpace ( ) const
inline

Returns the extra space between key and time signature.

Lua-supported (also as property).

twobyte FCDistancePrefs::GetSecondaryBeamSpace ( ) const
inline

Returns the space between each secondary beam, in EVPUs.

Lua-supported (also as property).

twobyte FCDistancePrefs::GetSpaceAfter ( ) const
inline

Returns the document setting for extra space after the music in a measure.

Lua-supported (also as property).

twobyte FCDistancePrefs::GetSpaceBefore ( ) const
inline

Returns the document setting for extra space before the music in a measure.

Lua-supported (also as property).

Efix32 FCDistancePrefs::GetStemVerticalNoteheadOffset ( ) const
inline

Returns the vertical stem offset for noteheads, in EFIXes.

Lua-supported (also as property).

Evpu16 FCDistancePrefs::GetTimeSigAbbreviatedVertical ( ) const
inline

Returns the vertical adjustment of abbreviated time signature, in EVPUs, for the score.

Lua-supported (also as property).

Evpu16 FCDistancePrefs::GetTimeSigBottomVertical ( ) const
inline

Returns the vertical adjustment of bottom time sig symbol from bottom staff line, for the score.

Lua-supported (also as property).

Evpu16 FCDistancePrefs::GetTimeSigPartsAbbreviatedVertical ( ) const
inline

Returns the vertical adjustment of abbreviated time signature, in EVPUs, for the parts.

Lua-supported (also as property).

Evpu16 FCDistancePrefs::GetTimeSigPartsBottomVertical ( ) const
inline

Returns the vertical adjustment of bottom time sig symbol from bottom staff line, for the parts.

Lua-supported (also as property).

Evpu16 FCDistancePrefs::GetTimeSigPartsSpaceAfter ( ) const
inline

Returns the space after the time signature, in EVPUs, for the parts.

Lua-supported (also as property).

Evpu16 FCDistancePrefs::GetTimeSigPartsSpaceBefore ( ) const
inline

Returns the space before the time signature, in EVPUs, for the parts.

Lua-supported (also as property).

Evpu16 FCDistancePrefs::GetTimeSigPartsTopVertical ( ) const
inline

Returns the vertical adjustment of top time sig symbol from top staff line, for the parts.

Lua-supported (also as property).

Evpu16 FCDistancePrefs::GetTimeSigSpaceAfter ( ) const
inline

Returns the space after the time signature, in EVPUs, for the score.

Lua-supported (also as property).

Evpu16 FCDistancePrefs::GetTimeSigSpaceBefore ( ) const
inline

Returns the space before the time signature, in EVPUs, for the score.

Lua-supported (also as property).

Evpu16 FCDistancePrefs::GetTimeSigTopVertical ( ) const
inline

Returns the vertical adjustment of top time sig symbol from top staff line, for the score.

Lua-supported (also as property).

void FCDistancePrefs::SetAccidentalMultiCharSpace ( Evpu16  value)
inline

Sets the space within multi-character accidentals, in EVPUs.

Lua-supported (also as property).

void FCDistancePrefs::SetAccidentalMultiSpace ( Evpu16  value)
inline

Sets the space between accidentals on note, in EVPUs.

Lua-supported (also as property).

void FCDistancePrefs::SetAccidentalNoteSpace ( Evpu16  value)
inline

Sets the space between accidental and note, in EVPUs.

Lua-supported (also as property).

void FCDistancePrefs::SetAccidentalVertical ( twobyte  value)
inline

Sets the vertical spacing between accidentals, in spaces.

Lua-supported (also as property).

void FCDistancePrefs::SetAlternateBrevisDiamondVertical ( twobyte  value)
inline

Sets the value for Alternate Notation: Rhythmic Notation Vertical Positioning - Double Whole Note Diamond Baseline Adjust.

Lua-supported (also as property).

void FCDistancePrefs::SetAlternateHalfDiamondVertical ( twobyte  value)
inline

Sets the value for Alternate Notation: Rhythmic Notation Vertical Positioning - Half Note Diamond Baseline Adjust.

Lua-supported (also as property).

void FCDistancePrefs::SetAlternateWholeDiamondVertical ( twobyte  value)
inline

Sets the value for Alternate Notation: Rhythmic Notation Vertical Positioning - Whole Note Diamond Baseline Adjust.

Lua-supported (also as property).

void FCDistancePrefs::SetAugmentationDotNoteSpace ( twobyte  value)
inline

Sets the default horizontal space between augmentation dot and note.

Lua-supported (also as property).

void FCDistancePrefs::SetAugmentationDotSpace ( twobyte  value)
inline

Sets the default space between each augmentation dot.

Lua-supported (also as property).

void FCDistancePrefs::SetAugmentationDotUpstemAdjust ( twobyte  value)
inline

Sets the default horizontal adjustment for augmentation dots attached to upstem flags.

Lua-supported (also as property).

void FCDistancePrefs::SetAugmentationDotVerticalAdjust ( twobyte  value)
inline

Sets the default vertical offset for an augmentation dot.

Lua-supported (also as property).

void FCDistancePrefs::SetBarlineDashSpace ( Evpu32  value)
inline

Sets the barline dash space, in EVPUs.

Lua-supported (also as property).

void FCDistancePrefs::SetBarlineDoubleSpace ( Efix16  value)
inline

Sets the space between double barlines, in EFIXes.

Lua-supported (also as property).

void FCDistancePrefs::SetBarlineFinalSpace ( Efix16  value)
inline

Sets the space between final barlines, in EFIXes.

Lua-supported (also as property).

void FCDistancePrefs::SetBeamMaxDistance ( twobyte  value)
inline

Sets the Max Distance from Middle Staff Line, in spaces.

Lua-supported (also as property).

void FCDistancePrefs::SetClefChangeOffset ( twobyte  value)
inline

Sets the space after a clef change and the barline, as a positive value.

Lua-supported (also as property).

void FCDistancePrefs::SetClefKeyExtraSpace ( Evpu16  value)
inline

Sets the extra space between clef and key signature.

Lua-supported (also as property).

void FCDistancePrefs::SetClefSpaceAfter ( Evpu16  value)
inline

Sets the space after clef, in EVPUs.

Lua-supported (also as property).

void FCDistancePrefs::SetClefSpaceBefore ( Evpu16  value)
inline

Sets the space before clef, in EVPUs.

Lua-supported (also as property).

void FCDistancePrefs::SetClefTimeExtraSpace ( Evpu16  value)
inline

Sets the extra space between clef and time signature.

Lua-supported (also as property).

void FCDistancePrefs::SetGraceNoteSpacing ( Evpu16  value)
inline

Sets the horizontal grace note spacing, in EVPUs.

Lua-supported (also as property).

void FCDistancePrefs::SetGroupBracketDefaultDistance ( Evpu16  value)
inline

Sets the default horizontal distance for group brackets from the edge of the staff.

Lua-supported (also as property).

void FCDistancePrefs::SetKeySpaceAfter ( Evpu16  value)
inline

Sets the space after key signature, in EVPUs.

Lua-supported (also as property).

void FCDistancePrefs::SetKeySpaceAfterCancel ( Evpu16  value)
inline

Sets the space after a canceled key signature, in EVPUs.

Lua-supported (also as property).

void FCDistancePrefs::SetKeySpaceBefore ( Evpu16  value)
inline

Sets the space before key signature, in EVPUs.

Lua-supported (also as property).

void FCDistancePrefs::SetKeySpaceBetweenAccidentals ( Evpu16  value)
inline

Sets the space between key signature accidentals, in EVPUs.

Lua-supported (also as property).

void FCDistancePrefs::SetKeyTimeExtraSpace ( Evpu16  value)
inline

Sets the extra space between key and time signature.

Lua-supported (also as property).

void FCDistancePrefs::SetSecondaryBeamSpace ( twobyte  value)
inline

Sets the space between each secondary beam.

Lua-supported (also as property).

void FCDistancePrefs::SetSpaceAfter ( twobyte  value)
inline

Sets the document setting for extra space after the music in a measure.

Lua-supported (also as property).

void FCDistancePrefs::SetSpaceBefore ( twobyte  value)
inline

Sets the document setting for extra space before the music in a measure.

Lua-supported (also as property).

void FCDistancePrefs::SetStemVerticalNoteheadOffset ( Efix32  value)
inline

Sets the vertical stem offset for noteheads, in EFIXes.

Lua-supported (also as property).

void FCDistancePrefs::SetTimeSigAbbreviatedVertical ( Evpu16  value)
inline

Sets the vertical adjustment of abbreviated time signature, in EVPUs, for the score.

Lua-supported (also as property).

void FCDistancePrefs::SetTimeSigBottomVertical ( Evpu16  value)
inline

Sets the vertical adjustment of bottom time sig symbol from bottom staff line, for the score.

Lua-supported (also as property).

void FCDistancePrefs::SetTimeSigPartsAbbreviatedVertical ( Evpu16  value)
inline

Sets the vertical adjustment of abbreviated time signature, in EVPUs, for the parts.

Lua-supported (also as property).

void FCDistancePrefs::SetTimeSigPartsBottomVertical ( Evpu16  value)
inline

Sets the vertical adjustment of bottom time sig symbol from bottom staff line, for the parts.

Lua-supported (also as property).

void FCDistancePrefs::SetTimeSigPartsSpaceAfter ( Evpu16  value)
inline

Sets the space after the time signature, in EVPUs, for the parts.

Lua-supported (also as property).

void FCDistancePrefs::SetTimeSigPartsSpaceBefore ( Evpu16  value)
inline

Sets the space before the time signature, in EVPUs, for the parts.

Lua-supported (also as property).

void FCDistancePrefs::SetTimeSigPartsTopVertical ( Evpu16  value)
inline

Sets the vertical adjustment of top time sig symbol from top staff line, for the parts.

Lua-supported (also as property).

void FCDistancePrefs::SetTimeSigSpaceAfter ( Evpu16  value)
inline

Sets the space after the time signature, in EVPUs, for the score.

Lua-supported (also as property).

void FCDistancePrefs::SetTimeSigSpaceBefore ( Evpu16  value)
inline

Sets the space before the time signature, in EVPUs, for the score.

Lua-supported (also as property).

void FCDistancePrefs::SetTimeSigTopVertical ( Evpu16  value)
inline

Sets the vertical adjustment of top time sig symbol from top staff line, for the score.

Lua-supported (also as property).