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

Class for the Smart Shape preferences. More...

#include <ff_prefs.h>

Inheritance diagram for FCSmartShapePrefs:
__FCPrefsBase __FCBaseData __FCBase

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...
 
 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, if 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...
 
fourbyte 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...
 
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 spacevalue)
 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 spacevalue)
 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 maxvalue)
 Sets the Engraver Slur max stretch value for fixed stretches, in EFIXes. More...
 
void SetEngraverSlurMaxLift (Efix32 maxlift)
 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 (fourbyte 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...
 
virtual void DebugDump ()
 Outputs the class data/information for debugging purposes. 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 EXTAG Tag ()=0
 The Enigma tag for the derived class. More...
 
virtual EVERSION EnigmaVersion ()
 The Enigma version for save/load/create/delete operations. More...
 
virtual int DataSizeLoad ()=0
 Returns the data size for the data structure that should be loaded. More...
 
virtual int DataSizeSave ()
 Returns the data size for the data structure that should be saved or created. More...
 
void _CloneFrom (__FCBaseData *pSource)
 For internal use only. Copies object data (except data block) from another object. More...
 
virtual void CloneMemoryFrom (__FCBaseData *pSource)
 
const EDataID * _GetDataID ()
 Intended ONLY for the _CloneFrom implementation. More...
 
int _GetLoadedSize () const
 Intended ONLY for the _CloneFrom implementation. More...
 
const void * GetDataBlock ()
 Intended ONLY for the _CloneFrom implementation. More...
 
EXTAG GetCustomTag ()
 Returns the custom Enigma tag, if any. More...
 
void SetCustomTag (EXTAG tag)
 Sets the custom Enigma tag, for classes that support multiple Enigma tags. More...
 
 __FCBaseData ()
 The constructor.
 
virtual ~__FCBaseData ()
 Virtual destructor.
 
virtual bool 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 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

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

Detailed Description

Class for the Smart Shape preferences.

The smart shape symbols are found in FCMusicCharacterPrefs.

Constructor & Destructor Documentation

FCSmartShapePrefs::FCSmartShapePrefs ( )
inline

The constructor.

Lua-supported.

Member Function Documentation

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

virtual void FCSmartShapePrefs::DebugDump ( )
inlinevirtual

Outputs the class data/information for debugging purposes.

Accessible if PDK_FRAMEWORK_DEBUG is defined.

When child class inherit this method to output the contents of its own members, it should call the parent before providing its own output.

Reimplemented from __FCBaseData.

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

CMPER FCSmartShapePrefs::GetCustomLineDefID ( ) const
inline

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

Lua-supported (also as property).

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

bool FCSmartShapePrefs::GetEngraverSlurAvoidAccidentals ( ) const
inline

Returns if the engraver slur should avoid accidentals.

Lua-supported (also as property).

twobyte FCSmartShapePrefs::GetEngraverSlurMaxAngle ( ) const
inline

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

Lua-supported (also as property).

Efix32 FCSmartShapePrefs::GetEngraverSlurMaxLift ( ) const
inline

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

Lua-supported (also as property).

Efix32 FCSmartShapePrefs::GetEngraverSlurMaxStretchFixed ( ) const
inline

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

Lua-supported (also as property).

twobyte FCSmartShapePrefs::GetEngraverSlurMaxStretchPercent ( ) const
inline

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

Lua-supported (also as property).

Evpu16 FCSmartShapePrefs::GetEngraverSlurSpaceAround ( ) const
inline

Returns space around objects for Engraver Slurs.

Lua-supported (also as property).

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.
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.
twobyte FCSmartShapePrefs::GetEngraverSlurSymmetryPercent ( ) const
inline

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

Lua-supported (also as property).

CMPER FCSmartShapePrefs::GetGlissandoDefID ( ) const
inline

Returns the default custom startshape definition ID for glissando lines.

Lua-supported (also as property).

bool FCSmartShapePrefs::GetGuitarBendAutoGenerateText ( ) const
inline

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

Lua-supported (also as property).

CMPER FCSmartShapePrefs::GetGuitarBendDefID ( ) const
inline

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

Lua-supported (also as property).

bool FCSmartShapePrefs::GetGuitarBendHideNumber ( ) const
inline

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

Lua-supported (also as property).

bool FCSmartShapePrefs::GetGuitarBendParentheses ( ) const
inline

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

Lua-supported (also as property).

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

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

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.
Efix16 FCSmartShapePrefs::GetHairpinLineWidth ( ) const
inline

Returns the hairpin line width, in EFIXes.

Lua-supported (also as property).

bool FCSmartShapePrefs::GetHairpinMakeHorizontal ( ) const
inline

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

Lua-supported (also as property).

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.
Evpu16 FCSmartShapePrefs::GetHookLength ( ) const
inline

Returns the hook length, if EVPUs.

Lua-supported (also as property).

Evpu16 FCSmartShapePrefs::GetLineDashLength ( ) const
inline

Returns the default dash length, if EVPUs.

Lua-supported (also as property).

Evpu16 FCSmartShapePrefs::GetLineDashSpace ( ) const
inline

Returns the default dash space, if EVPUs.

Lua-supported (also as property).

Efix16 FCSmartShapePrefs::GetLineWidth ( ) const
inline

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

Lua-supported (also as property).

bool FCSmartShapePrefs::GetOctavesAsText ( ) const
inline

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

Lua-supported (also as property).

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

Evpu16 FCSmartShapePrefs::GetSlurBreakSystemEnd ( ) const
inline

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

Lua-supported (also as property).

Evpu16 FCSmartShapePrefs::GetSlurBreakSystemStart ( ) const
inline

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

Lua-supported (also as property).

Evpu16 FCSmartShapePrefs::GetSlurThicknessHorizontalLeft ( ) const
inline

Returns slur thickness to the horizontal left, in EVPUs.

Lua-supported (also as property).

Evpu16 FCSmartShapePrefs::GetSlurThicknessHorizontalRight ( ) const
inline

Returns slur thickness to the horizontal right, in EVPUs.

Lua-supported (also as property).

Evpu16 FCSmartShapePrefs::GetSlurThicknessVerticalLeft ( ) const
inline

Returns slur thickness to the vertical left, in EVPUs.

Lua-supported (also as property).

Evpu16 FCSmartShapePrefs::GetSlurThicknessVerticalRight ( ) const
inline

Returns slur thickness to the vertical right, in EVPUs.

Lua-supported (also as property).

Evpu16 FCSmartShapePrefs::GetSlurTipAvoidStaffAmount ( ) const
inline

Returns if slur tips should avoid staff lines.

The setting is controlled by GetSlurTipAvoidStaffUse.

Lua-supported (also as property).

bool FCSmartShapePrefs::GetSlurTipAvoidStaffUse ( ) const
inline

Returns if slur tips should avoid staff lines.

The setting is returned by GetSlurTipAvoidStaffAmount.

Lua-supported (also as property).

fourbyte FCSmartShapePrefs::GetSlurTipWidth ( ) const
inline

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

Lua-supported (also as property).

CMPER FCSmartShapePrefs::GetTabSlideDefID ( ) const
inline

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

Lua-supported (also as property).

bool FCSmartShapePrefs::GetUseEngraverSlurs ( ) const
inline

Returns true if engraver slurs should be used.

Lua-supported (also as property).

void FCSmartShapePrefs::SetCustomLineDefID ( CMPER  idvalue)
inline

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

Lua-supported (also as property).

void FCSmartShapePrefs::SetEngraverSlurAccidentalSpace ( Evpu16  spacevalue)
inline

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

Setting is only used if GetEngraverSlurAvoidAccidentals returns true.

Lua-supported (also as property).

void FCSmartShapePrefs::SetEngraverSlurAvoidAccidentals ( bool  state)
inline

Sets if the engraver slurs should avoid accidentals.

Lua-supported (also as property).

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

void FCSmartShapePrefs::SetEngraverSlurMaxLift ( Efix32  maxlift)
inline

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

Lua-supported (also as property).

void FCSmartShapePrefs::SetEngraverSlurMaxStretchFixed ( Efix32  maxvalue)
inline

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

Lua-supported (also as property).

void FCSmartShapePrefs::SetEngraverSlurMaxStretchPercent ( twobyte  value)
inline

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

Lua-supported (also as property).

void FCSmartShapePrefs::SetEngraverSlurSpaceAround ( Evpu16  spacevalue)
inline

Sets the space around objects for Engraver Slurs.

Lua-supported (also as property).

void FCSmartShapePrefs::SetEngraverSlurStretchByPercent ( bool  state)
inline

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

Lua-supported (also as property).

Parameters
statetrue - Stretch by percent. False - Stretch by fixed value.
void FCSmartShapePrefs::SetEngraverSlurStretchFirst ( bool  state)
inline

Sets if Engraver Slurs should stretch before lift.

Lua-supported (also as property).

Returns
True - Stretch first, then lift. False - Lift first.
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).

void FCSmartShapePrefs::SetGlissandoDefID ( CMPER  idvalue)
inline

Sets the default custom startshape definition ID for glissando lines.

Lua-supported (also as property).

void FCSmartShapePrefs::SetGuitarBendAutoGenerateText ( bool  state)
inline

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

Lua-supported (also as property).

void FCSmartShapePrefs::SetGuitarBendDefID ( CMPER  idvalue)
inline

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

Lua-supported (also as property).

void FCSmartShapePrefs::SetGuitarBendHideNumber ( bool  state)
inline

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

Lua-supported (also as property).

void FCSmartShapePrefs::SetGuitarBendParentheses ( bool  state)
inline

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

Lua-supported (also as property).

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

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

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

void FCSmartShapePrefs::SetHairpinLineWidth ( Efix16  value)
inline

Sets the hairpin line width, in EFIXes.

Lua-supported (also as property).

void FCSmartShapePrefs::SetHairpinMakeHorizontal ( bool  state)
inline

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

Lua-supported (also as property).

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

void FCSmartShapePrefs::SetHookLength ( Evpu16  value)
inline

Sets the hook length, if EVPUs.

Lua-supported (also as property).

void FCSmartShapePrefs::SetLineDashLength ( Evpu16  value)
inline

Returns the default dash length, if EVPUs.

Lua-supported (also as property).

void FCSmartShapePrefs::SetLineDashSpace ( Evpu16  value)
inline

Sets the default dash space, if EVPUs.

Lua-supported (also as property).

void FCSmartShapePrefs::SetLineWidth ( Efix16  value)
inline

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

Lua-supported (also as property).

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

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

void FCSmartShapePrefs::SetSlurBreakSystemEnd ( Evpu16  value)
inline

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

Lua-supported (also as property).

void FCSmartShapePrefs::SetSlurBreakSystemStart ( Evpu16  value)
inline

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

Lua-supported (also as property).

void FCSmartShapePrefs::SetSlurThicknessHorizontalLeft ( Evpu16  value)
inline

Sets slur thickness to the horizontal left, in EVPUs.

Lua-supported (also as property).

void FCSmartShapePrefs::SetSlurThicknessHorizontalRight ( Evpu16  value)
inline

Sets slur thickness to the horizontal right, in EVPUs.

Lua-supported (also as property).

void FCSmartShapePrefs::SetSlurThicknessVerticalLeft ( Evpu16  value)
inline

Sets slur thickness to the vertical left, in EVPUs.

Lua-supported (also as property).

void FCSmartShapePrefs::SetSlurThicknessVerticalRight ( Evpu16  value)
inline

Sets slur thickness to the vertical right, in EVPUs.

Lua-supported (also as property).

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

void FCSmartShapePrefs::SetSlurTipAvoidStaffUse ( bool  state)
inline

Sets if slur tips should avoid staff lines.

The setting is returned by GetSlurTipAvoidStaffAmount.

Lua-supported (also as property).

void FCSmartShapePrefs::SetSlurTipWidth ( fourbyte  value)
inline

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

Lua-supported (also as property).

void FCSmartShapePrefs::SetTabSlideDefID ( CMPER  idvalue)
inline

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

Lua-supported (also as property).

void FCSmartShapePrefs::SetUseEngraverSlurs ( bool  state)
inline

Sets true if engraver slurs should be used.

Lua-supported (also as property).