The preferences for ties (includes options both from tie options and tie contour options). More...

#include <ff_prefs.h>

Inheritance diagram for FCTiePrefs:

Public Types
enum	TIE_SECONDS_CONSTANTS { TIESECONDS_NONE = TIE_SCNDS_NONE , TIESECONDS_SHIFTSTART = TIE_SCNDS_SHIFT_START , TIESECONDS_SHIFTEND = TIE_SCNDS_SHIFT_END , TIESECONDS_SHIFTBOTH = TIE_SCNDS_BOTH }
	The constants for seconds placement. More...

enum	TIE_CHORD_DIRECTIONS { TIECHORDDIR_OUTSIDEINSIDE = 0 , TIECHORDDIR_STEMREVERSAL = 1 , TIECHORDDIR_SPLITEVENLY = 2 }
	The constants for the tie chord direction type. More...

enum	TIE_MIXED_STEM_TYPES { TIEMIXEDSTEM_OVER = 0 , TIEMIXEDSTEM_UNDER = 1 , TIEMIXEDSTEM_OPPOSITEFIRSTSTEM = 2 }
	Constants for tie direction at mixed stems. 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.

	FCTiePrefs ()
	The constructor.

Evpu16	GetThicknessRight () const
	Returns the right-side tie thickness.

Evpu16	GetThicknessLeft () const
	Returns the left-side tie thickness.

bool	GetBreakForTimeSigs () const
	Returns true if the tie should break for time signatures.

bool	GetBreakForKeySigs () const
	Returns true if the tie should break for key signatures.

Evpu16	GetTimeSigLeftHorizontalOffset () const
	Returns the "Break for time signatures - left gap" setting.

Evpu16	GetTimeSigRightHorizontalOffset () const
	Returns the "Break for time signatures - right gap" setting.

Evpu16	GetKeySigLeftHorizontalOffset () const
	Returns the "Break for key signatures - left gap" setting.

Evpu16	GetKeySigRightHorizontalOffset () const
	Returns the "Break for key signatures - right gap" setting.

Evpu16	GetSystemLeftHorizontalOffset () const
	Returns the value for "Tie system break, horizontal start adjustment".

Evpu16	GetSystemRightHorizontalOffset () const
	Returns the value for "Tie system break, horizontal end adjustment".

Evpu16	GetExtraSystemStartSpace () const
	Returns the sign-reversed value for "Extra System Start Space".

bool	GetUseOuterPlacement () const
	Returns the "Use outer placement" value.

FLAG_16	GetSecondsPlacement () const
	Returns the seconds placement style.

twobyte	GetChordDirectionType () const
	Returns the chord direction type.

bool	GetChordDirectionOpposingSeconds () const
	Returns the "Tie direction - opposing seconds" state.

twobyte	GetMixedStemDirectionType () const
	Returns the "Tie direction at mixed stems" type.

bool	GetAfterSingleDot () const
	Returns if the tie should start after a single dot.

bool	GetAfterMultipleDots () const
	Returns if the tie should start after multiple dots.

bool	GetBeforeSingleAccidental () const
	Returns if the tie should end before a single accidental.

bool	GetAvoidStaffLines () const
	Returns if the tie should avoid staff lines.

Evpu16	GetAvoidStaffLinesDistance () const
	Returns the EVPU distance for how much to avoid staff lines vertically (in the tie contour options).

bool	GetFixedInsetStyle () const
	Returns if the inset style is fixed or in percent (in the tie contour options).

bool	GetUseInterpolation () const
	Returns if heights should be interpolated or not (in the tie contour options).

bool	GetUseTieEndStyle () const
	Returns the "Use Tie End Style" state (in the tie contour options).

bool	GetAvoidStaffLinesOnly () const
	Returns the "In Staff Only" state (in the tie contour options). If set, avoid staff lines in staves only.

fourbyte	GetTipWidth () const
	Returns the tie tip width, in 1/10000 of an EVPU.

void	SetThicknessRight (Evpu16 value)
	Returns the right-side tie thickness.

void	SetThicknessLeft (Evpu16 value)
	Returns the left-side tie thickness.

void	SetBreakForTimeSigs (bool state)
	Sets if the tie should break for time signatures.

void	SetBreakForKeySigs (bool state)
	Sets if the tie should break for key signatures.

void	SetTimeSigLeftHorizontalOffset (Evpu16 value)
	Returns the "Break for time signatures - left gap" setting.

void	SetTimeSigRightHorizontalOffset (Evpu16 value)
	Returns the "Break for time signatures - right gap" setting.

void	SetKeySigLeftHorizontalOffset (Evpu16 value)
	Returns the "Break for key signatures - left gap" setting.

void	SetKeySigRightHorizontalOffset (Evpu16 value)
	Returns the "Break for key signatures - right gap" setting.

void	SetSystemLeftHorizontalOffset (Evpu16 value)
	Sets the value for "Tie system break, horizontal start adjustment".

void	SetSystemRightHorizontalOffset (Evpu16 value)
	Sets the value for "Tie system break, horizontal end adjustment".

void	SetExtraSystemStartSpace (Evpu16 value)
	Sets the sign-reversed value for "Extra System Start Space".

void	SetUseOuterPlacement (bool state)
	Sets the "Use outer placement" state.

void	SetSecondsPlacement (FLAG_16 value)
	Sets the seconds placement style.

void	SetChordDirectionType (twobyte value)
	Sets the chord direction type.

void	SetChordDirectionOpposingSeconds (bool state)
	Sets the "Tie direction - opposing seconds" state.

void	SetMixedStemDirectionType (twobyte value)
	Returns the "Tie direction at mixed stems" type.

void	SetAfterSingleDot (bool state)
	Sets if the tie should start after a single dot.

void	SetAfterMultipleDots (bool state)
	Sets if the tie should start after multiple dots.

void	SetBeforeSingleAccidental (bool state)
	Sets if the tie should end before a single accidental.

void	SetAvoidStaffLines (bool state)
	Sets if the tie should avoid staff lines.

void	SetAvoidStaffLinesDistance (Evpu16 value)
	Sets the EVPU distance for how much to avoid staff lines vertically (in the tie contour options).

void	SetFixedInsetStyle (bool state)
	Sets if the inset style is fixed or in percent (in the tie contour options).

void	SetUseInterpolation (bool state)
	Sets if heights should be interpolated or not (in the tie contour options).

void	SetUseTieEndStyle (bool state)
	Sets the "Use Tie End Style" state (in the tie contour options).

void	SetAvoidStaffLinesOnly (bool state)
	Sets the "In Staff Only" state (in the tie contour options). If set, avoid staff lines in staves only.

void	SetTipWidth (fourbyte value)
	Sets the tie tip width, in 1/10000 of an EVPU.

FCTiePlacementPrefs *	CreateTiePlacementPrefs () const
	Creates the tie placement prefs.

bool	SaveTiePlacementPrefs (FCTiePlacementPrefs *pPlacementPrefs)
	Saves the tie placement prefs.

FCTieContourPrefs *	CreateTieContourPrefs () const
	Creates the tie contour prefs.

bool	SaveTieContourPrefs (FCTieContourPrefs *pPrefs)
	Saves the tie contour prefs.

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

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

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

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

int	GetItemNo () const
	Returns the prefs number for the loaded data.

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 EVERSION	EnigmaVersion () const
	The Enigma version for save/load/create/delete operations.

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.

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

virtual bool	DeepDeleteData ()
	Deletes data and all data that's connected to the object.

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	DebugDump () override
	Outputs the class data/information for debugging purposes.

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

Protected Member Functions inherited from __FCBaseData
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!

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 preferences for ties (includes options both from tie options and tie contour options).

One of the tie settings is also available in the FCMusicSpacingPrefs class as FCMusicSpacingPrefs::GetTiesGutter, since it affects the beat chart. However, as of version 0.58 it is recommended to use FCTiePrefs::GetExtraSystemStartSpace instead.

Member Enumeration Documentation

◆ TIE_CHORD_DIRECTIONS

enum FCTiePrefs::TIE_CHORD_DIRECTIONS

The constants for the tie chord direction type.

Lua-supported.

Enumerator
TIECHORDDIR_OUTSIDEINSIDE	Outside/inside
TIECHORDDIR_STEMREVERSAL	Stem reversal
TIECHORDDIR_SPLITEVENLY	Split evenly

◆ TIE_MIXED_STEM_TYPES

enum FCTiePrefs::TIE_MIXED_STEM_TYPES

Constants for tie direction at mixed stems.

Lua-supported.

Enumerator
TIEMIXEDSTEM_OVER	Over
TIEMIXEDSTEM_UNDER	Under
TIEMIXEDSTEM_OPPOSITEFIRSTSTEM	Opposite first stem

◆ TIE_SECONDS_CONSTANTS

enum FCTiePrefs::TIE_SECONDS_CONSTANTS

The constants for seconds placement.

Lua-supported.

Enumerator
TIESECONDS_NONE	Do not shift for seconds on start or end of tie.
TIESECONDS_SHIFTSTART	Shift for seconds on start of tie
TIESECONDS_SHIFTEND	Shift for seconds on end of tie
TIESECONDS_SHIFTBOTH	Shift for seconds on start and end of tie.

Constructor & Destructor Documentation

◆ FCTiePrefs()

FCTiePrefs::FCTiePrefs ( )

inline

The constructor.

Lua-supported.

Member Function Documentation

◆ ClassName()

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

◆ CreateTieContourPrefs()

FCTieContourPrefs * FCTiePrefs::CreateTieContourPrefs ( ) const

inline

Creates the tie 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.58).

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.

◆ CreateTiePlacementPrefs()

FCTiePlacementPrefs * FCTiePrefs::CreateTiePlacementPrefs ( ) const

inline

Creates the tie placement prefs.

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

Lua-supported (0.58).

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

◆ GetAfterMultipleDots()

bool FCTiePrefs::GetAfterMultipleDots ( ) const

inline

Returns if the tie should start after multiple dots.

Lua-supported (also as property).

◆ GetAfterSingleDot()

bool FCTiePrefs::GetAfterSingleDot ( ) const

inline

Returns if the tie should start after a single dot.

Lua-supported (also as property).

◆ GetAvoidStaffLines()

bool FCTiePrefs::GetAvoidStaffLines ( ) const

inline

Returns if the tie should avoid staff lines.

Lua-supported (also as property).

◆ GetAvoidStaffLinesDistance()

Evpu16 FCTiePrefs::GetAvoidStaffLinesDistance ( ) const

inline

Returns the EVPU distance for how much to avoid staff lines vertically (in the tie contour options).

Lua-supported (also as property).

◆ GetAvoidStaffLinesOnly()

bool FCTiePrefs::GetAvoidStaffLinesOnly ( ) const

inline

Returns the "In Staff Only" state (in the tie contour options).
If set, avoid staff lines in staves only.

Lua-supported (also as property).

◆ GetBeforeSingleAccidental()

bool FCTiePrefs::GetBeforeSingleAccidental ( ) const

inline

Returns if the tie should end before a single accidental.

Lua-supported (also as property).

◆ GetBreakForKeySigs()

bool FCTiePrefs::GetBreakForKeySigs ( ) const

inline

Returns true if the tie should break for key signatures.

Lua-supported (also as property).

◆ GetBreakForTimeSigs()

bool FCTiePrefs::GetBreakForTimeSigs ( ) const

inline

Returns true if the tie should break for time signatures.

Lua-supported (also as property).

◆ GetChordDirectionOpposingSeconds()

bool FCTiePrefs::GetChordDirectionOpposingSeconds ( ) const

inline

Returns the "Tie direction - opposing seconds" state.

Lua-supported (also as property).

◆ GetChordDirectionType()

twobyte FCTiePrefs::GetChordDirectionType ( ) const

inline

Returns the chord direction type.

Lua-supported (also as property).

Returns: Any of the TIECHORDDIR_ constants.

◆ GetClassID()

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

◆ GetExtraSystemStartSpace()

Evpu16 FCTiePrefs::GetExtraSystemStartSpace ( ) const

inline

Returns the sign-reversed value for "Extra System Start Space".

Remarks: Use this instead of FCMusicSpacingPrefs::GetTiesGutter. (Both access the same setting in the document.) However, be aware that the sign is reversed from the value you see in the Finale UI and the value that FCMusicSpacingPrefs::GetTiesGutter returns.

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

◆ GetFixedInsetStyle()

bool FCTiePrefs::GetFixedInsetStyle ( ) const

inline

Returns if the inset style is fixed or in percent (in the tie contour options).

Lua-supported (also as property).

Returns: True - fixed inset style, false - inset style in percent.

◆ GetKeySigLeftHorizontalOffset()

Evpu16 FCTiePrefs::GetKeySigLeftHorizontalOffset ( ) const

inline

Returns the "Break for key signatures - left gap" setting.

Lua-supported (also as property).

◆ GetKeySigRightHorizontalOffset()

Evpu16 FCTiePrefs::GetKeySigRightHorizontalOffset ( ) const

inline

Returns the "Break for key signatures - right gap" setting.

Lua-supported (also as property).

◆ GetMixedStemDirectionType()

twobyte FCTiePrefs::GetMixedStemDirectionType ( ) const

inline

Returns the "Tie direction at mixed stems" type.

Lua-supported (also as property).

Returns: Any of the TIEMIXEDSTEM_ constants.

◆ GetSecondsPlacement()

FLAG_16 FCTiePrefs::GetSecondsPlacement ( ) const

inline

Returns the seconds placement style.

Lua-supported (also as property).

Returns: Any of the TIESECONDS_ constants.

◆ GetSystemLeftHorizontalOffset()

Evpu16 FCTiePrefs::GetSystemLeftHorizontalOffset ( ) const

inline

Returns the value for "Tie system break, horizontal start adjustment".

Lua-supported (also as property).

◆ GetSystemRightHorizontalOffset()

Evpu16 FCTiePrefs::GetSystemRightHorizontalOffset ( ) const

inline

Returns the value for "Tie system break, horizontal end adjustment".

Lua-supported (also as property).

◆ GetThicknessLeft()

Evpu16 FCTiePrefs::GetThicknessLeft ( ) const

inline

Returns the left-side tie thickness.

Lua-supported (also as property).

◆ GetThicknessRight()

Evpu16 FCTiePrefs::GetThicknessRight ( ) const

inline

Returns the right-side tie thickness.

Lua-supported (also as property).

◆ GetTimeSigLeftHorizontalOffset()

Evpu16 FCTiePrefs::GetTimeSigLeftHorizontalOffset ( ) const

inline

Returns the "Break for time signatures - left gap" setting.

Lua-supported (also as property).

◆ GetTimeSigRightHorizontalOffset()

Evpu16 FCTiePrefs::GetTimeSigRightHorizontalOffset ( ) const

inline

Returns the "Break for time signatures - right gap" setting.

Lua-supported (also as property).

◆ GetTipWidth()

fourbyte FCTiePrefs::GetTipWidth ( ) const

inline

Returns the tie tip width, in 1/10000 of an EVPU.

Lua-supported (also as property).

◆ GetUseInterpolation()

bool FCTiePrefs::GetUseInterpolation ( ) const

inline

Returns if heights should be interpolated or not (in the tie contour options).

Lua-supported (also as property).

Returns: True - Interpolate Height Between Short and Long Span. False - Use Medium Height Between Short and Long Span

◆ GetUseOuterPlacement()

bool FCTiePrefs::GetUseOuterPlacement ( ) const

inline

Returns the "Use outer placement" value.

Lua-supported (also as property).

◆ GetUseTieEndStyle()

bool FCTiePrefs::GetUseTieEndStyle ( ) const

inline

Returns the "Use Tie End Style" state (in the tie contour options).

Lua-supported (also as property).

◆ SaveTieContourPrefs()

bool FCTiePrefs::SaveTieContourPrefs ( FCTieContourPrefs * pPrefs )

inline

Saves the tie contour prefs.

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

Lua-supported (0.58).

Returns: True on success.

◆ SaveTiePlacementPrefs()

bool FCTiePrefs::SaveTiePlacementPrefs ( FCTiePlacementPrefs * pPlacementPrefs )

inline

Saves the tie placement prefs.

This function stores the input tie placement prefs in the FCTiePrefs. To store any changes in the Finale document, call FCTiePrefs::Save after calling this function.

Lua-supported (0.58).

Returns: True on success.

◆ SetAfterMultipleDots()

void FCTiePrefs::SetAfterMultipleDots ( bool state )

inline

Sets if the tie should start after multiple dots.

Lua-supported (also as property).

◆ SetAfterSingleDot()

void FCTiePrefs::SetAfterSingleDot ( bool state )

inline

Sets if the tie should start after a single dot.

Lua-supported (also as property).

◆ SetAvoidStaffLines()

void FCTiePrefs::SetAvoidStaffLines ( bool state )

inline

Sets if the tie should avoid staff lines.

Lua-supported (also as property).

◆ SetAvoidStaffLinesDistance()

void FCTiePrefs::SetAvoidStaffLinesDistance ( Evpu16 value )

inline

Sets the EVPU distance for how much to avoid staff lines vertically (in the tie contour options).

Lua-supported (also as property).

◆ SetAvoidStaffLinesOnly()

void FCTiePrefs::SetAvoidStaffLinesOnly ( bool state )

inline

Sets the "In Staff Only" state (in the tie contour options). If set, avoid staff lines in staves only.

Lua-supported (also as property).

◆ SetBeforeSingleAccidental()

void FCTiePrefs::SetBeforeSingleAccidental ( bool state )

inline

Sets if the tie should end before a single accidental.

Lua-supported (also as property).

◆ SetBreakForKeySigs()

void FCTiePrefs::SetBreakForKeySigs ( bool state )

inline

Sets if the tie should break for key signatures.

Lua-supported (also as property).

◆ SetBreakForTimeSigs()

void FCTiePrefs::SetBreakForTimeSigs ( bool state )

inline

Sets if the tie should break for time signatures.

Lua-supported (also as property).

◆ SetChordDirectionOpposingSeconds()

void FCTiePrefs::SetChordDirectionOpposingSeconds ( bool state )

inline

Sets the "Tie direction - opposing seconds" state.

Lua-supported (also as property).

◆ SetChordDirectionType()

void FCTiePrefs::SetChordDirectionType ( twobyte value )

inline

Sets the chord direction type.

Lua-supported (also as property).

Parameters

value Any of the TIECHORDDIR_ constants.

◆ SetExtraSystemStartSpace()

void FCTiePrefs::SetExtraSystemStartSpace ( Evpu16 value )

inline

Sets the sign-reversed value for "Extra System Start Space".

Remarks: Use this instead of FCMusicSpacingPrefs::SetTiesGutter. (Both access the same setting in the document.) However, be aware that the sign should be reversed from the value you set in the Finale UI and the value that you sent to FCMusicSpacingPrefs::SetTiesGutter.

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

◆ SetFixedInsetStyle()

void FCTiePrefs::SetFixedInsetStyle ( bool state )

inline

Sets if the inset style is fixed or in percent (in the tie contour options).

Lua-supported (also as property).

Parameters

state True - fixed inset style, false - inset style in percent.

◆ SetKeySigLeftHorizontalOffset()

void FCTiePrefs::SetKeySigLeftHorizontalOffset ( Evpu16 value )

inline

Returns the "Break for key signatures - left gap" setting.

Lua-supported (also as property).

◆ SetKeySigRightHorizontalOffset()

void FCTiePrefs::SetKeySigRightHorizontalOffset ( Evpu16 value )

inline

Returns the "Break for key signatures - right gap" setting.

Lua-supported (also as property).

◆ SetMixedStemDirectionType()

void FCTiePrefs::SetMixedStemDirectionType ( twobyte value )

inline

Returns the "Tie direction at mixed stems" type.

Lua-supported (also as property).

Parameters

value Any of the TIEMIXEDSTEM_ constants.

◆ SetSecondsPlacement()

void FCTiePrefs::SetSecondsPlacement ( FLAG_16 value )

inline

Sets the seconds placement style.

Lua-supported (also as property).

Parameters

value Any of the TIESECONDS_ constants.

◆ SetSystemLeftHorizontalOffset()

void FCTiePrefs::SetSystemLeftHorizontalOffset ( Evpu16 value )

inline

Sets the value for "Tie system break, horizontal start adjustment".

Lua-supported (also as property).

◆ SetSystemRightHorizontalOffset()

void FCTiePrefs::SetSystemRightHorizontalOffset ( Evpu16 value )

inline

Sets the value for "Tie system break, horizontal end adjustment".

Lua-supported (also as property).

◆ SetThicknessLeft()

void FCTiePrefs::SetThicknessLeft ( Evpu16 value )

inline

Returns the left-side tie thickness.

Lua-supported (also as property).

◆ SetThicknessRight()

void FCTiePrefs::SetThicknessRight ( Evpu16 value )

inline

Returns the right-side tie thickness.

Lua-supported (also as property).

◆ SetTimeSigLeftHorizontalOffset()

void FCTiePrefs::SetTimeSigLeftHorizontalOffset ( Evpu16 value )

inline

Returns the "Break for time signatures - left gap" setting.

Lua-supported (also as property).

◆ SetTimeSigRightHorizontalOffset()

void FCTiePrefs::SetTimeSigRightHorizontalOffset ( Evpu16 value )

inline

Returns the "Break for time signatures - right gap" setting.

Lua-supported (also as property).

◆ SetTipWidth()

void FCTiePrefs::SetTipWidth ( fourbyte value )

inline

Sets the tie tip width, in 1/10000 of an EVPU.

Lua-supported (also as property).

◆ SetUseInterpolation()

void FCTiePrefs::SetUseInterpolation ( bool state )

inline

Sets if heights should be interpolated or not (in the tie contour options).

Lua-supported (also as property).

Parameters

state True - Interpolate Height Between Short and Long Span. False - Use Medium Height Between Short and Long Span

◆ SetUseOuterPlacement()

void FCTiePrefs::SetUseOuterPlacement ( bool state )

inline

Sets the "Use outer placement" state.

Lua-supported (also as property).

◆ SetUseTieEndStyle()

void FCTiePrefs::SetUseTieEndStyle ( bool state )

inline

Sets the "Use Tie End Style" state (in the tie contour options).

Lua-supported (also as property).

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ TIE_CHORD_DIRECTIONS

◆ TIE_MIXED_STEM_TYPES

◆ TIE_SECONDS_CONSTANTS

Constructor & Destructor Documentation

◆ FCTiePrefs()

Member Function Documentation

◆ ClassName()

◆ CreateTieContourPrefs()

◆ CreateTiePlacementPrefs()

◆ GetAfterMultipleDots()

◆ GetAfterSingleDot()

◆ GetAvoidStaffLines()

◆ GetAvoidStaffLinesDistance()

◆ GetAvoidStaffLinesOnly()

◆ GetBeforeSingleAccidental()

◆ GetBreakForKeySigs()

◆ GetBreakForTimeSigs()

◆ GetChordDirectionOpposingSeconds()

◆ GetChordDirectionType()

◆ GetClassID()

◆ GetExtraSystemStartSpace()

◆ GetFixedInsetStyle()

◆ GetKeySigLeftHorizontalOffset()

◆ GetKeySigRightHorizontalOffset()

◆ GetMixedStemDirectionType()

◆ GetSecondsPlacement()

◆ GetSystemLeftHorizontalOffset()

◆ GetSystemRightHorizontalOffset()

◆ GetThicknessLeft()

◆ GetThicknessRight()

◆ GetTimeSigLeftHorizontalOffset()

◆ GetTimeSigRightHorizontalOffset()

◆ GetTipWidth()

◆ GetUseInterpolation()

◆ GetUseOuterPlacement()

◆ GetUseTieEndStyle()

◆ SaveTieContourPrefs()

◆ SaveTiePlacementPrefs()

◆ SetAfterMultipleDots()

◆ SetAfterSingleDot()

◆ SetAvoidStaffLines()

◆ SetAvoidStaffLinesDistance()

◆ SetAvoidStaffLinesOnly()

◆ SetBeforeSingleAccidental()

◆ SetBreakForKeySigs()

◆ SetBreakForTimeSigs()

◆ SetChordDirectionOpposingSeconds()

◆ SetChordDirectionType()

◆ SetExtraSystemStartSpace()

◆ SetFixedInsetStyle()

◆ SetKeySigLeftHorizontalOffset()

◆ SetKeySigRightHorizontalOffset()

◆ SetMixedStemDirectionType()

◆ SetSecondsPlacement()

◆ SetSystemLeftHorizontalOffset()

◆ SetSystemRightHorizontalOffset()

◆ SetThicknessLeft()

◆ SetThicknessRight()

◆ SetTimeSigLeftHorizontalOffset()

◆ SetTimeSigRightHorizontalOffset()

◆ SetTipWidth()

◆ SetUseInterpolation()

◆ SetUseOuterPlacement()

◆ SetUseTieEndStyle()