Class for the Smart Shape preferences. More...

#include <ff_prefs.h>

Inheritance diagram for FCSmartShapePrefs:

Public Types
enum	SSENTCNCTSTYLE_TYPES { SSENTCNCTSTYLETYPE_SLURS = 1 , SSENTCNCTSTYLETYPE_TAB_SLIDES = 2 , SSENTCNCTSTYLETYPE_GLISSANDOS = 3 , SSENTCNCTSTYLETYPE_BEND_CURVES = 4 }
	The different types of entry connection styles. 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. More...

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

	FCSmartShapePrefs ()
	The constructor. More...

CMPER	GetCustomLineDefID () const
	Returns the default custom startshape definition ID for custom smartshape lines. More...

CMPER	GetGlissandoDefID () const
	Returns the default custom startshape definition ID for glissando lines. More...

CMPER	GetTabSlideDefID () const
	Returns the default custom startshape definition ID for tab slide lines. More...

CMPER	GetGuitarBendDefID () const
	Returns the default custom startshape definition ID for guitar bend lines. More...

bool	GetHairpinMakeHorizontal () const
	Returns the "make horizontal" value in the Smart Shape preferences. More...

Evpu16	GetHairpinDefaultOpening () const
	Returns the default hairpin opening width in the Smart Shape preferences. More...

Evpu16	GetHairpinDefaultShortOpening () const
	On Finale 25.3 and later, returns the default "short span" hairpin opening width in the Smart Shape preferences. More...

twobyte	GetHairpinMaxShortSpanLength () const
	Returns the "Maximum short span length" (added in Finale 25.3) in the Smart Shape preferences. More...

Efix16	GetHairpinLineWidth () const
	Returns the hairpin line width, in EFIXes. More...

bool	GetUseEngraverSlurs () const
	Returns true if engraver slurs should be used. More...

Efix16	GetLineWidth () const
	Returns the default line width for normal lines, if EFIXes. More...

Evpu16	GetLineDashLength () const
	Returns the default dash length, in EVPUs. More...

Evpu16	GetLineDashSpace () const
	Returns the default dash space, if EVPUs. More...

Evpu16	GetHookLength () const
	Returns the hook length, if EVPUs. More...

bool	GetOctavesAsText () const
	Returns the flag for if octavas should display as text instead of a symbol. More...

twobyte	GetEngraverSlurMaxAngle () const
	Returns maximum slur angle (in 1/100 of a degree) for Engraver Slurs. More...

twobyte	GetEngraverSlurSymmetryPercent () const
	Returns slur symmetry percentage (in 1/100 of a percent) for Engraver Slurs. More...

Evpu16	GetEngraverSlurSpaceAround () const
	Returns space around objects for Engraver Slurs. More...

bool	GetEngraverSlurAvoidAccidentals () const
	Returns if the engraver slur should avoid accidentals. More...

Evpu16	GetEngraverSlurAccidentalSpace () const
	Returns the space around accidentals for Engraver Slurs, in EVPUs. More...

bool	GetEngraverSlurStretchFirst () const
	Returns if Engraver Slurs should stretch before lift. More...

bool	GetEngraverSlurStretchByPercent () const
	Returns if Engraver Slur stretches should be made in percent or absolute. More...

twobyte	GetEngraverSlurMaxStretchPercent () const
	Returns the Engraver Slur max stretch value for stretches (in 1/100 percent). More...

Efix32	GetEngraverSlurMaxStretchFixed () const
	Returns the Engraver Slur max stretch value for fixed stretches, in EFIXes. More...

Efix32	GetEngraverSlurMaxLift () const
	Returns the max lift value for Engraver Slurs, in EFIXes. More...

Evpu16	GetSlurBreakStaffLineAvoid () const
	Returns the minimum distance to avoid staff lines by, for slur system breaks. In EVPUs. More...

Evpu16	GetSlurBreakSystemStart () const
	Returns the horizontal system start adjustment for slur system breaks. In EVPUs. More...

Evpu16	GetSlurBreakSystemEnd () const
	Returns the horizontal system end adjustment for slur system breaks. In EVPUs. More...

Int10000ths32	GetSlurTipWidth () const
	Returns the slur tip width (in 1/10,000 of an EVPU) More...

bool	GetSlurTipAvoidStaffUse () const
	Returns if slur tips should avoid staff lines. More...

Evpu16	GetSlurTipAvoidStaffAmount () const
	Returns if slur tips should avoid staff lines. More...

Evpu16	GetSlurThicknessHorizontalLeft () const
	Returns slur thickness to the horizontal left, in EVPUs. More...

Evpu16	GetSlurThicknessVerticalLeft () const
	Returns slur thickness to the vertical left, in EVPUs. More...

Evpu16	GetSlurThicknessHorizontalRight () const
	Returns slur thickness to the horizontal right, in EVPUs. More...

Evpu16	GetSlurThicknessVerticalRight () const
	Returns slur thickness to the vertical right, in EVPUs. More...

bool	GetGuitarBendParentheses () const
	Returns the value for Guitar Bend Options - Place Release Bend Number in Parentheses. More...

bool	GetGuitarBendHideNumber () const
	Returns the value for Guitar Bend Options - Hide "Bend-To" Number. More...

bool	GetGuitarBendAutoGenerateText () const
	Returns the value for Guitar Bend Options - Automatically Generate Text. More...

bool	GetGuitarBendReplaceWithFull () const
	Returns the value for Guitar Bend Options - Replace "1" with "Full". More...

Evpu16	GetArticulationAvoidSlursBy () const
	Returns the value for Articulations Avoid Slurs By (in EVPU) More...

void	SetCustomLineDefID (CMPER idvalue)
	Sets the default custom startshape definition ID for custom smartshape lines. More...

void	SetGlissandoDefID (CMPER idvalue)
	Sets the default custom startshape definition ID for glissando lines. More...

void	SetTabSlideDefID (CMPER idvalue)
	Sets the default custom startshape definition ID for tab slide lines. More...

void	SetGuitarBendDefID (CMPER idvalue)
	Sets the default custom startshape definition ID for guitar bend lines. More...

void	SetHairpinMakeHorizontal (bool state)
	Sets the "make horizontal" value in the Smart Shape preferences. More...

void	SetHairpinDefaultOpening (Evpu16 value)
	Sets the default hairpin opening value in the Smart Shape preferences. More...

void	SetHairpinDefaultShortOpening (Evpu16 value)
	Sets the default hairpin short opening value (added in Finale 25.3) in the Smart Shape preferences. More...

void	SetHairpinMaxShortSpanLength (twobyte value)
	Sets the "Maximum short span length" (added in Finale 25.3) in the Smart Shape preferences. More...

void	SetHairpinLineWidth (Efix16 value)
	Sets the hairpin line width, in EFIXes. More...

void	SetUseEngraverSlurs (bool state)
	Sets true if engraver slurs should be used. More...

void	SetLineWidth (Efix16 value)
	Sets the default line width for normal lines, if EFIXes. More...

void	SetLineDashLength (Evpu16 value)
	Returns the default dash length, if EVPUs. More...

void	SetLineDashSpace (Evpu16 value)
	Sets the default dash space, if EVPUs. More...

void	SetHookLength (Evpu16 value)
	Sets the hook length, if EVPUs. More...

void	SetOctavesAsText (bool state)
	Set the flag for if octavas should display as text instead of a symbol. More...

void	SetEngraverSlurMaxAngle (twobyte value)
	Sets the maximum slur angle (in 1/100 of a degree) for Engraver Slurs. More...

void	SetEngraverSlurSymmetryPercent (twobyte value)
	Sets the slur symmetry percentage (in 1/100 of a percent) for Engraver Slurs. More...

void	SetEngraverSlurSpaceAround (Evpu16 value)
	Sets the space around objects for Engraver Slurs. More...

void	SetEngraverSlurAvoidAccidentals (bool state)
	Sets if the engraver slurs should avoid accidentals. More...

void	SetEngraverSlurAccidentalSpace (Evpu16 value)
	Sets the space around accidentals for Engraver Slurs, in EVPUs. More...

void	SetEngraverSlurStretchFirst (bool state)
	Sets if Engraver Slurs should stretch before lift. More...

void	SetEngraverSlurStretchByPercent (bool state)
	Sets if Engraver Slur stretches should be made in percent or absolute. More...

void	SetEngraverSlurMaxStretchPercent (twobyte value)
	Sets the Engraver Slur max stretch value for stretches (in 1/100 percent). More...

void	SetEngraverSlurMaxStretchFixed (Efix32 value)
	Sets the Engraver Slur max stretch value for fixed stretches, in EFIXes. More...

void	SetEngraverSlurMaxLift (Efix32 value)
	Sets the max lift value for Engraver Slurs, in EFIXes. More...

void	SetSlurBreakStaffLineAvoid (Evpu16 value)
	Sets the minimum distance to avoid staff lines by, for slur system breaks. In EVPUs. More...

void	SetSlurBreakSystemStart (Evpu16 value)
	Sets the horizontal system start adjustment for slur system breaks. In EVPUs. More...

void	SetSlurBreakSystemEnd (Evpu16 value)
	Sets the horizontal system end adjustment for slur system breaks. In EVPUs. More...

void	SetSlurTipWidth (Int10000ths32 value)
	Sets the slur tip width (in 1/10,000 of an EVPU) More...

void	SetSlurTipAvoidStaffUse (bool state)
	Sets if slur tips should avoid staff lines. More...

void	SetSlurTipAvoidStaffAmount (Evpu16 value)
	Sets if slur tips should avoid staff lines. More...

void	SetSlurThicknessHorizontalLeft (Evpu16 value)
	Sets slur thickness to the horizontal left, in EVPUs. More...

void	SetSlurThicknessVerticalLeft (Evpu16 value)
	Sets slur thickness to the vertical left, in EVPUs. More...

void	SetSlurThicknessHorizontalRight (Evpu16 value)
	Sets slur thickness to the horizontal right, in EVPUs. More...

void	SetSlurThicknessVerticalRight (Evpu16 value)
	Sets slur thickness to the vertical right, in EVPUs. More...

void	SetGuitarBendParentheses (bool state)
	Sets the value for Guitar Bend Options - Place Release Bend Number in Parentheses. More...

void	SetGuitarBendHideNumber (bool state)
	Sets the value for Guitar Bend Options - Hide "Bend-To" Number. More...

void	SetGuitarBendAutoGenerateText (bool state)
	Sets the value for Guitar Bend Options - Automatically Generate Text. More...

void	SetGuitarBendReplaceWithFull (bool state)
	Sets the value for Guitar Bend Options - Replace "1" with "Full". More...

void	SetArticulationAvoidSlursBy (Evpu16 value)
	Returns the value for Articulations Avoid Slurs By (in EVPU) More...

FCSlurContourPrefs *	CreateSlurContourPrefs () const
	Creates the slur contour prefs. More...

bool	SaveSlurContourPrefs (FCSlurContourPrefs *pPrefs)
	Saves the slur contour prefs. More...

twobyte	GetEntryConnectStyleCount (twobyte styleType) const
	Returns the number of entry connection styles for the input style. More...

FCSmartShapeEntryConnectStyle *	CreateEntryConnectStyle (twobyte styleType, utwobyte index) const
	Allocates on the heap an instance of FCSmartShapeEntryConnectStyle for the input type and index. Non-Lua callers must free the instance after they are finished with it. More...

bool	SaveEntryConnectStyle (const FCSmartShapeEntryConnectStyle *inpConnectStyle, twobyte styleType, utwobyte index)
	Updates the current FCSmartShapePrefs instance with the input FCSmartShapeEntryConnectStyle, using the input type and index to determing which connection style to update. The connection style indices must match or else no action is taken and the function returns false. (See FCSmartShapeEntryConnectStyle::GetConnectionIndex.) More...

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

Public Member Functions inherited from __FCPrefsBase
bool	Reload () override
	Overridden version of Reload(), that handles prefs from multiple sources. More...

virtual bool	Load (twobyte prefsno=1)
	The default Load method for preference data. All preference data loading must go through here at some point. More...

bool	Save () override
	Saves the currently loaded to its current location. More...

bool	LoadFirst () override
	Loads the very first element in the database, if any. More...

int	GetItemNo () const
	Returns the prefs number for the loaded data. 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 () const =0
	The Enigma tag for the derived class. More...

virtual EVERSION	EnigmaVersion () const
	The Enigma version for save/load/create/delete operations. More...

virtual int	DataSizeLoad () const =0
	Returns the data size for the data structure that should be loaded. More...

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

virtual bool	DeepDeleteData ()
	Deletes data and all data that's connected to the object. 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...

bool	RelinkToCurrentView ()
	Relinks the contents in the current view so that the score and part(s) match. More...

bool	RelinkToScore ()
	Relinks all parts to the contents of the score. More...

__FCBaseData *	CreateClone ()
	Creates an identical copy of an object. More...

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

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

void	DebugDataOffsetDump (int offset, int size)
	For debug mode only. Dumps a data memory block at a specific offset and with a specific size.

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

Public Member Functions inherited from __FCBase
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. 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. More...

void	Set32BitFlag (FLAG_32 *flag, FLAG_32 flagbits, bool state)
	Sets/resets a 32 bit flag, by using a bit mask. 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...

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. 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 (const __FCBase *pCompareObject) const
	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	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. More...

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. 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 __FCPrefsBase
	__FCPrefsBase ()
	standard constructor

Protected Member Functions inherited from __FCBaseData
virtual void *	Allocate ()=0

virtual void	Deallocate ()

virtual bool	IsDynamicSize ()

bool	LoadDataBlock ()
	Loads the data. If the object is of dynamic size, the old memory block is freed and a new is allocated.

void	ClearData ()

virtual twobyte	CalcLastInci ()
	For internal use only! More...

virtual __FCBaseData *	CreateObject ()=0
	Creates a new instance of the object. More...

bool	DataIsLoaded () const
	Returns true is any data has been loaded into the object.

void	_TagDocumentID ()
	For internal use only. More...

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

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

Detailed Description

Class for the Smart Shape preferences.

The smart shape symbols are found in FCMusicCharacterPrefs.

Member Enumeration Documentation

◆ SSENTCNCTSTYLE_TYPES

enum FCSmartShapePrefs::SSENTCNCTSTYLE_TYPES

The different types of entry connection styles.

Lua-supported (0.65).

Enumerator
SSENTCNCTSTYLETYPE_SLURS	Entry connection styles for slurs.
SSENTCNCTSTYLETYPE_TAB_SLIDES	Entry connection styles for tab slides.
SSENTCNCTSTYLETYPE_GLISSANDOS	Entry connection styles for tab slides.
SSENTCNCTSTYLETYPE_BEND_CURVES	Entry connection styles for bend curves.

Constructor & Destructor Documentation

◆ FCSmartShapePrefs()

FCSmartShapePrefs::FCSmartShapePrefs ( )

inline

The constructor.

Lua-supported.

Member Function Documentation

◆ ClassName()

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

◆ CreateEntryConnectStyle()

FCSmartShapeEntryConnectStyle * FCSmartShapePrefs::CreateEntryConnectStyle	(	twobyte	styleType,
		utwobyte	index
	)		const

inline

Allocates on the heap an instance of FCSmartShapeEntryConnectStyle for the input type and index. Non-Lua callers must free the instance after they are finished with it.

Each index corresponds to one of the H,V offset pairs in the Smart Shape Placement dialog box. To find the index corresponding to a given H,V offset pair in the dialog box, count each pair in the dialog left to right from zero starting with the top option for the selected smart shape type.

For example, index 0 corresponds to the start point H,V pair of the top option and index 1 corresponds to the end point H,V pair. Some choices have only one H,V pair, and those take up only a single index in the count. The sixth slur option is an example of these. This means that start point and end point H,V pairs may each have odd or even index values, depending on the number of preceding singleton options.

This function always returns NULL in versions of Finale before Finale 26.2.

Lua-supported (0.65)

Parameters

styleType	one of the SSENTCNCTSTYLE_TYPES constants.
index	0-based index of the type to retrieve. Valid values are in the range 0 to GetEntryConnectStyleCount - 1.

Returns: a newly created instance of FCSmartShapeEntryConnectStyle or NULL if invalid index or Finale version.

◆ CreateSlurContourPrefs()

FCSlurContourPrefs * FCSmartShapePrefs::CreateSlurContourPrefs ( ) const

inline

Creates the slur contour prefs.

Use this function to get the tie contour prefs rather than loading them directly. This function works on all supported Finale versions.

Lua-supported (0.65).

Returns: Pointer to the tie contour prefs object or nullptr if error. Callers other than Lua scripts must be delete it from the heap after use.

◆ DebugDump()

void FCSmartShapePrefs::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 __FCBaseData.

◆ GetArticulationAvoidSlursBy()

Evpu16 FCSmartShapePrefs::GetArticulationAvoidSlursBy ( ) const

inline

Returns the value for Articulations Avoid Slurs By (in EVPU)

Always returns 0 if running a Finale version less than Finale 26.2

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

◆ GetClassID()

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

◆ GetCustomLineDefID()

CMPER FCSmartShapePrefs::GetCustomLineDefID ( ) const

inline

Returns the default custom startshape definition ID for custom smartshape lines.

Lua-supported (also as property).

◆ GetEngraverSlurAccidentalSpace()

Evpu16 FCSmartShapePrefs::GetEngraverSlurAccidentalSpace ( ) const

inline

Returns the space around accidentals for Engraver Slurs, in EVPUs.

Setting is only used if GetEngraverSlurAvoidAccidentals returns true.

Lua-supported (also as property).

◆ GetEngraverSlurAvoidAccidentals()

bool FCSmartShapePrefs::GetEngraverSlurAvoidAccidentals ( ) const

inline

Returns if the engraver slur should avoid accidentals.

Lua-supported (also as property).

◆ GetEngraverSlurMaxAngle()

twobyte FCSmartShapePrefs::GetEngraverSlurMaxAngle ( ) const

inline

Returns maximum slur angle (in 1/100 of a degree) for Engraver Slurs.

Lua-supported (also as property).

◆ GetEngraverSlurMaxLift()

Efix32 FCSmartShapePrefs::GetEngraverSlurMaxLift ( ) const

inline

Returns the max lift value for Engraver Slurs, in EFIXes.

Lua-supported (also as property).

◆ GetEngraverSlurMaxStretchFixed()

Efix32 FCSmartShapePrefs::GetEngraverSlurMaxStretchFixed ( ) const

inline

Returns the Engraver Slur max stretch value for fixed stretches, in EFIXes.

Lua-supported (also as property).

◆ GetEngraverSlurMaxStretchPercent()

twobyte FCSmartShapePrefs::GetEngraverSlurMaxStretchPercent ( ) const

inline

Returns the Engraver Slur max stretch value for stretches (in 1/100 percent).

Lua-supported (also as property).

◆ GetEngraverSlurSpaceAround()

Evpu16 FCSmartShapePrefs::GetEngraverSlurSpaceAround ( ) const

inline

Returns space around objects for Engraver Slurs.

Lua-supported (also as property).

◆ GetEngraverSlurStretchByPercent()

bool FCSmartShapePrefs::GetEngraverSlurStretchByPercent ( ) const

inline

Returns if Engraver Slur stretches should be made in percent or absolute.

Lua-supported (also as property).

Returns: true - Stretch by percent. False - Stretch by fixed value.

◆ GetEngraverSlurStretchFirst()

bool FCSmartShapePrefs::GetEngraverSlurStretchFirst ( ) const

inline

Returns if Engraver Slurs should stretch before lift.

Lua-supported (also as property).

Returns: True - Stretch first, then lift. False - Lift first.

◆ GetEngraverSlurSymmetryPercent()

twobyte FCSmartShapePrefs::GetEngraverSlurSymmetryPercent ( ) const

inline

Returns slur symmetry percentage (in 1/100 of a percent) for Engraver Slurs.

Lua-supported (also as property).

◆ GetEntryConnectStyleCount()

twobyte FCSmartShapePrefs::GetEntryConnectStyleCount ( twobyte styleType ) const

inline

Returns the number of entry connection styles for the input style.

Lua-supported (0.65).

Parameters

styleType one of the SSENTCNCTSTYLE_TYPES constants.

◆ GetGlissandoDefID()

CMPER FCSmartShapePrefs::GetGlissandoDefID ( ) const

inline

Returns the default custom startshape definition ID for glissando lines.

Lua-supported (also as property).

◆ GetGuitarBendAutoGenerateText()

bool FCSmartShapePrefs::GetGuitarBendAutoGenerateText ( ) const

inline

Returns the value for Guitar Bend Options - Automatically Generate Text.

Lua-supported (also as property).

◆ GetGuitarBendDefID()

CMPER FCSmartShapePrefs::GetGuitarBendDefID ( ) const

inline

Returns the default custom startshape definition ID for guitar bend lines.

Lua-supported (also as property).

◆ GetGuitarBendHideNumber()

bool FCSmartShapePrefs::GetGuitarBendHideNumber ( ) const

inline

Returns the value for Guitar Bend Options - Hide "Bend-To" Number.

Lua-supported (also as property).

◆ GetGuitarBendParentheses()

bool FCSmartShapePrefs::GetGuitarBendParentheses ( ) const

inline

Returns the value for Guitar Bend Options - Place Release Bend Number in Parentheses.

Lua-supported (also as property).

◆ GetGuitarBendReplaceWithFull()

bool FCSmartShapePrefs::GetGuitarBendReplaceWithFull ( ) const

inline

Returns the value for Guitar Bend Options - Replace "1" with "Full".

The value is only used if GetGuitarBendAutoGenerateText returns true.

Lua-supported (also as property).

◆ GetHairpinDefaultOpening()

Evpu16 FCSmartShapePrefs::GetHairpinDefaultOpening ( ) const

inline

Returns the default hairpin opening width in the Smart Shape preferences.

In Finale 25.3 and later, this is the "Long Span Opening Width" setting, since short and long spans are separated.

Lua-supported (also as property).

◆ GetHairpinDefaultShortOpening()

Evpu16 FCSmartShapePrefs::GetHairpinDefaultShortOpening ( ) const

On Finale 25.3 and later, returns the default "short span" hairpin opening width in the Smart Shape preferences.

Lua-supported (also as property).

Returns: On Finale versions earlier than 25.3, it will return the value from GetHairpinDefaultOpening. Otherwise, it will return the short span opening width value.

◆ GetHairpinLineWidth()

Efix16 FCSmartShapePrefs::GetHairpinLineWidth ( ) const

inline

Returns the hairpin line width, in EFIXes.

Lua-supported (also as property).

◆ GetHairpinMakeHorizontal()

bool FCSmartShapePrefs::GetHairpinMakeHorizontal ( ) const

inline

Returns the "make horizontal" value in the Smart Shape preferences.

Lua-supported (also as property).

◆ GetHairpinMaxShortSpanLength()

twobyte FCSmartShapePrefs::GetHairpinMaxShortSpanLength ( ) const

Returns the "Maximum short span length" (added in Finale 25.3) in the Smart Shape preferences.

Lua-supported (also as property).

Returns: On Finale versions earlier than 25.3, it always return 0. Otherwisem the "Maximum short span length" value.

◆ GetHookLength()

Evpu16 FCSmartShapePrefs::GetHookLength ( ) const

inline

Returns the hook length, if EVPUs.

Lua-supported (also as property).

◆ GetLineDashLength()

Evpu16 FCSmartShapePrefs::GetLineDashLength ( ) const

inline

Returns the default dash length, in EVPUs.

Lua-supported (also as property).

◆ GetLineDashSpace()

Evpu16 FCSmartShapePrefs::GetLineDashSpace ( ) const

inline

Returns the default dash space, if EVPUs.

Lua-supported (also as property).

◆ GetLineWidth()

Efix16 FCSmartShapePrefs::GetLineWidth ( ) const

inline

Returns the default line width for normal lines, if EFIXes.

Lua-supported (also as property).

◆ GetOctavesAsText()

bool FCSmartShapePrefs::GetOctavesAsText ( ) const

inline

Returns the flag for if octavas should display as text instead of a symbol.

Lua-supported (also as property).

◆ GetSlurBreakStaffLineAvoid()

Evpu16 FCSmartShapePrefs::GetSlurBreakStaffLineAvoid ( ) const

inline

Returns the minimum distance to avoid staff lines by, for slur system breaks. In EVPUs.

Lua-supported (also as property).

◆ GetSlurBreakSystemEnd()

Evpu16 FCSmartShapePrefs::GetSlurBreakSystemEnd ( ) const

inline

Returns the horizontal system end adjustment for slur system breaks. In EVPUs.

Lua-supported (also as property).

◆ GetSlurBreakSystemStart()

Evpu16 FCSmartShapePrefs::GetSlurBreakSystemStart ( ) const

inline

Returns the horizontal system start adjustment for slur system breaks. In EVPUs.

Lua-supported (also as property).

◆ GetSlurThicknessHorizontalLeft()

Evpu16 FCSmartShapePrefs::GetSlurThicknessHorizontalLeft ( ) const

inline

Returns slur thickness to the horizontal left, in EVPUs.

Lua-supported (also as property).

◆ GetSlurThicknessHorizontalRight()

Evpu16 FCSmartShapePrefs::GetSlurThicknessHorizontalRight ( ) const

inline

Returns slur thickness to the horizontal right, in EVPUs.

Lua-supported (also as property).

◆ GetSlurThicknessVerticalLeft()

Evpu16 FCSmartShapePrefs::GetSlurThicknessVerticalLeft ( ) const

inline

Returns slur thickness to the vertical left, in EVPUs.

Lua-supported (also as property).

◆ GetSlurThicknessVerticalRight()

Evpu16 FCSmartShapePrefs::GetSlurThicknessVerticalRight ( ) const

inline

Returns slur thickness to the vertical right, in EVPUs.

Lua-supported (also as property).

◆ GetSlurTipAvoidStaffAmount()

Evpu16 FCSmartShapePrefs::GetSlurTipAvoidStaffAmount ( ) const

inline

Returns if slur tips should avoid staff lines.

The setting is controlled by GetSlurTipAvoidStaffUse.

Lua-supported (also as property).

◆ GetSlurTipAvoidStaffUse()

bool FCSmartShapePrefs::GetSlurTipAvoidStaffUse ( ) const

inline

Returns if slur tips should avoid staff lines.

The corresponding value is returned by GetSlurTipAvoidStaffAmount.

Lua-supported (also as property).

◆ GetSlurTipWidth()

Int10000ths32 FCSmartShapePrefs::GetSlurTipWidth ( ) const

inline

Returns the slur tip width (in 1/10,000 of an EVPU)

Lua-supported (also as property).

◆ GetTabSlideDefID()

CMPER FCSmartShapePrefs::GetTabSlideDefID ( ) const

inline

Returns the default custom startshape definition ID for tab slide lines.

Lua-supported (also as property).

◆ GetUseEngraverSlurs()

bool FCSmartShapePrefs::GetUseEngraverSlurs ( ) const

inline

Returns true if engraver slurs should be used.

Lua-supported (also as property).

◆ SaveEntryConnectStyle()

bool FCSmartShapePrefs::SaveEntryConnectStyle	(	const FCSmartShapeEntryConnectStyle *	inpConnectStyle,
		twobyte	styleType,
		utwobyte	index
	)

inline

Updates the current FCSmartShapePrefs instance with the input FCSmartShapeEntryConnectStyle, using the input type and index to determing which connection style to update. The connection style indices must match or else no action is taken and the function returns false. (See FCSmartShapeEntryConnectStyle::GetConnectionIndex.)

See CreateEntryConnectStyle for more information about the indices that you pass to SaveEntryConnectStyle.

After calling SaveEntryConnectStyle, you must call FCSmartShapePrefs::Save for the changes to be saved in the document.

In versions of Finale before Finale 26.2 this function always takes no action and returns false.

Lua-supported (0.65)

Parameters

inpConnectStyle	the connection style data to update
styleType	one of the SSENTCNCTSTYLE_TYPES constants.
index	0-based index of the type to retrieve. Valid values are in the range 0 to GetEntryConnectStyleCount - 1.

Returns: true if succesfully updated, otherwise false.

◆ SaveSlurContourPrefs()

bool FCSmartShapePrefs::SaveSlurContourPrefs ( FCSlurContourPrefs * pPrefs )

inline

Saves the slur contour prefs.

This function stores the input slur contour prefs in the FCSmartShapePrefs. To store any changes in the Finale document, call FCSmartShapePrefs::Save after calling this function.

Lua-supported (0.65).

Returns: True on success.

◆ SetArticulationAvoidSlursBy()

void FCSmartShapePrefs::SetArticulationAvoidSlursBy ( Evpu16 value )

inline

Returns the value for Articulations Avoid Slurs By (in EVPU)

Does nothing if running a Finale version less than Finale 26.2

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

◆ SetCustomLineDefID()

void FCSmartShapePrefs::SetCustomLineDefID ( CMPER idvalue )

inline

Sets the default custom startshape definition ID for custom smartshape lines.

Lua-supported (also as property).

◆ SetEngraverSlurAccidentalSpace()

void FCSmartShapePrefs::SetEngraverSlurAccidentalSpace ( Evpu16 value )

inline

Sets the space around accidentals for Engraver Slurs, in EVPUs.

Setting is only used if GetEngraverSlurAvoidAccidentals returns true.

Lua-supported (also as property).

◆ SetEngraverSlurAvoidAccidentals()

void FCSmartShapePrefs::SetEngraverSlurAvoidAccidentals ( bool state )

inline

Sets if the engraver slurs should avoid accidentals.

Lua-supported (also as property).

◆ SetEngraverSlurMaxAngle()

void FCSmartShapePrefs::SetEngraverSlurMaxAngle ( twobyte value )

inline

Sets the maximum slur angle (in 1/100 of a degree) for Engraver Slurs.

Lua-supported (also as property).

◆ SetEngraverSlurMaxLift()

void FCSmartShapePrefs::SetEngraverSlurMaxLift ( Efix32 value )

inline

Sets the max lift value for Engraver Slurs, in EFIXes.

Lua-supported (also as property).

◆ SetEngraverSlurMaxStretchFixed()

void FCSmartShapePrefs::SetEngraverSlurMaxStretchFixed ( Efix32 value )

inline

Sets the Engraver Slur max stretch value for fixed stretches, in EFIXes.

Lua-supported (also as property).

◆ SetEngraverSlurMaxStretchPercent()

void FCSmartShapePrefs::SetEngraverSlurMaxStretchPercent ( twobyte value )

inline

Sets the Engraver Slur max stretch value for stretches (in 1/100 percent).

Lua-supported (also as property).

◆ SetEngraverSlurSpaceAround()

void FCSmartShapePrefs::SetEngraverSlurSpaceAround ( Evpu16 value )

inline

Sets the space around objects for Engraver Slurs.

Lua-supported (also as property).

◆ SetEngraverSlurStretchByPercent()

void FCSmartShapePrefs::SetEngraverSlurStretchByPercent ( bool state )

inline

Sets if Engraver Slur stretches should be made in percent or absolute.

Lua-supported (also as property).

Parameters

state True - Stretch by percent. False - Stretch by fixed value.

◆ SetEngraverSlurStretchFirst()

void FCSmartShapePrefs::SetEngraverSlurStretchFirst ( bool state )

inline

Sets if Engraver Slurs should stretch before lift.

Lua-supported (also as property).

Parameters

state True - Stretch first, then lift. False - Lift first.

◆ SetEngraverSlurSymmetryPercent()

void FCSmartShapePrefs::SetEngraverSlurSymmetryPercent ( twobyte value )

inline

Sets the slur symmetry percentage (in 1/100 of a percent) for Engraver Slurs.

Lua-supported (also as property).

◆ SetGlissandoDefID()

void FCSmartShapePrefs::SetGlissandoDefID ( CMPER idvalue )

inline

Sets the default custom startshape definition ID for glissando lines.

Lua-supported (also as property).

◆ SetGuitarBendAutoGenerateText()

void FCSmartShapePrefs::SetGuitarBendAutoGenerateText ( bool state )

inline

Sets the value for Guitar Bend Options - Automatically Generate Text.

Lua-supported (also as property).

◆ SetGuitarBendDefID()

void FCSmartShapePrefs::SetGuitarBendDefID ( CMPER idvalue )

inline

Sets the default custom startshape definition ID for guitar bend lines.

Lua-supported (also as property).

◆ SetGuitarBendHideNumber()

void FCSmartShapePrefs::SetGuitarBendHideNumber ( bool state )

inline

Sets the value for Guitar Bend Options - Hide "Bend-To" Number.

Lua-supported (also as property).

◆ SetGuitarBendParentheses()

void FCSmartShapePrefs::SetGuitarBendParentheses ( bool state )

inline

Sets the value for Guitar Bend Options - Place Release Bend Number in Parentheses.

Lua-supported (also as property).

◆ SetGuitarBendReplaceWithFull()

void FCSmartShapePrefs::SetGuitarBendReplaceWithFull ( bool state )

inline

Sets the value for Guitar Bend Options - Replace "1" with "Full".

The value is only used if GetGuitarBendAutoGenerateText returns true.

Lua-supported (also as property).

◆ SetHairpinDefaultOpening()

void FCSmartShapePrefs::SetHairpinDefaultOpening ( Evpu16 value )

inline

Sets the default hairpin opening value in the Smart Shape preferences.

In Finale 25.3 and later, this is the "Long Span Opening Width" setting, since short and long spans are separated.

Lua-supported (also as property).

◆ SetHairpinDefaultShortOpening()

void FCSmartShapePrefs::SetHairpinDefaultShortOpening ( Evpu16 value )

Sets the default hairpin short opening value (added in Finale 25.3) in the Smart Shape preferences.

On version earlier than Finale 25.3, this method does nothing.

Lua-supported (also as property).

◆ SetHairpinLineWidth()

void FCSmartShapePrefs::SetHairpinLineWidth ( Efix16 value )

inline

Sets the hairpin line width, in EFIXes.

Lua-supported (also as property).

◆ SetHairpinMakeHorizontal()

void FCSmartShapePrefs::SetHairpinMakeHorizontal ( bool state )

inline

Sets the "make horizontal" value in the Smart Shape preferences.

Lua-supported (also as property).

◆ SetHairpinMaxShortSpanLength()

void FCSmartShapePrefs::SetHairpinMaxShortSpanLength ( twobyte value )

Sets the "Maximum short span length" (added in Finale 25.3) in the Smart Shape preferences.

On version earlier than Finale 25.3, this method does nothing.

Lua-supported (also as property).

◆ SetHookLength()

void FCSmartShapePrefs::SetHookLength ( Evpu16 value )

inline

Sets the hook length, if EVPUs.

Lua-supported (also as property).

◆ SetLineDashLength()

void FCSmartShapePrefs::SetLineDashLength ( Evpu16 value )

inline

Returns the default dash length, if EVPUs.

Lua-supported (also as property).

◆ SetLineDashSpace()

void FCSmartShapePrefs::SetLineDashSpace ( Evpu16 value )

inline

Sets the default dash space, if EVPUs.

Lua-supported (also as property).

◆ SetLineWidth()

void FCSmartShapePrefs::SetLineWidth ( Efix16 value )

inline

Sets the default line width for normal lines, if EFIXes.

Lua-supported (also as property).

◆ SetOctavesAsText()

void FCSmartShapePrefs::SetOctavesAsText ( bool state )

inline

Set the flag for if octavas should display as text instead of a symbol.

Lua-supported (also as property).

◆ SetSlurBreakStaffLineAvoid()

void FCSmartShapePrefs::SetSlurBreakStaffLineAvoid ( Evpu16 value )

inline

Sets the minimum distance to avoid staff lines by, for slur system breaks. In EVPUs.

Lua-supported (also as property).

◆ SetSlurBreakSystemEnd()

void FCSmartShapePrefs::SetSlurBreakSystemEnd ( Evpu16 value )

inline

Sets the horizontal system end adjustment for slur system breaks. In EVPUs.

Lua-supported (also as property).

◆ SetSlurBreakSystemStart()

void FCSmartShapePrefs::SetSlurBreakSystemStart ( Evpu16 value )

inline

Sets the horizontal system start adjustment for slur system breaks. In EVPUs.

Lua-supported (also as property).

◆ SetSlurThicknessHorizontalLeft()

void FCSmartShapePrefs::SetSlurThicknessHorizontalLeft ( Evpu16 value )

inline

Sets slur thickness to the horizontal left, in EVPUs.

Lua-supported (also as property).

◆ SetSlurThicknessHorizontalRight()

void FCSmartShapePrefs::SetSlurThicknessHorizontalRight ( Evpu16 value )

inline

Sets slur thickness to the horizontal right, in EVPUs.

Lua-supported (also as property).

◆ SetSlurThicknessVerticalLeft()

void FCSmartShapePrefs::SetSlurThicknessVerticalLeft ( Evpu16 value )

inline

Sets slur thickness to the vertical left, in EVPUs.

Lua-supported (also as property).

◆ SetSlurThicknessVerticalRight()

void FCSmartShapePrefs::SetSlurThicknessVerticalRight ( Evpu16 value )

inline

Sets slur thickness to the vertical right, in EVPUs.

Lua-supported (also as property).

◆ SetSlurTipAvoidStaffAmount()

void FCSmartShapePrefs::SetSlurTipAvoidStaffAmount ( Evpu16 value )

inline

Sets if slur tips should avoid staff lines.

The setting is controlled by GetSlurTipAvoidStaffUse.

Lua-supported (also as property).

◆ SetSlurTipAvoidStaffUse()

void FCSmartShapePrefs::SetSlurTipAvoidStaffUse ( bool state )

inline

Sets if slur tips should avoid staff lines.

The corresponding value is set by SetSlurTipAvoidStaffAmount.

Lua-supported (also as property).

◆ SetSlurTipWidth()

void FCSmartShapePrefs::SetSlurTipWidth ( Int10000ths32 value )

inline

Sets the slur tip width (in 1/10,000 of an EVPU)

Lua-supported (also as property).

◆ SetTabSlideDefID()

void FCSmartShapePrefs::SetTabSlideDefID ( CMPER idvalue )

inline

Sets the default custom startshape definition ID for tab slide lines.

Lua-supported (also as property).

◆ SetUseEngraverSlurs()

void FCSmartShapePrefs::SetUseEngraverSlurs ( bool state )

inline

Sets true if engraver slurs should be used.

Lua-supported (also as property).

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ SSENTCNCTSTYLE_TYPES

Constructor & Destructor Documentation

◆ FCSmartShapePrefs()

Member Function Documentation

◆ ClassName()

◆ CreateEntryConnectStyle()

◆ CreateSlurContourPrefs()

◆ DebugDump()

◆ GetArticulationAvoidSlursBy()

◆ GetClassID()

◆ GetCustomLineDefID()

◆ GetEngraverSlurAccidentalSpace()

◆ GetEngraverSlurAvoidAccidentals()

◆ GetEngraverSlurMaxAngle()

◆ GetEngraverSlurMaxLift()

◆ GetEngraverSlurMaxStretchFixed()

◆ GetEngraverSlurMaxStretchPercent()

◆ GetEngraverSlurSpaceAround()

◆ GetEngraverSlurStretchByPercent()

◆ GetEngraverSlurStretchFirst()

◆ GetEngraverSlurSymmetryPercent()

◆ GetEntryConnectStyleCount()

◆ GetGlissandoDefID()

◆ GetGuitarBendAutoGenerateText()

◆ GetGuitarBendDefID()

◆ GetGuitarBendHideNumber()

◆ GetGuitarBendParentheses()

◆ GetGuitarBendReplaceWithFull()

◆ GetHairpinDefaultOpening()

◆ GetHairpinDefaultShortOpening()

◆ GetHairpinLineWidth()

◆ GetHairpinMakeHorizontal()

◆ GetHairpinMaxShortSpanLength()

◆ GetHookLength()

◆ GetLineDashLength()

◆ GetLineDashSpace()

◆ GetLineWidth()

◆ GetOctavesAsText()

◆ GetSlurBreakStaffLineAvoid()

◆ GetSlurBreakSystemEnd()

◆ GetSlurBreakSystemStart()

◆ GetSlurThicknessHorizontalLeft()

◆ GetSlurThicknessHorizontalRight()

◆ GetSlurThicknessVerticalLeft()

◆ GetSlurThicknessVerticalRight()

◆ GetSlurTipAvoidStaffAmount()

◆ GetSlurTipAvoidStaffUse()

◆ GetSlurTipWidth()

◆ GetTabSlideDefID()

◆ GetUseEngraverSlurs()

◆ SaveEntryConnectStyle()

◆ SaveSlurContourPrefs()

◆ SetArticulationAvoidSlursBy()

◆ SetCustomLineDefID()

◆ SetEngraverSlurAccidentalSpace()

◆ SetEngraverSlurAvoidAccidentals()

◆ SetEngraverSlurMaxAngle()

◆ SetEngraverSlurMaxLift()

◆ SetEngraverSlurMaxStretchFixed()

◆ SetEngraverSlurMaxStretchPercent()

◆ SetEngraverSlurSpaceAround()

◆ SetEngraverSlurStretchByPercent()

◆ SetEngraverSlurStretchFirst()

◆ SetEngraverSlurSymmetryPercent()

◆ SetGlissandoDefID()

◆ SetGuitarBendAutoGenerateText()

◆ SetGuitarBendDefID()

◆ SetGuitarBendHideNumber()

◆ SetGuitarBendParentheses()

◆ SetGuitarBendReplaceWithFull()

◆ SetHairpinDefaultOpening()

◆ SetHairpinDefaultShortOpening()

◆ SetHairpinLineWidth()

◆ SetHairpinMakeHorizontal()

◆ SetHairpinMaxShortSpanLength()