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

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

#include <ff_prefs.h>

Inheritance diagram for FCTiePrefs:
__FCPrefsBase __FCBaseData __FCBase

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_ALLOTMENT, FCID_ARTICULATION,
  FCID_ARTICULATIONDEF, FCID_BACKWARDREPEAT, FCID_BASELINE, FCID_BEAMMOD,
  FCID_BEATCHARTELEMENT, FCID_BROKENBEAMMOD, FCID_CATEGORYDEF, FCID_CELLCLEFCHANGE,
  FCID_CELLFRAMEHOLD, FCID_CELLGRAPHIC, FCID_CELLTEXT, FCID_CENTERSMARTSHAPE,
  FCID_CHORD, FCID_CHORDPREFS, FCID_CHORDSUFFIXELEMENT, FCID_CHORUSSYLLABLE,
  FCID_CLEFDEF, FCID_COMPOSITETIMESIGBOTTOMELEMENT, FCID_COMPOSITETIMESIGTOPELEMENT, FCID_CROSSSTAFFMOD,
  FCID_CUSTOMSMARTLINEDEF, FCID_CUSTOMSTEMMOD, FCID_DISTANCEPREFS, FCID_DOTMOD,
  FCID_ENCLOSURE, FCID_ENDINGREPEAT, FCID_ENTRYALTERMOD, FCID_EXECUTABLESHAPEDEF,
  FCID_EXPRESSION, FCID_FONTINFO, FCID_FONTPREFS, FCID_FREEZESYSTEM,
  FCID_FRETBOARDSTYLEDEF, FCID_FRETBOARDSTYLEDEFS, FCID_FRETBOARDGROUPDEF, FCID_FRETBOARDGROUPDEFS,
  FCID_FRETINSTRUMENTDEF, FCID_GENERALPREFS, FCID_GRIDSGUIDESPREFS, FCID_GROUP,
  FCID_GROUPNAMEPOSITIONPREFS, FCID_HUMANPLAYBACKPREFS, FCID_INDEPENDENTCELLDETAIL, FCID_INSTRUMENTDEF,
  FCID_INSTRUMENTPLAYBACKDATA, FCID_KEYSIGNATURE, FCID_LAYERPREFS, FCID_LYRICSPREFS,
  FCID_MEASURE, FCID_MEASURENUMBERREGION, FCID_METATOOLASSIGNMENT, FCID_MIDIEXPRESSION,
  FCID_MISCDOCPREFS, FCID_MULTIMEASUREREST, FCID_MULTIMEASURERESTPREFS, FCID_MULTISTAFFINSTRUMENT,
  FCID_MULTISTAFFINSTRUMENTS, FCID_MUSICCHARACTERPREFS, FCID_MUSICSPACINGPREFS, FCID_NUMBER,
  FCID_NOTEHEADMOD, FCID_OTHERINCI, FCID_PERCUSSIONLAYOUTNOTE, FCID_PERCUSSIONSTAFF,
  FCID_PERFORMANCEMOD, FCID_PAGE, FCID_PAGEFORMATPREFS, FCID_PAGEGRAPHIC,
  FCID_PAGETEXT, FCID_PART, FCID_PARTEXTRACTPREFS, FCID_PARTSCOPEPREFS,
  FCID_PERCUSSIONNOTEMOD, FCID_PIANOBRACEPREFS, FCID_PLAYBACKPREFS, FCID_RAWTEXT,
  FCID_REPEATPREFS, FCID_SECONDARYBEAMBREAKMOD, FCID_SECTIONSYLLABLE, FCID_SEPARATEMEASURENUMBER,
  FCID_SEPARATEPLACEMENT, FCID_SHAPEDEF, FCID_SHAPEEXPRESSIONDEF, FCID_SLURCONTOURPREFS,
  FCID_SIZEPREFS, FCID_SMARTSHAPE, FCID_SMARTSHAPEENTRYMARK, FCID_SMARTSHAPEMEASUREMARK,
  FCID_SMARTSHAPEPREFS, FCID_STAFF, FCID_STAFFLIST, FCID_STAFFNAMEPOSITION,
  FCID_STAFFNAMEPOSITIONPREFS, FCID_STAFFSTYLEASSIGN, FCID_STAFFSTYLEDEF, FCID_STAFFSYSTEM,
  FCID_STEMCONNECTIONTABLE, FCID_STEMMOD, FCID_STRING, FCID_SYLLABLEENTRYMOD,
  FCID_SYSTEMSTAFF, FCID_TABLATURENOTEMOD, FCID_TEMPOELEMENT, FCID_TEXTBLOCK,
  FCID_TEXTEXPRESSIONDEF, FCID_TEXTREPEAT, FCID_TEXTREPEATDEF, FCID_TIEMOD,
  FCID_TIEPREFS, FCID_TIECONTOURPREFS, FCID_TIEPLACEMENTPREFS, FCID_TIMESIGNATURE,
  FCID_TUPLET, FCID_TUPLETPREFS, FCID_VERSESYLLABLE
}
 Constants for the GetClassID method. More...
 
enum  MEASUREMENTUNITS {
  MEASUREMENTUNIT_DEFAULT = UNIT_DEFAULT, MEASUREMENTUNIT_EVPUS = UNIT_EVPUS, MEASUREMENTUNIT_INCHES = UNIT_INCHES, MEASUREMENTUNIT_CENTIMETERS = UNIT_CENTS,
  MEASUREMENTUNIT_POINTS = UNIT_POINTS, MEASUREMENTUNIT_PICAS = UNIT_PICAS, MEASUREMENTUNIT_SPACES = UNIT_SPACES, MEASUREMENTUNIT_MILLIMETERS = 100
}
 Constants for Finale's standard measurement units. More...
 

Public Member Functions

virtual const char * ClassName ()
 Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child class. More...
 
virtual const PDKFRAMEWORK_CLASSID GetClassID ()
 Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has problems to resolve the true classes of inherited objects. More...
 
 FCTiePrefs ()
 The constructor. More...
 
Evpu16 GetThicknessRight () const
 Returns the right-side tie thickness. More...
 
Evpu16 GetThicknessLeft () const
 Returns the left-side tie thickness. More...
 
bool GetBreakForTimeSigs () const
 Returns true if the tie should break for time signatures. More...
 
bool GetBreakForKeySigs () const
 Returns true if the tie should break for key signatures. More...
 
Evpu16 GetTimeSigLeftHorizontalOffset () const
 Returns the "Break for time signatures - left gap" setting. More...
 
Evpu16 GetTimeSigRightHorizontalOffset () const
 Returns the "Break for time signatures - right gap" setting. More...
 
Evpu16 GetKeySigLeftHorizontalOffset () const
 Returns the "Break for key signatures - left gap" setting. More...
 
Evpu16 GetKeySigRightHorizontalOffset () const
 Returns the "Break for key signatures - right gap" setting. More...
 
Evpu16 GetSystemLeftHorizontalOffset () const
 Returns the value for "Tie system break, horizontal start adjustment". More...
 
Evpu16 GetSystemRightHorizontalOffset () const
 Returns the value for "Tie system break, horizontal end adjustment". More...
 
bool GetUseOuterPlacement () const
 Returns the "Use outer placement" value. More...
 
FLAG_16 GetSecondsPlacement () const
 Returns the seconds placement style. More...
 
twobyte GetChordDirectionType () const
 Returns the chord direction type. More...
 
bool GetChordDirectionOpposingSeconds () const
 Returns the "Tie direction - opposing seconds" state. More...
 
twobyte GetMixedStemDirectionType () const
 Returns the "Tie direction at mixed stems" type. More...
 
bool GetAfterSingleDot () const
 Returns if the tie should start after a single dot. More...
 
bool GetAfterMultipleDots () const
 Returns if the tie should start after multiple dots. More...
 
bool GetBeforeSingleAccidental () const
 Returns if the tie should end before a single accidental. More...
 
bool GetAvoidStaffLines () const
 Returns if the tie should avoid staff lines. More...
 
Evpu16 GetAvoidStaffLinesDistance () const
 Returns the EVPU distance for how much to avoid staff lines vertically (in the tie contour options). More...
 
bool GetFixedInsetStyle () const
 Returns if the inset style is fixed or in percent (in the tie contour options). More...
 
bool GetUseInterpolation () const
 Returns if heights should be interpolated or not (in the tie contour options). More...
 
bool GetUseTieEndStyle () const
 Returns the "Use Tie End Style" state (in the tie contour options). More...
 
bool GetAvoidStaffLinesOnly () const
 Returns the "In Staff Only" state (in the tie contour options). If set, avoid staff lines in staves only. More...
 
fourbyte GetTipWidth () const
 Returns the tie tip width, in 1/10000 of an EVPU. More...
 
void SetThicknessRight (Evpu16 value)
 Returns the right-side tie thickness. More...
 
void SetThicknessLeft (Evpu16 value)
 Returns the left-side tie thickness. More...
 
void SetBreakForTimeSigs (bool state)
 Sets if the tie should break for time signatures. More...
 
void SetBreakForKeySigs (bool state)
 Sets if the tie should break for key signatures. More...
 
void SetTimeSigLeftHorizontalOffset (Evpu16 value)
 Returns the "Break for time signatures - left gap" setting. More...
 
void SetTimeSigRightHorizontalOffset (Evpu16 value)
 Returns the "Break for time signatures - right gap" setting. More...
 
void SetKeySigLeftHorizontalOffset (Evpu16 value)
 Returns the "Break for key signatures - left gap" setting. More...
 
void SetKeySigRightHorizontalOffset (Evpu16 value)
 Returns the "Break for key signatures - right gap" setting. More...
 
void SetSystemLeftHorizontalOffset (Evpu16 value)
 Sets the value for "Tie system break, horizontal start adjustment". More...
 
void SetSystemRightHorizontalOffset (Evpu16 value)
 Sets the value for "Tie system break, horizontal end adjustment". More...
 
void SetUseOuterPlacement (bool state)
 Sets the "Use outer placement" state. More...
 
void SetSecondsPlacement (FLAG_16 value)
 Sets the seconds placement style. More...
 
void SetChordDirectionType (twobyte value)
 Returns the chord direction type. More...
 
void SetChordDirectionOpposingSeconds (bool state)
 Sets the "Tie direction - opposing seconds" state. More...
 
void SetMixedStemDirectionType (twobyte value)
 Returns the "Tie direction at mixed stems" type. More...
 
void SetAfterSingleDot (bool state)
 Sets if the tie should start after a single dot. More...
 
void SetAfterMultipleDots (bool state)
 Sets if the tie should start after multiple dots. More...
 
void SetBeforeSingleAccidental (bool state)
 Sets if the tie should end before a single accidental. More...
 
void SetAvoidStaffLines (bool state)
 Sets if the tie should avoid staff lines. More...
 
void SetAvoidStaffLinesDistance (Evpu16 value)
 Sets the EVPU distance for how much to avoid staff lines vertically (in the tie contour options). More...
 
void SetFixedInsetStyle (bool state)
 Sets if the inset style is fixed or in percent (in the tie contour options). More...
 
void SetUseInterpolation (bool state)
 Sets if heights should be interpolated or not (in the tie contour options). More...
 
void SetUseTieEndStyle (bool state)
 Sets the "Use Tie End Style" state (in the tie contour options). More...
 
void SetAvoidStaffLinesOnly (bool state)
 Sets the "In Staff Only" state (in the tie contour options). If set, avoid staff lines in staves only. More...
 
void SetTipWidth (fourbyte value)
 Sets the tie tip width, in 1/10000 of an EVPU. More...
 
- Public Member Functions inherited from __FCPrefsBase
virtual bool Reload ()
 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. More...
 
virtual bool Save ()
 Saves the currently loaded to its current location. More...
 
virtual bool LoadFirst ()
 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 EVERSION EnigmaVersion ()
 The Enigma version for save/load/create/delete operations. More...
 
virtual int DataSizeSave ()
 Returns the data size for the data structure that should be saved or created. More...
 
void _CloneFrom (__FCBaseData *pSource)
 For internal use only. Copies object data (except data block) from another object. More...
 
const EDataID * _GetDataID ()
 Intended ONLY for the _CloneFrom implementation. More...
 
int _GetLoadedSize () const
 Intended ONLY for the _CloneFrom implementation. More...
 
const void * GetDataBlock ()
 Intended ONLY for the _CloneFrom implementation. More...
 
EXTAG GetCustomTag ()
 Returns the custom Enigma tag, if any. More...
 
void SetCustomTag (EXTAG tag)
 Sets the custom Enigma tag, for classes that support multiple Enigma tags. More...
 
 __FCBaseData ()
 The constructor.
 
virtual ~__FCBaseData ()
 Virtual destructor.
 
virtual bool 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...
 
__FCBaseDataCreateClone ()
 Creates an identical copy of an object. More...
 
virtual void DebugDump ()
 Outputs the class data/information for debugging purposes. More...
 
virtual void DebugDataDump ()
 Outputs a memory dump of the data block in the object for debugging purposes. More...
 
virtual void DebugDataByteArrayDump ()
 Outputs a memory dump of the data block in the object for debugging purposes, as a C++ byte array. More...
 
void DebugDataOffsetDump (int offset, int size)
 For debug mode only. Dumps a data memory block at a specific offset and with a specific size.
 
FCNumbersCreateRawDataDump ()
 Creates a byte collection with the raw loaded data block for the object (if the object type supports single data blocks). This method is only intended for debug purposes. More...
 
- Public Member Functions inherited from __FCBase
 __FCBase ()
 The constructor.
 
virtual ~__FCBase ()
 Virtual destructor, so all inherited classes get the virtual destructor. More...
 
void DebugMsgDigit (const char *pszPrefixText, int i)
 Creates a simple Message Box for debug purposes. The text appears with the extra digit (in decimal presentation) appearing afterwards. More...
 
void DebugMsgHex (const char *pszPrefixText, int i)
 Creates a simple Message Box for debug purposes. The text appears with the extra digit (as a hexadecimal number) appearing afterwards. More...
 
void DebugMsgString (const char *pszPrefixText, const char *thestring)
 Creates a simple Message Box for debug purposes. The text appears with the extra string appearing afterwards. More...
 
void DebugMsg (const char *pszMsg)
 Creates a simple Message Box for debug purposes with just one text string. More...
 
void DebugOutMenuInfo (FCUI *pUI, int menuixd_horiz, int menuixd_vert) const
 Outputs the menu command info for debugging purposes. More...
 
int DebugOutFormat (const char *fmt,...)
 Outputs debug text using C style "printf" syntax. More...
 
void Set16BitFlag (FLAG_16 *flag, FLAG_16 flagbits, bool state)
 Sets a 16 bit flag in the data block. More...
 
void Set32BitFlag (FLAG_32 *flag, FLAG_32 flagbits, bool state)
 Sets a 32 bit flag in the data block. More...
 
bool GetBitFlag (FLAG_32 flag, FLAG_32 flagbits) const
 Gets a state from flag bits. Returns true if any bit in the mask is set. More...
 
void SetUserData (void *pData)
 Sets the user data attached to the instance of an object. More...
 
void SetUserData2 (void *pData)
 Sets the additional user data attached to the instance of an object. More...
 
void * GetUserData () const
 Gets the user data attached to the instance of an object. More...
 
void * GetUserData2 () const
 Gets the additional user data attached to the instance of an object. More...
 
virtual bool IsIdentical (__FCBase *pCompareObject)
 Returns true if the data in the passed object is considered to be identical to the current object, otherwise false. More...
 
void StoreXML_String (tinyxml2::XMLElement *pParentNode, const char *pszElementName, FCString *pStringValue)
 Helper function to store FCString objects in the XML file. More...
 
void StoreXML_Integer (tinyxml2::XMLElement *pParentNode, const char *pszElementName, int value)
 Helper function to store integer objects in the XML file. More...
 
void StoreXML_Bool (tinyxml2::XMLElement *pParentNode, const char *pszElementName, bool value)
 Helper function to store boolean objects in the XML file. More...
 
void StoreXML_StringAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, FCString *pStringValue)
 Helper function to store FCString objects in the XML file, as an attribute to a node. More...
 
void StoreXML_IntegerAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, int value)
 Helper function to store integer objects in the XML file, as an attribute to a node. More...
 
void StoreXML_BoolAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, bool value)
 Helper function to store boolean objects in the XML file, as an attribute to a node. More...
 
void StoreXML_FloatAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, float value)
 Helper function to store floating point objects in the XML file, as an attribute to a node. More...
 
virtual void StoreToXML (tinyxml2::XMLElement *pParentNode)
 Virtual method that is used to store an object's data. More...
 
bool ReadXML_String (tinyxml2::XMLElement *pParentNode, const char *pszElementName, FCString *pStringValue)
 Helper method to read FCString objects from the XML file. More...
 
bool ReadXML_Integer (tinyxml2::XMLElement *pParentNode, const char *pszElementName, int *pValue)
 Helper method to read integer objects from the XML file. More...
 
bool ReadXML_Bool (tinyxml2::XMLElement *pParentNode, const char *pszElementName, bool *pValue)
 Helper method to read boolean objects from the XML file. More...
 
bool ReadXML_StringAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, FCString *pStringValue)
 Helper method to read FCString objects from the XML file, as an attribute to a node. More...
 
bool ReadXML_IntegerAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, int *pValue)
 Helper method to read integer objects from the XML file, as an attribute to a node. More...
 
bool ReadXML_BoolAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, bool *pValue)
 Helper method to read boolean objects from the XML file, as an attribute to a node. More...
 
bool ReadXML_FloatAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, float *pValue)
 Helper method to read floating point objects from the XML file, as an attribute to a node. More...
 
virtual bool ReadFromXML (tinyxml2::XMLElement *pParentNode)
 Virtual method that is used to read object data. More...
 

Additional Inherited Members

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

Detailed Description

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

One of the tie settings (FCMusicSpacingPrefs::GetTiesGutter) is available in the FCMusicSpacingPrefs class since it affects the beat chart.

Member Enumeration Documentation

The constants for the tie chord direction type.

Lua-supported.

Enumerator
TIECHORDDIR_OUTSIDEINSIDE 

Outside/inside

TIECHORDDIR_STEMREVERSAL 

Stem reversal

TIECHORDDIR_SPLITEVENLY 

Split evenly

Constants for tie direction at mixed stems.

Lua-supported.

Enumerator
TIEMIXEDSTEM_OVER 

Over

TIEMIXEDSTEM_UNDER 

Under

TIEMIXEDSTEM_OPPOSITEFIRSTSTEM 

Opposite first stem

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 ( )
inline

The constructor.

Lua-supported.

Member Function Documentation

virtual const char* FCTiePrefs::ClassName ( )
inlinevirtual

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

Lua-supported.

Reimplemented from __FCBaseData.

bool FCTiePrefs::GetAfterMultipleDots ( ) const
inline

Returns if the tie should start after multiple dots.

Lua-supported (also as property).

bool FCTiePrefs::GetAfterSingleDot ( ) const
inline

Returns if the tie should start after a single dot.

Lua-supported (also as property).

bool FCTiePrefs::GetAvoidStaffLines ( ) const
inline

Returns if the tie should avoid staff lines.

Lua-supported (also as property).

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

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

bool FCTiePrefs::GetBeforeSingleAccidental ( ) const
inline

Returns if the tie should end before a single accidental.

Lua-supported (also as property).

bool FCTiePrefs::GetBreakForKeySigs ( ) const
inline

Returns true if the tie should break for key signatures.

Lua-supported (also as property).

bool FCTiePrefs::GetBreakForTimeSigs ( ) const
inline

Returns true if the tie should break for time signatures.

Lua-supported (also as property).

bool FCTiePrefs::GetChordDirectionOpposingSeconds ( ) const
inline

Returns the "Tie direction - opposing seconds" state.

Lua-supported (also as property).

twobyte FCTiePrefs::GetChordDirectionType ( ) const
inline

Returns the chord direction type.

Lua-supported (also as property).

Returns
Any of the TIECHORDDIR_ constants.
virtual const PDKFRAMEWORK_CLASSID FCTiePrefs::GetClassID ( )
inlinevirtual

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

This method must be overwritten by all child classes.

Lua-supported.

Implements __FCBaseData.

bool 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.
Evpu16 FCTiePrefs::GetKeySigLeftHorizontalOffset ( ) const
inline

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

Lua-supported (also as property).

Evpu16 FCTiePrefs::GetKeySigRightHorizontalOffset ( ) const
inline

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

Lua-supported (also as property).

twobyte FCTiePrefs::GetMixedStemDirectionType ( ) const
inline

Returns the "Tie direction at mixed stems" type.

Lua-supported (also as property).

Returns
Any of the TIEMIXEDSTEM_ constants.
FLAG_16 FCTiePrefs::GetSecondsPlacement ( ) const
inline

Returns the seconds placement style.

Lua-supported (also as property).

Returns
Any of the TIESECONDS_ constants.
Evpu16 FCTiePrefs::GetSystemLeftHorizontalOffset ( ) const
inline

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

Lua-supported (also as property).

Evpu16 FCTiePrefs::GetSystemRightHorizontalOffset ( ) const
inline

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

Lua-supported (also as property).

Evpu16 FCTiePrefs::GetThicknessLeft ( ) const
inline

Returns the left-side tie thickness.

Lua-supported (also as property).

Evpu16 FCTiePrefs::GetThicknessRight ( ) const
inline

Returns the right-side tie thickness.

Lua-supported (also as property).

Evpu16 FCTiePrefs::GetTimeSigLeftHorizontalOffset ( ) const
inline

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

Lua-supported (also as property).

Evpu16 FCTiePrefs::GetTimeSigRightHorizontalOffset ( ) const
inline

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

Lua-supported (also as property).

fourbyte FCTiePrefs::GetTipWidth ( ) const
inline

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

Lua-supported (also as property).

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
bool FCTiePrefs::GetUseOuterPlacement ( ) const
inline

Returns the "Use outer placement" value.

Lua-supported (also as property).

bool FCTiePrefs::GetUseTieEndStyle ( ) const
inline

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

Lua-supported (also as property).

void FCTiePrefs::SetAfterMultipleDots ( bool  state)
inline

Sets if the tie should start after multiple dots.

Lua-supported (also as property).

void FCTiePrefs::SetAfterSingleDot ( bool  state)
inline

Sets if the tie should start after a single dot.

Lua-supported (also as property).

void FCTiePrefs::SetAvoidStaffLines ( bool  state)
inline

Sets if the tie should avoid staff lines.

Lua-supported (also as property).

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

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

void FCTiePrefs::SetBeforeSingleAccidental ( bool  state)
inline

Sets if the tie should end before a single accidental.

Lua-supported (also as property).

void FCTiePrefs::SetBreakForKeySigs ( bool  state)
inline

Sets if the tie should break for key signatures.

Lua-supported (also as property).

void FCTiePrefs::SetBreakForTimeSigs ( bool  state)
inline

Sets if the tie should break for time signatures.

Lua-supported (also as property).

void FCTiePrefs::SetChordDirectionOpposingSeconds ( bool  state)
inline

Sets the "Tie direction - opposing seconds" state.

Lua-supported (also as property).

void FCTiePrefs::SetChordDirectionType ( twobyte  value)
inline

Returns the chord direction type.

Lua-supported (also as property).

Parameters
valueAny of the TIECHORDDIR_ constants.
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
stateTrue - fixed inset style, false - inset style in percent.
void FCTiePrefs::SetKeySigLeftHorizontalOffset ( Evpu16  value)
inline

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

Lua-supported (also as property).

void FCTiePrefs::SetKeySigRightHorizontalOffset ( Evpu16  value)
inline

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

Lua-supported (also as property).

void FCTiePrefs::SetMixedStemDirectionType ( twobyte  value)
inline

Returns the "Tie direction at mixed stems" type.

Lua-supported (also as property).

Returns
Any of the TIEMIXEDSTEM_ constants.
void FCTiePrefs::SetSecondsPlacement ( FLAG_16  value)
inline

Sets the seconds placement style.

Lua-supported (also as property).

Parameters
valueAny of the TIESECONDS_ constants.
void FCTiePrefs::SetSystemLeftHorizontalOffset ( Evpu16  value)
inline

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

Lua-supported (also as property).

void FCTiePrefs::SetSystemRightHorizontalOffset ( Evpu16  value)
inline

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

Lua-supported (also as property).

void FCTiePrefs::SetThicknessLeft ( Evpu16  value)
inline

Returns the left-side tie thickness.

Lua-supported (also as property).

void FCTiePrefs::SetThicknessRight ( Evpu16  value)
inline

Returns the right-side tie thickness.

Lua-supported (also as property).

void FCTiePrefs::SetTimeSigLeftHorizontalOffset ( Evpu16  value)
inline

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

Lua-supported (also as property).

void FCTiePrefs::SetTimeSigRightHorizontalOffset ( Evpu16  value)
inline

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

Lua-supported (also as property).

void FCTiePrefs::SetTipWidth ( fourbyte  value)
inline

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

Lua-supported (also as property).

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
stateTrue - Interpolate Height Between Short and Long Span. False - Use Medium Height Between Short and Long Span
void FCTiePrefs::SetUseOuterPlacement ( bool  state)
inline

Sets the "Use outer placement" state.

Lua-supported (also as property).

void FCTiePrefs::SetUseTieEndStyle ( bool  state)
inline

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

Lua-supported (also as property).