Class for a text expression definition. More...

#include <ff_other.h>

Inheritance diagram for FCTextExpressionDef:

Public Types
enum	REHEARSALMARK_STYLES { REHMARKSTYLE_MANUAL = FX_EXPR_REHEARSAL_MANUAL, REHMARKSTYLE_LETTER = FX_EXPR_REHERASAL_LETTERS, REHMARKSTYLE_LETNUM = FX_EXPR_REHEARSAL_LETNUM, REHMARKSTYLE_LETTER_LC = FX_EXPR_REHEARSAL_LETTERS_LC, REHMARKSTYLE_LETNUM_LC = FX_EXPR_REHEARSAL_LETNUM_LC, REHMARKSTYLE_NUMBER = FX_EXPR_REHEARSAL_NUMBERS, REHMARKSTYLE_MEASNUM = FX_EXPR_REHEARSAL_MEASNUM }
	The rehearsal number mark types available to text expressions. More...

enum	SMARTMUSIC_MARKER_TYPES { SMARTMUSICTYPE_NONE = 0, SMARTMUSICTYPE_UNKNOWN = -1, SMARTMUSICTYPE_INTELLIGENTACC0, SMARTMUSICTYPE_INTELLIGENTACC1, SMARTMUSICTYPE_INTELLIGENTACC2, SMARTMUSICTYPE_INTELLIGENTACC3, SMARTMUSICTYPE_INTELLIGENTACC4, SMARTMUSICTYPE_INTELLIGENTACC5, SMARTMUSICTYPE_INTELLIGENTACC6, SMARTMUSICTYPE_INTELLIGENTACC7, SMARTMUSICTYPE_INTELLIGENTACC8, SMARTMUSICTYPE_INTELLIGENTACC9, SMARTMUSICTYPE_INTELLIGENTACC10, SMARTMUSICTYPE_WAITFORENDOFNOTE, SMARTMUSICTYPE_WAITFORNOTEON, SMARTMUSICTYPE_WAITFORFOOTPEDAL, SMARTMUSICTYPE_RESUME, SMARTMUSICTYPE_RESETTEMPO, SMARTMUSICTYPE_OPTIONALOCTAVEUP, SMARTMUSICTYPE_OPTIONALOCTAVEDOWN, SMARTMUSICTYPE_OPTIONALOCTAVEEND, SMARTMUSICTYPE_REHEARSALMARK, SMARTMUSICTYPE_REPEATSTART, SMARTMUSICTYPE_REPEATEND, SMARTMUSICTYPE_REPEAT_ENDING, SMARTMUSICTYPE_REPEAT_DS, SMARTMUSICTYPE_REPEAT_DC, SMARTMUSICTYPE_USEDESCRIPTIONTEXT, SMARTMUSICTYPE_SMALLBREATH, SMARTMUSICTYPE_LARGEBREATH, SMARTMUSICTYPE_BREATHEND, SMARTMUSICTYPE_RESETMEASURECOUNTER, SMARTMUSICTYPE_ASSESSMENTON, SMARTMUSICTYPE_ASSESSMENTOFF, SMARTMUSICTYPE_SOLOPLAYBACKON, SMARTMUSICTYPE_SOLOPLAYBACKOFF, SMARTMUSICTYPE_SWINGASSESSMENTON, SMARTMUSICTYPE_SWINGASSESSMENTOFF }
	The different types that can be returned by GetSmartMusicMarkerType. More...

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

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

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

virtual const PDKFRAMEWORK_CLASSID	GetClassID ()
	Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has problems to resolve the true classes of inherited objects. More...

	FCTextExpressionDef ()
	The constructor. More...

virtual	~FCTextExpressionDef ()
	The destructor.

virtual bool	DeepSaveAs (CMPER itemno)
	Reimplemented method that makes a copy of the text string before resaving. More...

virtual bool	DeepDeleteData ()
	Reimplemented version of DeepDeleteData() for FCTextExpressionDef objects. More...

CMPER	GetTextBlockID ()
	Returns the text block ID (for use with FCTextBlock). More...

bool	GetUseExecutableShape () const
	Returns true if an executable is used for the expression def. More...

twobyte	GetExecutableShapeID () const
	Returns the executable shape ID. More...

void	SetExecutableShapeID (twobyte shapeID)
	Sets the executable shape ID for the expression def. More...

void	SetUseExecutableShape (bool state)
	Sets the use of executable shape. Normally this isn't called directly. Instead, use SetExecutableShapeID. More...

bool	GetHideMeasureNumbers () const
	Returns true if the rehearsal mark text expression hides the measure numbers. More...

void	SetHideMeasureNumbers (bool value)
	Sets if the rehearsal mark text expression hides the measure numbers or not. More...

bool	GetUseEnclosure () const
	Returns true if the text expression uses an enclosure. More...

void	SetUseEnclosure (bool value)
	Sets if the text expression uses an enclosure or not. More...

twobyte	GetCategoryID () const
	Returns the category ID for the expression definition. More...

twobyte	GetTextID () const
	Returns the text ID for the expression text. For use with the FCTextBlock class. More...

twobyte	GetPlaybackTempoValue ()
	For tempo expressions, returns the playback tempo value. More...

twobyte	GetPlaybackTempoDuration ()
	For tempo expressions, returns the metronome duration (in EDUs) for the defined playback tempo. More...

twobyte	GetPlaybackPass () const

void	SetPlaybackPass (twobyte value)

FCCategoryDef::VERT_ALIGNMENT	GetVerticalAlignmentPoint () const
	Returns the vertical alignment point for the expression definition positioning. More...

twobyte	GetVerticalBaselineOffset () const
	Returns the vertical "Additional Baseline Offset" in the text expression definition. More...

twobyte	GetVerticalEntryOffset () const
	Returns the vertical "Additional Entry Offset" in the text expression definition. More...

REHEARSALMARK_STYLES	GetRehearsalMarkStyle () const
	Returns the rehearsal mark numbering style. More...

void	SetRehearsalMarkStyle (REHEARSALMARK_STYLES value)
	Sets the rehearsal mark numbering style. More...

bool	GetBreakMMRest () const
	Returns the "Break Multi-measure rest" option in the text expression definition. More...

void	SetBreakMMRest (bool state)
	Sets the "Break Multi-measure rest" option in the text expression definition. More...

void	SetCategoryID (twobyte ID)
	Sets the category ID for the expression definition. More...

void	SetUseCategoryFont (bool value)
	Sets if the "use category font" should be checked or not. More...

void	SetUseCategoryPos (bool value)
	Sets if the "use category positioning" should be checked or not. More...

void	SetPlaybackController (twobyte controllernumber, twobyte value)
	Sets the playback to a specific MIDI CC controller. More...

void	SetPlaybackTempo (TimeEdu32 eduduration, int tempo)
	Sets the playback tempo style for the expression definition. More...

void	SetVerticalAlignmentPoint (FCCategoryDef::VERT_ALIGNMENT value)
	Sets the vertical alignment point for the expression definition positioning. More...

void	SetVerticalBaselineOffset (twobyte value)
	Sets the vertical "Additional Baseline Offset" in the text expression definition. More...

void	SetVerticalEntryOffset (twobyte value)
	Sets the vertical "Additional Entry Offset" in the text expression definition. More...

FCCategoryDef::HORIZ_JUSTIFICATION	GetHorizontalJustification () const
	Returns the "Horizontal Justification" setting in the text expression definition. More...

void	SetHorizontalJustification (FCCategoryDef::HORIZ_JUSTIFICATION value)
	Sets the "Horizontal Justification" in the text expression definition. More...

FCCategoryDef::HORIZ_ALIGNMENT	GetHorizontalAlignmentPoint () const
	Returns the "Horizontal Alignment Point" setting in the text expression definition. More...

void	SetHorizontalAlignmentPoint (FCCategoryDef::HORIZ_ALIGNMENT value)
	Sets the "Horizontal Alignment Point" setting in the text expression definition. More...

twobyte	GetHorizontalOffset () const
	Returns the "Additional Horizontal Offset" value in the text expression definition. More...

void	SetHorizontalOffset (twobyte value)
	Sets the "Additional Horizontal Offset" in the text expression definition. More...

FCString *	CreateTextString ()
	Gets a pointer to the text expression string, as a string object. If the string is empty, the string object will still be created. More...

FCEnclosure *	CreateEnclosure ()
	Loads and creates an enclosure object. It's the caller's responsibility to free the allocated memory from the heap. More...

bool	IsPlaybackTempo () const
	Returns true if the expression is defined for tempo playback. More...

bool	IsSmartMusicMarker () const
	Returns true if the text expression's playback style is defined as a SmartMusic marker. More...

SMARTMUSIC_MARKER_TYPES	GetSmartMusicMarkerType () const
	Returns the SmartMusic Marker type. More...

void	SetSmartMusicMarkerType (FCTextExpressionDef::SMARTMUSIC_MARKER_TYPES value)
	Sets the SmartMusic Marker type. More...

bool	IsAutoRehearsalMark () const
	Returns true if an automatic rehearsal number style is used. More...

bool	MakeRehearsalMark (FCString *pString, int measure)
	Creates an automatic rehearsal string based on the definition and a measure. More...

bool	SaveTextString (FCString *pString)
	Resaves the text for an existing text expression. More...

bool	SaveNewTextBlock (FCString *pString)
	Saves a new raw text block (both a raw text and the connected text block) and assigns it to the expression definition. This does not save the expression definition, which needs to be saved separately afterwards. More...

bool	DeleteTextBlock ()
	Removes the expression's text block (including its raw text data block) from Finale's database. More...

bool	AssignToCategory (FCCategoryDef *pDef)
	Assigns the expression definition to a category. More...

bool	GetUseCategoryFont () const
	Returns true if the expression is marked to use the category font. More...

bool	GetUseCategoryPos () const
	Returns true if the expression is marked to use the category positioning. More...

void	SetDescription (FCString *pDescriptionString)
	Sets the description text for the text expression definition. More...

void	GetDescription (FCString *pDescriptionString)
	Gets the description text for the text expression definition. More...

FCString *	CreateDescription ()
	Creates a string object that contains the description text. More...

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

Public Member Functions inherited from __FCNoInciOther
	__FCNoInciOther ()
	The constructor.

virtual bool	Load (CMPER itemno)
	Loads the indicated item. More...

virtual bool	Reload ()
	Overridden Reload() method to support complex data types.

virtual bool	SaveAs (CMPER itemno)
	Saves the data under another item number. The object will now be connected to the new item number. More...

virtual bool	SaveNew ()
	Creates the data as completely new item number. The object will now be connected to the new item number. More...

virtual CMPER	GetItemNo () const
	Returns the item number. This typically points to items such as a page number, a measure number, a 1-based expression definition number, etc. More...

void	SetItemNo (CMPER cmper)
	Sets the item number. Use with extreme care! This is mostly intended for situations when creating new records isn't supported by Finale (preventing SaveAs to work). More...

virtual bool	LoadFirst ()
	Loads the first element of 1-based data. More...

Public Member Functions inherited from __FCOther
void	SetCmperAndInci (CMPER cmper, twobyte inci)
	Sets both the CMPER and the incident number in the dataID record. Mainly for internal use.

	__FCOther ()
	The constructor.

bool	IsIdenticalRecord (__FCOther *pCompare)
	Compares an object to see if both objects point to the same data record. More...

Public Member Functions inherited from __FCBaseData
EDOCID	GetConnectedDocID () const
	Returns the document ID that was connected to the last load/save of the data. More...

bool	VerifyConnectedDocID ()
	Checks that the stored document ID for the data object matches the current document's ID. More...

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

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	DeleteData ()
	Deletes the associated data from Finale's database. Be careful when deleting multiple objects. 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...

__FCBaseData *	CreateClone ()
	Creates an identical copy of an object. 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.

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

Public Member Functions inherited from __FCBase
	__FCBase ()
	The constructor.

virtual	~__FCBase ()
	Virtual destructor, so all inherited classes get the virtual destructor. More...

void	DebugMsgDigit (const char *pszPrefixText, int i)
	Creates a simple Message Box for debug purposes. The text appears with the extra digit (in decimal presentation) appearing afterwards. More...

void	DebugMsgHex (const char *pszPrefixText, int i)
	Creates a simple Message Box for debug purposes. The text appears with the extra digit (as a hexadecimal number) appearing afterwards. More...

void	DebugMsgString (const char pszPrefixText, const char thestring)
	Creates a simple Message Box for debug purposes. The text appears with the extra string appearing afterwards. More...

void	DebugMsg (const char *pszMsg)
	Creates a simple Message Box for debug purposes with just one text string. More...

void	DebugOutMenuInfo (FCUI *pUI, int menuixd_horiz, int menuixd_vert) const
	Outputs the menu command info for debugging purposes. More...

int	DebugOutFormat (const char *fmt,...)
	Outputs debug text using C style "printf" syntax. More...

void	Set16BitFlag (FLAG_16 *flag, FLAG_16 flagbits, bool state)
	Sets a 16 bit flag in the data block. More...

void	Set32BitFlag (FLAG_32 *flag, FLAG_32 flagbits, bool state)
	Sets a 32 bit flag in the data block. More...

bool	GetBitFlag (FLAG_32 flag, FLAG_32 flagbits) const
	Gets a state from flag bits. Returns true if any bit in the mask is set. More...

void	SetUserData (void *pData)
	Sets the user data attached to the instance of an object. More...

void	SetUserData2 (void *pData)
	Sets the additional user data attached to the instance of an object. More...

void *	GetUserData () const
	Gets the user data attached to the instance of an object. More...

void *	GetUserData2 () const
	Gets the additional user data attached to the instance of an object. More...

virtual bool	IsIdentical (__FCBase *pCompareObject)
	Returns true if the data in the passed object is considered to be identical to the current object, otherwise false. More...

void	StoreXML_String (tinyxml2::XMLElement pParentNode, const char pszElementName, FCString *pStringValue)
	Helper function to store FCString objects in the XML file. More...

void	StoreXML_Integer (tinyxml2::XMLElement pParentNode, const char pszElementName, int value)
	Helper function to store integer objects in the XML file. More...

void	StoreXML_Bool (tinyxml2::XMLElement pParentNode, const char pszElementName, bool value)
	Helper function to store boolean objects in the XML file. More...

void	StoreXML_StringAttribute (tinyxml2::XMLElement pNode, const char pszAttributeName, FCString *pStringValue)
	Helper function to store FCString objects in the XML file, as an attribute to a node. More...

void	StoreXML_IntegerAttribute (tinyxml2::XMLElement pNode, const char pszAttributeName, int value)
	Helper function to store integer objects in the XML file, as an attribute to a node. More...

void	StoreXML_BoolAttribute (tinyxml2::XMLElement pNode, const char pszAttributeName, bool value)
	Helper function to store boolean objects in the XML file, as an attribute to a node. More...

void	StoreXML_FloatAttribute (tinyxml2::XMLElement pNode, const char pszAttributeName, float value)
	Helper function to store floating point objects in the XML file, as an attribute to a node. More...

virtual void	StoreToXML (tinyxml2::XMLElement *pParentNode)
	Virtual method that is used to store an object's data. More...

bool	ReadXML_String (tinyxml2::XMLElement pParentNode, const char pszElementName, FCString *pStringValue)
	Helper method to read FCString objects from the XML file. More...

bool	ReadXML_Integer (tinyxml2::XMLElement pParentNode, const char pszElementName, int *pValue)
	Helper method to read integer objects from the XML file. More...

bool	ReadXML_Bool (tinyxml2::XMLElement pParentNode, const char pszElementName, bool *pValue)
	Helper method to read boolean objects from the XML file. More...

bool	ReadXML_StringAttribute (tinyxml2::XMLElement pNode, const char pszAttributeName, FCString *pStringValue)
	Helper method to read FCString objects from the XML file, as an attribute to a node. More...

bool	ReadXML_IntegerAttribute (tinyxml2::XMLElement pNode, const char pszAttributeName, int *pValue)
	Helper method to read integer objects from the XML file, as an attribute to a node. More...

bool	ReadXML_BoolAttribute (tinyxml2::XMLElement pNode, const char pszAttributeName, bool *pValue)
	Helper method to read boolean objects from the XML file, as an attribute to a node. More...

bool	ReadXML_FloatAttribute (tinyxml2::XMLElement pNode, const char pszAttributeName, float *pValue)
	Helper method to read floating point objects from the XML file, as an attribute to a node. More...

virtual bool	ReadFromXML (tinyxml2::XMLElement *pParentNode)
	Virtual method that is used to read object data. More...

Additional Inherited Members
Static Public Member Functions inherited from __FCBase
static void	DebugOutPtr (const char pszPrefixText, void ptr)
	Static method that outputs a line for debugging purposes. The prefix text appears with the extra ptr (in hexadeximal representation) appearing afterwards. More...

static void	DebugOutDigit (const char *pszPrefixText, int i)
	Static method that outputs a line for debugging purposes. The text appears with the extra digit (in decimal presentation) appearing afterwards. More...

static void	DebugOutFloat (const char *pszPrefixText, float f)
	Static method that outputs a line for debugging purposes. The text appears with the extra float value appearing afterwards. More...

static void	DebugOutTag (const char *pszPrefixText, EXTAG extag)
	Static method that outputs a line for debugging purposes. The text appears with the EXTAG (in text) appearing afterwards. More...

static void	DebugOutHex (const char *pszPrefixText, int i)
	Static method that outputs a line for debugging purposes. The text appears with the extra digit (in hexadecimal presentation) appearing afterwards. More...

static void	DebugOutBin (const char *pszPrefixText, int i)
	Static method that outputs a line for debugging purposes. The text appears with the extra digit (in binary presentation) appearing afterwards. More...

static void	DebugOutString (const char pszPrefixText, const char thestring)
	Static method that outputs a line for debugging purposes (C string version). The text appears with the extra string appearing afterwards. More...

static void	DebugOutString (const char pszPrefixText, FCString pString)
	Static method that outputs a line for debugging purposes (FCString version). The text appears with the extra string appearing afterwards. More...

static void	DebugOutBool (const char *pszPrefixText, bool state)
	Static method that outputs a line for debugging purposes. The boolean state appears afterwards as either "TRUE" or "FALSE". More...

static void	DebugOutBlock (const void *pBuffer, int startoffset, int size)
	Static method that outputs a memory block for debugging purposes. Eight bytes per line will appear (as hex digits) until the whole memory block is dumped. More...

static void	DebugOutByteArrayBlock (const void *pBuffer, int startoffset, int size)
	Static method that outputs a memory block for debugging purposes. Eight bytes per line will appear (as hex digits) as a C++ onebyte array, until the whole memory block is dumped. More...

static void	DebugOut (const char *pszLine)
	Static method to output a line of text for debugging purposes. More...

Protected Member Functions inherited from __FCBaseData
virtual void *	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 __FCBaseData *	CreateObject ()=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 inherited from __FCBaseData
EDOCID	_connecteddocID
	The "connected" document ID., which is the document the where the document was loaded (or last saved). This is for a mechanism to prevent resaving of certain data in other documents.

void *	_datablock
	Pointer to the object's data block, the meaning is implementation-specific for each derived subclass.

bool	_heapdatablock
	Variable that tells if _datablock is dynamically created on the heap (and should be deleted at object destruction).

int	_loadedsize
	Loaded size of the data block for a loaded object, in bytes. Since the datablock is implementation-specific, the _loadedsize should be updated by child classes that create new data. More...

EDataID	_dataid
	The EdataID for the last loaded/saved object.

Detailed Description

Class for a text expression definition.

Please note that deleted text expression definitions should be deleted with DeepDeleteData().

Member Enumeration Documentation

enum FCTextExpressionDef::REHEARSALMARK_STYLES

The rehearsal number mark types available to text expressions.

Lua-supported.

Enumerator
REHMARKSTYLE_MANUAL	Rehearsal style: manual (non-automatic)
REHMARKSTYLE_LETTER	Rehearsal style: Letters only (upper-case)
REHMARKSTYLE_LETNUM	Rehearsal style: Letters and numbers (upper-case)
REHMARKSTYLE_LETTER_LC	Rehearsal style: Letters only, lower-case
REHMARKSTYLE_LETNUM_LC	Rehearsal style: Letters and numbers, lower-case
REHMARKSTYLE_NUMBER	Rehearsal style: Numbers only
REHMARKSTYLE_MEASNUM	Rehearsal style: MEasure numbers

enum FCTextExpressionDef::SMARTMUSIC_MARKER_TYPES

The different types that can be returned by GetSmartMusicMarkerType.

Enumerator
SMARTMUSICTYPE_NONE	SmartMusic Marker isn't used
SMARTMUSICTYPE_UNKNOWN	Unknown SmartMusic Marker Type
SMARTMUSICTYPE_INTELLIGENTACC0	SmartMusic Marker Type: Intelligent Accompaniment, Level 0
SMARTMUSICTYPE_INTELLIGENTACC1	SmartMusic Marker Type: Intelligent Accompaniment, Level 1
SMARTMUSICTYPE_INTELLIGENTACC2	SmartMusic Marker Type: Intelligent Accompaniment, Level 2
SMARTMUSICTYPE_INTELLIGENTACC3	SmartMusic Marker Type: Intelligent Accompaniment, Level 3
SMARTMUSICTYPE_INTELLIGENTACC4	SmartMusic Marker Type: Intelligent Accompaniment, Level 4
SMARTMUSICTYPE_INTELLIGENTACC5	SmartMusic Marker Type: Intelligent Accompaniment, Level 5
SMARTMUSICTYPE_INTELLIGENTACC6	SmartMusic Marker Type: Intelligent Accompaniment, Level 6
SMARTMUSICTYPE_INTELLIGENTACC7	SmartMusic Marker Type: Intelligent Accompaniment, Level 7
SMARTMUSICTYPE_INTELLIGENTACC8	SmartMusic Marker Type: Intelligent Accompaniment, Level 8
SMARTMUSICTYPE_INTELLIGENTACC9	SmartMusic Marker Type: Intelligent Accompaniment, Level 9
SMARTMUSICTYPE_INTELLIGENTACC10	SmartMusic Marker Type: Intelligent Accompaniment, Level 10
SMARTMUSICTYPE_WAITFORENDOFNOTE	SmartMusic Marker Type: Wait for End of Note
SMARTMUSICTYPE_WAITFORNOTEON	SmartMusic Marker Type: Wait for Note On
SMARTMUSICTYPE_WAITFORFOOTPEDAL	SmartMusic Marker Type: Wait for Foot Pedal
SMARTMUSICTYPE_RESUME	SmartMusic Marker Type: Resume
SMARTMUSICTYPE_RESETTEMPO	SmartMusic Marker Type: Reset Tempo
SMARTMUSICTYPE_OPTIONALOCTAVEUP	SmartMusic Marker Type: Optional Octave Up
SMARTMUSICTYPE_OPTIONALOCTAVEDOWN	SmartMusic Marker Type: Optional Octave Down
SMARTMUSICTYPE_OPTIONALOCTAVEEND	SmartMusic Marker Type: End Optional Octave
SMARTMUSICTYPE_REHEARSALMARK	SmartMusic Marker Type: Rehearsal Mark
SMARTMUSICTYPE_REPEATSTART	SmartMusic Marker Type: Repeat Start
SMARTMUSICTYPE_REPEATEND	SmartMusic Marker Type: Repeat End
SMARTMUSICTYPE_REPEAT_ENDING	SmartMusic Marker Type: Repeat Ending
SMARTMUSICTYPE_REPEAT_DS	SmartMusic Marker Type: Repeat Dal Segno
SMARTMUSICTYPE_REPEAT_DC	SmartMusic Marker Type: Repeat Da Capo
SMARTMUSICTYPE_USEDESCRIPTIONTEXT	SmartMusic Marker Type: Use Description Text
SMARTMUSICTYPE_SMALLBREATH	SmartMusic Marker Type: Small Breath
SMARTMUSICTYPE_LARGEBREATH	SmartMusic Marker Type: Large Breath
SMARTMUSICTYPE_BREATHEND	SmartMusic Marker Type: End Breath Mark
SMARTMUSICTYPE_RESETMEASURECOUNTER	SmartMusic Marker Type: Reset Measure Counter
SMARTMUSICTYPE_ASSESSMENTON	SmartMusic Marker Type: Assessment ON
SMARTMUSICTYPE_ASSESSMENTOFF	SmartMusic Marker Type: Assessment OFF
SMARTMUSICTYPE_SOLOPLAYBACKON	SmartMusic Marker Type: Solo Playback ON
SMARTMUSICTYPE_SOLOPLAYBACKOFF	SmartMusic Marker Type: Solo Playback OFF
SMARTMUSICTYPE_SWINGASSESSMENTON	SmartMusic Marker Type: Swing Assessment OFF
SMARTMUSICTYPE_SWINGASSESSMENTOFF	SmartMusic Marker Type: Swing Assessment OFF

Constructor & Destructor Documentation

FCTextExpressionDef::FCTextExpressionDef ( )

The constructor.

Lua-supported.

Member Function Documentation

bool FCTextExpressionDef::AssignToCategory ( FCCategoryDef * pDef )

Assigns the expression definition to a category.

This goes deeper than just setting the category ID (in terms of controlling the positioning etc), but it does not change the raw text block.

Lua-supported.

Returns: True if successful.

virtual const char* FCTextExpressionDef::ClassName ( )

inlinevirtual

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

Lua-supported.

Reimplemented from __FCNoInciOther.

FCString * FCTextExpressionDef::CreateDescription ( )

Creates a string object that contains the description text.

It's the caller's responsibility to delete the created object from the heap after use.

Lua-supported.

FCEnclosure * FCTextExpressionDef::CreateEnclosure ( )

Loads and creates an enclosure object. It's the caller's responsibility to free the allocated memory from the heap.

Lua-supported.

Returns: NULL if the expression doesn't have an enclosure or if the data couldn't be loaded. Otherwise, a pointer to the enclosure object.

FCString * FCTextExpressionDef::CreateTextString ( )

Gets a pointer to the text expression string, as a string object. If the string is empty, the string object will still be created.

Lua-supported.

Returns: Pointer to the created string object. This object must be deleted from the heap after use.

virtual void FCTextExpressionDef::DebugDump ( )

inlinevirtual

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

bool FCTextExpressionDef::DeepDeleteData ( )

virtual

Reimplemented version of DeepDeleteData() for FCTextExpressionDef objects.

This version deletes the basic text expression def data, the text block, the raw text, and the enclosure.

Lua-supported (through inheritance).

Reimplemented from __FCNoInciOther.

virtual bool FCTextExpressionDef::DeepSaveAs ( CMPER itemno )

inlinevirtual

Reimplemented method that makes a copy of the text string before resaving.

Lua-supported (through inheritance).

Reimplemented from __FCNoInciOther.

bool FCTextExpressionDef::DeleteTextBlock ( )

Removes the expression's text block (including its raw text data block) from Finale's database.

Lua-supported.

bool FCTextExpressionDef::GetBreakMMRest ( ) const

inline

Returns the "Break Multi-measure rest" option in the text expression definition.

Lua-supported (also as property).

twobyte FCTextExpressionDef::GetCategoryID ( ) const

inline

Returns the category ID for the expression definition.

Standard (hard-coded) category IDs:

1 - Dynamics
2 - Tempo Marks
???
6 - Rehearsal Marks

Lua-supported (also as property).

Returns: The category ID.

virtual const PDKFRAMEWORK_CLASSID FCTextExpressionDef::GetClassID ( )

inlinevirtual

Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has problems to resolve the true classes of inherited objects.

This method must be overwritten by all child classes.

Lua-supported.

Implements __FCBaseData.

void FCTextExpressionDef::GetDescription ( FCString * pDescriptionString )

Gets the description text for the text expression definition.

Lua-supported.

twobyte FCTextExpressionDef::GetExecutableShapeID ( ) const

inline

Returns the executable shape ID.

Lua-supported (also as property).

Returns: 0 if no executable shape is used. Otherwise the shape ID.

bool FCTextExpressionDef::GetHideMeasureNumbers ( ) const

inline

Returns true if the rehearsal mark text expression hides the measure numbers.

Lua-supported (also as property).

FCCategoryDef::HORIZ_ALIGNMENT FCTextExpressionDef::GetHorizontalAlignmentPoint ( ) const

inline

Returns the "Horizontal Alignment Point" setting in the text expression definition.

Lua-supported (also as property).

FCCategoryDef::HORIZ_JUSTIFICATION FCTextExpressionDef::GetHorizontalJustification ( ) const

inline

Returns the "Horizontal Justification" setting in the text expression definition.

Lua-supported (also as property).

Returns: Any of the EXPRJUSTIFY_ constants.

twobyte FCTextExpressionDef::GetHorizontalOffset ( ) const

inline

Returns the "Additional Horizontal Offset" value in the text expression definition.

Lua-supported (also as property).

twobyte FCTextExpressionDef::GetPlaybackPass ( ) const

inline

Returns: Returns the specific (1-based) pass number when the expression should play back.

Lua-supported (also as property).

\return 0 if the expression should always play back. Otherwise, the 1-based pass number.

twobyte FCTextExpressionDef::GetPlaybackTempoDuration ( )

inline

For tempo expressions, returns the metronome duration (in EDUs) for the defined playback tempo.

Lua-supported.

Returns
0 if the tempo is not used or set.

twobyte FCTextExpressionDef::GetPlaybackTempoValue ( )

inline

For tempo expressions, returns the playback tempo value.

Lua-supported.

Returns: 0 if the tempo is not used or set.

REHEARSALMARK_STYLES FCTextExpressionDef::GetRehearsalMarkStyle ( ) const

inline

Returns the rehearsal mark numbering style.

Lua-supported (also as property).

Returns: Any of the REHMARKSTYLE_ constants. REHMARKSTYLE_MANUAL (=0) if no rehearsal mark numbering style is used.

FCTextExpressionDef::SMARTMUSIC_MARKER_TYPES FCTextExpressionDef::GetSmartMusicMarkerType ( ) const

Returns the SmartMusic Marker type.

Returns: Any of the SMARTMUSICTYPE_ defines.

CMPER FCTextExpressionDef::GetTextBlockID ( )

Returns the text block ID (for use with FCTextBlock).

twobyte FCTextExpressionDef::GetTextID ( ) const

inline

Returns the text ID for the expression text. For use with the FCTextBlock class.

Lua-supported (also as read-only).

bool FCTextExpressionDef::GetUseCategoryFont ( ) const

Returns true if the expression is marked to use the category font.

Lua-supported (also as property).

bool FCTextExpressionDef::GetUseCategoryPos ( ) const

Returns true if the expression is marked to use the category positioning.

Lua-supported (also as property).

bool FCTextExpressionDef::GetUseEnclosure ( ) const

inline

Returns true if the text expression uses an enclosure.

Lua-supported (also as property).

bool FCTextExpressionDef::GetUseExecutableShape ( ) const

inline

Returns true if an executable is used for the expression def.

Lua-supported (also as property).

FCCategoryDef::VERT_ALIGNMENT FCTextExpressionDef::GetVerticalAlignmentPoint ( ) const

inline

Returns the vertical alignment point for the expression definition positioning.

Lua-supported (also as property).

twobyte FCTextExpressionDef::GetVerticalBaselineOffset ( ) const

inline

Returns the vertical "Additional Baseline Offset" in the text expression definition.

Lua-supported (also as property).

twobyte FCTextExpressionDef::GetVerticalEntryOffset ( ) const

inline

Returns the vertical "Additional Entry Offset" in the text expression definition.

Lua-supported (also as property).

bool FCTextExpressionDef::IsAutoRehearsalMark ( ) const

inline

Returns true if an automatic rehearsal number style is used.

Lua-supported (also as property).

bool FCTextExpressionDef::IsPlaybackTempo ( ) const

inline

Returns true if the expression is defined for tempo playback.

Lua-supported (also as property).

bool FCTextExpressionDef::IsSmartMusicMarker ( ) const

inline

Returns true if the text expression's playback style is defined as a SmartMusic marker.

Lua-supported.

bool FCTextExpressionDef::MakeRehearsalMark	(	FCString *	pString,
		int	measure
	)

Creates an automatic rehearsal string based on the definition and a measure.

This method doesn't create anything connected directly to expression data.

Lua-supported.

Parameters

pString	Pointer to the string object that should contain the result.
measure	the measure number

Returns: True if succesful.

bool FCTextExpressionDef::SaveNewTextBlock ( FCString * pString )

Saves a new raw text block (both a raw text and the connected text block) and assigns it to the expression definition. This does not save the expression definition, which needs to be saved separately afterwards.

Lua-supported.

bool FCTextExpressionDef::SaveTextString ( FCString * pString )

Resaves the text for an existing text expression.

Since the text is saved separately to the definition, the expression definition doesn't need to be resaved afterwards.

Lua-supported.

void FCTextExpressionDef::SetBreakMMRest ( bool state )

inline

Sets the "Break Multi-measure rest" option in the text expression definition.

Lua-supported (also as property).

void FCTextExpressionDef::SetCategoryID ( twobyte ID )

inline

Sets the category ID for the expression definition.

Lua-supported (also as property).

Parameters

ID	The new category ID.

void FCTextExpressionDef::SetDescription ( FCString * pDescriptionString )

Sets the description text for the text expression definition.

Lua-supported.

void FCTextExpressionDef::SetExecutableShapeID ( twobyte shapeID )

inline

Sets the executable shape ID for the expression def.

Setting the shape to 0 can be used to clear the use of executable shape.

Lua-supported (also as property).

void FCTextExpressionDef::SetHideMeasureNumbers ( bool value )

inline

Sets if the rehearsal mark text expression hides the measure numbers or not.

Lua-supported (also as property).

void FCTextExpressionDef::SetHorizontalAlignmentPoint ( FCCategoryDef::HORIZ_ALIGNMENT value )

inline

Sets the "Horizontal Alignment Point" setting in the text expression definition.

Lua-supported (also as property).

void FCTextExpressionDef::SetHorizontalJustification ( FCCategoryDef::HORIZ_JUSTIFICATION value )

inline

Sets the "Horizontal Justification" in the text expression definition.

Lua-supported (also as property).

Parameters

value Any of the EXPRHORIZ_ constants.

void FCTextExpressionDef::SetHorizontalOffset ( twobyte value )

inline

Sets the "Additional Horizontal Offset" in the text expression definition.

Lua-supported (also as property).

void FCTextExpressionDef::SetPlaybackController	(	twobyte	controllernumber,
		twobyte	value
	)

inline

Sets the playback to a specific MIDI CC controller.

Lua-supported.

void FCTextExpressionDef::SetPlaybackPass ( twobyte value )

inline

Returns: Sets the specific (1-based) pass number when the expression should play back.

Lua-supported (also as property).

\param value 0 if the expression should always play back. Otherwise, the 1-based pass number.

void FCTextExpressionDef::SetPlaybackTempo	(	TimeEdu32	eduduration,
		int	tempo
	)

inline

Sets the playback tempo style for the expression definition.

Lua-supported.

void FCTextExpressionDef::SetRehearsalMarkStyle ( REHEARSALMARK_STYLES value )

inline

Sets the rehearsal mark numbering style.

Lua-supported (also as property).

Parameters

value Any of the REHMARKSTYLE_ constants. REHMARKSTYLE_MANUAL (=0) if no rehearsal mark numbering style is used.

void FCTextExpressionDef::SetSmartMusicMarkerType ( FCTextExpressionDef::SMARTMUSIC_MARKER_TYPES value )

Sets the SmartMusic Marker type.

Parameters

value Any of the SMARTMUSICTYPE_ defines.

void FCTextExpressionDef::SetUseCategoryFont ( bool value )

Sets if the "use category font" should be checked or not.

Only works in Finale 2012 and later. (Trying to use it in earlier versions seems to to mess up the "Additional Baseline Offset" value.) CHANGE 2013-04-15: Now enabled in pre-2012 as well if run on the Fin2010 PDK.

Lua-supported (also as property).

void FCTextExpressionDef::SetUseCategoryPos ( bool value )

Sets if the "use category positioning" should be checked or not.

Only works in Finale 2012 and later. (Trying to use it in earlier versions seems to to mess up the "Additional Baseline Offset" value.) CHANGE 2013-04-15: Now enabled in pre-2012 as well if run on the Fin2010 PDK.

Lua-supported (also as property).

void FCTextExpressionDef::SetUseEnclosure ( bool value )

inline

Sets if the text expression uses an enclosure or not.

Lua-supported (also as property).

void FCTextExpressionDef::SetUseExecutableShape ( bool state )

inline

Sets the use of executable shape. Normally this isn't called directly. Instead, use SetExecutableShapeID.

Lua-supported (also as property).

void FCTextExpressionDef::SetVerticalAlignmentPoint ( FCCategoryDef::VERT_ALIGNMENT value )

inline

Sets the vertical alignment point for the expression definition positioning.

Lua-supported (also as property).

void FCTextExpressionDef::SetVerticalBaselineOffset ( twobyte value )

inline

Sets the vertical "Additional Baseline Offset" in the text expression definition.

Lua-supported (also as property).

void FCTextExpressionDef::SetVerticalEntryOffset ( twobyte value )

inline

Sets the vertical "Additional Entry Offset" in the text expression definition.

Lua-supported (also as property).

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation