FCDistancePrefs Class Reference

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

#include <ff_prefs.h>

Inheritance diagram for FCDistancePrefs:

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.
	FCDistancePrefs ()
	The constructor.
twobyte	GetSpaceBefore () const
	Returns the document setting for extra space before the music in a measure.
twobyte	GetSpaceAfter () const
	Returns the document setting for extra space after the music in a measure.
twobyte	GetAugmentationDotSpace () const
	Returns the space between each augmentation dot.
twobyte	GetAugmentationDotNoteSpace () const
	Returns the default horizontal space between augmentation dot and note.
twobyte	GetAugmentationDotVerticalAdjust () const
	Returns the default vertical offset for an augmentation dot.
twobyte	GetAugmentationDotUpstemAdjust () const
	Returns the default horizontal adjustment for augmentation dots attached to upstem flags.
twobyte	GetClefChangeOffset () const
	Returns the space after a clef change and the barline, as a positive value.
twobyte	GetSecondaryBeamSpace () const
	Returns the space between each secondary beam, in EVPUs.
Evpu16	GetTimeSigTopVertical () const
	Returns the vertical adjustment of top time sig symbol from top staff line, for the score.
Evpu16	GetTimeSigPartsTopVertical () const
	Returns the vertical adjustment of top time sig symbol from top staff line, for the parts.
Evpu16	GetTimeSigBottomVertical () const
	Returns the vertical adjustment of bottom time sig symbol from bottom staff line, for the score.
Evpu16	GetTimeSigPartsBottomVertical () const
	Returns the vertical adjustment of bottom time sig symbol from bottom staff line, for the parts.
Efix16	GetBarlineDoubleSpace () const
	Returns the space between double barlines, in EFIXes.
Efix16	GetBarlineFinalSpace () const
	Returns the space between final barlines, in EFIXes.
Evpu32	GetBarlineDashSpace () const
	Returns the barline dash space, in EVPUs.
Evpu16	GetKeySpaceBefore () const
	Returns the space before key signature, in EVPUs.
Evpu16	GetKeySpaceAfter () const
	Returns the space after key signature, in EVPUs.
Evpu16	GetKeySpaceAfterCancel () const
	Returns the space after a canceled key signature, in EVPUs.
Evpu16	GetKeySpaceBetweenAccidentals () const
	Returns the space between key signature accidentals, in EVPUs.
Evpu16	GetClefSpaceBefore () const
	Returns the space before clef, in EVPUs.
Evpu16	GetClefSpaceAfter () const
	Returns the space after clef, in EVPUs.
Efix32	GetStemVerticalNoteheadOffset () const
	Returns the vertical stem offset for noteheads, in EFIXes.
Evpu16	GetTimeSigAbbreviatedVertical () const
	Returns the vertical adjustment of abbreviated time signature, in EVPUs, for the score.
Evpu16	GetTimeSigPartsAbbreviatedVertical () const
	Returns the vertical adjustment of abbreviated time signature, in EVPUs, for the parts.
Evpu16	GetTimeSigSpaceBefore () const
	Returns the space before the time signature, in EVPUs, for the score.
Evpu16	GetTimeSigPartsSpaceBefore () const
	Returns the space before the time signature, in EVPUs, for the parts.
Evpu16	GetTimeSigSpaceAfter () const
	Returns the space after the time signature, in EVPUs, for the score.
Evpu16	GetTimeSigPartsSpaceAfter () const
	Returns the space after the time signature, in EVPUs, for the parts.
twobyte	GetAccidentalVertical () const
	Returns the vertical spacing between accidentals, in spaces.
Evpu16	GetAccidentalMultiCharSpace () const
	Returns the space within multi-character accidentals, in EVPUs.
Evpu16	GetAccidentalNoteSpace () const
	Returns the space between accidental and note, in EVPUs.
Evpu16	GetAccidentalMultiSpace () const
	Returns the space between accidentals on note, in EVPUs.
twobyte	GetAlternateHalfDiamondVertical () const
	Returns the value for Alternate Notation: Rhythmic Notation Vertical Positioning - Half Note Diamond Baseline Adjust.
twobyte	GetAlternateWholeDiamondVertical () const
	Returns the value for Alternate Notation: Rhythmic Notation Vertical Positioning - Whole Note Diamond Baseline Adjust.
twobyte	GetAlternateBrevisDiamondVertical () const
	Returns the value for Alternate Notation: Rhythmic Notation Vertical Positioning - Double Whole Note Diamond Baseline Adjust.
twobyte	GetBeamMaxDistance () const
	Returns the Max Distance from Middle Staff Line, in spaces.
Evpu16	GetGraceNoteSpacing () const
	Returns the horizontal grace note spacing, in EVPUs.
Evpu16	GetGroupBracketDefaultDistance () const
	Returns the default horizontal distance for group brackets from the edge of the staff.
Evpu16	GetKeyTimeExtraSpace () const
	Returns the extra space between key and time signature.
Evpu16	GetClefKeyExtraSpace () const
	Returns the extra space between clef and key signature.
Evpu16	GetClefTimeExtraSpace () const
	Returns the extra space between clef and time signature.
bool	GetAccidentalCrossLayerPositioning () const
	Returns the Use Accidental Cross-Layer Positioning option.
void	SetSpaceBefore (twobyte value)
	Sets the document setting for extra space before the music in a measure.
void	SetSpaceAfter (twobyte value)
	Sets the document setting for extra space after the music in a measure.
void	SetAugmentationDotSpace (twobyte value)
	Sets the default space between each augmentation dot.
void	SetAugmentationDotNoteSpace (twobyte value)
	Sets the default horizontal space between augmentation dot and note.
void	SetAugmentationDotVerticalAdjust (twobyte value)
	Sets the default vertical offset for an augmentation dot.
void	SetAugmentationDotUpstemAdjust (twobyte value)
	Sets the default horizontal adjustment for augmentation dots attached to upstem flags.
void	SetClefChangeOffset (twobyte value)
	Sets the space after a clef change and the barline, as a positive value.
void	SetSecondaryBeamSpace (twobyte value)
	Sets the space between each secondary beam.
void	SetTimeSigTopVertical (Evpu16 value)
	Sets the vertical adjustment of top time sig symbol from top staff line, for the score.
void	SetTimeSigPartsTopVertical (Evpu16 value)
	Sets the vertical adjustment of top time sig symbol from top staff line, for the parts.
void	SetTimeSigBottomVertical (Evpu16 value)
	Sets the vertical adjustment of bottom time sig symbol from bottom staff line, for the score.
void	SetTimeSigPartsBottomVertical (Evpu16 value)
	Sets the vertical adjustment of bottom time sig symbol from bottom staff line, for the parts.
void	SetBarlineDoubleSpace (Efix16 value)
	Sets the space between double barlines, in EFIXes.
void	SetBarlineFinalSpace (Efix16 value)
	Sets the space between final barlines, in EFIXes.
void	SetBarlineDashSpace (Evpu32 value)
	Sets the barline dash space, in EVPUs.
void	SetKeySpaceBefore (Evpu16 value)
	Sets the space before key signature, in EVPUs.
void	SetKeySpaceAfter (Evpu16 value)
	Sets the space after key signature, in EVPUs.
void	SetKeySpaceAfterCancel (Evpu16 value)
	Sets the space after a canceled key signature, in EVPUs.
void	SetKeySpaceBetweenAccidentals (Evpu16 value)
	Sets the space between key signature accidentals, in EVPUs.
void	SetClefSpaceBefore (Evpu16 value)
	Sets the space before clef, in EVPUs.
void	SetClefSpaceAfter (Evpu16 value)
	Sets the space after clef, in EVPUs.
void	SetStemVerticalNoteheadOffset (Efix32 value)
	Sets the vertical stem offset for noteheads, in EFIXes.
void	SetTimeSigAbbreviatedVertical (Evpu16 value)
	Sets the vertical adjustment of abbreviated time signature, in EVPUs, for the score.
void	SetTimeSigPartsAbbreviatedVertical (Evpu16 value)
	Sets the vertical adjustment of abbreviated time signature, in EVPUs, for the parts.
void	SetTimeSigSpaceBefore (Evpu16 value)
	Sets the space before the time signature, in EVPUs, for the score.
void	SetTimeSigPartsSpaceBefore (Evpu16 value)
	Sets the space before the time signature, in EVPUs, for the parts.
void	SetTimeSigSpaceAfter (Evpu16 value)
	Sets the space after the time signature, in EVPUs, for the score.
void	SetTimeSigPartsSpaceAfter (Evpu16 value)
	Sets the space after the time signature, in EVPUs, for the parts.
void	SetAccidentalVertical (twobyte value)
	Sets the vertical spacing between accidentals, in spaces.
void	SetAccidentalMultiCharSpace (Evpu16 value)
	Sets the space within multi-character accidentals, in EVPUs.
void	SetAccidentalNoteSpace (Evpu16 value)
	Sets the space between accidental and note, in EVPUs.
void	SetAccidentalMultiSpace (Evpu16 value)
	Sets the space between accidentals on note, in EVPUs.
void	SetAlternateHalfDiamondVertical (twobyte value)
	Sets the value for Alternate Notation: Rhythmic Notation Vertical Positioning - Half Note Diamond Baseline Adjust.
void	SetAlternateWholeDiamondVertical (twobyte value)
	Sets the value for Alternate Notation: Rhythmic Notation Vertical Positioning - Whole Note Diamond Baseline Adjust.
void	SetAlternateBrevisDiamondVertical (twobyte value)
	Sets the value for Alternate Notation: Rhythmic Notation Vertical Positioning - Double Whole Note Diamond Baseline Adjust.
void	SetBeamMaxDistance (twobyte value)
	Sets the Max Distance from Middle Staff Line, in spaces.
void	SetGraceNoteSpacing (Evpu16 value)
	Sets the horizontal grace note spacing, in EVPUs.
void	SetGroupBracketDefaultDistance (Evpu16 value)
	Sets the default horizontal distance for group brackets from the edge of the staff.
void	SetKeyTimeExtraSpace (Evpu16 value)
	Sets the extra space between key and time signature.
void	SetClefKeyExtraSpace (Evpu16 value)
	Sets the extra space between clef and key signature.
void	SetClefTimeExtraSpace (Evpu16 value)
	Sets the extra space between clef and time signature.
void	SetAccidentalCrossLayerPositioning (bool value)
	Sets the Use Accidental Cross-Layer Positioning option.
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
Public Types inherited from __FCBase
enum	PDKFRAMEWORK_CLASSID {   FCID_UNKNOWN = 0 , FCID_ACCIDENTALMOD , FCID_ACTIVELYRIC , FCID_ALLOTMENT ,   FCID_ARTICULATION , FCID_ARTICULATIONDEF , FCID_BACKWARDREPEAT , FCID_BASELINE ,   FCID_BEAMMOD , FCID_BEATCHARTELEMENT , FCID_BOOKMARK , FCID_BROKENBEAMMOD ,   FCID_CATEGORYDEF , FCID_CELLCLEFCHANGE , FCID_CELLFRAMEHOLD , FCID_CELLGRAPHIC ,   FCID_CELLTEXT , FCID_CENTERSMARTSHAPE , FCID_CHORD , FCID_CHORDPREFS ,   FCID_CHORDSUFFIXELEMENT , FCID_CHORUSSYLLABLE , FCID_CLEFDEF , FCID_COMPOSITETIMESIGBOTTOMELEMENT ,   FCID_COMPOSITETIMESIGTOPELEMENT , FCID_CROSSSTAFFMOD , FCID_CUSTOMSMARTLINEDEF , FCID_CUSTOMSTEMMOD ,   FCID_DISTANCEPREFS , FCID_DOTMOD , FCID_ENCLOSURE , FCID_ENDINGREPEAT ,   FCID_ENIGMATEXTSTYLE , FCID_ENTRYALTERMOD , FCID_EXECUTABLESHAPEDEF , FCID_EXPRESSION ,   FCID_FONTINFO , FCID_FONTPREFS , FCID_FREEZESYSTEM , FCID_FRETBOARDSTYLEDEF ,   FCID_FRETBOARDSTYLEDEFS , FCID_FRETBOARDGROUPDEF , FCID_FRETBOARDGROUPDEFS , FCID_FRETINSTRUMENTDEF ,   FCID_GENERALPREFS , FCID_GRIDSGUIDESPREFS , FCID_GROUP , FCID_GROUPNAMEPOSITIONPREFS ,   FCID_HUMANPLAYBACKPREFS , FCID_INDEPENDENTCELLDETAIL , FCID_INSTRUMENTDEF , FCID_INSTRUMENTPLAYBACKDATA ,   FCID_KEYMODEDEF , FCID_KEYSIGNATURE , FCID_LAYERPREFS , FCID_LYRICSBASELINE ,   FCID_LYRICSPREFS , FCID_MEASURE , FCID_MEASURENUMBERREGION , FCID_METATOOLASSIGNMENT ,   FCID_MIDIEXPRESSION , FCID_MISCDOCPREFS , FCID_MULTIMEASUREREST , FCID_MULTIMEASURERESTPREFS ,   FCID_MULTISTAFFINSTRUMENT , FCID_MULTISTAFFINSTRUMENTS , FCID_MUSICCHARACTERPREFS , FCID_MUSICSPACINGPREFS ,   FCID_NUMBER , FCID_NOTEHEADMOD , FCID_OTHERINCI , FCID_PERCUSSIONLAYOUTNOTE ,   FCID_PERCUSSIONSTAFF , FCID_PERFORMANCEMOD , FCID_PAGE , FCID_PAGEFORMATPREFS ,   FCID_PAGEGRAPHIC , FCID_PAGETEXT , FCID_PART , FCID_PARTEXTRACTPREFS ,   FCID_PARTSCOPEPREFS , FCID_PARTSTAFFVOICING , FCID_PERCUSSIONNOTEMOD , FCID_PIANOBRACEPREFS ,   FCID_PLAYBACKPREFS , FCID_RAWTEXT , FCID_REPEATPREFS , FCID_SECONDARYBEAMBREAKMOD ,   FCID_BEAMEXTENSIONMOD , FCID_SECTIONSYLLABLE , FCID_SEPARATEMEASURENUMBER , FCID_SEPARATEPLACEMENT ,   FCID_SHAPEDEF , FCID_SHAPEEXPRESSIONDEF , FCID_SLURCONTOURPREFS , FCID_SIZEPREFS ,   FCID_SMARTSHAPE , FCID_SMARTSHAPEENTRYMARK , FCID_SMARTSHAPEMEASUREMARK , FCID_SMARTSHAPEPREFS ,   FCID_STAFF , FCID_STAFFLIST , FCID_STAFFNAMEPOSITION , FCID_STAFFNAMEPOSITIONPREFS ,   FCID_STAFFSTYLEASSIGN , FCID_STAFFSTYLEDEF , FCID_STAFFSYSTEM , FCID_STEMCONNECTIONTABLE ,   FCID_STEMMOD , FCID_STRING , FCID_SYLLABLEENTRYMOD , FCID_SYSTEMSTAFF ,   FCID_TABLATURENOTEMOD , FCID_TEMPOELEMENT , FCID_TEXTBLOCK , FCID_TEXTEXPRESSIONDEF ,   FCID_TEXTREPEAT , FCID_TEXTREPEATDEF , FCID_TIEMOD , FCID_TIEPREFS ,   FCID_TIECONTOURPREFS , FCID_TIEPLACEMENTPREFS , FCID_TIMESIGNATURE , FCID_TUPLET ,   FCID_TUPLETPREFS , FCID_VERSESYLLABLE }
	Constants for the GetClassID method. More...
enum	MEASUREMENTUNITS {   MEASUREMENTUNIT_DEFAULT = UNIT_DEFAULT , MEASUREMENTUNIT_EVPUS = UNIT_EVPUS , MEASUREMENTUNIT_INCHES = UNIT_INCHES , MEASUREMENTUNIT_CENTIMETERS = UNIT_CENTS ,   MEASUREMENTUNIT_POINTS = UNIT_POINTS , MEASUREMENTUNIT_PICAS = UNIT_PICAS , MEASUREMENTUNIT_SPACES = UNIT_SPACES , MEASUREMENTUNIT_MILLIMETERS = 100 }
	Constants for Finale's standard measurement units. More...
Static Public Member Functions inherited from __FCBase
static void	DebugOutPtr (const char *pszPrefixText, void *ptr)
	Static method that outputs a line for debugging purposes. The prefix text appears with the extra ptr (in hexadeximal representation) appearing afterwards.
static void	DebugOutInt (const char *pszPrefixText, int i)
	Static method that outputs a line for debugging purposes. The text appears with the extra digit (in decimal presentation) appearing afterwards.
static void	DebugOutFloat (const char *pszPrefixText, double f)
	Static method that outputs a line for debugging purposes. The text appears with the extra float value appearing afterwards.
static void	DebugOutTag (const char *pszPrefixText, EXTAG extag)
	Static method that outputs a line for debugging purposes. The text appears with the EXTAG (in text) appearing afterwards.
static void	DebugOutHex (const char *pszPrefixText, int i)
	Static method that outputs a line for debugging purposes. The text appears with the extra digit (in hexadecimal presentation) appearing afterwards.
static void	DebugOutBin (const char *pszPrefixText, int i)
	Static method that outputs a line for debugging purposes. The text appears with the extra digit (in binary presentation) appearing afterwards.
static void	DebugOutString (const char *pszPrefixText, const char *thestring)
	Static method that outputs a line for debugging purposes (C string version). The text appears with the extra string appearing afterwards.
static void	DebugOutString (const char *pszPrefixText, FCString *pString)
	Static method that outputs a line for debugging purposes (FCString version). The text appears with the extra string appearing afterwards.
static void	DebugOutBool (const char *pszPrefixText, bool state)
	Static method that outputs a line for debugging purposes. The boolean state appears afterwards as either "TRUE" or "FALSE".
static void	DebugOutBlock (const void *pBuffer, int startoffset, int size)
	Static method that outputs a memory block for debugging purposes. Eight bytes per line will appear (as hex digits) until the whole memory block is dumped.
static void	DebugOutByteArrayBlock (const void *pBuffer, int startoffset, int size)
	Static method that outputs a memory block for debugging purposes. Eight bytes per line will appear (as hex digits) as a C++ onebyte array, until the whole memory block is dumped.
static void	DebugOut (const char *pszLine)
	Static method to output a line of text for debugging purposes.
Protected Member Functions inherited from __FCPrefsBase
	__FCPrefsBase ()
	standard constructor
Protected Member Functions inherited from __FCBaseData
virtual void	Deallocate ()
virtual bool	IsDynamicSize ()
bool	LoadDataBlock ()
	Loads the data. If the object is of dynamic size, the old memory block is freed and a new is allocated.
void	ClearData ()
virtual twobyte	CalcLastInci ()
	For internal use only!
bool	DataIsLoaded () const
	Returns true is any data has been loaded into the object.
void	_TagDocumentID ()
	For internal use only.
Protected Member Functions inherited from __FCBase
	__FCBase ()
	The constructor.
Protected Attributes inherited from __FCBaseData
EDOCID	_connecteddocID
	The "connected" document ID., which is the document the where the document was loaded (or last saved). This is for a mechanism to prevent resaving of certain data in other documents.
void *	_datablock
	Pointer to the object's data block, the meaning is implementation-specific for each derived subclass.
bool	_heapdatablock
	Variable that tells if _datablock is dynamically created on the heap (and should be deleted at object destruction).
int	_loadedsize
	Loaded size of the data block for a loaded object, in bytes. Since the datablock is implementation-specific, the _loadedsize should be updated by child classes that create new data.
EDataID	_dataid
	The EdataID for the last loaded/saved object.

Detailed Description

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

Constructor & Destructor Documentation

FCDistancePrefs()

FCDistancePrefs::FCDistancePrefs ( )

inline

The constructor.

Lua-supported.

Member Function Documentation

ClassName()

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

GetAccidentalCrossLayerPositioning()

bool FCDistancePrefs::GetAccidentalCrossLayerPositioning ( ) const

inline

Returns the Use Accidental Cross-Layer Positioning option.

Lua-supported (also as property) (0.59).

GetAccidentalMultiCharSpace()

Evpu16 FCDistancePrefs::GetAccidentalMultiCharSpace ( ) const

inline

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

Lua-supported (also as property).

GetAccidentalMultiSpace()

Evpu16 FCDistancePrefs::GetAccidentalMultiSpace ( ) const

inline

Returns the space between accidentals on note, in EVPUs.

Lua-supported (also as property).

GetAccidentalNoteSpace()

Evpu16 FCDistancePrefs::GetAccidentalNoteSpace ( ) const

inline

Returns the space between accidental and note, in EVPUs.

Lua-supported (also as property).

GetAccidentalVertical()

twobyte FCDistancePrefs::GetAccidentalVertical ( ) const

inline

Returns the vertical spacing between accidentals, in spaces.

Lua-supported (also as property).

GetAlternateBrevisDiamondVertical()

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

GetAlternateHalfDiamondVertical()

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

GetAlternateWholeDiamondVertical()

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

GetAugmentationDotNoteSpace()

twobyte FCDistancePrefs::GetAugmentationDotNoteSpace ( ) const

inline

Returns the default horizontal space between augmentation dot and note.

Lua-supported (also as property).

GetAugmentationDotSpace()

twobyte FCDistancePrefs::GetAugmentationDotSpace ( ) const

inline

Returns the space between each augmentation dot.

Lua-supported (also as property).

GetAugmentationDotUpstemAdjust()

twobyte FCDistancePrefs::GetAugmentationDotUpstemAdjust ( ) const

inline

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

Lua-supported (also as property).

GetAugmentationDotVerticalAdjust()

twobyte FCDistancePrefs::GetAugmentationDotVerticalAdjust ( ) const

inline

Returns the default vertical offset for an augmentation dot.

Lua-supported (also as property).

GetBarlineDashSpace()

Evpu32 FCDistancePrefs::GetBarlineDashSpace ( ) const

inline

Returns the barline dash space, in EVPUs.

Lua-supported (also as property).

GetBarlineDoubleSpace()

Efix16 FCDistancePrefs::GetBarlineDoubleSpace ( ) const

inline

Returns the space between double barlines, in EFIXes.

Lua-supported (also as property).

GetBarlineFinalSpace()

Efix16 FCDistancePrefs::GetBarlineFinalSpace ( ) const

inline

Returns the space between final barlines, in EFIXes.

Lua-supported (also as property).

GetBeamMaxDistance()

twobyte FCDistancePrefs::GetBeamMaxDistance ( ) const

inline

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

Lua-supported (also as property).

GetClassID()

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

GetClefChangeOffset()

twobyte FCDistancePrefs::GetClefChangeOffset ( ) const

inline

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

Lua-supported (also as property).

GetClefKeyExtraSpace()

Evpu16 FCDistancePrefs::GetClefKeyExtraSpace ( ) const

inline

Returns the extra space between clef and key signature.

Lua-supported (also as property).

GetClefSpaceAfter()

Evpu16 FCDistancePrefs::GetClefSpaceAfter ( ) const

inline

Returns the space after clef, in EVPUs.

Lua-supported (also as property).

GetClefSpaceBefore()

Evpu16 FCDistancePrefs::GetClefSpaceBefore ( ) const

inline

Returns the space before clef, in EVPUs.

Lua-supported (also as property).

GetClefTimeExtraSpace()

Evpu16 FCDistancePrefs::GetClefTimeExtraSpace ( ) const

inline

Returns the extra space between clef and time signature.

Lua-supported (also as property).

GetGraceNoteSpacing()

Evpu16 FCDistancePrefs::GetGraceNoteSpacing ( ) const

inline

Returns the horizontal grace note spacing, in EVPUs.

Lua-supported (also as property).

GetGroupBracketDefaultDistance()

Evpu16 FCDistancePrefs::GetGroupBracketDefaultDistance ( ) const

inline

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

Lua-supported (also as property).

GetKeySpaceAfter()

Evpu16 FCDistancePrefs::GetKeySpaceAfter ( ) const

inline

Returns the space after key signature, in EVPUs.

Lua-supported (also as property).

GetKeySpaceAfterCancel()

Evpu16 FCDistancePrefs::GetKeySpaceAfterCancel ( ) const

inline

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

Lua-supported (also as property).

GetKeySpaceBefore()

Evpu16 FCDistancePrefs::GetKeySpaceBefore ( ) const

inline

Returns the space before key signature, in EVPUs.

Lua-supported (also as property).

GetKeySpaceBetweenAccidentals()

Evpu16 FCDistancePrefs::GetKeySpaceBetweenAccidentals ( ) const

inline

Returns the space between key signature accidentals, in EVPUs.

Lua-supported (also as property).

GetKeyTimeExtraSpace()

Evpu16 FCDistancePrefs::GetKeyTimeExtraSpace ( ) const

inline

Returns the extra space between key and time signature.

Lua-supported (also as property).

GetSecondaryBeamSpace()

twobyte FCDistancePrefs::GetSecondaryBeamSpace ( ) const

inline

Returns the space between each secondary beam, in EVPUs.

Lua-supported (also as property).

GetSpaceAfter()

twobyte FCDistancePrefs::GetSpaceAfter ( ) const

inline

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

Lua-supported (also as property).

GetSpaceBefore()

twobyte FCDistancePrefs::GetSpaceBefore ( ) const

inline

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

Lua-supported (also as property).

GetStemVerticalNoteheadOffset()

Efix32 FCDistancePrefs::GetStemVerticalNoteheadOffset ( ) const

inline

Returns the vertical stem offset for noteheads, in EFIXes.

Lua-supported (also as property).

GetTimeSigAbbreviatedVertical()

Evpu16 FCDistancePrefs::GetTimeSigAbbreviatedVertical ( ) const

inline

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

Lua-supported (also as property).

GetTimeSigBottomVertical()

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

GetTimeSigPartsAbbreviatedVertical()

Evpu16 FCDistancePrefs::GetTimeSigPartsAbbreviatedVertical ( ) const

inline

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

Lua-supported (also as property).

GetTimeSigPartsBottomVertical()

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

GetTimeSigPartsSpaceAfter()

Evpu16 FCDistancePrefs::GetTimeSigPartsSpaceAfter ( ) const

inline

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

Lua-supported (also as property).

GetTimeSigPartsSpaceBefore()

Evpu16 FCDistancePrefs::GetTimeSigPartsSpaceBefore ( ) const

inline

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

Lua-supported (also as property).

GetTimeSigPartsTopVertical()

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

GetTimeSigSpaceAfter()

Evpu16 FCDistancePrefs::GetTimeSigSpaceAfter ( ) const

inline

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

Lua-supported (also as property).

GetTimeSigSpaceBefore()

Evpu16 FCDistancePrefs::GetTimeSigSpaceBefore ( ) const

inline

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

Lua-supported (also as property).

GetTimeSigTopVertical()

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

SetAccidentalCrossLayerPositioning()

void FCDistancePrefs::SetAccidentalCrossLayerPositioning ( bool value )

inline

Sets the Use Accidental Cross-Layer Positioning option.

Lua-supported (also as property) (0.59).

SetAccidentalMultiCharSpace()

void FCDistancePrefs::SetAccidentalMultiCharSpace ( Evpu16 value )

inline

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

Lua-supported (also as property).

SetAccidentalMultiSpace()

void FCDistancePrefs::SetAccidentalMultiSpace ( Evpu16 value )

inline

Sets the space between accidentals on note, in EVPUs.

Lua-supported (also as property).

SetAccidentalNoteSpace()

void FCDistancePrefs::SetAccidentalNoteSpace ( Evpu16 value )

inline

Sets the space between accidental and note, in EVPUs.

Lua-supported (also as property).

SetAccidentalVertical()

void FCDistancePrefs::SetAccidentalVertical ( twobyte value )

inline

Sets the vertical spacing between accidentals, in spaces.

Lua-supported (also as property).

SetAlternateBrevisDiamondVertical()

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

SetAlternateHalfDiamondVertical()

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

SetAlternateWholeDiamondVertical()

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

SetAugmentationDotNoteSpace()

void FCDistancePrefs::SetAugmentationDotNoteSpace ( twobyte value )

inline

Sets the default horizontal space between augmentation dot and note.

Lua-supported (also as property).

SetAugmentationDotSpace()

void FCDistancePrefs::SetAugmentationDotSpace ( twobyte value )

inline

Sets the default space between each augmentation dot.

Lua-supported (also as property).

SetAugmentationDotUpstemAdjust()

void FCDistancePrefs::SetAugmentationDotUpstemAdjust ( twobyte value )

inline

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

Lua-supported (also as property).

SetAugmentationDotVerticalAdjust()

void FCDistancePrefs::SetAugmentationDotVerticalAdjust ( twobyte value )

inline

Sets the default vertical offset for an augmentation dot.

Lua-supported (also as property).

SetBarlineDashSpace()

void FCDistancePrefs::SetBarlineDashSpace ( Evpu32 value )

inline

Sets the barline dash space, in EVPUs.

Lua-supported (also as property).

SetBarlineDoubleSpace()

void FCDistancePrefs::SetBarlineDoubleSpace ( Efix16 value )

inline

Sets the space between double barlines, in EFIXes.

Lua-supported (also as property).

SetBarlineFinalSpace()

void FCDistancePrefs::SetBarlineFinalSpace ( Efix16 value )

inline

Sets the space between final barlines, in EFIXes.

Lua-supported (also as property).

SetBeamMaxDistance()

void FCDistancePrefs::SetBeamMaxDistance ( twobyte value )

inline

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

Lua-supported (also as property).

SetClefChangeOffset()

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

SetClefKeyExtraSpace()

void FCDistancePrefs::SetClefKeyExtraSpace ( Evpu16 value )

inline

Sets the extra space between clef and key signature.

Lua-supported (also as property).

SetClefSpaceAfter()

void FCDistancePrefs::SetClefSpaceAfter ( Evpu16 value )

inline

Sets the space after clef, in EVPUs.

Lua-supported (also as property).

SetClefSpaceBefore()

void FCDistancePrefs::SetClefSpaceBefore ( Evpu16 value )

inline

Sets the space before clef, in EVPUs.

Lua-supported (also as property).

SetClefTimeExtraSpace()

void FCDistancePrefs::SetClefTimeExtraSpace ( Evpu16 value )

inline

Sets the extra space between clef and time signature.

Lua-supported (also as property).

SetGraceNoteSpacing()

void FCDistancePrefs::SetGraceNoteSpacing ( Evpu16 value )

inline

Sets the horizontal grace note spacing, in EVPUs.

Lua-supported (also as property).

SetGroupBracketDefaultDistance()

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

SetKeySpaceAfter()

void FCDistancePrefs::SetKeySpaceAfter ( Evpu16 value )

inline

Sets the space after key signature, in EVPUs.

Lua-supported (also as property).

SetKeySpaceAfterCancel()

void FCDistancePrefs::SetKeySpaceAfterCancel ( Evpu16 value )

inline

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

Lua-supported (also as property).

SetKeySpaceBefore()

void FCDistancePrefs::SetKeySpaceBefore ( Evpu16 value )

inline

Sets the space before key signature, in EVPUs.

Lua-supported (also as property).

SetKeySpaceBetweenAccidentals()

void FCDistancePrefs::SetKeySpaceBetweenAccidentals ( Evpu16 value )

inline

Sets the space between key signature accidentals, in EVPUs.

Lua-supported (also as property).

SetKeyTimeExtraSpace()

void FCDistancePrefs::SetKeyTimeExtraSpace ( Evpu16 value )

inline

Sets the extra space between key and time signature.

Lua-supported (also as property).

SetSecondaryBeamSpace()

void FCDistancePrefs::SetSecondaryBeamSpace ( twobyte value )

inline

Sets the space between each secondary beam.

Lua-supported (also as property).

SetSpaceAfter()

void FCDistancePrefs::SetSpaceAfter ( twobyte value )

inline

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

Lua-supported (also as property).

SetSpaceBefore()

void FCDistancePrefs::SetSpaceBefore ( twobyte value )

inline

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

Lua-supported (also as property).

SetStemVerticalNoteheadOffset()

void FCDistancePrefs::SetStemVerticalNoteheadOffset ( Efix32 value )

inline

Sets the vertical stem offset for noteheads, in EFIXes.

Lua-supported (also as property).

SetTimeSigAbbreviatedVertical()

void FCDistancePrefs::SetTimeSigAbbreviatedVertical ( Evpu16 value )

inline

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

Lua-supported (also as property).

SetTimeSigBottomVertical()

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

SetTimeSigPartsAbbreviatedVertical()

void FCDistancePrefs::SetTimeSigPartsAbbreviatedVertical ( Evpu16 value )

inline

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

Lua-supported (also as property).

SetTimeSigPartsBottomVertical()

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

SetTimeSigPartsSpaceAfter()

void FCDistancePrefs::SetTimeSigPartsSpaceAfter ( Evpu16 value )

inline

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

Lua-supported (also as property).

SetTimeSigPartsSpaceBefore()

void FCDistancePrefs::SetTimeSigPartsSpaceBefore ( Evpu16 value )

inline

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

Lua-supported (also as property).

SetTimeSigPartsTopVertical()

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

SetTimeSigSpaceAfter()

void FCDistancePrefs::SetTimeSigSpaceAfter ( Evpu16 value )

inline

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

Lua-supported (also as property).

SetTimeSigSpaceBefore()

void FCDistancePrefs::SetTimeSigSpaceBefore ( Evpu16 value )

inline

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

Lua-supported (also as property).

SetTimeSigTopVertical()

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