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:

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 , ARTPOS_ALWAYS_ON_STEM }
	The auto positioning modes for articulations. Used by FCArticulationDef::GetAutoPosSide() and FCArticulationDef::SetAutoPosSide() More...

enum	ARTSLUR_INTERACTION { ARTSLURINT_IGNORE , ARTSLURINT_INSIDE , ARTSLURINT_AUTO_INOUT }
	The options for slur interaction used by FCArticulationDef::GetSlurInteraction() and FCArticulationDef::SetSlurInteraction() 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.

	FCArticulationDef ()
	The constructor.

bool	GetOnScreenOnly () const
	Returns true if the main symbol should not print.

FCFontInfo *	CreateMainSymbolFontInfo () const
	Creates a FCFontInfo object based on the main symbol font information.

FCFontInfo *	CreateFlippedSymbolFontInfo () const
	Creates a FCFontInfo object based on the flipped symbol font information.

eUniChar32	GetAboveSymbolChar () const
	Returns the character for the "above" symbol. On Finale 2012 and above, this supports the Unicode range.

eUniChar32	GetBelowSymbolChar () const
	Returns the character for the "below" symbol. On Finale 2012 and above, this supports the Unicode range.

eUniChar32	GetMainSymbolChar () const
	Returns the character for the main symbol. On Finale 2012 and above, this supports the Unicode range.

twobyte	GetMainSymbolShapeID () const
	Returns the shape ID for the main symbol.

eUniChar32	GetFlippedSymbolChar () const
	Returns the character for the flipped symbol. On Finale 2012 and above, this supports the Unicode range.

twobyte	GetFlippedSymbolShapeID () const
	Returns the shape ID for the flipped symbol.

std::string	GetMainSymbolFont () const
	Gets the font name for the main symbol.

const EFONTID	GetMainSymbolFontID () const
	Returns the internal document-specific font ID for the main symbol.

std::string	GetFlippedSymbolFont () const
	Gets the font name for the flipped symbol.

const EFONTID	GetFlippedSymbolFontID () const
	Returns the internal document-specific font ID for the flipped symbol.

twobyte	GetMainSymbolSize () const
	Returns the font size of the main symbol.

twobyte	GetFlippedSymbolSize () const
	Returns the font size of the flipped symbol.

bool	GetAboveUsesMain () const
	Return the state of the "When Placed Above a Note, Use the" setting.

bool	GetBelowUsesMain () const
	Return the state of the "When Placed Below a Note, Use the" setting.

bool	GetCopyMainSymbol () const
	Returns the state of the "Copy the Main Symbol" setting.

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

bool	GetPlayback () const
	Gets the playback change state bit for the articulation definition.

bool	GetAttackIsPercent () const
	Returns the "Values are percentages" state for the "Attack" playback change.

twobyte	GetTopAttack () const
	Returns the Top Note Value for "Attack" change of playback.

twobyte	GetBottomAttack () const
	Returns the Bottom Note Value for "Attack" change of playback.

bool	GetDurationIsPercent () const
	Returns the "Values are percentages" for "Duration" playback change.

twobyte	GetTopDuration () const
	Returns the Top Note Value for "Duration" change of playback.

twobyte	GetBottomDuration () const
	Returns the Bottom Note Value for "Duration" change of playback.

bool	GetVelocityIsPercent () const
	Returns the "Values are percentages" for "Velocity" playback change.

twobyte	GetTopVelocity () const
	Returns the Top Note Value for "Velocity" change of playback.

twobyte	GetBottomVelocity () const
	Returns the Bottom Note Value for "Velocity" change of playback.

twobyte	GetOnStemDistanceFromStemEnd () const
	Returns the "On-stem distance from stem end/flag/beam" value.

bool	GetAvoidStaffLines () const
	Returns the state of the "Avoid staff lines" setting.

bool	GetAlwaysPlaceOutsideStaff () const
	Returns the state of the "Always place outside staff" setting.

bool	GetCenterHorizontally () const
	Returns the state of the "Center horizontally" setting.

ARTSLUR_INTERACTION	GetSlurInteraction () const
	Gets the settings for slur interaction.

bool	GetInsideSlurs () const
	Returns the state of the "Inside slurs" setting.

bool	GetAttachToTopNote () const
	Returns the state of the "Attach to top note" setting.

bool	GetStackAutomatically () const
	Returns the state of the "Stack automatically" setting.

bool	GetCenterOnStemWhenStemSide () const
	Returns the state of the "Center over/under stem when stem side" setting.

bool	GetStemSideWhenMultipleLayers () const
	Returns the state of the "place stem side when multiple layers are present" setting.

Evpu16	GetDefaultVerticalPos () const
	Returns the default vertical position for the articulation definition.

ARTPOSITIONING_SIDES	GetAutoPosSide () const
	Gets the vertical auto positioning setting for the articulation definition.

Evpu16	GetMainHandleVerticalOffset () const
	Gets the vertical offset to handle for the main symbol.

Evpu16	GetMainHandleHorizontalOffset () const
	Gets the horizontal offset to handle for the main symbol.

Evpu16	GetFlippedHandleVerticalOffset () const
	Gets the vertical offset to handle for the flipped symbol.

Evpu16	GetFlippedHandleHorizontalOffset () const
	Gets the horizontal offset to handle for the flipped symbol.

bool	GetMainSymbolIsShape () const
	Returns true if the main symbol is a shape.

bool	GetFlippedSymbolIsShape () const
	Returns true if the flipped symbol is a shape.

bool	IsShapeUsed ()
	Returns true if a shape is used for the articulation definition.

bool	IsMainSymbolFont (const char *pszFontName) const
	Returns true if the main symbol font matches the font string. The font name check is case sensitive.

bool	IsFlippedSymbolFont (const char *pszFontName) const
	Returns true if the flipped symbol font matches the font string. The font name check is case sensitive.

bool	IsIdenticalTo (const FCArticulationDef &compareWith, bool playbackinfo, bool positioningvalues, bool positioningoptions, bool defaultside) const
	Compares the articulation definition to another definition and checks if all settings are identical.

void	GetMainSymbolFontInfo (FCFontInfo *pFontInfo) const
	Gets the main symbol font for the articulation definition based on a FCFontInfo record.

void	GetFlippedSymbolFontInfo (FCFontInfo *pFontInfo) const
	Gets the flipped symbol font for the articulation definition based on a FCFontInfo record.

void	SetOnScreenOnly (bool state)
	Sets the flag if the articulation definition should be displayed on the screen only.

void	SetMainSymbolFontInfo (FCFontInfo *pFontInfo)
	Sets the main symbol font for the articulation definition based on a FCFontInfo record.

void	SetFlippedSymbolFontInfo (FCFontInfo *pFontInfo)
	Sets the flipped symbol font for the articulation definition based on a FCFontInfo record.

void	SetMainSymbolSize (twobyte size)
	Sets the main symbol font size.

void	SetFlippedSymbolSize (twobyte size)
	Sets the flipped symbol font size.

void	SetMainSymbolFont (const std::string &pszFontName)
	Sets the main symbol font.

void	SetMainSymbolFontID (EFONTID fontid)
	Sets the internal document-specific font ID for the main symbol.

void	SetFlippedSymbolFont (const std::string &pszFontName)
	Sets the flipped symbol font.

void	SetFlippedSymbolFontID (EFONTID fontid)
	Sets the internal document-specific font ID for the flipped symbol.

void	SetAboveSymbolChar (eUniChar32 symbol)
	Sets the character for the "above" symbol. On Finale 2012 and above, this supports the Unicode range.

void	SetBelowSymbolChar (eUniChar32 symbol)
	Sets the character for the "below" symbol. On Finale 2012 and above, this supports the Unicode range.

void	SetMainSymbolChar (eUniChar32 symbol)
	Sets the character for the main symbol. On Finale 2012 and above, this supports the Unicode range.

void	SetMainSymbolIsShape (bool useshape)
	Set the main symbol to use shape or a font character.

void	SetFlippedSymbolIsShape (bool useshape)
	Set the flipped symbol to use shape or a font character.

void	SetMainSymbolShapeID (CMPER shapeID)
	Sets the shape ID for the main symbol.

void	SetFlippedSymbolShapeID (twobyte shapeID)
	Sets the shape ID for the flipped symbol.

void	SetFlippedSymbolChar (eUniChar32 symbol)
	Sets the character for the flipped symbol. On Finale 2012 and above, this supports the Unicode range.

void	SetAboveUsesMain (bool state)
	Sets the state of the "When Placed Above a Note, Use the" setting.

void	SetBelowUsesMain (bool state)
	Sets the state of the "When Placed Below a Note, Use the" setting.

void	SetCopyMainSymbol (bool state)
	Sets the state of the "Copy the Main Symbol" setting.

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

void	SetPlayback (bool state)
	Sets the playback change state bit for the articulation definition.

void	SetAttackIsPercent (bool state)
	Sets the "Values are percentages" state for the "Attack" playback change.

void	SetTopAttack (twobyte value)
	Sets the Top Note Value for "Attack" change of playback.

void	SetBottomAttack (twobyte value)
	Sets the Bottom Note Value for "Attack" change of playback.

void	SetAutoPosSide (ARTPOSITIONING_SIDES mode)
	Sets the vertical auto positioning setting for the articulation definition.

void	SetAlwaysPlaceOutsideStaff (bool state)
	Sets the state of the "Always place outside staff" setting.

void	SetCenterHorizontally (bool state)
	Sets the state of the "Center horizontally" setting.

void	SetAvoidStaffLines (bool state)
	Sets the state of the "Avoid staff lines" setting.

void	SetSlurInteraction (ARTSLUR_INTERACTION mode)
	Sets the "Slur Interaction" setting.

void	SetInsideSlurs (bool state)
	Sets the state of the "Inside slurs" setting.

void	SetAttachToTopNote (bool state)
	Sets the state of the "Attach to top note" setting.

void	SetStackAutomatically (bool state)
	Sets the state of the "Stack automatically" setting.

void	SetCenterOnStemWhenStemSide (bool state)
	Sets the state of the "Center over/under stem when stem side" setting.

void	SetStemSideWhenMultipleLayers (bool state)
	Sets the state of the "place stem side when multiple layers are present" setting.

void	SetDefaultVerticalPos (Evpu16 value)
	Sets the default vertical position for the articulation definition.

void	SetMainHandleVerticalOffset (Evpu16 value)
	Sets the vertical offset to handle for the main symbol.

void	SetMainHandleHorizontalOffset (Evpu16 value)
	Sets the horizontal offset to handle for the main symbol.

void	SetFlippedHandleVerticalOffset (Evpu16 value)
	Sets the vertical offset to handle for the flipped symbol.

void	SetFlippedHandleHorizontalOffset (Evpu16 value)
	Sets the horizontal offset to handle for the flipped symbol.

void	SetTopDuration (twobyte value)
	Sets the Top Note Value for "Duration" change of playback.

void	SetBottomDuration (twobyte value)
	Sets the Bottom Note Value for "Duration" change of playback.

void	SetDurationIsPercent (bool value)
	Sets the "Values are percentages" for the "Duration" playback change.

void	SetTopVelocity (twobyte value)
	Sets the Top Note Value for "Velocity" change of playback.

void	SetBottomVelocity (twobyte value)
	Sets the Bottom Note Value for "Velocity" change of playback.

void	SetOnStemDistanceFromStemEnd (twobyte value)
	Sets the "On-stem distance from stem end/flag/beam" value.

void	SetVelocityIsPercent (bool value)
	Sets the "Values are percentages" for the "Velocity" playback change.

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	DeepSaveAs (CMPER itemno)
	Saves the data under another item number, but also makes a deep copy of the object.

bool	DeepDeleteData () override
	Deletes the data and all related data available in other data structures.

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.

__FCBaseData *	CreateClone ()
	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.

FCNumbers *	CreateRawDataDump ()
	Creates a byte collection with the raw loaded data block for the object (if the object type supports single data blocks). This method is only intended for debug purposes.

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 __FCBaseData *	CreateObject ()=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

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

Member Enumeration Documentation

◆ ARTPOSITIONING_SIDES

enum FCArticulationDef::ARTPOSITIONING_SIDES

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
ARTPOS_ALWAYS_ON_STEM - Always on stem (Finale 26+

Lua-supported. (ARTPOS_ALWAYS_ON_STEM added 0.58)

◆ ARTSLUR_INTERACTION

enum FCArticulationDef::ARTSLUR_INTERACTION

The options for slur interaction used by FCArticulationDef::GetSlurInteraction() and FCArticulationDef::SetSlurInteraction()

Any of these values:

ARTSLURINT_IGNORE - Ignore slurs
ARTSLURINT_INSIDE - Inside slurs
ARTSLURINT_AUTO_INOUT - Auto Inside/Outside

Finale 26 and higher

Lua-supported (0.58)

Constructor & Destructor Documentation

◆ FCArticulationDef()

FCArticulationDef::FCArticulationDef ( )

inline

The constructor.

Lua-supported.

Member Function Documentation

◆ ClassName()

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

◆ CreateFlippedSymbolFontInfo()

FCFontInfo * FCArticulationDef::CreateFlippedSymbolFontInfo ( ) const

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.

◆ CreateMainSymbolFontInfo()

FCFontInfo * FCArticulationDef::CreateMainSymbolFontInfo ( ) const

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.

◆ DebugDump()

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

◆ GetAboveSymbolChar()

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.

◆ GetAboveUsesMain()

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.

◆ GetAlwaysPlaceOutsideStaff()

bool FCArticulationDef::GetAlwaysPlaceOutsideStaff ( ) const

inline

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

Lua-supported (also as property).

◆ GetAttachToTopNote()

bool FCArticulationDef::GetAttachToTopNote ( ) const

inline

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

Lua-supported (also as property).

◆ GetAttackIsPercent()

bool FCArticulationDef::GetAttackIsPercent ( ) const

inline

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

Lua-supported (also as property).

◆ GetAutoPosSide()

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
ARTPOS_ALWAYS_ON_STEM - Always on stem (0.58)

◆ GetAvoidStaffLines()

bool FCArticulationDef::GetAvoidStaffLines ( ) const

inline

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

Lua-supported (also as property).

◆ GetBelowSymbolChar()

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.

◆ GetBelowUsesMain()

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.

◆ GetBottomAttack()

twobyte FCArticulationDef::GetBottomAttack ( ) const

inline

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

Lua-supported (also as property).

◆ GetBottomDuration()

twobyte FCArticulationDef::GetBottomDuration ( ) const

inline

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

Lua-supported (also as property).

◆ GetBottomVelocity()

twobyte FCArticulationDef::GetBottomVelocity ( ) const

inline

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

Lua-supported (also as property).

◆ GetCenterHorizontally()

bool FCArticulationDef::GetCenterHorizontally ( ) const

inline

Returns the state of the "Center horizontally" setting.

Lua-supported (also as property).

◆ GetCenterOnStemWhenStemSide()

bool FCArticulationDef::GetCenterOnStemWhenStemSide ( ) const

Returns the state of the "Center over/under stem when stem side" setting.

Always false for Finale versions older than Finale 26.

Lua-supported (also as property) (0.58).

◆ GetClassID()

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

◆ GetCopyMainSymbol()

bool FCArticulationDef::GetCopyMainSymbol ( ) const

inline

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

Lua-supported (also as property).

◆ GetCopyMainSymbolHorizontally()

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.

◆ GetDefaultVerticalPos()

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.

◆ GetDurationIsPercent()

bool FCArticulationDef::GetDurationIsPercent ( ) const

inline

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

Lua-supported (also as property).

◆ GetFlippedHandleHorizontalOffset()

Evpu16 FCArticulationDef::GetFlippedHandleHorizontalOffset ( ) const

inline

Gets the horizontal offset to handle for the flipped symbol.

Lua-supported (also as property).

◆ GetFlippedHandleVerticalOffset()

Evpu16 FCArticulationDef::GetFlippedHandleVerticalOffset ( ) const

inline

Gets the vertical offset to handle for the flipped symbol.

Lua-supported (also as property).

◆ GetFlippedSymbolChar()

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.

◆ GetFlippedSymbolFont()

std::string 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. Starting with version 0.73, it is encoded UTF8.

◆ GetFlippedSymbolFontID()

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.

◆ GetFlippedSymbolFontInfo()

void FCArticulationDef::GetFlippedSymbolFontInfo ( FCFontInfo * pFontInfo ) const

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

pFontInfo The font information object.

◆ GetFlippedSymbolIsShape()

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.

◆ GetFlippedSymbolShapeID()

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.

◆ GetFlippedSymbolSize()

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.

◆ GetInsideSlurs()

bool FCArticulationDef::GetInsideSlurs ( ) const

inline

Returns the state of the "Inside slurs" setting.

Deprecated. Use GetSlurInteraction instead.

Lua-supported (also as property).

◆ GetMainHandleHorizontalOffset()

Evpu16 FCArticulationDef::GetMainHandleHorizontalOffset ( ) const

inline

Gets the horizontal offset to handle for the main symbol.

Lua-supported (also as property).

◆ GetMainHandleVerticalOffset()

Evpu16 FCArticulationDef::GetMainHandleVerticalOffset ( ) const

inline

Gets the vertical offset to handle for the main symbol.

Lua-supported (also as property).

◆ GetMainSymbolChar()

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.

◆ GetMainSymbolFont()

std::string 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. Starting with version 0.73, it is encoded UTF8.

◆ GetMainSymbolFontID()

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.

◆ GetMainSymbolFontInfo()

void FCArticulationDef::GetMainSymbolFontInfo ( FCFontInfo * pFontInfo ) const

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

pFontInfo The font information object.

◆ GetMainSymbolIsShape()

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.

◆ GetMainSymbolShapeID()

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.

◆ GetMainSymbolSize()

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.

◆ GetOnScreenOnly()

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.

◆ GetOnStemDistanceFromStemEnd()

twobyte FCArticulationDef::GetOnStemDistanceFromStemEnd ( ) const

Returns the "On-stem distance from stem end/flag/beam" value.

This value is only available in Finale 26 and higher. Earlier versions always return 0.

Lua-supported (also as property) (0.66).

◆ GetPlayback()

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.

◆ GetSlurInteraction()

FCArticulationDef::ARTSLUR_INTERACTION FCArticulationDef::GetSlurInteraction ( ) const

Gets the settings for slur interaction.

Versions of Finale before Finale 26 never return ARTSLURINT_AUTO_INOUT.

Lua-supported (also as property) (0.58).

Returns

Any of these values:

ARTSLURINT_IGNORE - Ignore slurs
ARTSLURINT_INSIDE - Inside slurs
ARTSLURINT_AUTO_INOUT - Auto Inside/Outside

◆ GetStackAutomatically()

bool FCArticulationDef::GetStackAutomatically ( ) const

Returns the state of the "Stack automatically" setting.

Always false for Finale versions older than Finale 26.

Lua-supported (also as property) (0.58).

◆ GetStemSideWhenMultipleLayers()

bool FCArticulationDef::GetStemSideWhenMultipleLayers ( ) const

Returns the state of the "place stem side when multiple layers are present" setting.

Always false for Finale versions older than Finale 26.1.

Lua-supported (also as property) (0.58).

◆ GetTopAttack()

twobyte FCArticulationDef::GetTopAttack ( ) const

inline

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

Lua-supported (also as property).

◆ GetTopDuration()

twobyte FCArticulationDef::GetTopDuration ( ) const

inline

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

Lua-supported (also as property).

◆ GetTopVelocity()

twobyte FCArticulationDef::GetTopVelocity ( ) const

inline

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

Lua-supported (also as property).

◆ GetVelocityIsPercent()

bool FCArticulationDef::GetVelocityIsPercent ( ) const

inline

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

Lua-supported (also as property).

◆ IsFlippedSymbolFont()

bool FCArticulationDef::IsFlippedSymbolFont ( const char * pszFontName ) const

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

Lua-supported.

Parameters

pszFontName The font name to check against the flipped symbol font. As of version 0.73, this should be a UTF-8 string. However, if the string cannot be encoded UTF-8 it is handled as ANSI (Windows) or MacRoman (Mac).

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.

◆ IsIdenticalTo()

bool FCArticulationDef::IsIdenticalTo	(	const FCArticulationDef &	compareWith,
		bool	playbackinfo,
		bool	positioningvalues,
		bool	positioningoptions,
		bool	defaultside ) const

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

compareWith	The articulation definition to compare settings with.
playbackinfo	If set, playback parameters will be compared.
positioningvalues	If set, numerical positioning parameters will be compared.
positioningoptions	If set, position options will be compared (but excluding the default side placement).
defaultside	If set, the default side placement option will be compared.

Returns: True if all settings matches. False if any setting is different.

◆ IsMainSymbolFont()

bool FCArticulationDef::IsMainSymbolFont ( const char * pszFontName ) const

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

Lua-supported.

Parameters

pszFontName The font name to check against the main symbol font. As of version 0.73, this should be a UTF-8 string. However, if the string cannot be encoded UTF-8 it is handled as ANSI (Windows) or MacRoman (Mac).

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.

◆ IsShapeUsed()

bool FCArticulationDef::IsShapeUsed ( )

inline

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

Lua-supported.

◆ SetAboveSymbolChar()

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

◆ SetAboveUsesMain()

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

state True - Main symbol is used above notes. False - Flipped symbol is used above notes.

◆ SetAlwaysPlaceOutsideStaff()

void FCArticulationDef::SetAlwaysPlaceOutsideStaff ( bool state )

inline

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

Lua-supported (also as property).

◆ SetAttachToTopNote()

void FCArticulationDef::SetAttachToTopNote ( bool state )

inline

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

Lua-supported (also as property).

◆ SetAttackIsPercent()

void FCArticulationDef::SetAttackIsPercent ( bool state )

inline

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

Lua-supported (also as property).

◆ SetAutoPosSide()

void FCArticulationDef::SetAutoPosSide ( ARTPOSITIONING_SIDES mode )

Sets the vertical auto positioning setting for the articulation definition.

Lua-supported (also as property).

◆ SetAvoidStaffLines()

void FCArticulationDef::SetAvoidStaffLines ( bool state )

inline

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

Lua-supported (also as property).

◆ SetBelowSymbolChar()

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

◆ SetBelowUsesMain()

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

state True - Main symbol is used below notes. False - Flipped symbol is used below notes.

◆ SetBottomAttack()

void FCArticulationDef::SetBottomAttack ( twobyte value )

inline

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

Lua-supported (also as property).

◆ SetBottomDuration()

void FCArticulationDef::SetBottomDuration ( twobyte value )

inline

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

Lua-supported (also as property).

◆ SetBottomVelocity()

void FCArticulationDef::SetBottomVelocity ( twobyte value )

inline

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

Lua-supported (also as property).

◆ SetCenterHorizontally()

void FCArticulationDef::SetCenterHorizontally ( bool state )

inline

Sets the state of the "Center horizontally" setting.

Lua-supported (also as property).

◆ SetCenterOnStemWhenStemSide()

void FCArticulationDef::SetCenterOnStemWhenStemSide ( bool state )

Sets the state of the "Center over/under stem when stem side" setting.

Only works with Finale 26 and higher.

Lua-supported (also as property) (0.58).

◆ SetCopyMainSymbol()

void FCArticulationDef::SetCopyMainSymbol ( bool state )

inline

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

Lua-supported (also as property).

◆ SetCopyMainSymbolHorizontally()

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

state True - Main symbol is copied horizontally. False - Main symbol is copied vertically.

◆ SetDefaultVerticalPos()

void FCArticulationDef::SetDefaultVerticalPos ( Evpu16 value )

inline

Sets the default vertical position for the articulation definition.

Lua-supported (also as property).

◆ SetDurationIsPercent()

void FCArticulationDef::SetDurationIsPercent ( bool value )

inline

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

Lua-supported (also as property).

◆ SetFlippedHandleHorizontalOffset()

void FCArticulationDef::SetFlippedHandleHorizontalOffset ( Evpu16 value )

inline

Sets the horizontal offset to handle for the flipped symbol.

Lua-supported (also as property).

◆ SetFlippedHandleVerticalOffset()

void FCArticulationDef::SetFlippedHandleVerticalOffset ( Evpu16 value )

inline

Sets the vertical offset to handle for the flipped symbol.

Lua-supported (also as property).

◆ SetFlippedSymbolChar()

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

Parameters

symbol The font character. 0 if it's a shape.

◆ SetFlippedSymbolFont()

void FCArticulationDef::SetFlippedSymbolFont ( const std::string & pszFontName )

Sets the flipped symbol font.

Lua-supported (also as property).

Parameters

pszFontName the name of the font to set. As of version 0.73, this should be UTF8-encoded.

◆ SetFlippedSymbolFontID()

void FCArticulationDef::SetFlippedSymbolFontID ( EFONTID fontid )

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

Parameters

fontid The font ID. 0 if the flipped symbol is a shape. (Also 0 for the default music font.)

◆ SetFlippedSymbolFontInfo()

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

pFontInfo The font information object.

◆ SetFlippedSymbolIsShape()

void FCArticulationDef::SetFlippedSymbolIsShape ( bool useshape )

inline

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

Lua-supported (also as property).

◆ SetFlippedSymbolShapeID()

void FCArticulationDef::SetFlippedSymbolShapeID ( twobyte shapeID )

inline

Sets the shape ID for the flipped symbol.

Lua-supported (also as property).

Parameters

shapeID The shape ID (for the FCShapeDef class).

◆ SetFlippedSymbolSize()

void FCArticulationDef::SetFlippedSymbolSize ( twobyte size )

Sets the flipped symbol font size.

Lua-supported (also as property).

◆ SetInsideSlurs()

void FCArticulationDef::SetInsideSlurs ( bool state )

inline

Sets the state of the "Inside slurs" setting.

Deprecated. Use SetSlurInteraction instead.

Lua-supported (also as property).

◆ SetMainHandleHorizontalOffset()

void FCArticulationDef::SetMainHandleHorizontalOffset ( Evpu16 value )

inline

Sets the horizontal offset to handle for the main symbol.

Lua-supported (also as property).

◆ SetMainHandleVerticalOffset()

void FCArticulationDef::SetMainHandleVerticalOffset ( Evpu16 value )

inline

Sets the vertical offset to handle for the main symbol.

Lua-supported (also as property).

◆ SetMainSymbolChar()

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

◆ SetMainSymbolFont()

void FCArticulationDef::SetMainSymbolFont ( const std::string & pszFontName )

Sets the main symbol font.

Lua-supported (also as property).

Parameters

pszFontName the name of the font to set. As of version 0.73, this should be UTF8-encoded.

◆ SetMainSymbolFontID()

void FCArticulationDef::SetMainSymbolFontID ( EFONTID fontid )

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

Parameters

fontid The font ID. 0 if the main symbol is a shape. (Also 0 for the default music font.)

◆ SetMainSymbolFontInfo()

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

pFontInfo The font information object.

◆ SetMainSymbolIsShape()

void FCArticulationDef::SetMainSymbolIsShape ( bool useshape )

inline

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

Lua-supported (also as property).

◆ SetMainSymbolShapeID()

void FCArticulationDef::SetMainSymbolShapeID ( CMPER shapeID )

inline

Sets the shape ID for the main symbol.

Lua-supported (also as property).

Parameters

shapeID The shape ID (for the FCShapeDef class).

◆ SetMainSymbolSize()

void FCArticulationDef::SetMainSymbolSize ( twobyte size )

Sets the main symbol font size.

Lua-supported (also as property).

◆ SetOnScreenOnly()

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

◆ SetOnStemDistanceFromStemEnd()

void FCArticulationDef::SetOnStemDistanceFromStemEnd ( twobyte value )

Sets the "On-stem distance from stem end/flag/beam" value.

This value is only available in Finale 26 and higher. This function does nothing in earlier versions.

Lua-supported (also as property) (0.66).

◆ SetPlayback()

void FCArticulationDef::SetPlayback ( bool state )

inline

Sets the playback change state bit for the articulation definition.

Lua-supported (also as property).

Parameters

state True if any of the playback changes (attack, velocity, duration) are used.

◆ SetSlurInteraction()

void FCArticulationDef::SetSlurInteraction ( ARTSLUR_INTERACTION mode )

Sets the "Slur Interaction" setting.

Versions of Finale before Finale 26 ignore ARTSLUR_AUTO_INOUT.

Lua-supported (also as property) (0.58).

◆ SetStackAutomatically()

void FCArticulationDef::SetStackAutomatically ( bool state )

Sets the state of the "Stack automatically" setting.

Only works with Finale 26 and higher.

Lua-supported (also as property) (0.58).

◆ SetStemSideWhenMultipleLayers()

void FCArticulationDef::SetStemSideWhenMultipleLayers ( bool state )

Sets the state of the "place stem side when multiple layers are present" setting.

Only works with Finale 26.1 and higher.

Lua-supported (also as property) (0.58).

◆ SetTopAttack()

void FCArticulationDef::SetTopAttack ( twobyte value )

inline

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

Lua-supported (also as property).

◆ SetTopDuration()

void FCArticulationDef::SetTopDuration ( twobyte value )

inline

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

Lua-supported (also as property).

◆ SetTopVelocity()

void FCArticulationDef::SetTopVelocity ( twobyte value )

inline

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

Lua-supported (also as property).

◆ SetVelocityIsPercent()

void FCArticulationDef::SetVelocityIsPercent ( bool value )

inline

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

Lua-supported (also as property).

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ARTPOSITIONING_SIDES

◆ ARTSLUR_INTERACTION

Constructor & Destructor Documentation

◆ FCArticulationDef()

Member Function Documentation

◆ ClassName()

◆ CreateFlippedSymbolFontInfo()

◆ CreateMainSymbolFontInfo()

◆ DebugDump()

◆ GetAboveSymbolChar()

◆ GetAboveUsesMain()

◆ GetAlwaysPlaceOutsideStaff()

◆ GetAttachToTopNote()

◆ GetAttackIsPercent()

◆ GetAutoPosSide()

◆ GetAvoidStaffLines()

◆ GetBelowSymbolChar()

◆ GetBelowUsesMain()

◆ GetBottomAttack()

◆ GetBottomDuration()

◆ GetBottomVelocity()

◆ GetCenterHorizontally()

◆ GetCenterOnStemWhenStemSide()

◆ GetClassID()

◆ GetCopyMainSymbol()

◆ GetCopyMainSymbolHorizontally()

◆ GetDefaultVerticalPos()

◆ GetDurationIsPercent()

◆ GetFlippedHandleHorizontalOffset()

◆ GetFlippedHandleVerticalOffset()

◆ GetFlippedSymbolChar()

◆ GetFlippedSymbolFont()

◆ GetFlippedSymbolFontID()

◆ GetFlippedSymbolFontInfo()

◆ GetFlippedSymbolIsShape()

◆ GetFlippedSymbolShapeID()

◆ GetFlippedSymbolSize()

◆ GetInsideSlurs()

◆ GetMainHandleHorizontalOffset()

◆ GetMainHandleVerticalOffset()

◆ GetMainSymbolChar()

◆ GetMainSymbolFont()

◆ GetMainSymbolFontID()

◆ GetMainSymbolFontInfo()

◆ GetMainSymbolIsShape()

◆ GetMainSymbolShapeID()

◆ GetMainSymbolSize()

◆ GetOnScreenOnly()

◆ GetOnStemDistanceFromStemEnd()

◆ GetPlayback()

◆ GetSlurInteraction()

◆ GetStackAutomatically()

◆ GetStemSideWhenMultipleLayers()

◆ GetTopAttack()

◆ GetTopDuration()

◆ GetTopVelocity()

◆ GetVelocityIsPercent()

◆ IsFlippedSymbolFont()

◆ IsIdenticalTo()

◆ IsMainSymbolFont()

◆ IsShapeUsed()

◆ SetAboveSymbolChar()

◆ SetAboveUsesMain()

◆ SetAlwaysPlaceOutsideStaff()

◆ SetAttachToTopNote()

◆ SetAttackIsPercent()

◆ SetAutoPosSide()

◆ SetAvoidStaffLines()

◆ SetBelowSymbolChar()

◆ SetBelowUsesMain()

◆ SetBottomAttack()

◆ SetBottomDuration()

◆ SetBottomVelocity()

◆ SetCenterHorizontally()

◆ SetCenterOnStemWhenStemSide()