Base class for the Finale Framework classes. More...

#include <ff_base.h>

Inheritance diagram for __FCBase:

Public Types
enum	PDKFRAMEWORK_CLASSID { FCID_UNKNOWN = 0 , FCID_ACCIDENTALMOD , FCID_ACTIVELYRIC , FCID_ALLOTMENT , FCID_ARTICULATION , FCID_ARTICULATIONDEF , FCID_BACKWARDREPEAT , FCID_BASELINE , FCID_BEAMMOD , FCID_BEATCHARTELEMENT , FCID_BOOKMARK , FCID_BROKENBEAMMOD , FCID_CATEGORYDEF , FCID_CELLCLEFCHANGE , FCID_CELLFRAMEHOLD , FCID_CELLGRAPHIC , FCID_CELLTEXT , FCID_CENTERSMARTSHAPE , FCID_CHORD , FCID_CHORDPREFS , FCID_CHORDSUFFIXELEMENT , FCID_CHORUSSYLLABLE , FCID_CLEFDEF , FCID_COMPOSITETIMESIGBOTTOMELEMENT , FCID_COMPOSITETIMESIGTOPELEMENT , FCID_CROSSSTAFFMOD , FCID_CUSTOMSMARTLINEDEF , FCID_CUSTOMSTEMMOD , FCID_DISTANCEPREFS , FCID_DOTMOD , FCID_ENCLOSURE , FCID_ENDINGREPEAT , FCID_ENIGMATEXTSTYLE , FCID_ENTRYALTERMOD , FCID_EXECUTABLESHAPEDEF , FCID_EXPRESSION , FCID_FONTINFO , FCID_FONTPREFS , FCID_FREEZESYSTEM , FCID_FRETBOARDSTYLEDEF , FCID_FRETBOARDSTYLEDEFS , FCID_FRETBOARDGROUPDEF , FCID_FRETBOARDGROUPDEFS , FCID_FRETINSTRUMENTDEF , FCID_GENERALPREFS , FCID_GRIDSGUIDESPREFS , FCID_GROUP , FCID_GROUPNAMEPOSITIONPREFS , FCID_HUMANPLAYBACKPREFS , FCID_INDEPENDENTCELLDETAIL , FCID_INSTRUMENTDEF , FCID_INSTRUMENTPLAYBACKDATA , FCID_KEYMODEDEF , FCID_KEYSIGNATURE , FCID_LAYERPREFS , FCID_LYRICSBASELINE , FCID_LYRICSPREFS , FCID_MEASURE , FCID_MEASURENUMBERREGION , FCID_METATOOLASSIGNMENT , FCID_MIDIEXPRESSION , FCID_MISCDOCPREFS , FCID_MULTIMEASUREREST , FCID_MULTIMEASURERESTPREFS , FCID_MULTISTAFFINSTRUMENT , FCID_MULTISTAFFINSTRUMENTS , FCID_MUSICCHARACTERPREFS , FCID_MUSICSPACINGPREFS , FCID_NUMBER , FCID_NOTEHEADMOD , FCID_OTHERINCI , FCID_PERCUSSIONLAYOUTNOTE , FCID_PERCUSSIONSTAFF , FCID_PERFORMANCEMOD , FCID_PAGE , FCID_PAGEFORMATPREFS , FCID_PAGEGRAPHIC , FCID_PAGETEXT , FCID_PART , FCID_PARTEXTRACTPREFS , FCID_PARTSCOPEPREFS , FCID_PARTSTAFFVOICING , FCID_PERCUSSIONNOTEMOD , FCID_PIANOBRACEPREFS , FCID_PLAYBACKPREFS , FCID_RAWTEXT , FCID_REPEATPREFS , FCID_SECONDARYBEAMBREAKMOD , FCID_BEAMEXTENSIONMOD , FCID_SECTIONSYLLABLE , FCID_SEPARATEMEASURENUMBER , FCID_SEPARATEPLACEMENT , FCID_SHAPEDEF , FCID_SHAPEEXPRESSIONDEF , FCID_SLURCONTOURPREFS , FCID_SIZEPREFS , FCID_SMARTSHAPE , FCID_SMARTSHAPEENTRYMARK , FCID_SMARTSHAPEMEASUREMARK , FCID_SMARTSHAPEPREFS , FCID_STAFF , FCID_STAFFLIST , FCID_STAFFNAMEPOSITION , FCID_STAFFNAMEPOSITIONPREFS , FCID_STAFFSTYLEASSIGN , FCID_STAFFSTYLEDEF , FCID_STAFFSYSTEM , FCID_STEMCONNECTIONTABLE , FCID_STEMMOD , FCID_STRING , FCID_SYLLABLEENTRYMOD , FCID_SYSTEMSTAFF , FCID_TABLATURENOTEMOD , FCID_TEMPOELEMENT , FCID_TEXTBLOCK , FCID_TEXTEXPRESSIONDEF , FCID_TEXTREPEAT , FCID_TEXTREPEATDEF , FCID_TIEMOD , FCID_TIEPREFS , FCID_TIECONTOURPREFS , FCID_TIEPLACEMENTPREFS , FCID_TIMESIGNATURE , FCID_TUPLET , FCID_TUPLETPREFS , FCID_VERSESYLLABLE }
	Constants for the GetClassID method. More...

enum	MEASUREMENTUNITS { MEASUREMENTUNIT_DEFAULT = UNIT_DEFAULT , MEASUREMENTUNIT_EVPUS = UNIT_EVPUS , MEASUREMENTUNIT_INCHES = UNIT_INCHES , MEASUREMENTUNIT_CENTIMETERS = UNIT_CENTS , MEASUREMENTUNIT_POINTS = UNIT_POINTS , MEASUREMENTUNIT_PICAS = UNIT_PICAS , MEASUREMENTUNIT_SPACES = UNIT_SPACES , MEASUREMENTUNIT_MILLIMETERS = 100 }
	Constants for Finale's standard measurement units. More...

Public Member Functions
virtual const PDKFRAMEWORK_CLASSID	GetClassID () const
	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.

virtual const char *	ClassName () const =0
	Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child class.

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.

virtual void	DebugDump ()
	Outputs the class data/information for debugging purposes.

virtual void	DebugDataDump ()
	Outputs a memory dump of the data block in the object for debugging purposes.

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

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.

Static Public Member Functions
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
	__FCBase ()
	The constructor.

Detailed Description

Base class for the Finale Framework classes.

Member Enumeration Documentation

◆ MEASUREMENTUNITS

enum __FCBase::MEASUREMENTUNITS

Constants for Finale's standard measurement units.

Lua-supported.

Enumerator
MEASUREMENTUNIT_DEFAULT	The current user measurement settings
MEASUREMENTUNIT_EVPUS	EVPUs
MEASUREMENTUNIT_INCHES	Inches
MEASUREMENTUNIT_CENTIMETERS	Centimeters
MEASUREMENTUNIT_POINTS	Points
MEASUREMENTUNIT_PICAS	Picas
MEASUREMENTUNIT_SPACES	Spaces
MEASUREMENTUNIT_MILLIMETERS	Millimeters (not supported by the Finale user interface, but in calculations)

◆ PDKFRAMEWORK_CLASSID

enum __FCBase::PDKFRAMEWORK_CLASSID

Constants for the GetClassID method.

Lua-supported.

Enumerator
FCID_FONTINFO	FCString isn't a Finale data type.
FCID_NUMBER	FCNumber isn't a Finale data type.
FCID_STRING	FCString isn't a Finale data type.

Member Function Documentation

◆ ClassName()

virtual const char * __FCBase::ClassName ( ) const

pure virtual

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

Lua-supported.

Implemented in __FCBaseData, __FCBrowserBase, __FCBrowserBaseData, __FCBrowserNoInciOther, __FCCellDetail, __FCCollection, __FCCollectionCellDetail, __FCCollectionData, __FCCollectionDetail, __FCCollectionEntryDetail, __FCCollectionGlobal, __FCCollectionInciOther, __FCCollectionNoInciCellDetail, __FCCollectionNoInciDetail, __FCCollectionNoInciOther, __FCCollectionPrefs, __FCCompositeTimeSigBottomElement, __FCCompositeTimeSigTopElement, __FCDetail, __FCEntryDetail, __FCEntryDetailNoteID, __FCFileDialogBase, __FCFretItemBase, __FCFretItemsBase, __FCGlobals, __FCInci, __FCInciOther, __FCIteratorBase, __FCLyricsBase, __FCNoInciCellDetail, __FCNoInciDetail, __FCNoInciOther, __FCNoteEntryCollection, __FCOther, __FCOtherText, __FCPrefsBase, __FCStaffBase, __FCUserWindow, FCAccidentalMod, FCAccidentalMods, FCActiveLyric, FCAllotment, FCAllotments, FCArticulation, FCArticulationDef, FCArticulationDefs, FCArticulations, FCBackwardRepeat, FCBaseline, FCBaselines, FCBeamExtensionMod, FCBeamMod, FCBeatChartElement, FCBeatChartElements, FCBookmark, FCBookmarks, FCBookmarkText, FCBrokenBeamMod, FCBrokenBeamMods, FCBrowserArticulationDefs, FCBrowserMeasures, FCBrowserPages, FCBrowserStaffSystems, FCBrowserStaves, FCCategoryDef, FCCategoryDefs, FCCell, FCCellClefChange, FCCellClefChanges, FCCellFrameHold, FCCellFrameHolds, FCCellGraphic, FCCellGraphics, FCCellMetrics, FCCellPos, FCCells, FCCellText, FCCellTexts, FCCenterSmartShape, FCChord, FCChordPrefs, FCChords, FCChordSuffixElement, FCChordSuffixElements, FCChordSuffixKeyNumberOffsets, FCChorusLyricsText, FCChorusSyllable, FCChorusSyllables, FCClefDefs, FCCompositeTimeSigBottom, FCCompositeTimeSigTop, FCControl, FCCrossStaffMod, FCCrossStaffMods, FCCtrlButton, FCCtrlCheckbox, FCCtrlComboBox, FCCtrlDataList, FCCtrlEdit, FCCtrlHorizontalLine, FCCtrlImage, FCCtrlLine, FCCtrlListBox, FCCtrlPopup, FCCtrlRadioButton, FCCtrlRadioButtonGroup, FCCtrlSlider, FCCtrlStatic, FCCtrlSwitcher, FCCtrlTextEditor, FCCtrlTree, FCCtrlUpDown, FCCtrlVerticalLine, FCCurrentStaffSpec, FCCustomKeyModeDef, FCCustomKeyModeDefs, FCCustomKeyModeSymbolList, FCCustomKeyModeSymbolLists, FCCustomLuaWindow, FCCustomSmartLineDef, FCCustomSmartLineDefs, FCCustomStemMod, FCCustomStemMods, FCCustomWindow, FCDataListRow, FCDistancePrefs, FCDocument, FCDocuments, FCDotMod, FCDotMods, FCEnclosure, FCEndingRepeat, FCEndingRepeatText, FCEndTieMods, FCEnigmaTextStyle, FCEntryAlterMod, FCEntryMetrics, FCExecutableShapeDef, FCExecutableShapeDefs, FCExpression, FCExpressions, FCFileInfoText, FCFileOpenDialog, FCFileSaveAsDialog, FCFolderBrowseDialog, FCFontDialog, FCFontInfo, FCFontPrefs, FCFreezeSystem, FCFreezeSystems, FCFretBarreItem, FCFretBarreItems, FCFretboardGroup, FCFretboardGroupDef, FCFretboardGroupDefs, FCFretboardGroupItem, FCFretboardStyleDef, FCFretboardStyleDefs, FCFretInstrumentDef, FCFretInstrumentDefs, FCFretItem, FCFretItems, FCGeneralPrefs, FCGridsGuidesPrefs, FCGroup, FCGroupNamePositionPrefs, FCGroups, FCGuide, FCGuides, FCHumanPlaybackPrefs, FCHyperClick, FCIndependentCellDetail, FCInstrumentDef, FCInstrumentDefs, FCInstrumentDefText, FCInstrumentPlaybackData, FCIteratorHandler, FCKeySignature, FCLayerPlaybackData, FCLayerPrefs, FCListenToMidiResult, FCLuaIterator, FCLuaScriptItem, FCLuaScriptItems, FCMeasure, FCMeasureNumberRegion, FCMeasureNumberRegions, FCMeasures, FCMetatoolAssignment, FCMetatoolAssignments, FCMidiExpression, FCMidiExpressions, FCMiscDocPrefs, FCMultiMeasureRest, FCMultiMeasureRestPrefs, FCMultiMeasureRests, FCMultiStaffInstrument, FCMultiStaffInstruments, FCMusicCharacterPrefs, FCMusicRegion, FCMusicSpacingPrefs, FCNote, FCNoteEntries, FCNoteEntry, FCNoteEntryCell, FCNoteEntryCellMetrics, FCNoteEntryLayer, FCNoteheadMod, FCNoteheadMods, FCNotePitch, FCNotePitches, FCNumber, FCNumberCollection, FCNumbers, FCOtherInci, FCOtherIncis, FCPage, FCPageFormatPrefs, FCPageGraphic, FCPageGraphics, FCPages, FCPageText, FCPageTexts, FCPart, FCPartExtractPrefs, FCParts, FCPartScopePrefs, FCPartStaffVoicing, FCPercussionLayoutNote, FCPercussionLayoutNotes, FCPercussionLayoutNotesLookup, FCPercussionLayoutNotesText, FCPercussionMapNote, FCPercussionMapNotes, FCPercussionMapNotesLookup, FCPercussionNoteMod, FCPercussionNoteMods, FCPercussionNoteType, FCPercussionStaff, FCPerformanceMod, FCPerformanceMods, FCPianoBracePrefs, FCPlaybackPrefs, FCPoint, FCPrimaryBeamMods, FCPrintSettings, FCRange, FCRanges, FCRawText, FCRepeatPrefs, FCResourceWindow, FCSecondaryBeamBreakMod, FCSecondaryBeamBreakMods, FCSecondaryBeamMods, FCSectionLyricsText, FCSectionSyllable, FCSectionSyllables, FCSeparateMeasureNumber, FCSeparateMeasureNumbers, FCSeparatePlacement, FCSeparatePlacements, FCSettingsPair, FCSettingsPairs, FCShapeDef, FCShapeDefInstruction, FCShapeDefInstructions, FCShapeDefs, FCShapeExpressionDefs, FCSizePrefs, FCSlurContourPrefs, FCSmartShape, FCSmartShapeCtrlPointAdjust, FCSmartShapeEntryConnectStyle, FCSmartShapeEntryMark, FCSmartShapeEntryMarks, FCSmartShapeMeasureMark, FCSmartShapeMeasureMarks, FCSmartShapePrefs, FCSmartShapes, FCSmartShapeSegment, FCStaff, FCStaffList, FCStaffListCategoryText, FCStaffListLookup, FCStaffLists, FCStaffListStaffAssignText, FCStaffListText, FCStaffNamePosition, FCStaffNamePositionPrefs, FCStaffStyleAssign, FCStaffStyleAssigns, FCStaffStyleDef, FCStaffStyleDefs, FCStaffSystem, FCStaffSystems, FCStaffSystemsLookup, FCStartTieMods, FCStaves, FCStemConnectionTable, FCStemMod, FCStemMods, FCString, FCStrings, FCSyllableBase, FCSyllableEntryMod, FCSystemStaff, FCSystemStaves, FCTablatureNoteMod, FCTablatureNoteMods, FCTempoElement, FCTempoElements, FCTextBlock, FCTextBlocks, FCTextExpressionDef, FCTextExpressionDefs, FCTextFileUTF8Stream, FCTextMetrics, FCTextRepeat, FCTextRepeatDef, FCTextRepeatDefs, FCTextRepeats, FCTextRepeatText, FCTieContourPrefs, FCTieMod, FCTiePlacementPrefs, FCTiePrefs, FCTimeSignature, FCTreeNode, FCTuplet, FCTupletPrefs, FCTuplets, FCUI, FCUndoController, FCVerseLyricsText, FCVerseSyllable, and FCVerseSyllables.

◆ DebugDataByteArrayDump()

void __FCBase::DebugDataByteArrayDump ( )

virtual

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

◆ DebugDataDump()

void __FCBase::DebugDataDump ( )

virtual

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

◆ DebugDump()

void __FCBase::DebugDump ( )

virtual

Outputs the class data/information 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 in __FCBaseData, __FCCellDetail, __FCCollection, __FCCompositeTimeSigBottomElement, __FCCompositeTimeSigTopElement, __FCEntryDetail, __FCNoInciDetail, __FCNoInciOther, FCAllotment, FCArticulation, FCArticulationDef, FCBeamMod, FCBeatChartElement, FCBookmark, FCCategoryDef, FCCellFrameHold, FCCellGraphic, FCCellMetrics, FCCellText, FCCenterSmartShape, FCChord, FCChordSuffixElement, FCCustomSmartLineDef, FCDocument, FCEnclosure, FCEntryAlterMod, FCEntryMetrics, FCExecutableShapeDef, FCExpression, FCFontInfo, FCFreezeSystem, FCFretboardGroupDef, FCFretboardStyleDef, FCFretInstrumentDef, FCGroup, FCIndependentCellDetail, FCInstrumentDef, FCInstrumentPlaybackData, FCKeySignature, FCMeasureNumberRegion, FCMetatoolAssignment, FCMidiExpression, FCMultiMeasureRest, FCMultiMeasureRestPrefs, FCMultiStaffInstrument, FCMusicRegion, FCNote, FCNoteEntryLayer, FCNotePitches, FCNumber, FCPage, FCPageText, FCPart, FCPartStaffVoicing, FCPercussionLayoutNote, FCPercussionStaff, FCRawText, FCSeparateMeasureNumber, FCSettingsPair, FCShapeDef, FCShapeDefInstruction, FCShapeExpressionDef, FCSlurContourPrefs, FCSmartShape, FCSmartShapeCtrlPointAdjust, FCSmartShapeEntryMark, FCSmartShapeMeasureMark, FCSmartShapePrefs, FCSmartShapeSegment, FCStaff, FCStaffList, FCStaffStyleAssign, FCStaffStyleDef, FCStaffSystem, FCStemConnectionTable, FCString, FCSyllableBase, FCSyllableEntryMod, FCSystemGlyphInfo, FCSystemStaff, FCTextBlock, FCTextExpressionDef, FCTextMetrics, FCTextRepeat, FCTextRepeatDef, FCTreeNode, FCTuplet, FCTupletPrefs, and FCUI.

◆ DebugMsg()

void __FCBase::DebugMsg ( const char * pszMsg )

Creates a simple Message Box for debug purposes with just one text string.

Accessible if PDK_FRAMEWORK_DEBUG is defined.

◆ DebugMsgHex()

void __FCBase::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.

Accessible if PDK_FRAMEWORK_DEBUG is defined.

◆ DebugMsgInt()

void __FCBase::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.

Accessible if PDK_FRAMEWORK_DEBUG is defined.

Todo: Put class information in the title.

◆ DebugMsgString()

void __FCBase::DebugMsgString	(	const char *	pszPrefixText,
		const char *	thestring )

Creates a simple Message Box for debug purposes. The text appears with the extra string appearing afterwards.

Accessible if PDK_FRAMEWORK_DEBUG is defined.

◆ DebugOut()

void __FCBase::DebugOut ( const char * pszLine )

static

Static method to output a line of text for debugging purposes.

Accessible if PDK_FRAMEWORK_DEBUG is defined.

◆ DebugOutBin()

void __FCBase::DebugOutBin	(	const char *	pszPrefixText,
		int	i )

static

Static method that outputs a line for debugging purposes. The text appears with the extra digit (in binary presentation) appearing afterwards.

Accessible if PDK_FRAMEWORK_DEBUG is defined.

◆ DebugOutBlock()

void __FCBase::DebugOutBlock	(	const void *	pBuffer,
		int	startoffset,
		int	size )

static

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.

Accessible if PDK_FRAMEWORK_DEBUG is defined.

◆ DebugOutBool()

void __FCBase::DebugOutBool	(	const char *	pszPrefixText,
		bool	state )

static

Static method that outputs a line for debugging purposes. The boolean state appears afterwards as either "TRUE" or "FALSE".

Accessible if PDK_FRAMEWORK_DEBUG is defined.

◆ DebugOutByteArrayBlock()

void __FCBase::DebugOutByteArrayBlock	(	const void *	pBuffer,
		int	startoffset,
		int	size )

static

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.

Accessible if PDK_FRAMEWORK_DEBUG is defined.

\param [in] startoffset The 0-based start offset, where the dump should start. (The dump will then continue to the end of the block.)

\param [in] size The size of the full memory in bytes (regardless of where the start offset is).

◆ DebugOutFloat()

void __FCBase::DebugOutFloat	(	const char *	pszPrefixText,
		double	f )

static

Static method that outputs a line for debugging purposes. The text appears with the extra float value appearing afterwards.

Accessible if PDK_FRAMEWORK_DEBUG is defined.

◆ DebugOutFormat()

int __FCBase::DebugOutFormat	(	const char *	fmt,
			... )

Outputs debug text using C style "printf" syntax.

Accessible if both PDK_FRAMEWORK_DEBUG and PDK_FRAMEWORK_FORMAT are defined.

◆ DebugOutHex()

void __FCBase::DebugOutHex	(	const char *	pszPrefixText,
		int	i )

static

Static method that outputs a line for debugging purposes. The text appears with the extra digit (in hexadecimal presentation) appearing afterwards.

Accessible if PDK_FRAMEWORK_DEBUG is defined.

◆ DebugOutInt()

void __FCBase::DebugOutInt	(	const char *	pszPrefixText,
		int	i )

static

Static method that outputs a line for debugging purposes. The text appears with the extra digit (in decimal presentation) appearing afterwards.

Accessible if PDK_FRAMEWORK_DEBUG is defined.

◆ DebugOutMenuInfo()

void __FCBase::DebugOutMenuInfo	(	FCUI *	pUI,
		int	menuixd_horiz,
		int	menuixd_vert ) const

Outputs the menu command info for debugging purposes.

Accessible if PDK_FRAMEWORK_DEBUG is defined.

◆ DebugOutPtr()

void __FCBase::DebugOutPtr	(	const char *	pszPrefixText,
		void *	ptr )

static

Static method that outputs a line for debugging purposes. The prefix text appears with the extra ptr (in hexadeximal representation) appearing afterwards.

This method works with 64-bit pointers.

Accessible if PDK_FRAMEWORK_DEBUG is defined.

◆ DebugOutString() [1/2]

void __FCBase::DebugOutString	(	const char *	pszPrefixText,
		const char *	thestring )

static

Static method that outputs a line for debugging purposes (C string version). The text appears with the extra string appearing afterwards.

Accessible if PDK_FRAMEWORK_DEBUG is defined.

◆ DebugOutString() [2/2]

void __FCBase::DebugOutString	(	const char *	pszPrefixText,
		FCString *	pString )

static

Static method that outputs a line for debugging purposes (FCString version). The text appears with the extra string appearing afterwards.

Accessible if PDK_FRAMEWORK_DEBUG is defined.

◆ DebugOutTag()

void __FCBase::DebugOutTag	(	const char *	pszPrefixText,
		EXTAG	extag )

static

Static method that outputs a line for debugging purposes. The text appears with the EXTAG (in text) appearing afterwards.

Accessible if PDK_FRAMEWORK_DEBUG is defined.

◆ GetBitFlag()

bool __FCBase::GetBitFlag	(	FLAG_32	flag,
		FLAG_32	flagbits ) const

inline

Gets a state from flag bits. Returns true if any bit in the mask is set.

This method works with both 16 and 32 bit storage.

Parameters

flag	The flag storage.
flagbits	The mask of the bits to test

◆ GetClassID()

virtual const PDKFRAMEWORK_CLASSID __FCBase::GetClassID ( ) const

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 (also read-only property) (0.55).

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

◆ GetUserData()

void * __FCBase::GetUserData ( ) const

inline

Gets the user data attached to the instance of an object.

Returns: pData Pointer to the user data. This can be of any arbitrary format know only to the caller, for example a pointer to another object.

◆ GetUserData2()

void * __FCBase::GetUserData2 ( ) const

inline

Gets the additional user data attached to the instance of an object.

Returns: pData Pointer to the user data. This can be of any arbitrary format know only to the caller, for example a pointer to another object.

◆ IsIdentical()

virtual bool __FCBase::IsIdentical ( const __FCBase * pCompareObject ) const

inlinevirtual

Returns true if the data in the passed object is considered to be identical to the current object, otherwise false.

This is implementation-specific for each class. Override in all child classes that has data. When overriding, ALWAYS call the inherited method first and return false if that has already failed.

This initial implementation assures that a comparison object exists and that
the ClassName() returns matches.

Parameters

pCompareObject Pointer to the passed object, where the data should be compared.

Reimplemented in __FCCollection, FCCategoryDef, FCDocument, FCKeySignature, FCMusicRegion, FCPart, FCShapeDefInstruction, and FCTimeSignature.

◆ ReadFromXML()

virtual bool __FCBase::ReadFromXML ( tinyxml2::XMLElement * pParentNode )

inlinevirtual

Virtual method that is used to read object data.

This method requires the PDK_FRAMEWORK_TINYXML define.

Override in classes that should store object data to the XML file.

Overridden methods must return true if the data is valid!

◆ ReadXML_Bool()

bool __FCBase::ReadXML_Bool	(	tinyxml2::XMLElement *	pParentNode,
		const char *	pszElementName,
		bool *	pValue )

Helper method to read boolean objects from the XML file.

This method requires the PDK_FRAMEWORK_TINYXML define.

Returns: True on successful read.

◆ ReadXML_BoolAttribute()

bool __FCBase::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.

This method requires the PDK_FRAMEWORK_TINYXML define.

Returns: True on successful read.

◆ ReadXML_FloatAttribute()

bool __FCBase::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.

This method requires the PDK_FRAMEWORK_TINYXML define.

Returns: True on successful read.

◆ ReadXML_Integer()

bool __FCBase::ReadXML_Integer	(	tinyxml2::XMLElement *	pParentNode,
		const char *	pszElementName,
		int *	pValue )

Helper method to read integer objects from the XML file.

This method requires the PDK_FRAMEWORK_TINYXML define.

Returns: True on successful read.

◆ ReadXML_IntegerAttribute()

bool __FCBase::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.

This method requires the PDK_FRAMEWORK_TINYXML define.

Returns: True on successful read.

◆ ReadXML_String()

bool __FCBase::ReadXML_String	(	tinyxml2::XMLElement *	pParentNode,
		const char *	pszElementName,
		FCString *	pStringValue )

Helper method to read FCString objects from the XML file.

This method requires the PDK_FRAMEWORK_TINYXML define.

Returns: True on successful read.

◆ ReadXML_StringAttribute()

bool __FCBase::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.

This method requires the PDK_FRAMEWORK_TINYXML define.

Returns: True on successful read.

◆ Set16BitFlag()

void __FCBase::Set16BitFlag	(	FLAG_16 *	flag,
		FLAG_16	flagbits,
		bool	state )

Sets a 16 bit flag.

Parameters

flag	The pointer to the flag storage.
flagbits	The mask of the bits to set/reset.
state	The state of the bits. true = set, false = reset

◆ Set32BitFlag()

void __FCBase::Set32BitFlag	(	FLAG_32 *	flag,
		FLAG_32	flagbits,
		bool	state )

Sets/resets a 32 bit flag, by using a bit mask.

Parameters

flag	The pointer to the flag storage.
flagbits	The mask of the bits to set/reset.
state	The state of the bits. true = set, false = reset

◆ SetSpecific32Bit()

void __FCBase::SetSpecific32Bit	(	FLAG_32 *	flag,
		int	bitnumber,
		bool	state )

Sets/resets a single bit in a 32 bit flag, by specifying one specific bit.

Parameters

[in,out]	flag	The pointer to the flag storage.
[in]	bitnumber	The number of the bit to set/reset. Must be between 1 and 32.
[in]	state	The state of the bits. true = set, false = reset

◆ SetUserData()

void __FCBase::SetUserData ( void * pData )

inline

Sets the user data attached to the instance of an object.

Parameters

pData Pointer to the user data. This can be of any arbitrary format know only to the caller, for example a pointer to another object.

◆ SetUserData2()

void __FCBase::SetUserData2 ( void * pData )

inline

Sets the additional user data attached to the instance of an object.

Parameters

pData Pointer to the user data. This can be of any arbitrary format know only to the caller, for example a pointer to another object.

◆ StoreToXML()

virtual void __FCBase::StoreToXML ( tinyxml2::XMLElement * pParentNode )

inlinevirtual

Virtual method that is used to store an object's data.

This method requires the PDK_FRAMEWORK_TINYXML define.

Override in classes that should store object data to the XML file.

◆ StoreXML_Bool()

void __FCBase::StoreXML_Bool	(	tinyxml2::XMLElement *	pParentNode,
		const char *	pszElementName,
		bool	value )

Helper function to store boolean objects in the XML file.

This method requires the PDK_FRAMEWORK_TINYXML define.

◆ StoreXML_BoolAttribute()

void __FCBase::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.

This method requires the PDK_FRAMEWORK_TINYXML define.

◆ StoreXML_FloatAttribute()

void __FCBase::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.

This method requires the PDK_FRAMEWORK_TINYXML define.

◆ StoreXML_Integer()

void __FCBase::StoreXML_Integer	(	tinyxml2::XMLElement *	pParentNode,
		const char *	pszElementName,
		int	value )

Helper function to store integer objects in the XML file.

This method requires the PDK_FRAMEWORK_TINYXML define.

◆ StoreXML_IntegerAttribute()

void __FCBase::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.

This method requires the PDK_FRAMEWORK_TINYXML define.

◆ StoreXML_String()

void __FCBase::StoreXML_String	(	tinyxml2::XMLElement *	pParentNode,
		const char *	pszElementName,
		FCString *	pStringValue )

Helper function to store FCString objects in the XML file.

This method requires the PDK_FRAMEWORK_TINYXML define.

◆ StoreXML_StringAttribute()

void __FCBase::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.

This method requires the PDK_FRAMEWORK_TINYXML define.

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Enumeration Documentation

◆ MEASUREMENTUNITS

◆ PDKFRAMEWORK_CLASSID

Member Function Documentation

◆ ClassName()

◆ DebugDataByteArrayDump()

◆ DebugDataDump()

◆ DebugDump()

◆ DebugMsg()

◆ DebugMsgHex()

◆ DebugMsgInt()

◆ DebugMsgString()

◆ DebugOut()

◆ DebugOutBin()

◆ DebugOutBlock()

◆ DebugOutBool()

◆ DebugOutByteArrayBlock()

◆ DebugOutFloat()

◆ DebugOutFormat()

◆ DebugOutHex()

◆ DebugOutInt()

◆ DebugOutMenuInfo()

◆ DebugOutPtr()

◆ DebugOutString() [1/2]

◆ DebugOutString() [2/2]

◆ DebugOutTag()

◆ GetBitFlag()

◆ GetClassID()

◆ GetUserData()

◆ GetUserData2()

◆ IsIdentical()

◆ ReadFromXML()

◆ ReadXML_Bool()

◆ ReadXML_BoolAttribute()

◆ ReadXML_FloatAttribute()

◆ ReadXML_Integer()

◆ ReadXML_IntegerAttribute()

◆ ReadXML_String()

◆ ReadXML_StringAttribute()

◆ Set16BitFlag()

◆ Set32BitFlag()

◆ SetSpecific32Bit()

◆ SetUserData()

◆ SetUserData2()

◆ StoreToXML()

◆ StoreXML_Bool()

◆ StoreXML_BoolAttribute()

◆ StoreXML_FloatAttribute()

◆ StoreXML_Integer()

◆ StoreXML_IntegerAttribute()

◆ StoreXML_String()

◆ StoreXML_StringAttribute()