Finale PDK Framework  0.54
Public Types | Public Member Functions | List of all members
FCArticulationDef Class Reference

The class for an articulation definition. On Finale 2012 and above, this class supports the Unicode character range. More...

#include <ff_other.h>

Inheritance diagram for FCArticulationDef:
__FCNoInciOther __FCOther __FCBaseData __FCBase

Public Types

enum  ARTPOSITIONING_SIDES {
  ARTPOS_MANUAL_POSITIONING, ARTPOS_AUTO_NOTESTEM, ARTPOS_ALWAYS_NOTE_SIDE, ARTPOS_ALWAYS_STEM_SIDE,
  ARTPOS_BELOW_ENTRY, ARTPOS_ABOVE_ENTRY
}
 The auto positioning modes for articulations. Used by FCArticulationDef::GetAutoPosSide() and FCArticulationDef::SetAutoPosSide() 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...
 
 FCArticulationDef ()
 The constructor. More...
 
bool GetOnScreenOnly () const
 Returns true if the main symbol should not print. More...
 
FCFontInfoCreateMainSymbolFontInfo ()
 Creates a FCFontInfo object based on the main symbol font information. More...
 
FCFontInfoCreateFlippedSymbolFontInfo ()
 Creates a FCFontInfo object based on the flipped symbol font information. More...
 
eUniChar32 GetAboveSymbolChar () const
 Returns the character for the "above" symbol. On Finale 2012 and above, this supports the Unicode range. More...
 
eUniChar32 GetBelowSymbolChar () const
 Returns the character for the "below" symbol. On Finale 2012 and above, this supports the Unicode range. More...
 
eUniChar32 GetMainSymbolChar () const
 Returns the character for the main symbol. On Finale 2012 and above, this supports the Unicode range. More...
 
twobyte GetMainSymbolShapeID () const
 Returns the shape ID for the main symbol. More...
 
eUniChar32 GetFlippedSymbolChar () const
 Returns the character for the flipped symbol. On Finale 2012 and above, this supports the Unicode range. More...
 
twobyte GetFlippedSymbolShapeID () const
 Returns the shape ID for the flipped symbol. More...
 
const char * GetMainSymbolFont () const
 Gets the font name for the main symbol. More...
 
const EFONTID GetMainSymbolFontID () const
 Returns the internal document-specific font ID for the main symbol. More...
 
const eUniChar16 * GetMainSymbolFontUTF16 () const
 Gets the font name for the main symbol. More...
 
const char * GetFlippedSymbolFont () const
 Gets the font name for the flipped symbol. More...
 
const EFONTID GetFlippedSymbolFontID () const
 Returns the internal document-specific font ID for the flipped symbol. More...
 
const eUniChar16 * GetFlippedSymbolFontUTF16 () const
 Gets the font name for the flipped symbol. More...
 
twobyte GetMainSymbolSize () const
 Returns the font size of the main symbol. More...
 
twobyte GetFlippedSymbolSize () const
 Returns the font size of the flipped symbol. More...
 
bool GetAboveUsesMain () const
 Return the state of the "When Placed Above a Note, Use the" setting. More...
 
bool GetBelowUsesMain () const
 Return the state of the "When Placed Below a Note, Use the" setting. More...
 
bool GetCopyMainSymbol () const
 Returns the state of the "Copy the Main Symbol" setting. More...
 
bool GetCopyMainSymbolHorizontally () const
 Returns the state of the "Horizontally/Vertically" setting that's used (when GetCopyMainSymbol is set). More...
 
bool GetPlayback () const
 Gets the playback change state bit for the articulation definition. More...
 
bool GetAttackIsPercent () const
 Returns the "Values are percentages" state for the "Attack" playback change. More...
 
twobyte GetTopAttack () const
 Returns the Top Note Value for "Attack" change of playback. More...
 
twobyte GetBottomAttack () const
 Returns the Bottom Note Value for "Attack" change of playback. More...
 
bool GetDurationIsPercent () const
 Returns the "Values are percentages" for "Duration" playback change. More...
 
twobyte GetTopDuration () const
 Returns the Top Note Value for "Duration" change of playback. More...
 
twobyte GetBottomDuration () const
 Returns the Bottom Note Value for "Duration" change of playback. More...
 
bool GetVelocityIsPercent () const
 Returns the "Values are percentages" for "Velocity" playback change. More...
 
twobyte GetTopVelocity () const
 Returns the Top Note Value for "Velocity" change of playback. More...
 
twobyte GetBottomVelocity () const
 Returns the Bottom Note Value for "Velocity" change of playback. More...
 
bool GetAvoidStaffLines () const
 Returns the state of the "Avoid staff lines" setting. More...
 
bool GetAlwaysPlaceOutsideStaff () const
 Returns the state of the "Always place outside staff" setting. More...
 
bool GetCenterHorizontally () const
 Returns the state of the "Center horizontally" setting. More...
 
bool GetInsideSlurs () const
 Returns the state of the "Inside slurs" setting. More...
 
bool GetAttachToTopNote () const
 Returns the state of the "Attach to top note" setting. More...
 
Evpu16 GetDefaultVerticalPos () const
 Returns the default vertical position for the articulation definition. More...
 
ARTPOSITIONING_SIDES GetAutoPosSide () const
 Gets the vertical auto positioning setting for the articulation definition. More...
 
Evpu16 GetMainHandleVerticalOffset () const
 Gets the vertical offset to handle for the main symbol. More...
 
Evpu16 GetMainHandleHorizontalOffset () const
 Gets the horizontal offset to handle for the main symbol. More...
 
Evpu16 GetFlippedHandleVerticalOffset () const
 Gets the vertical offset to handle for the flipped symbol. More...
 
Evpu16 GetFlippedHandleHorizontalOffset () const
 Gets the horizontal offset to handle for the flipped symbol. More...
 
bool GetMainSymbolIsShape () const
 Returns true if the main symbol is a shape. More...
 
bool GetFlippedSymbolIsShape () const
 Returns true if the flipped symbol is a shape. More...
 
bool IsShapeUsed ()
 Returns true if a shape is used for the articulation definition. More...
 
bool IsMainSymbolFont (const char *pszFontName)
 Returns true if the main symbol font matches the font string. The font name check is case sensitive. More...
 
bool IsMainSymbolFontUTF16 (const eUniChar16 *pszFontName)
 Returns true if the main symbol font matches the font string. The font name check is case sensitive. More...
 
bool IsFlippedSymbolFont (const char *pszFontName)
 Returns true if the flipped symbol font matches the font string. The font name check is case sensitive. More...
 
bool IsFlippedSymbolFontUTF16 (const eUniChar16 *pszFontName)
 Returns true if the flipped symbol font matches the font string. The font name check is case sensitive. More...
 
bool IsIdenticalTo (FCArticulationDef *pDef, bool playbackinfo, bool positioningvalues, bool positioningoptions, bool defaultside)
 Compares the articulation definition to another definition and checks if all settings are identical. More...
 
void GetMainSymbolFontInfo (FCFontInfo *pFontInfo)
 Gets the main symbol font for the articulation definition based on a FCFontInfo record. More...
 
void GetFlippedSymbolFontInfo (FCFontInfo *pFontInfo)
 Gets the flipped symbol font for the articulation definition based on a FCFontInfo record. More...
 
void SetOnScreenOnly (bool state)
 Sets the flag if the articulation definition should be displayed on the screen only. More...
 
void SetMainSymbolFontInfo (FCFontInfo *pFontInfo)
 Sets the main symbol font for the articulation definition based on a FCFontInfo record. More...
 
void SetFlippedSymbolFontInfo (FCFontInfo *pFontInfo)
 Sets the flipped symbol font for the articulation definition based on a FCFontInfo record. More...
 
void SetMainSymbolSize (twobyte size)
 Sets the main symbol font size. More...
 
void SetFlippedSymbolSize (twobyte size)
 Sets the flipped symbol font size. More...
 
void SetMainSymbolFont (const char *pszFontName)
 Sets the main symbol font. More...
 
void SetFlippedSymbolFont (const char *pszFontName)
 Sets the flipped symbol font. More...
 
void SetMainSymbolFontUTF16 (const eUniChar16 *pszFontName)
 Sets the main symbol font. More...
 
void SetFlippedSymbolFontUTF16 (const eUniChar16 *pszFontName)
 Sets the flipped symbol font. More...
 
void SetAboveSymbolChar (eUniChar32 symbol)
 Sets the character for the "above" symbol. On Finale 2012 and above, this supports the Unicode range. More...
 
void SetBelowSymbolChar (eUniChar32 symbol)
 Sets the character for the "below" symbol. On Finale 2012 and above, this supports the Unicode range. More...
 
void SetMainSymbolChar (eUniChar32 symbol)
 Sets the character for the main symbol. On Finale 2012 and above, this supports the Unicode range. More...
 
void SetMainSymbolIsShape (bool useshape)
 Set the main symbol to use shape or a font character. More...
 
void SetFlippedSymbolIsShape (bool useshape)
 Set the flipped symbol to use shape or a font character. More...
 
void SetMainSymbolShapeID (CMPER shapeID)
 Sets the shape ID for the main symbol. More...
 
void SetFlippedSymbolShapeID (twobyte shapeID)
 Sets the shape ID for the flipped symbol. More...
 
void SetFlippedSymbolChar (eUniChar32 symbol)
 Sets the character for the flipped symbol. On Finale 2012 and above, this supports the Unicode range. More...
 
void SetAboveUsesMain (bool state)
 Sets the state of the "When Placed Above a Note, Use the" setting. More...
 
void SetBelowUsesMain (bool state)
 Sets the state of the "When Placed Below a Note, Use the" setting. More...
 
void SetCopyMainSymbol (bool state)
 Sets the state of the "Copy the Main Symbol" setting. More...
 
void SetCopyMainSymbolHorizontally (bool state)
 Sets the state of the "Horizontally/Vertically" setting that's used (when GetCopyMainSymbol is set). More...
 
void SetPlayback (bool state)
 Sets the playback change state bit for the articulation definition. More...
 
void SetAttackIsPercent (bool state)
 Sets the "Values are percentages" state for the "Attack" playback change. More...
 
void SetTopAttack (twobyte value)
 Sets the Top Note Value for "Attack" change of playback. More...
 
void SetBottomAttack (twobyte value)
 Sets the Bottom Note Value for "Attack" change of playback. More...
 
void SetAutoPosSide (ARTPOSITIONING_SIDES mode)
 Sets the vertical auto positioning setting for the articulation definition. More...
 
void SetAlwaysPlaceOutsideStaff (bool state)
 Sets the state of the "Always place outside staff" setting. More...
 
void SetCenterHorizontally (bool state)
 Sets the state of the "Center horizontally" setting. More...
 
void SetAvoidStaffLines (bool state)
 Sets the state of the "Avoid staff lines" setting. More...
 
void SetInsideSlurs (bool state)
 Sets the state of the "Inside slurs" setting. More...
 
void SetAttachToTopNote (bool state)
 Sets the state of the "Attach to top note" setting. More...
 
void SetDefaultVerticalPos (Evpu16 value)
 Sets the default vertical position for the articulation definition. More...
 
void SetMainHandleVerticalOffset (Evpu16 value)
 Sets the vertical offset to handle for the main symbol. More...
 
void SetMainHandleHorizontalOffset (Evpu16 value)
 Sets the horizontal offset to handle for the main symbol. More...
 
void SetFlippedHandleVerticalOffset (Evpu16 value)
 Sets the vertical offset to handle for the flipped symbol. More...
 
void SetFlippedHandleHorizontalOffset (Evpu16 value)
 Sets the horizontal offset to handle for the flipped symbol. More...
 
void SetTopDuration (twobyte value)
 Sets the Top Note Value for "Duration" change of playback. More...
 
void SetBottomDuration (twobyte value)
 Sets the Bottom Note Value for "Duration" change of playback. More...
 
void SetDurationIsPercent (bool value)
 Sets the "Values are percentages" for the "Duration" playback change. More...
 
void SetTopVelocity (twobyte value)
 Sets the Top Note Value for "Velocity" change of playback. More...
 
void SetBottomVelocity (twobyte value)
 Sets the Bottom Note Value for "Velocity" change of playback. More...
 
void SetVelocityIsPercent (bool value)
 Sets the "Values are percentages" for the "Velocity" playback change. 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 DeepSaveAs (CMPER itemno)
 Saves the data under another item number, but also makes a deep copy of the object. More...
 
virtual bool DeepDeleteData ()
 Deletes the data and all related data available in other data structures. 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...
 
__FCBaseDataCreateClone ()
 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.
 
FCNumbersCreateRawDataDump ()
 Creates a byte collection with the raw loaded data block for the object (if the object type supports single data blocks). This method is only intended for debug purposes. More...
 
- Public Member Functions inherited from __FCBase
 __FCBase ()
 The constructor.
 
virtual ~__FCBase ()
 Virtual destructor, so all inherited classes get the virtual destructor. More...
 
void DebugMsgDigit (const char *pszPrefixText, int i)
 Creates a simple Message Box for debug purposes. The text appears with the extra digit (in decimal presentation) appearing afterwards. More...
 
void DebugMsgHex (const char *pszPrefixText, int i)
 Creates a simple Message Box for debug purposes. The text appears with the extra digit (as a hexadecimal number) appearing afterwards. More...
 
void DebugMsgString (const char *pszPrefixText, const char *thestring)
 Creates a simple Message Box for debug purposes. The text appears with the extra string appearing afterwards. More...
 
void DebugMsg (const char *pszMsg)
 Creates a simple Message Box for debug purposes with just one text string. More...
 
void DebugOutMenuInfo (FCUI *pUI, int menuixd_horiz, int menuixd_vert) const
 Outputs the menu command info for debugging purposes. More...
 
int DebugOutFormat (const char *fmt,...)
 Outputs debug text using C style "printf" syntax. More...
 
void Set16BitFlag (FLAG_16 *flag, FLAG_16 flagbits, bool state)
 Sets a 16 bit flag in the data block. More...
 
void Set32BitFlag (FLAG_32 *flag, FLAG_32 flagbits, bool state)
 Sets a 32 bit flag in the data block. More...
 
bool GetBitFlag (FLAG_32 flag, FLAG_32 flagbits) const
 Gets a state from flag bits. Returns true if any bit in the mask is set. More...
 
void SetUserData (void *pData)
 Sets the user data attached to the instance of an object. More...
 
void SetUserData2 (void *pData)
 Sets the additional user data attached to the instance of an object. More...
 
void * GetUserData () const
 Gets the user data attached to the instance of an object. More...
 
void * GetUserData2 () const
 Gets the additional user data attached to the instance of an object. More...
 
virtual bool IsIdentical (__FCBase *pCompareObject)
 Returns true if the data in the passed object is considered to be identical to the current object, otherwise false. More...
 
void StoreXML_String (tinyxml2::XMLElement *pParentNode, const char *pszElementName, FCString *pStringValue)
 Helper function to store FCString objects in the XML file. More...
 
void StoreXML_Integer (tinyxml2::XMLElement *pParentNode, const char *pszElementName, int value)
 Helper function to store integer objects in the XML file. More...
 
void StoreXML_Bool (tinyxml2::XMLElement *pParentNode, const char *pszElementName, bool value)
 Helper function to store boolean objects in the XML file. More...
 
void StoreXML_StringAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, FCString *pStringValue)
 Helper function to store FCString objects in the XML file, as an attribute to a node. More...
 
void StoreXML_IntegerAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, int value)
 Helper function to store integer objects in the XML file, as an attribute to a node. More...
 
void StoreXML_BoolAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, bool value)
 Helper function to store boolean objects in the XML file, as an attribute to a node. More...
 
void StoreXML_FloatAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, float value)
 Helper function to store floating point objects in the XML file, as an attribute to a node. More...
 
virtual void StoreToXML (tinyxml2::XMLElement *pParentNode)
 Virtual method that is used to store an object's data. More...
 
bool ReadXML_String (tinyxml2::XMLElement *pParentNode, const char *pszElementName, FCString *pStringValue)
 Helper method to read FCString objects from the XML file. More...
 
bool ReadXML_Integer (tinyxml2::XMLElement *pParentNode, const char *pszElementName, int *pValue)
 Helper method to read integer objects from the XML file. More...
 
bool ReadXML_Bool (tinyxml2::XMLElement *pParentNode, const char *pszElementName, bool *pValue)
 Helper method to read boolean objects from the XML file. More...
 
bool ReadXML_StringAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, FCString *pStringValue)
 Helper method to read FCString objects from the XML file, as an attribute to a node. More...
 
bool ReadXML_IntegerAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, int *pValue)
 Helper method to read integer objects from the XML file, as an attribute to a node. More...
 
bool ReadXML_BoolAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, bool *pValue)
 Helper method to read boolean objects from the XML file, as an attribute to a node. More...
 
bool ReadXML_FloatAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, float *pValue)
 Helper method to read floating point objects from the XML file, as an attribute to a node. More...
 
virtual bool ReadFromXML (tinyxml2::XMLElement *pParentNode)
 Virtual method that is used to read object data. More...
 

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 __FCBaseDataCreateObject ()=0
 Creates a new instance of the object. More...
 
bool DataIsLoaded () const
 Returns true is any data has been loaded into the object. More...
 
void _TagDocumentID ()
 For internal use only. More...
 
- Protected Attributes 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

The class for an articulation definition. On Finale 2012 and above, this class supports the Unicode character range.

Member Enumeration Documentation

The auto positioning modes for articulations. Used by FCArticulationDef::GetAutoPosSide() and FCArticulationDef::SetAutoPosSide()

Any of these values:

  • ARTPOS_MANUAL_POSITIONING - Manual positioning
  • ARTPOS_AUTO_NOTESTEM - Auto note/stem side
  • ARTPOS_ALWAYS_NOTE_SIDE - Always on note side
  • ARTPOS_ALWAYS_STEM_SIDE - Always on stem side
  • ARTPOS_BELOW_ENTRY - Always below the entry
  • ARTPOS_ABOVE_ENTRY - Always above the entry

Constructor & Destructor Documentation

FCArticulationDef::FCArticulationDef ( )
inline

The constructor.

Lua-supported.

Member Function Documentation

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

FCFontInfo * FCArticulationDef::CreateFlippedSymbolFontInfo ( )

Creates a FCFontInfo object based on the flipped symbol font information.

Lua-supported.

Returns
The font information object. This has to be deleted from the heap after use.
FCFontInfo * FCArticulationDef::CreateMainSymbolFontInfo ( )

Creates a FCFontInfo object based on the main symbol font information.

Lua-supported.

Returns
The font information object. This has to be destroyed after use.
virtual void FCArticulationDef::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.

eUniChar32 FCArticulationDef::GetAboveSymbolChar ( ) const
inline

Returns the character for the "above" symbol. On Finale 2012 and above, this supports the Unicode range.

This might be either the main or the flipped symbol.

Lua-supported (also as property).

  • Returns
    The font character. 0 if it's a shape.
bool FCArticulationDef::GetAboveUsesMain ( ) const
inline

Return the state of the "When Placed Above a Note, Use the" setting.

Lua-supported (also as property).

Returns
True - Main symbol is used above notes. False - Flipped symbol is used above notes.
bool FCArticulationDef::GetAlwaysPlaceOutsideStaff ( ) const
inline

Returns the state of the "Always place outside staff" setting.

Lua-supported (also as property).

bool FCArticulationDef::GetAttachToTopNote ( ) const
inline

Returns the state of the "Attach to top note" setting.

Lua-supported (also as property).

bool FCArticulationDef::GetAttackIsPercent ( ) const
inline

Returns the "Values are percentages" state for the "Attack" playback change.

Lua-supported (also as property).

FCArticulationDef::ARTPOSITIONING_SIDES FCArticulationDef::GetAutoPosSide ( ) const

Gets the vertical auto positioning setting for the articulation definition.

  • Lua-supported (also as property).
Returns
Any of these values:
  • ARTPOS_MANUAL_POSITIONING - Manual positioning
  • ARTPOS_AUTO_NOTESTEM - Auto note/stem side
  • ARTPOS_ALWAYS_NOTE_SIDE - Always on note side
  • ARTPOS_ALWAYS_STEM_SIDE - Always on stem side
  • ARTPOS_BELOW_ENTRY - Always below the entry
  • ARTPOS_ABOVE_ENTRY - Always above the entry
bool FCArticulationDef::GetAvoidStaffLines ( ) const
inline

Returns the state of the "Avoid staff lines" setting.

Lua-supported (also as property).

eUniChar32 FCArticulationDef::GetBelowSymbolChar ( ) const
inline

Returns the character for the "below" symbol. On Finale 2012 and above, this supports the Unicode range.

This might be either the main or the flipped symbol.

Lua-supported (also as property).

  • Returns
    The font character. 0 if it's a shape.
bool FCArticulationDef::GetBelowUsesMain ( ) const
inline

Return the state of the "When Placed Below a Note, Use the" setting.

Lua-supported (also as property).

Returns
True - Main symbol is used below notes. False - Flipped symbol is used below notes.
twobyte FCArticulationDef::GetBottomAttack ( ) const
inline

Returns the Bottom Note Value for "Attack" change of playback.

Lua-supported (also as property).

twobyte FCArticulationDef::GetBottomDuration ( ) const
inline

Returns the Bottom Note Value for "Duration" change of playback.

Lua-supported (also as property).

twobyte FCArticulationDef::GetBottomVelocity ( ) const
inline

Returns the Bottom Note Value for "Velocity" change of playback.

Lua-supported (also as property).

bool FCArticulationDef::GetCenterHorizontally ( ) const
inline

Returns the state of the "Center horizontally" setting.

Lua-supported (also as property).

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

bool FCArticulationDef::GetCopyMainSymbol ( ) const
inline

Returns the state of the "Copy the Main Symbol" setting.

Lua-supported (also as property).

bool FCArticulationDef::GetCopyMainSymbolHorizontally ( ) const
inline

Returns the state of the "Horizontally/Vertically" setting that's used (when GetCopyMainSymbol is set).

Lua-supported (also as property).

Returns
True - Main symbol is copied horizontally. False - Main symbol is copied vertically.
Evpu16 FCArticulationDef::GetDefaultVerticalPos ( ) const
inline

Returns the default vertical position for the articulation definition.

Lua-supported (also as property).

Returns
The default vertical position in EVPUs.
bool FCArticulationDef::GetDurationIsPercent ( ) const
inline

Returns the "Values are percentages" for "Duration" playback change.

Lua-supported (also as property).

Evpu16 FCArticulationDef::GetFlippedHandleHorizontalOffset ( ) const
inline

Gets the horizontal offset to handle for the flipped symbol.

Lua-supported (also as property).

Evpu16 FCArticulationDef::GetFlippedHandleVerticalOffset ( ) const
inline

Gets the vertical offset to handle for the flipped symbol.

Lua-supported (also as property).

eUniChar32 FCArticulationDef::GetFlippedSymbolChar ( ) const

Returns the character for the flipped symbol. On Finale 2012 and above, this supports the Unicode range.

Lua-supported (also as property).

Returns
The font character. 0 if it's a shape.
const char * FCArticulationDef::GetFlippedSymbolFont ( ) const

Gets the font name for the flipped symbol.

Lua-supported (also as property).

Returns
The C-string font name. Empty string if it's a shape.
const EFONTID FCArticulationDef::GetFlippedSymbolFontID ( ) const

Returns the internal document-specific font ID for the flipped symbol.

Returns
The font ID. 0 if the flipped symbol is a shape.
void FCArticulationDef::GetFlippedSymbolFontInfo ( FCFontInfo pFontInfo)

Gets the flipped symbol font for the articulation definition based on a FCFontInfo record.

Since Finale can't set differernt fonts for main/flipped separately through the user interface, the FCArticulationDef::GetMainSymbolFontInfo() method should normally be called as well.

This method copies the internal font ID to the FCFontInfo object, as well as the font name.

Lua-supported.

Parameters
pFontInfoThe font information object.
const eUniChar16* FCArticulationDef::GetFlippedSymbolFontUTF16 ( ) const

Gets the font name for the flipped symbol.

Returns
The UTF16 font name. Empty string if it's a shape.
bool FCArticulationDef::GetFlippedSymbolIsShape ( ) const
inline

Returns true if the flipped symbol is a shape.

Lua-supported (also as property).

Returns
True if the flipped symbol is a shape. False if flipped symbol is a font character.
twobyte FCArticulationDef::GetFlippedSymbolShapeID ( ) const
inline

Returns the shape ID for the flipped symbol.

Lua-supported (also as property).

Returns
The shape ID (for the FCShapeDef class). 0 if it's not a shape.
twobyte FCArticulationDef::GetFlippedSymbolSize ( ) const

Returns the font size of the flipped symbol.

Lua-supported (also as property).

Returns
The font size in points. 0 if it's a shape.
bool FCArticulationDef::GetInsideSlurs ( ) const
inline

Returns the state of the "Inside slurs" setting.

Lua-supported (also as property).

Evpu16 FCArticulationDef::GetMainHandleHorizontalOffset ( ) const
inline

Gets the horizontal offset to handle for the main symbol.

Lua-supported (also as property).

Evpu16 FCArticulationDef::GetMainHandleVerticalOffset ( ) const
inline

Gets the vertical offset to handle for the main symbol.

Lua-supported (also as property).

eUniChar32 FCArticulationDef::GetMainSymbolChar ( ) const

Returns the character for the main symbol. On Finale 2012 and above, this supports the Unicode range.

Lua-supported (also as property).

Returns
The font character. 0 if it's a shape.
const char * FCArticulationDef::GetMainSymbolFont ( ) const

Gets the font name for the main symbol.

Lua-supported (also as property).

Returns
The C-string font name. Empty string if it's a shape.
const EFONTID FCArticulationDef::GetMainSymbolFontID ( ) const

Returns the internal document-specific font ID for the main symbol.

Returns
The font ID. 0 if the main symbol is a shape.
void FCArticulationDef::GetMainSymbolFontInfo ( FCFontInfo pFontInfo)

Gets the main symbol font for the articulation definition based on a FCFontInfo record.

Since Finale can't set different fonts for main/flipped separately through the user interface, the FCArticulationDef::GetFlippedSymbolFontInfo() method should normally be called as well.

This method copies the internal font ID to the FCFontInfo object, as well as the font name.

Lua-supported.

Parameters
pFontInfoThe font information object.
const eUniChar16* FCArticulationDef::GetMainSymbolFontUTF16 ( ) const

Gets the font name for the main symbol.

Returns
The UTF16 font name. Empty string if it's a shape.
bool FCArticulationDef::GetMainSymbolIsShape ( ) const
inline

Returns true if the main symbol is a shape.

Lua-supported (also as property).

Returns
True if main symbol is a shape. False if main symbol is a font character.
twobyte FCArticulationDef::GetMainSymbolShapeID ( ) const
inline

Returns the shape ID for the main symbol.

Lua-supported (also as property).

Returns
The shape ID (for the FCShapeDef class). 0 if it's not a shape.
twobyte FCArticulationDef::GetMainSymbolSize ( ) const

Returns the font size of the main symbol.

Lua-supported (also as property).

Returns
The font size in points. 0 if it's a shape.
bool FCArticulationDef::GetOnScreenOnly ( ) const
inline

Returns true if the main symbol should not print.

Lua-supported (also as property).

Returns
True if main symbol is a shape. False if main symbol is a font character.
bool FCArticulationDef::GetPlayback ( ) const
inline

Gets the playback change state bit for the articulation definition.

Lua-supported (also as property).

Returns
True if any of the playback changes (attack, velocity, duration) are used.
twobyte FCArticulationDef::GetTopAttack ( ) const
inline

Returns the Top Note Value for "Attack" change of playback.

Lua-supported (also as property).

twobyte FCArticulationDef::GetTopDuration ( ) const
inline

Returns the Top Note Value for "Duration" change of playback.

Lua-supported (also as property).

twobyte FCArticulationDef::GetTopVelocity ( ) const
inline

Returns the Top Note Value for "Velocity" change of playback.

Lua-supported (also as property).

bool FCArticulationDef::GetVelocityIsPercent ( ) const
inline

Returns the "Values are percentages" for "Velocity" playback change.

Lua-supported (also as property).

bool FCArticulationDef::IsFlippedSymbolFont ( const char *  pszFontName)

Returns true if the flipped symbol font matches the font string. The font name check is case sensitive.

Lua-supported.

Parameters
pszFontNameThe font name to check against the flipped symbol font.
Returns
True if there's full match of the font name. False if there's no font match, or if the main symbol is a shape.
bool FCArticulationDef::IsFlippedSymbolFontUTF16 ( const eUniChar16 *  pszFontName)

Returns true if the flipped symbol font matches the font string. The font name check is case sensitive.

Parameters
pszFontNameThe font name to check against the flipped symbol font.
Returns
True if there's full match of the font name. False if there's no font match, or if the main symbol is a shape.
bool FCArticulationDef::IsIdenticalTo ( FCArticulationDef pDef,
bool  playbackinfo,
bool  positioningvalues,
bool  positioningoptions,
bool  defaultside 
)

Compares the articulation definition to another definition and checks if all settings are identical.

This method is document independent, so it can be used to compare articulation definitions between different documents.

Lua-supported.

Parameters
pDefThe articulation definition to compare settings with.
playbackinfoIf set, playback parameters will be compared.
positioningvaluesIf set, numerical positioning parameters will be compared.
positioningoptionsIf set, position options will be compared (but excluding the default side placement).
defaultsideIf set, the default side placement option will be compared.
Returns
True if all settings matches. False if any setting is different.
bool FCArticulationDef::IsMainSymbolFont ( const char *  pszFontName)

Returns true if the main symbol font matches the font string. The font name check is case sensitive.

Lua-supported.

Parameters
pszFontNameThe font name to check against the main symbol font.
Returns
True if there's full match of the font name. False if there's no font match, or if the main symbol is a shape.
bool FCArticulationDef::IsMainSymbolFontUTF16 ( const eUniChar16 *  pszFontName)

Returns true if the main symbol font matches the font string. The font name check is case sensitive.

Parameters
pszFontNameThe font name to check against the main symbol font.
Returns
True if there's full match of the font name. False if there's no font match, or if the main symbol is a shape.
bool FCArticulationDef::IsShapeUsed ( )
inline

Returns true if a shape is used for the articulation definition.

Lua-supported.

void FCArticulationDef::SetAboveSymbolChar ( eUniChar32  symbol)
inline

Sets the character for the "above" symbol. On Finale 2012 and above, this supports the Unicode range.

Lua-supported (also as property).

void FCArticulationDef::SetAboveUsesMain ( bool  state)
inline

Sets the state of the "When Placed Above a Note, Use the" setting.

Lua-supported (also as property).

Parameters
stateTrue - Main symbol is used above notes. False - Flipped symbol is used above notes.
void FCArticulationDef::SetAlwaysPlaceOutsideStaff ( bool  state)
inline

Sets the state of the "Always place outside staff" setting.

Lua-supported (also as property).

void FCArticulationDef::SetAttachToTopNote ( bool  state)
inline

Sets the state of the "Attach to top note" setting.

Lua-supported (also as property).

void FCArticulationDef::SetAttackIsPercent ( bool  state)
inline

Sets the "Values are percentages" state for the "Attack" playback change.

Lua-supported (also as property).

void FCArticulationDef::SetAutoPosSide ( ARTPOSITIONING_SIDES  mode)

Sets the vertical auto positioning setting for the articulation definition.

Lua-supported (also as property).

void FCArticulationDef::SetAvoidStaffLines ( bool  state)
inline

Sets the state of the "Avoid staff lines" setting.

Lua-supported (also as property).

void FCArticulationDef::SetBelowSymbolChar ( eUniChar32  symbol)
inline

Sets the character for the "below" symbol. On Finale 2012 and above, this supports the Unicode range.

Lua-supported (also as property).

void FCArticulationDef::SetBelowUsesMain ( bool  state)
inline

Sets the state of the "When Placed Below a Note, Use the" setting.

Lua-supported (also as property).

Parameters
stateTrue - Main symbol is used below notes. False - Flipped symbol is used below notes.
void FCArticulationDef::SetBottomAttack ( twobyte  value)
inline

Sets the Bottom Note Value for "Attack" change of playback.

Lua-supported (also as property).

void FCArticulationDef::SetBottomDuration ( twobyte  value)
inline

Sets the Bottom Note Value for "Duration" change of playback.

Lua-supported (also as property).

void FCArticulationDef::SetBottomVelocity ( twobyte  value)
inline

Sets the Bottom Note Value for "Velocity" change of playback.

Lua-supported (also as property).

void FCArticulationDef::SetCenterHorizontally ( bool  state)
inline

Sets the state of the "Center horizontally" setting.

Lua-supported (also as property).

void FCArticulationDef::SetCopyMainSymbol ( bool  state)
inline

Sets the state of the "Copy the Main Symbol" setting.

Lua-supported (also as property).

void FCArticulationDef::SetCopyMainSymbolHorizontally ( bool  state)
inline

Sets the state of the "Horizontally/Vertically" setting that's used (when GetCopyMainSymbol is set).

Lua-supported (also as property).

Parameters
stateTrue - Main symbol is copied horizontally. False - Main symbol is copied vertically.
void FCArticulationDef::SetDefaultVerticalPos ( Evpu16  value)
inline

Sets the default vertical position for the articulation definition.

Lua-supported (also as property).

void FCArticulationDef::SetDurationIsPercent ( bool  value)
inline

Sets the "Values are percentages" for the "Duration" playback change.

Lua-supported (also as property).

void FCArticulationDef::SetFlippedHandleHorizontalOffset ( Evpu16  value)
inline

Sets the horizontal offset to handle for the flipped symbol.

Lua-supported (also as property).

void FCArticulationDef::SetFlippedHandleVerticalOffset ( Evpu16  value)
inline

Sets the vertical offset to handle for the flipped symbol.

Lua-supported (also as property).

void FCArticulationDef::SetFlippedSymbolChar ( eUniChar32  symbol)
inline

Sets the character for the flipped symbol. On Finale 2012 and above, this supports the Unicode range.

Lua-supported (also as property).

Returns
The font character. 0 if it's a shape.
void FCArticulationDef::SetFlippedSymbolFont ( const char *  pszFontName)

Sets the flipped symbol font.

Lua-supported (also as property).

void FCArticulationDef::SetFlippedSymbolFontInfo ( FCFontInfo pFontInfo)

Sets the flipped symbol font for the articulation definition based on a FCFontInfo record.

Since Finale can't set differerent fonts for main/flipped separately through the user interface, FCArticulationDef::SetMainSymbolFontInfo() should normally be called as well.

Lua-supported.

Parameters
pFontInfoThe font information object.
void FCArticulationDef::SetFlippedSymbolFontUTF16 ( const eUniChar16 *  pszFontName)

Sets the flipped symbol font.

void FCArticulationDef::SetFlippedSymbolIsShape ( bool  useshape)
inline

Set the flipped symbol to use shape or a font character.

Lua-supported (also as property).

void FCArticulationDef::SetFlippedSymbolShapeID ( twobyte  shapeID)
inline

Sets the shape ID for the flipped symbol.

Lua-supported (also as property).

Parameters
shapeIDThe shape ID (for the FCShapeDef class).
void FCArticulationDef::SetFlippedSymbolSize ( twobyte  size)

Sets the flipped symbol font size.

Lua-supported (also as property).

void FCArticulationDef::SetInsideSlurs ( bool  state)
inline

Sets the state of the "Inside slurs" setting.

Lua-supported (also as property).

void FCArticulationDef::SetMainHandleHorizontalOffset ( Evpu16  value)
inline

Sets the horizontal offset to handle for the main symbol.

Lua-supported (also as property).

void FCArticulationDef::SetMainHandleVerticalOffset ( Evpu16  value)
inline

Sets the vertical offset to handle for the main symbol.

Lua-supported (also as property).

void FCArticulationDef::SetMainSymbolChar ( eUniChar32  symbol)
inline

Sets the character for the main symbol. On Finale 2012 and above, this supports the Unicode range.

Lua-supported (also as property).

void FCArticulationDef::SetMainSymbolFont ( const char *  pszFontName)

Sets the main symbol font.

Lua-supported (also as property).

void FCArticulationDef::SetMainSymbolFontInfo ( FCFontInfo pFontInfo)

Sets the main symbol font for the articulation definition based on a FCFontInfo record.

Since Finale can't set differerent fonts for main/flipped separately through the user interface, FCArticulationDef::SetFlippedSymbolFontInfo() should normally be called as well.

Lua-supported.

Parameters
pFontInfoThe font information object.
void FCArticulationDef::SetMainSymbolFontUTF16 ( const eUniChar16 *  pszFontName)

Sets the main symbol font.

void FCArticulationDef::SetMainSymbolIsShape ( bool  useshape)
inline

Set the main symbol to use shape or a font character.

Lua-supported (also as property).

void FCArticulationDef::SetMainSymbolShapeID ( CMPER  shapeID)
inline

Sets the shape ID for the main symbol.

Lua-supported (also as property).

Parameters
shapeIDThe shape ID (for the FCShapeDef class).
void FCArticulationDef::SetMainSymbolSize ( twobyte  size)

Sets the main symbol font size.

Lua-supported (also as property).

void FCArticulationDef::SetOnScreenOnly ( bool  state)
inline

Sets the flag if the articulation definition should be displayed on the screen only.

Lua-supported (also as property).

void FCArticulationDef::SetPlayback ( bool  state)
inline

Sets the playback change state bit for the articulation definition.

Lua-supported (also as property).

Parameters
stateTrue if any of the playback changes (attack, velocity, duration) are used.
void FCArticulationDef::SetTopAttack ( twobyte  value)
inline

Sets the Top Note Value for "Attack" change of playback.

Lua-supported (also as property).

void FCArticulationDef::SetTopDuration ( twobyte  value)
inline

Sets the Top Note Value for "Duration" change of playback.

Lua-supported (also as property).

void FCArticulationDef::SetTopVelocity ( twobyte  value)
inline

Sets the Top Note Value for "Velocity" change of playback.

Lua-supported (also as property).

void FCArticulationDef::SetVelocityIsPercent ( bool  value)
inline

Sets the "Values are percentages" for the "Velocity" playback change.

Lua-supported (also as property).