Finale PDK Framework 0.77
Power Up Your Finale Music Software
Loading...
Searching...
No Matches
FCTextExpressionDef Class Reference

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  EXPR_PLAYBACK_TYPES {
  EXPPLAYTYPE_UNKNOWN = 0 , EXPPLAYTYPE_KEYVELOCITY = 1 , EXPPLAYTYPE_TEMPO = 2 , EXPPLAYTYPE_CONTROLLER = 3 ,
  EXPPLAYTYPE_TRANSPOSE = 4 , EXPPLAYTYPE_MIDIDUMP = 5 , EXPPLAYTYPE_MIDICHANNEL = 6 , EXPPLAYTYPE_RESTRIKEKEYS = 7 ,
  EXPPLAYTYPE_PLAYTEMPOTOOL = 8 , EXPPLAYTYPE_IGNORETEMPOTOOL = 9 , EXPPLAYTYPE_PATCHCHANGE = 10 , EXPPLAYTYPE_CHANNELPRESSURE = 11 ,
  EXPPLAYTYPE_PITCHWHEEL = 12 , EXPPLAYTYPE_PERCUSSIONMAP = 13 , EXPPLAYTYPE_SWING = 14 , EXPPLAYTYPE_HUMANPLAYBACKON = 15 ,
  EXPPLAYTYPE_HUMANPLAYBACKOFF = 16 , EXPPLAYTYPE_NONE = 100
}
 Return values for the GetPlaybackType method. More...
 
- Public Types inherited from __FCBase
enum  PDKFRAMEWORK_CLASSID {
  FCID_UNKNOWN = 0 , FCID_ACCIDENTALMOD , FCID_ACTIVELYRIC , FCID_ALLOTMENT ,
  FCID_ARTICULATION , FCID_ARTICULATIONDEF , FCID_BACKWARDREPEAT , FCID_BASELINE ,
  FCID_BEAMMOD , FCID_BEATCHARTELEMENT , FCID_BOOKMARK , FCID_BROKENBEAMMOD ,
  FCID_CATEGORYDEF , FCID_CELLCLEFCHANGE , FCID_CELLFRAMEHOLD , FCID_CELLGRAPHIC ,
  FCID_CELLTEXT , FCID_CENTERSMARTSHAPE , FCID_CHORD , FCID_CHORDPREFS ,
  FCID_CHORDSUFFIXELEMENT , FCID_CHORUSSYLLABLE , FCID_CLEFDEF , FCID_COMPOSITETIMESIGBOTTOMELEMENT ,
  FCID_COMPOSITETIMESIGTOPELEMENT , FCID_CROSSSTAFFMOD , FCID_CUSTOMSMARTLINEDEF , FCID_CUSTOMSTEMMOD ,
  FCID_DISTANCEPREFS , FCID_DOTMOD , FCID_ENCLOSURE , FCID_ENDINGREPEAT ,
  FCID_ENIGMATEXTSTYLE , FCID_ENTRYALTERMOD , FCID_EXECUTABLESHAPEDEF , FCID_EXPRESSION ,
  FCID_FONTINFO , FCID_FONTPREFS , FCID_FREEZESYSTEM , FCID_FRETBOARDSTYLEDEF ,
  FCID_FRETBOARDSTYLEDEFS , FCID_FRETBOARDGROUPDEF , FCID_FRETBOARDGROUPDEFS , FCID_FRETINSTRUMENTDEF ,
  FCID_GENERALPREFS , FCID_GRIDSGUIDESPREFS , FCID_GROUP , FCID_GROUPNAMEPOSITIONPREFS ,
  FCID_HUMANPLAYBACKPREFS , FCID_INDEPENDENTCELLDETAIL , FCID_INSTRUMENTDEF , FCID_INSTRUMENTPLAYBACKDATA ,
  FCID_KEYMODEDEF , FCID_KEYSIGNATURE , FCID_LAYERPREFS , FCID_LYRICSBASELINE ,
  FCID_LYRICSPREFS , FCID_MEASURE , FCID_MEASURENUMBERREGION , FCID_METATOOLASSIGNMENT ,
  FCID_MIDIEXPRESSION , FCID_MISCDOCPREFS , FCID_MULTIMEASUREREST , FCID_MULTIMEASURERESTPREFS ,
  FCID_MULTISTAFFINSTRUMENT , FCID_MULTISTAFFINSTRUMENTS , FCID_MUSICCHARACTERPREFS , FCID_MUSICSPACINGPREFS ,
  FCID_NUMBER , FCID_NOTEHEADMOD , FCID_OTHERINCI , FCID_PERCUSSIONLAYOUTNOTE ,
  FCID_PERCUSSIONSTAFF , FCID_PERFORMANCEMOD , FCID_PAGE , FCID_PAGEFORMATPREFS ,
  FCID_PAGEGRAPHIC , FCID_PAGETEXT , FCID_PART , FCID_PARTEXTRACTPREFS ,
  FCID_PARTSCOPEPREFS , FCID_PARTSTAFFVOICING , FCID_PERCUSSIONNOTEMOD , FCID_PIANOBRACEPREFS ,
  FCID_PLAYBACKPREFS , FCID_RAWTEXT , FCID_REPEATPREFS , FCID_SECONDARYBEAMBREAKMOD ,
  FCID_BEAMEXTENSIONMOD , FCID_SECTIONSYLLABLE , FCID_SEPARATEMEASURENUMBER , FCID_SEPARATEPLACEMENT ,
  FCID_SHAPEDEF , FCID_SHAPEEXPRESSIONDEF , FCID_SLURCONTOURPREFS , FCID_SIZEPREFS ,
  FCID_SMARTSHAPE , FCID_SMARTSHAPEENTRYMARK , FCID_SMARTSHAPEMEASUREMARK , FCID_SMARTSHAPEPREFS ,
  FCID_STAFF , FCID_STAFFLIST , FCID_STAFFNAMEPOSITION , FCID_STAFFNAMEPOSITIONPREFS ,
  FCID_STAFFSTYLEASSIGN , FCID_STAFFSTYLEDEF , FCID_STAFFSYSTEM , FCID_STEMCONNECTIONTABLE ,
  FCID_STEMMOD , FCID_STRING , FCID_SYLLABLEENTRYMOD , FCID_SYSTEMSTAFF ,
  FCID_TABLATURENOTEMOD , FCID_TEMPOELEMENT , FCID_TEXTBLOCK , FCID_TEXTEXPRESSIONDEF ,
  FCID_TEXTREPEAT , FCID_TEXTREPEATDEF , FCID_TIEMOD , FCID_TIEPREFS ,
  FCID_TIECONTOURPREFS , FCID_TIEPLACEMENTPREFS , FCID_TIMESIGNATURE , FCID_TUPLET ,
  FCID_TUPLETPREFS , FCID_VERSESYLLABLE
}
 Constants for the GetClassID method. More...
 
enum  MEASUREMENTUNITS {
  MEASUREMENTUNIT_DEFAULT = UNIT_DEFAULT , MEASUREMENTUNIT_EVPUS = UNIT_EVPUS , MEASUREMENTUNIT_INCHES = UNIT_INCHES , MEASUREMENTUNIT_CENTIMETERS = UNIT_CENTS ,
  MEASUREMENTUNIT_POINTS = UNIT_POINTS , MEASUREMENTUNIT_PICAS = UNIT_PICAS , MEASUREMENTUNIT_SPACES = UNIT_SPACES , MEASUREMENTUNIT_MILLIMETERS = 100
}
 Constants for Finale's standard measurement units. More...
 

Public Member Functions

const char * ClassName () const override
 Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child class.
 
const PDKFRAMEWORK_CLASSID GetClassID () const override
 Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has problems to resolve the true classes of inherited objects.
 
 FCTextExpressionDef ()
 The constructor.
 
virtual ~FCTextExpressionDef ()
 The destructor.
 
bool DeepSaveAs (CMPER itemno) override
 Reimplemented method that makes a copy of the text string before resaving.
 
bool DeepDeleteData () override
 Reimplemented version of DeepDeleteData() for FCTextExpressionDef objects.
 
CMPER GetTextBlockID ()
 Returns the text block ID (for use with FCTextBlock).
 
EXPR_PLAYBACK_TYPES GetPlaybackType () const
 Returns the playback type for the expression def.
 
void SetPlaybackType (EXPR_PLAYBACK_TYPES playbackmode)
 Sets the playback type for the expression def.
 
bool GetUseExecutableShape () const
 Returns true if an executable is used for the expression def.
 
twobyte GetExecutableShapeID () const
 Returns the executable shape ID.
 
void SetExecutableShapeID (twobyte shapeID)
 Sets the executable shape ID for the expression def.
 
void SetUseExecutableShape (bool state)
 Sets the use of executable shape. Normally this isn't called directly. Instead, use SetExecutableShapeID.
 
bool GetHideMeasureNumbers () const
 Returns true if the rehearsal mark text expression hides the measure numbers.
 
void SetHideMeasureNumbers (bool value)
 Sets if the rehearsal mark text expression hides the measure numbers or not.
 
bool GetUseEnclosure () const
 Returns true if the text expression uses an enclosure.
 
void SetUseEnclosure (bool value)
 Sets if the text expression uses an enclosure or not.
 
twobyte GetCategoryID () const
 Returns the category ID for the expression definition.
 
twobyte GetTextID () const
 Returns the text ID for the expression text. For use with the FCTextBlock class.
 
twobyte GetPlaybackTempoValue ()
 For tempo expressions, returns the playback tempo value.
 
twobyte GetPlaybackTempoDuration ()
 For tempo expressions, returns the metronome duration (in EDUs) for the defined playback tempo.
 
twobyte GetPlaybackPass () const
 
void SetPlaybackPass (twobyte value)
 Sets the specific (1-based) pass number when the expression should play back.
 
twobyte GetPlaybackKeyVelocity () const
 Returns the key velocity value (if the playback type is key velocity).
 
void SetPlaybackKeyVelocity (twobyte value)
 Sets the playback mode to key velocity and changes the key velocity value.
 
FCCategoryDef::VERT_ALIGNMENT GetVerticalAlignmentPoint () const
 Returns the vertical alignment point for the expression definition positioning.
 
twobyte GetVerticalBaselineOffset () const
 Returns the vertical "Additional Baseline Offset" in the text expression definition.
 
twobyte GetVerticalEntryOffset () const
 Returns the vertical "Additional Entry Offset" in the text expression definition.
 
REHEARSALMARK_STYLES GetRehearsalMarkStyle () const
 Returns the rehearsal mark numbering style.
 
void SetRehearsalMarkStyle (REHEARSALMARK_STYLES value)
 Sets the rehearsal mark numbering style.
 
bool GetBreakMMRest () const
 Returns the "Break Multi-measure rest" option in the text expression definition.
 
void SetBreakMMRest (bool state)
 Sets the "Break Multi-measure rest" option in the text expression definition.
 
void SetCategoryID (twobyte ID)
 Sets the category ID for the expression definition.
 
void SetUseCategoryFont (bool value)
 Sets if the "use category font" should be checked or not.
 
void SetUseCategoryPos (bool value)
 Sets if the "use category positioning" checkbox should be checked or not.
 
twobyte GetPlaybackControllerValue () const
 returns the playback controller value.
 
twobyte GetPlaybackControllerNumber () const
 returns the playback MIDI controller number.
 
void SetPlaybackController (twobyte controllernumber, twobyte value)
 Sets the playback to a specific MIDI CC controller.
 
void SetPlaybackTempo (TimeEdu32 eduduration, int tempo)
 Sets the playback tempo type for the expression definition.
 
twobyte GetPlaybackTransposition () const
 Returns the playback transposition in half-steps.
 
void SetPlaybackTransposition (twobyte halfsteps)
 Sets the playback transposition type for the expression definition.
 
twobyte GetPitchWheelValue () const
 Returns the pitchwheel value.
 
void SetPitchWheelValue (twobyte value)
 Sets the playback MIDI pitchwheel type] for the expression definition.
 
void SetVerticalAlignmentPoint (FCCategoryDef::VERT_ALIGNMENT value)
 Sets the vertical alignment point for the expression definition positioning.
 
void SetVerticalBaselineOffset (twobyte value)
 Sets the vertical "Additional Baseline Offset" in the text expression definition.
 
void SetVerticalEntryOffset (twobyte value)
 Sets the vertical "Additional Entry Offset" in the text expression definition.
 
FCCategoryDef::HORIZ_JUSTIFICATION GetHorizontalJustification () const
 Returns the "Horizontal Justification" setting in the text expression definition.
 
void SetHorizontalJustification (FCCategoryDef::HORIZ_JUSTIFICATION value)
 Sets the "Horizontal Justification" in the text expression definition.
 
FCCategoryDef::HORIZ_ALIGNMENT GetHorizontalAlignmentPoint () const
 Returns the "Horizontal Alignment Point" setting in the text expression definition.
 
void SetHorizontalAlignmentPoint (FCCategoryDef::HORIZ_ALIGNMENT value)
 Sets the "Horizontal Alignment Point" setting in the text expression definition.
 
twobyte GetHorizontalOffset () const
 Returns the "Additional Horizontal Offset" value in the text expression definition.
 
void SetHorizontalOffset (twobyte value)
 Sets the "Additional Horizontal Offset" in the text expression definition.
 
FCStringCreateTextString ()
 Gets a pointer to the text expression string, as a string object. If the string is empty, the string object will still be created.

 
FCEnclosureCreateEnclosure ()
 Loads and creates an enclosure object. It's the caller's responsibility to free the allocated memory from the heap.
 
bool IsPlaybackTempo () const
 Returns true if the expression is defined for tempo playback.
 
bool IsSmartMusicMarker () const
 Returns true if the text expression's playback style is defined as a SmartMusic marker. Note: Classic SmartMusic support was removed from Finale. Do not use.
 
bool IsKeyVelocity () const
 Returns true if the text expression's playback style is defined as key velocity.

 
bool IsAutoRehearsalMark () const
 Returns true if an automatic rehearsal number style is used.
 
bool MakeRehearsalMark (FCString *pString, int measure)
 Creates an automatic rehearsal string based on the definition and a measure.
 
bool SaveTextString (FCString *pString)
 Resaves the text for an existing text expression.
 
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.
 
bool DeleteTextBlock ()
 Removes the expression's text block (including its raw text data block) from Finale's database.
 
bool AssignToCategory (FCCategoryDef *pDef)
 Assigns the expression definition to a category.
 
bool GetUseCategoryFont () const
 Returns true if the expression is marked to use the category font.
 
bool GetUseCategoryPos () const
 Returns true if the expression is marked to use the category positioning.
 
void SetDescription (FCString *pDescriptionString)
 Sets the description text for the text expression definition.
 
void GetDescription (FCString *pDescriptionString)
 Gets the description text for the text expression definition.
 
FCStringCreateDescription ()
 Creates a string object that contains the description text.
 
void DebugDump () override
 Outputs the class data/information for debugging purposes.
 
- Public Member Functions inherited from __FCNoInciOther
 __FCNoInciOther ()
 The constructor.
 
virtual bool Load (CMPER itemno)
 Loads the indicated item.
 
bool Reload () override
 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.
 
virtual bool SaveNew ()
 Creates the data as completely new item number. The object will now be connected to the new item number.
 
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.
 
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).
 
bool LoadFirst () override
 Loads the first element of 1-based data.
 
- 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.
 
- Public Member Functions inherited from __FCBaseData
EDOCID GetConnectedDocID () const
 Returns the document ID that was connected to the last load/save of the data.
 
bool VerifyConnectedDocID ()
 Checks that the stored document ID for the data object matches the current document's ID.
 
virtual EXTAG Tag () const =0
 The Enigma tag for the derived class.
 
virtual EVERSION EnigmaVersion () const
 The Enigma version for save/load/create/delete operations.
 
virtual int DataSizeLoad () const =0
 Returns the data size for the data structure that should be loaded.
 
virtual int DataSizeSave () const
 Returns the data size for the data structure that should be saved or created.
 
void _CloneFrom (__FCBaseData *pSource)
 For internal use only. Copies object data (except data block) from another object.
 
virtual void CloneMemoryFrom (__FCBaseData *pSource)
 
const EDataID * _GetDataID ()
 Intended ONLY for the _CloneFrom implementation.
 
int _GetLoadedSize () const
 Intended ONLY for the _CloneFrom implementation.
 
const void * GetDataBlock ()
 Intended ONLY for the _CloneFrom implementation.
 
EXTAG GetCustomTag () const
 Returns the custom Enigma tag, if any.
 
void SetCustomTag (EXTAG tag)
 Sets the custom Enigma tag, for classes that support multiple Enigma tags.
 
 __FCBaseData ()
 The constructor.
 
virtual ~__FCBaseData ()
 Virtual destructor.
 
virtual bool Save ()
 Saves the currently loaded to its current location.
 
virtual bool DeleteData ()
 Deletes the associated data from Finale's database. Be careful when deleting multiple objects.
 
virtual bool LoadLast ()
 Loads the very last element in the database, if any.
 
virtual bool LoadNext ()
 Loads the next element from the database, if any.
 
virtual bool LoadPrevious ()
 Loads the previous element in the database, if any.
 
bool RelinkToCurrentView ()
 Relinks the contents in the current view so that the score and part(s) match.
 
bool RelinkToScore ()
 Relinks all parts to the contents of the score.
 
__FCBaseDataCreateClone ()
 Creates an identical copy of an object.
 
void DebugDataDump () override
 Outputs a memory dump of the data block in the object for debugging purposes.
 
void DebugDataByteArrayDump () override
 Outputs a memory dump of the data block in the object for debugging purposes, as a C++ byte array.
 
void DebugDataOffsetDump (int offset, int size)
 For debug mode only. Dumps a data memory block at a specific offset and with a specific size.
 
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.
 
- Public Member Functions inherited from __FCBase
virtual ~__FCBase ()
 Virtual destructor, so all inherited classes get the virtual destructor.
 
void DebugMsgInt (const char *pszPrefixText, int i)
 Creates a simple Message Box for debug purposes. The text appears with the extra digit (in decimal presentation) appearing afterwards.
 
void DebugMsgHex (const char *pszPrefixText, int i)
 Creates a simple Message Box for debug purposes. The text appears with the extra digit (as a hexadecimal number) appearing afterwards.
 
void DebugMsgString (const char *pszPrefixText, const char *thestring)
 Creates a simple Message Box for debug purposes. The text appears with the extra string appearing afterwards.
 
void DebugMsg (const char *pszMsg)
 Creates a simple Message Box for debug purposes with just one text string.
 
void DebugOutMenuInfo (FCUI *pUI, int menuixd_horiz, int menuixd_vert) const
 Outputs the menu command info for debugging purposes.
 
int DebugOutFormat (const char *fmt,...)
 Outputs debug text using C style "printf" syntax.
 
void Set16BitFlag (FLAG_16 *flag, FLAG_16 flagbits, bool state)
 Sets a 16 bit flag.
 
void Set32BitFlag (FLAG_32 *flag, FLAG_32 flagbits, bool state)
 Sets/resets a 32 bit flag, by using a bit mask.
 
bool GetBitFlag (FLAG_32 flag, FLAG_32 flagbits) const
 Gets a state from flag bits. Returns true if any bit in the mask is set.
 
int GetBitCount (FLAG_32 flag)
 Returns the total number of set bits in a 32-bit unsigned int.
 
void SetSpecific32Bit (FLAG_32 *flag, int bitnumber, bool state)
 Sets/resets a single bit in a 32 bit flag, by specifying one specific bit.
 
void SetUserData (void *pData)
 Sets the user data attached to the instance of an object.
 
void SetUserData2 (void *pData)
 Sets the additional user data attached to the instance of an object.
 
void * GetUserData () const
 Gets the user data attached to the instance of an object.
 
void * GetUserData2 () const
 Gets the additional user data attached to the instance of an object.
 
virtual bool IsIdentical (const __FCBase *pCompareObject) const
 Returns true if the data in the passed object is considered to be identical to the current object, otherwise false.
 
void StoreXML_String (tinyxml2::XMLElement *pParentNode, const char *pszElementName, FCString *pStringValue)
 Helper function to store FCString objects in the XML file.
 
void StoreXML_Integer (tinyxml2::XMLElement *pParentNode, const char *pszElementName, int value)
 Helper function to store integer objects in the XML file.
 
void StoreXML_Bool (tinyxml2::XMLElement *pParentNode, const char *pszElementName, bool value)
 Helper function to store boolean objects in the XML file.
 
void StoreXML_StringAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, FCString *pStringValue)
 Helper function to store FCString objects in the XML file, as an attribute to a node.
 
void StoreXML_IntegerAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, int value)
 Helper function to store integer objects in the XML file, as an attribute to a node.
 
void StoreXML_BoolAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, bool value)
 Helper function to store boolean objects in the XML file, as an attribute to a node.
 
void StoreXML_FloatAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, float value)
 Helper function to store floating point objects in the XML file, as an attribute to a node.
 
virtual void StoreToXML (tinyxml2::XMLElement *pParentNode)
 Virtual method that is used to store an object's data.
 
bool ReadXML_String (tinyxml2::XMLElement *pParentNode, const char *pszElementName, FCString *pStringValue)
 Helper method to read FCString objects from the XML file.
 
bool ReadXML_Integer (tinyxml2::XMLElement *pParentNode, const char *pszElementName, int *pValue)
 Helper method to read integer objects from the XML file.
 
bool ReadXML_Bool (tinyxml2::XMLElement *pParentNode, const char *pszElementName, bool *pValue)
 Helper method to read boolean objects from the XML file.
 
bool ReadXML_StringAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, FCString *pStringValue)
 Helper method to read FCString objects from the XML file, as an attribute to a node.
 
bool ReadXML_IntegerAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, int *pValue)
 Helper method to read integer objects from the XML file, as an attribute to a node.
 
bool ReadXML_BoolAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, bool *pValue)
 Helper method to read boolean objects from the XML file, as an attribute to a node.
 
bool ReadXML_FloatAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, float *pValue)
 Helper method to read floating point objects from the XML file, as an attribute to a node.
 
virtual bool ReadFromXML (tinyxml2::XMLElement *pParentNode)
 Virtual method that is used to read object data.
 

Additional Inherited Members

- Static Public Member Functions inherited from __FCBase
static void DebugOutPtr (const char *pszPrefixText, void *ptr)
 Static method that outputs a line for debugging purposes. The prefix text appears with the extra ptr (in hexadeximal representation) appearing afterwards.
 
static void DebugOutInt (const char *pszPrefixText, int i)
 Static method that outputs a line for debugging purposes. The text appears with the extra digit (in decimal presentation) appearing afterwards.
 
static void DebugOutFloat (const char *pszPrefixText, double f)
 Static method that outputs a line for debugging purposes. The text appears with the extra float value appearing afterwards.
 
static void DebugOutTag (const char *pszPrefixText, EXTAG extag)
 Static method that outputs a line for debugging purposes. The text appears with the EXTAG (in text) appearing afterwards.
 
static void DebugOutHex (const char *pszPrefixText, int i)
 Static method that outputs a line for debugging purposes. The text appears with the extra digit (in hexadecimal presentation) appearing afterwards.
 
static void DebugOutBin (const char *pszPrefixText, int i)
 Static method that outputs a line for debugging purposes. The text appears with the extra digit (in binary presentation) appearing afterwards.
 
static void DebugOutString (const char *pszPrefixText, const char *thestring)
 Static method that outputs a line for debugging purposes (C string version). The text appears with the extra string appearing afterwards.
 
static void DebugOutString (const char *pszPrefixText, FCString *pString)
 Static method that outputs a line for debugging purposes (FCString version). The text appears with the extra string appearing afterwards.
 
static void DebugOutBool (const char *pszPrefixText, bool state)
 Static method that outputs a line for debugging purposes. The boolean state appears afterwards as either "TRUE" or "FALSE".
 
static void DebugOutBlock (const void *pBuffer, int startoffset, int size)
 Static method that outputs a memory block for debugging purposes. Eight bytes per line will appear (as hex digits) until the whole memory block is dumped.
 
static void DebugOutByteArrayBlock (const void *pBuffer, int startoffset, int size)
 Static method that outputs a memory block for debugging purposes. Eight bytes per line will appear (as hex digits) as a C++ onebyte array, until the whole memory block is dumped.
 
static void DebugOut (const char *pszLine)
 Static method to output a line of text for debugging purposes.
 
- Protected Member Functions inherited from __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!
 
virtual __FCBaseDataCreateObject ()=0
 Creates a new instance of the object.
 
bool DataIsLoaded () const
 Returns true is any data has been loaded into the object.
 
void _TagDocumentID ()
 For internal use only.
 
- Protected Member Functions inherited from __FCBase
 __FCBase ()
 The constructor.
 
- Protected Attributes inherited from __FCBaseData
EDOCID _connecteddocID
 The "connected" document ID., which is the document the where the document was loaded (or last saved). This is for a mechanism to prevent resaving of certain data in other documents.
 
void * _datablock
 Pointer to the object's data block, the meaning is implementation-specific for each derived subclass.
 
bool _heapdatablock
 Variable that tells if _datablock is dynamically created on the heap (and should be deleted at object destruction).
 
int _loadedsize
 Loaded size of the data block for a loaded object, in bytes. Since the datablock is implementation-specific, the _loadedsize should be updated by child classes that create new data.
 
EDataID _dataid
 The EdataID for the last loaded/saved object.
 

Detailed Description

Class for a text expression definition.

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

Member Enumeration Documentation

◆ EXPR_PLAYBACK_TYPES

Return values for the GetPlaybackType method.

Setting is restricted on some of these values. See the notes in the decription of each enumerated constant for more details. If not otherwise noted, you can use SetPlaybackType to change the playback type of the expression.

Lua-supported (0.55)

Enumerator
EXPPLAYTYPE_UNKNOWN 

Used for unknown playback types.

EXPPLAYTYPE_KEYVELOCITY 

Key Velocity (Use SetPlaybackKeyVelocity to set.)

EXPPLAYTYPE_TEMPO 

Tempo (Use SetPlaybackTempo to set.)

EXPPLAYTYPE_CONTROLLER 

MIDI Controller (Use SetPlaybackController to set.)

EXPPLAYTYPE_TRANSPOSE 

Transposition (Use SetPlaybackTransposition to set.)

EXPPLAYTYPE_MIDIDUMP 

MIDI Dump (Set not supported.)

EXPPLAYTYPE_MIDICHANNEL 

MIDI Channel (Set not supported.)

EXPPLAYTYPE_RESTRIKEKEYS 

Restrike Keys (Set not supported.)

EXPPLAYTYPE_PLAYTEMPOTOOL 

Play Tempo Tool Changes

EXPPLAYTYPE_IGNORETEMPOTOOL 

Ignore Tempo Tool Changes

EXPPLAYTYPE_PATCHCHANGE 

MIDI Patch Change (Set not supported.)

EXPPLAYTYPE_CHANNELPRESSURE 

MIDI Channel Pressure (Set not supported.)

EXPPLAYTYPE_PITCHWHEEL 

MIDI Pitch Wheel (Use SetPitchWheelValue to set.)

EXPPLAYTYPE_PERCUSSIONMAP 

Percussion MIDI Map (Set not supported.)

EXPPLAYTYPE_SWING 

Swing (Set not supported.)

EXPPLAYTYPE_HUMANPLAYBACKON 

Human Playback On

EXPPLAYTYPE_HUMANPLAYBACKOFF 

Human Playback Off

EXPPLAYTYPE_NONE 

None

◆ 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

Constructor & Destructor Documentation

◆ FCTextExpressionDef()

FCTextExpressionDef::FCTextExpressionDef ( )

The constructor.

Lua-supported.

Member Function Documentation

◆ AssignToCategory()

bool FCTextExpressionDef::AssignToCategory ( FCCategoryDef * pDef)

Assigns the expression definition to a category.

This is a deep assignment to the category. The positioning is changed to match the category positioning, and the expression is changed to use both category font and positioning. However, the function does not change the font in the raw text block.

If you simply want to put an expression in the category without changing anything about the expression, use SetCategoryID. Just be sure call SetUseCategoryPos and SetUseCategoryFont appropriately when you do so.

Lua-supported.

Returns
True if successful.

◆ ClassName()

const char * FCTextExpressionDef::ClassName ( ) const
inlineoverridevirtual

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

Lua-supported.

Reimplemented from __FCNoInciOther.

◆ CreateDescription()

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.

◆ CreateEnclosure()

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.

◆ CreateTextString()

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.

◆ DebugDump()

void FCTextExpressionDef::DebugDump ( )
inlineoverridevirtual

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.

◆ DeepDeleteData()

bool FCTextExpressionDef::DeepDeleteData ( )
overridevirtual

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.

◆ DeepSaveAs()

bool FCTextExpressionDef::DeepSaveAs ( CMPER itemno)
inlineoverridevirtual

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

Lua-supported (through inheritance).

Reimplemented from __FCNoInciOther.

◆ DeleteTextBlock()

bool FCTextExpressionDef::DeleteTextBlock ( )

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

Lua-supported.

◆ GetBreakMMRest()

bool FCTextExpressionDef::GetBreakMMRest ( ) const
inline

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

Lua-supported (also as property).

◆ GetCategoryID()

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.

◆ GetClassID()

const PDKFRAMEWORK_CLASSID FCTextExpressionDef::GetClassID ( ) const
inlineoverridevirtual

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

This method must be overwritten by all child classes.

Lua-supported (also read-only property) (0.55).

Implements __FCBaseData.

◆ GetDescription()

void FCTextExpressionDef::GetDescription ( FCString * pDescriptionString)

Gets the description text for the text expression definition.

Lua-supported.

◆ GetExecutableShapeID()

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.

◆ GetHideMeasureNumbers()

bool FCTextExpressionDef::GetHideMeasureNumbers ( ) const
inline

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

Lua-supported (also as property).

◆ GetHorizontalAlignmentPoint()

FCCategoryDef::HORIZ_ALIGNMENT FCTextExpressionDef::GetHorizontalAlignmentPoint ( ) const
inline

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

Lua-supported (also as property).

◆ GetHorizontalJustification()

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.

◆ GetHorizontalOffset()

twobyte FCTextExpressionDef::GetHorizontalOffset ( ) const
inline

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

Lua-supported (also as property).

◆ GetPitchWheelValue()

twobyte FCTextExpressionDef::GetPitchWheelValue ( ) const
inline

Returns the pitchwheel value.

The possible values are -8192 through 8192. Rest position is 0.

Lua-supported (0.65).

Returns
Pitchwheel value or zero if playback type is not EXPPLAYTYPE_PITCHWHEEL.

◆ GetPlaybackControllerNumber()

twobyte FCTextExpressionDef::GetPlaybackControllerNumber ( ) const
inline

returns the playback MIDI controller number.

Lua-supported (0.65).

Returns
MIDI controller number or 0 if playback type is not EXPPLAYTYPE_CONTROLLER

◆ GetPlaybackControllerValue()

twobyte FCTextExpressionDef::GetPlaybackControllerValue ( ) const
inline

returns the playback controller value.

Lua-supported (0.65).

Returns
controller value or 0 if playback type is not EXPPLAYTYPE_CONTROLLER

◆ GetPlaybackKeyVelocity()

twobyte FCTextExpressionDef::GetPlaybackKeyVelocity ( ) const
inline

Returns the key velocity value (if the playback type is key velocity).

Lua-supported (0.65)

◆ GetPlaybackPass()

twobyte FCTextExpressionDef::GetPlaybackPass ( ) const
inline
Returns
Returns the specific (1-based) pass number when the expression should play back.

Lua-supported (also as property).

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

◆ GetPlaybackTempoDuration()

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.

◆ GetPlaybackTempoValue()

twobyte FCTextExpressionDef::GetPlaybackTempoValue ( )
inline

For tempo expressions, returns the playback tempo value.

Lua-supported.

Returns
0 if the tempo is not used or set.

◆ GetPlaybackTransposition()

twobyte FCTextExpressionDef::GetPlaybackTransposition ( ) const
inline

Returns the playback transposition in half-steps.

Lua-supported (0.65).

Returns
Playback transposition in half-steps or zero if playback type is not EXPPLAYTYPE_TRANSPOSE.

◆ GetPlaybackType()

FCTextExpressionDef::EXPR_PLAYBACK_TYPES FCTextExpressionDef::GetPlaybackType ( ) const

Returns the playback type for the expression def.

Lua-supported (also as property) (0.55)

◆ GetRehearsalMarkStyle()

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.

◆ GetTextID()

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

◆ GetUseCategoryFont()

bool FCTextExpressionDef::GetUseCategoryFont ( ) const

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

Lua-supported (also as property).

◆ GetUseCategoryPos()

bool FCTextExpressionDef::GetUseCategoryPos ( ) const

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

Lua-supported (also as property).

◆ GetUseEnclosure()

bool FCTextExpressionDef::GetUseEnclosure ( ) const
inline

Returns true if the text expression uses an enclosure.

Lua-supported (also as property).

◆ GetUseExecutableShape()

bool FCTextExpressionDef::GetUseExecutableShape ( ) const
inline

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

Lua-supported (also as property).

◆ GetVerticalAlignmentPoint()

FCCategoryDef::VERT_ALIGNMENT FCTextExpressionDef::GetVerticalAlignmentPoint ( ) const
inline

Returns the vertical alignment point for the expression definition positioning.

Lua-supported (also as property).

◆ GetVerticalBaselineOffset()

twobyte FCTextExpressionDef::GetVerticalBaselineOffset ( ) const
inline

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

Lua-supported (also as property).

◆ GetVerticalEntryOffset()

twobyte FCTextExpressionDef::GetVerticalEntryOffset ( ) const
inline

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

Lua-supported (also as property).

◆ IsAutoRehearsalMark()

bool FCTextExpressionDef::IsAutoRehearsalMark ( ) const
inline

Returns true if an automatic rehearsal number style is used.

Lua-supported (also as property).

◆ IsPlaybackTempo()

bool FCTextExpressionDef::IsPlaybackTempo ( ) const
inline

Returns true if the expression is defined for tempo playback.

Lua-supported (also as property).

◆ IsSmartMusicMarker()

bool FCTextExpressionDef::IsSmartMusicMarker ( ) const
inline

Returns true if the text expression's playback style is defined as a SmartMusic marker. Note: Classic SmartMusic support was removed from Finale. Do not use.

Lua-supported.

◆ MakeRehearsalMark()

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
pStringPointer to the string object that should contain the result.
measurethe measure number
Returns
True if succesful.

◆ SaveNewTextBlock()

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.

◆ SaveTextString()

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.

◆ SetBreakMMRest()

void FCTextExpressionDef::SetBreakMMRest ( bool state)
inline

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

Lua-supported (also as property).

◆ SetCategoryID()

void FCTextExpressionDef::SetCategoryID ( twobyte ID)
inline

Sets the category ID for the expression definition.

Lua-supported (also as property).

Parameters
IDThe new category ID.

◆ SetDescription()

void FCTextExpressionDef::SetDescription ( FCString * pDescriptionString)

Sets the description text for the text expression definition.

Lua-supported.

◆ SetExecutableShapeID()

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

◆ SetHideMeasureNumbers()

void FCTextExpressionDef::SetHideMeasureNumbers ( bool value)
inline

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

Lua-supported (also as property).

◆ SetHorizontalAlignmentPoint()

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

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

Lua-supported (also as property).

◆ SetHorizontalJustification()

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

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

Lua-supported (also as property).

Parameters
valueAny of the EXPRHORIZ_ constants.

◆ SetHorizontalOffset()

void FCTextExpressionDef::SetHorizontalOffset ( twobyte value)
inline

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

Lua-supported (also as property).

◆ SetPitchWheelValue()

void FCTextExpressionDef::SetPitchWheelValue ( twobyte value)
inline

Sets the playback MIDI pitchwheel type] for the expression definition.

Lua-supported (0.65).

Parameters
valueThe pitchwheel value (-8912 through 8192, with 0 as the rest position).

◆ SetPlaybackController()

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

Sets the playback to a specific MIDI CC controller.

Lua-supported.

◆ SetPlaybackKeyVelocity()

void FCTextExpressionDef::SetPlaybackKeyVelocity ( twobyte value)
inline

Sets the playback mode to key velocity and changes the key velocity value.

Lua-supported (0.65)

Parameters
[in]valueOnly values in the range between 0 and 127 are allowed.

◆ SetPlaybackPass()

void FCTextExpressionDef::SetPlaybackPass ( twobyte value)
inline

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

Lua-supported (also as property).

Parameters
value0 if the expression should always play back. Otherwise, the 1-based pass number.

◆ SetPlaybackTempo()

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

Sets the playback tempo type for the expression definition.

Lua-supported.

◆ SetPlaybackTransposition()

void FCTextExpressionDef::SetPlaybackTransposition ( twobyte halfsteps)
inline

Sets the playback transposition type for the expression definition.

Lua-supported (0.65).

Parameters
halfstepsThe number of half-steps to transpose by.

◆ SetPlaybackType()

void FCTextExpressionDef::SetPlaybackType ( FCTextExpressionDef::EXPR_PLAYBACK_TYPES playbackmode)

Sets the playback type for the expression def.

This function allows you to set the playback type to any of the EXPR_PLAYBACK_TYPES values. However, some of them do not permit setting the rest of the data that is required, and therefore setting that playback type cannot be fully implemented. Others have dedicated Set functions that set all the required data at once. See the setter notes at EXPR_PLAYBACK_TYPES for more information.

Lua-supported (also as property) (0.55)

◆ SetRehearsalMarkStyle()

void FCTextExpressionDef::SetRehearsalMarkStyle ( REHEARSALMARK_STYLES value)
inline

Sets the rehearsal mark numbering style.

Lua-supported (also as property).

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

◆ SetUseCategoryFont()

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

◆ SetUseCategoryPos()

void FCTextExpressionDef::SetUseCategoryPos ( bool value)

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

This only sets the user interface state. Use AssignToCategory() to actually define the expression def to the category.

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

◆ SetUseEnclosure()

void FCTextExpressionDef::SetUseEnclosure ( bool value)
inline

Sets if the text expression uses an enclosure or not.

Lua-supported (also as property).

◆ SetUseExecutableShape()

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

◆ SetVerticalAlignmentPoint()

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

Sets the vertical alignment point for the expression definition positioning.

Lua-supported (also as property).

◆ SetVerticalBaselineOffset()

void FCTextExpressionDef::SetVerticalBaselineOffset ( twobyte value)
inline

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

Lua-supported (also as property).

◆ SetVerticalEntryOffset()

void FCTextExpressionDef::SetVerticalEntryOffset ( twobyte value)
inline

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

Lua-supported (also as property).