Finale PDK Framework  0.54
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
__FCBaseData Class Referenceabstract

Base class for all data-related classes (that handles Finale data). More...

#include <ff_base.h>

Inheritance diagram for __FCBaseData:
__FCBase __FCCellDetail __FCDetail __FCEntryDetail __FCGlobals __FCInci __FCOther __FCPrefsBase FCKeySignature FCRawText FCTimeSignature

Public Member Functions

virtual const PDKFRAMEWORK_CLASSID GetClassID ()=0
 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...
 
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 EXTAG Tag ()=0
 The Enigma tag for the derived class. More...
 
virtual EVERSION EnigmaVersion ()
 The Enigma version for save/load/create/delete operations. More...
 
virtual int DataSizeLoad ()=0
 Returns the data size for the data structure that should be loaded. More...
 
virtual int DataSizeSave ()
 Returns the data size for the data structure that should be saved or created. More...
 
virtual const char * ClassName ()
 Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child class. More...
 
void _CloneFrom (__FCBaseData *pSource)
 For internal use only. Copies object data (except data block) from another object. More...
 
virtual void CloneMemoryFrom (__FCBaseData *pSource)
 
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 Save ()
 Saves the currently loaded to its current location. More...
 
virtual bool Reload ()
 Refreshes the data for the object, to synch the data with Finale's current data. More...
 
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 LoadFirst ()=0
 Loads the very first element in the database, if any. 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...
 

Protected Member Functions

virtual void * Allocate ()=0
 
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...
 
virtual __FCBaseDataCreateObject ()=0
 Creates a new instance of the object. 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

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.
 

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

Detailed Description

Base class for all data-related classes (that handles Finale data).

This class is abstract and is overridden by child classes. Should not be used directly.

Member Function Documentation

void __FCBaseData::_CloneFrom ( __FCBaseData pSource)

For internal use only. Copies object data (except data block) from another object.

Calls CloneMemoryFrom() which copies the memory block.

const EDataID* __FCBaseData::_GetDataID ( )
inline

Intended ONLY for the _CloneFrom implementation.

Returns
Pointer to the EDataID storage.
int __FCBaseData::_GetLoadedSize ( ) const
inline

Intended ONLY for the _CloneFrom implementation.

Returns
The value of loadedsize
void __FCBaseData::_TagDocumentID ( )
protected

For internal use only.

Tags the data object to the current document ID. This method should be called after

virtual void* __FCBaseData::Allocate ( )
protectedpure virtual

For data of static size, the overridden method can return a pointer to one single data structure. For dynamical-sized data, the overriden method should allocate data of the proper size.

Implemented in FCRawText.

virtual twobyte __FCBaseData::CalcLastInci ( )
inlineprotectedvirtual

For internal use only!

Returns the last inci record within the current cmper. Should be overwritten by child classes, if necssary.

Returns
The last inci found. kNewInci if not found.

Reimplemented in __FCInciOther.

virtual const char* __FCBaseData::ClassName ( )
inlinevirtual

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

Lua-supported.

Reimplemented from __FCBase.

Reimplemented in FCMetatoolAssignment, FCCellClefChange, FCFretInstrumentDef, FCStaffList, FCPercussionLayoutNote, FCInstrumentPlaybackData, FCInstrumentDef, FCTempoElement, FCBeatChartElement, FCBackwardRepeat, FCEndingRepeat, FCFretboardGroupDef, FCFretboardStyleDef, FCChordSuffixElement, FCExecutableShapeDef, FCTextRepeat, FCTextRepeatDef, FCPageGraphic, FCAllotment, FCMultiStaffInstrument, FCMultiMeasureRest, FCStaffStyleAssign, FCStaffStyleDef, FCExpression, FCSeparatePlacement, FCPageText, FCTextBlock, FCTextExpressionDef, FCFreezeSystem, FCCategoryDef, FCArticulationDef, FCPartExtractPrefs, FCCurrentStaffSpec, FCStaff, FCPianoBracePrefs, FCGridsGuidesPrefs, FCRepeatPrefs, FCStemConnectionTable, FCHumanPlaybackPrefs, FCPartScopePrefs, FCMusicCharacterPrefs, FCGroupNamePositionPrefs, FCStaffNamePositionPrefs, FCChordPrefs, FCLayerPrefs, FCStaffNamePosition, FCPercussionStaff, FCSystemStaff, FCTiePrefs, FCTieContourPrefs, FCTiePlacementPrefs, FCSlurContourPrefs, FCMeasureNumberRegion, FCSmartShapePrefs, FCMultiMeasureRestPrefs, FCFontPrefs, FCTablatureNoteMod, FCBrokenBeamMod, FCTieMod, FCMeasure, FCPerformanceMod, FCMusicSpacingPrefs, FCBeamMod, FCGeneralPrefs, FCCustomStemMod, FCPercussionNoteMod, FCStaffSystem, FCPageFormatPrefs, FCPage, FCAccidentalMod, FCEntryAlterMod, FCEnclosure, FCSyllableEntryMod, FCTupletPrefs, FCSectionSyllable, FCChorusSyllable, FCVerseSyllable, FCSyllableBase, FCShapeDef, FCIndependentCellDetail, FCCustomSmartLineDef, FCCellText, FCCellGraphic, FCMiscDocPrefs, FCTuplet, FCArticulation, FCSizePrefs, FCStemMod, FCChord, FCBaseline, FCSecondaryBeamBreakMod, FCSmartShape, FCCrossStaffMod, __FCInci, FCCellFrameHold, FCDistancePrefs, FCDotMod, FCPlaybackPrefs, FCSeparateMeasureNumber, FCCenterSmartShape, __FCCompositeTimeSigBottomElement, FCNoteheadMod, __FCCompositeTimeSigTopElement, FCSmartShapeEntryMark, FCFileInfoText, FCMidiExpression, FCVerseLyricsText, __FCNoInciOther, __FCLyricsBase, FCInstrumentDefText, FCSmartShapeMeasureMark, FCPercussionLayoutNotesText, FCGroup, FCTextRepeatText, FCStaffListStaffAssignText, FCOtherInci, FCStaffListCategoryText, FCStaffListText, FCEndingRepeatText, __FCNoInciCellDetail, __FCOtherText, FCPart, FCTimeSignature, FCKeySignature, FCRawText, __FCCellDetail, __FCOther, and __FCGlobals.

void __FCBaseData::ClearData ( )
protected

Clears and deallocates data blocks for dynamically allocated data during the lifespan of the object. This is not called during destruction, so classes with dynamic data needs to clean up in the destructor.

void __FCBaseData::CloneMemoryFrom ( __FCBaseData pSource)
virtual

Copies the data block of the object.

  • IT'S THE RESPONSIBILITY OF EACH CHILD CLASS TO OVERRIDE TO COPY DIFFERENT KIND OF DATA BLOCKS!
Parameters
pSourceThe source object.
__FCBaseData * __FCBaseData::CreateClone ( )

Creates an identical copy of an object.

Calls the virtual methods CreateObject and _CloneFrom to create the cloned copy.

Returns
The cloned object.
virtual __FCBaseData* __FCBaseData::CreateObject ( )
protectedpure virtual

Creates a new instance of the object.

This method will ensure that the virtual methods are handled correctly. Each inherited child class should have it's own implementation of this method.

Returns
Pointer to a new object.

Implemented in FCRawText.

FCNumbers * __FCBaseData::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.

The first byte is in the first item of the collection, and so on. The size of the collection (in number of items) is the size of the data (in bytes).

Each byte in the collection is in the 0-255 decimal range.

Lua-supported.

If no data has been loaded, NULL is returned. Otherise, the created FCNumbers object containing the data dump.

bool __FCBaseData::DataIsLoaded ( ) const
inlineprotected

Returns true is any data has been loaded into the object.

virtual int __FCBaseData::DataSizeLoad ( )
pure virtual

Returns the data size for the data structure that should be loaded.

Must be overwritten by child classes.

Returns
The size in bytes for the data that should be loaded

Implemented in FCRawText.

int __FCBaseData::DataSizeSave ( )
virtual

Returns the data size for the data structure that should be saved or created.

Returns
The size in bytes for the data that should be saved/created
virtual void __FCBaseData::Deallocate ( )
inlineprotectedvirtual

Should be overwritten by all child classes that use dynamicaly-sized data to free allocated data.

Reimplemented in FCRawText.

virtual void __FCBaseData::DebugDataByteArrayDump ( )
inlinevirtual

Outputs a memory dump of the data block in the object for debugging purposes, as a C++ byte array.

Accessible if PDK_FRAMEWORK_DEBUG is defined.

When child class inherit this method to output the contents of its own members, it should call the parent before providing its own output.

Reimplemented from __FCBase.

virtual void __FCBaseData::DebugDataDump ( )
inlinevirtual

Outputs a memory dump of the data block in the object for debugging purposes.

Accessible if PDK_FRAMEWORK_DEBUG is defined.

When child class inherit this method to output the contents of its own members, it should call the parent before providing its own output.

Reimplemented from __FCBase.

virtual void __FCBaseData::DebugDump ( )
inlinevirtual
virtual bool __FCBaseData::DeepDeleteData ( )
inlinevirtual

Deletes data and all data that's connected to the object.

If the object links to other data that must be unique, this method should be overridden to delete that data as well.

Reimplemented in FCEndingRepeat, FCTextRepeatDef, FCPageText, FCTextBlock, FCTextExpressionDef, FCCustomSmartLineDef, and __FCNoInciOther.

bool __FCBaseData::DeleteData ( )
virtual

Deletes the associated data from Finale's database. Be careful when deleting multiple objects.

When deleting multiple objects, Finale's data table might get rearranged after each delete. For safety always delete multiple objects backwards.

Returns
True if delete was successful.

Reimplemented in FCStaffList, and FCShapeDef.

virtual EVERSION __FCBaseData::EnigmaVersion ( )
inlinevirtual

The Enigma version for save/load/create/delete operations.

Set this to a specific Finale version if some emulation is needed.

Returns
By default, this defaults to the version of the PDK. Override if necessary.

Reimplemented in FCRawText.

virtual const PDKFRAMEWORK_CLASSID __FCBaseData::GetClassID ( )
pure virtual

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.

Reimplemented from __FCBase.

Implemented in FCMetatoolAssignment, FCCellClefChange, FCFretInstrumentDef, FCStaffList, FCPercussionLayoutNote, FCInstrumentPlaybackData, FCInstrumentDef, FCTempoElement, FCBeatChartElement, FCBackwardRepeat, FCEndingRepeat, FCFretboardGroupDef, FCFretboardStyleDef, FCChordSuffixElement, FCExecutableShapeDef, FCTextRepeat, FCTextRepeatDef, FCPageGraphic, FCAllotment, FCMultiStaffInstrument, FCMultiMeasureRest, FCStaffStyleAssign, FCStaffStyleDef, FCExpression, FCSeparatePlacement, FCPageText, FCTextBlock, FCTextExpressionDef, FCFreezeSystem, FCCategoryDef, FCArticulationDef, FCPartExtractPrefs, FCStaff, FCPianoBracePrefs, FCGridsGuidesPrefs, FCRepeatPrefs, FCStemConnectionTable, FCHumanPlaybackPrefs, FCPartScopePrefs, FCMusicCharacterPrefs, FCGroupNamePositionPrefs, FCStaffNamePositionPrefs, FCChordPrefs, FCLayerPrefs, FCStaffNamePosition, FCPercussionStaff, FCSystemStaff, FCTiePrefs, FCTieContourPrefs, FCTiePlacementPrefs, FCSlurContourPrefs, FCMeasureNumberRegion, FCSmartShapePrefs, FCMultiMeasureRestPrefs, FCFontPrefs, FCTablatureNoteMod, FCBrokenBeamMod, FCTieMod, FCMeasure, FCPerformanceMod, FCMusicSpacingPrefs, FCBeamMod, FCGeneralPrefs, FCCustomStemMod, FCPercussionNoteMod, FCStaffSystem, FCPageFormatPrefs, FCPage, FCAccidentalMod, FCEntryAlterMod, FCEnclosure, FCSyllableEntryMod, FCTupletPrefs, FCSectionSyllable, FCChorusSyllable, FCVerseSyllable, FCShapeDef, FCIndependentCellDetail, FCCustomSmartLineDef, FCCellText, FCCellGraphic, FCMiscDocPrefs, FCTuplet, FCArticulation, FCSizePrefs, FCStemMod, FCChord, FCBaseline, FCSecondaryBeamBreakMod, FCSmartShape, FCCrossStaffMod, FCCellFrameHold, FCDistancePrefs, FCDotMod, FCPlaybackPrefs, FCSeparateMeasureNumber, FCCenterSmartShape, __FCCompositeTimeSigBottomElement, FCNoteheadMod, __FCCompositeTimeSigTopElement, FCSmartShapeEntryMark, FCMidiExpression, FCSmartShapeMeasureMark, FCGroup, FCOtherInci, FCPart, FCTimeSignature, FCKeySignature, and FCRawText.

EDOCID __FCBaseData::GetConnectedDocID ( ) const
inline

Returns the document ID that was connected to the last load/save of the data.

Lua-supported (also as a read-only property)

EXTAG __FCBaseData::GetCustomTag ( )
inline

Returns the custom Enigma tag, if any.

The custom tag mechanism is designed for data structure classes that support multiple Enigma tags. It's optional for the inherited class to use custom tags.

Returns
The Enigma tag. 0 if not used.
const void* __FCBaseData::GetDataBlock ( )
inline

Intended ONLY for the _CloneFrom implementation.

Returns
The value of datablock
virtual bool __FCBaseData::IsDynamicSize ( )
inlineprotectedvirtual

Classes that encapsulates dynamic-sized data should override this method to return true.

NOTE! It's up to the destructor of the child classes to clean up dynamically sized data.

Reimplemented in FCRawText.

virtual bool __FCBaseData::LoadFirst ( )
pure virtual

Loads the very first element in the database, if any.

This method must be overridden in all child classes.

Lua-supported.

Returns
True if a first element was found, otherwise false.

Implemented in FCFretInstrumentDef, FCFretboardGroupDef, FCShapeExpressionDef, FCShapeDef, __FCPrefsBase, __FCNoInciOther, __FCEntryDetail, FCTimeSignature, __FCCellDetail, FCRawText, FCKeySignature, and __FCGlobals.

virtual bool __FCBaseData::LoadLast ( )
inlinevirtual

Loads the very last element in the database, if any.

This method is a placeholder. It's overridden in child classes with class-specific functionality.

Reimplemented in __FCCellDetail.

bool __FCBaseData::LoadNext ( )
virtual

Loads the next element from the database, if any.

(This implementation will not work for variable-sized data blocks like text - overwrite in those classes!)

Reimplemented in FCFretInstrumentDef, FCStaffList, FCShapeExpressionDef, FCShapeDef, __FCEntryDetail, __FCCellDetail, and __FCGlobals.

virtual bool __FCBaseData::LoadPrevious ( )
inlinevirtual

Loads the previous element in the database, if any.

This method is a placeholder. It's overridden in child classes with class-specific functionality.

Reimplemented in __FCCellDetail.

bool __FCBaseData::Reload ( )
virtual

Refreshes the data for the object, to synch the data with Finale's current data.

This method can be used on both saved and loaded data objects. It can be useful when an object has gone through temporary unsaved changes and there's a need to synch with Finale's current data for the object.

For data with complex data (from multiple sources), this method must be overwritten.

Lua-supported.

Returns
True on success. False if the object contained no previous data.

Reimplemented in __FCPrefsBase, __FCNoInciOther, __FCInciOther, and __FCEntryDetail.

bool __FCBaseData::Save ( )
virtual

Saves the currently loaded to its current location.

Lua-supported.

Returns
False if no data has been loaded.

Reimplemented in FCStaffList, FCStaff, FCGridsGuidesPrefs, FCStemConnectionTable, FCMusicCharacterPrefs, FCSystemStaff, FCMeasure, FCBeamMod, FCPageFormatPrefs, FCTupletPrefs, FCBaseline, and __FCPrefsBase.

void __FCBaseData::SetCustomTag ( EXTAG  tag)
inline

Sets the custom Enigma tag, for classes that support multiple Enigma tags.

The custom tag mechanism is designed for data structure classes that support multiple Enigma tags. It's optional for the inherited class to use custom tags.

Parameters
tagThe Enigma tag for load/save operations (if the class implementation supports custom tags).
virtual EXTAG __FCBaseData::Tag ( )
pure virtual
bool __FCBaseData::VerifyConnectedDocID ( )

Checks that the stored document ID for the data object matches the current document's ID.

Lua-supported.

Returns
True if stored document ID matches the current document's ID.

Member Data Documentation

int __FCBaseData::_loadedsize
protected

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.

This was size_t before, but size_t caused problems with 64-bit Lua on Windows.