Finale PDK Framework 0.71
Public Types | Public Member Functions | List of all members
FCRepeatPrefs Class Reference

Class for repeat-related document preferences. More...

#include <ff_prefs.h>

Inheritance diagram for FCRepeatPrefs:
__FCPrefsBase __FCBaseData __FCBase

Public Types

enum  REPEATBACKTOBACKSTYLES { REPBACKTOBACK_THIN = RPT_BBSTL_THIN , REPBACKTOBACK_MIXED = RPT_BBSTL_MIXED , REPBACKTOBACK_THICK = RPT_BBSTL_THICK }
 The visual style when a back and forward repeat appears on the same barline. More...
 
enum  REPEATWINGSTYLES { REPWING_NONE = RPT_WINGSTL_NONE , REPWING_SINGLE = RPT_WINGSTL_SINGLE , REPWING_DOUBLE = RPT_WINGSTL_DOUBLE , REPWING_CURVED = RPT_WINGSTL_CURVED }
 The repeat wing styles. More...
 
- Public Types inherited from __FCBase
enum  PDKFRAMEWORK_CLASSID {
  FCID_UNKNOWN = 0 , FCID_ACCIDENTALMOD , FCID_ACTIVELYRIC , FCID_ALLOTMENT ,
  FCID_ARTICULATION , FCID_ARTICULATIONDEF , FCID_BACKWARDREPEAT , FCID_BASELINE ,
  FCID_BEAMMOD , FCID_BEATCHARTELEMENT , FCID_BOOKMARK , FCID_BROKENBEAMMOD ,
  FCID_CATEGORYDEF , FCID_CELLCLEFCHANGE , FCID_CELLFRAMEHOLD , FCID_CELLGRAPHIC ,
  FCID_CELLTEXT , FCID_CENTERSMARTSHAPE , FCID_CHORD , FCID_CHORDPREFS ,
  FCID_CHORDSUFFIXELEMENT , FCID_CHORUSSYLLABLE , FCID_CLEFDEF , FCID_COMPOSITETIMESIGBOTTOMELEMENT ,
  FCID_COMPOSITETIMESIGTOPELEMENT , FCID_CROSSSTAFFMOD , FCID_CUSTOMSMARTLINEDEF , FCID_CUSTOMSTEMMOD ,
  FCID_DISTANCEPREFS , FCID_DOTMOD , FCID_ENCLOSURE , FCID_ENDINGREPEAT ,
  FCID_ENIGMATEXTSTYLE , FCID_ENTRYALTERMOD , FCID_EXECUTABLESHAPEDEF , FCID_EXPRESSION ,
  FCID_FONTINFO , FCID_FONTPREFS , FCID_FREEZESYSTEM , FCID_FRETBOARDSTYLEDEF ,
  FCID_FRETBOARDSTYLEDEFS , FCID_FRETBOARDGROUPDEF , FCID_FRETBOARDGROUPDEFS , FCID_FRETINSTRUMENTDEF ,
  FCID_GENERALPREFS , FCID_GRIDSGUIDESPREFS , FCID_GROUP , FCID_GROUPNAMEPOSITIONPREFS ,
  FCID_HUMANPLAYBACKPREFS , FCID_INDEPENDENTCELLDETAIL , FCID_INSTRUMENTDEF , FCID_INSTRUMENTPLAYBACKDATA ,
  FCID_KEYSIGNATURE , FCID_LAYERPREFS , FCID_LYRICSBASELINE , FCID_LYRICSPREFS ,
  FCID_MEASURE , FCID_MEASURENUMBERREGION , FCID_METATOOLASSIGNMENT , FCID_MIDIEXPRESSION ,
  FCID_MISCDOCPREFS , FCID_MULTIMEASUREREST , FCID_MULTIMEASURERESTPREFS , FCID_MULTISTAFFINSTRUMENT ,
  FCID_MULTISTAFFINSTRUMENTS , FCID_MUSICCHARACTERPREFS , FCID_MUSICSPACINGPREFS , FCID_NUMBER ,
  FCID_NOTEHEADMOD , FCID_OTHERINCI , FCID_PERCUSSIONLAYOUTNOTE , FCID_PERCUSSIONSTAFF ,
  FCID_PERFORMANCEMOD , FCID_PAGE , FCID_PAGEFORMATPREFS , FCID_PAGEGRAPHIC ,
  FCID_PAGETEXT , FCID_PART , FCID_PARTEXTRACTPREFS , FCID_PARTSCOPEPREFS ,
  FCID_PARTSTAFFVOICING , FCID_PERCUSSIONNOTEMOD , FCID_PIANOBRACEPREFS , FCID_PLAYBACKPREFS ,
  FCID_RAWTEXT , FCID_REPEATPREFS , FCID_SECONDARYBEAMBREAKMOD , FCID_BEAMEXTENSIONMOD ,
  FCID_SECTIONSYLLABLE , FCID_SEPARATEMEASURENUMBER , FCID_SEPARATEPLACEMENT , FCID_SHAPEDEF ,
  FCID_SHAPEEXPRESSIONDEF , FCID_SLURCONTOURPREFS , FCID_SIZEPREFS , FCID_SMARTSHAPE ,
  FCID_SMARTSHAPEENTRYMARK , FCID_SMARTSHAPEMEASUREMARK , FCID_SMARTSHAPEPREFS , FCID_STAFF ,
  FCID_STAFFLIST , FCID_STAFFNAMEPOSITION , FCID_STAFFNAMEPOSITIONPREFS , FCID_STAFFSTYLEASSIGN ,
  FCID_STAFFSTYLEDEF , FCID_STAFFSYSTEM , FCID_STEMCONNECTIONTABLE , FCID_STEMMOD ,
  FCID_STRING , FCID_SYLLABLEENTRYMOD , FCID_SYSTEMSTAFF , FCID_TABLATURENOTEMOD ,
  FCID_TEMPOELEMENT , FCID_TEXTBLOCK , FCID_TEXTEXPRESSIONDEF , FCID_TEXTREPEAT ,
  FCID_TEXTREPEATDEF , FCID_TIEMOD , FCID_TIEPREFS , FCID_TIECONTOURPREFS ,
  FCID_TIEPLACEMENTPREFS , FCID_TIMESIGNATURE , FCID_TUPLET , FCID_TUPLETPREFS ,
  FCID_VERSESYLLABLE
}
 Constants for the GetClassID method. More...
 
enum  MEASUREMENTUNITS {
  MEASUREMENTUNIT_DEFAULT = UNIT_DEFAULT , MEASUREMENTUNIT_EVPUS = UNIT_EVPUS , MEASUREMENTUNIT_INCHES = UNIT_INCHES , MEASUREMENTUNIT_CENTIMETERS = UNIT_CENTS ,
  MEASUREMENTUNIT_POINTS = UNIT_POINTS , MEASUREMENTUNIT_PICAS = UNIT_PICAS , MEASUREMENTUNIT_SPACES = UNIT_SPACES , MEASUREMENTUNIT_MILLIMETERS = 100
}
 Constants for Finale's standard measurement units. More...
 

Public Member Functions

const char * ClassName () const override
 Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child class. More...
 
const PDKFRAMEWORK_CLASSID GetClassID () const override
 Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has problems to resolve the true classes of inherited objects. More...
 
 FCRepeatPrefs ()
 The constructor. More...
 
Efix16 GetHeavyLineThickness () const
 Returns the thick line thickness for repeat barlines, in EFIXes. More...
 
Efix16 GetThinLineThickness () const
 Returns the thin line thickness for repeat barlines, in EFIXes. More...
 
Efix16 GetSpaceBetweenLines () const
 Returns the distance between lines in a repeat, in EFIXes. More...
 
REPEATBACKTOBACKSTYLES GetBackToBackStyle () const
 Returns the back-to-back line style. More...
 
Evpu32 GetForwardSpace () const
 Returns the space between repeat dot and repeat lines in forward repeats, in EVPUs. More...
 
Evpu32 GetBackwardSpace () const
 Returns the space between repeat dot and repeat lines in backward repeats, in EVPUs. More...
 
Evpu32 GetVerticalTopDotAdjustment () const
 Returns the top repeat dot adjustment, in EVPUs. More...
 
Evpu32 GetVerticalBottomDotAdjustment () const
 Returns the bottom repeat dot adjustment, in EVPUs. More...
 
REPEATWINGSTYLES GetWingStyle () const
 Returns the wing styles for repeats barlines. More...
 
Evpu16 GetAfterClefSpace () const
 Returns the "Forward repeat spacing - after clef" document setting, in EVPUs. More...
 
Evpu32 GetAfterKeySpace () const
 Returns the "Forward repeat spacing - after key signature" document setting, in EVPUs. More...
 
Evpu32 GetAfterTimeSpace () const
 Returns the "Forward repeat spacing - after time signature" document setting, in EVPUs. More...
 
Evpu32 GetEndingBracketHeight () const
 Returns the default height of repeat brackets, in EVPUs. More...
 
Evpu32 GetEndingFrontHookLength () const
 Returns the default length (height) of repeat front hooks, in EVPUs. More...
 
Evpu32 GetEndingBackHookLength () const
 Return the default length (height) of back hooks, in EVPUs. More...
 
Efix16 GetEndingLineThickness () const
 Returns the line thickness, in EFIXes. More...
 
Evpu32 GetEndingInsetStart () const
 Returns the inset for the starts of bracket. More...
 
Evpu32 GetEndingInsetEnd () const
 Returns the inset for the ends of bracket. More...
 
Evpu32 GetEndingHorizontalText () const
 Returns the default horizontal positioning for ending text. More...
 
Evpu16 GetEndingVerticalText () const
 Returns default vertical positioning for ending text. More...
 
bool GetDotAfterNumber () const
 Returns if the repeat number automatically should display with a period dot at the end. More...
 
int GetMaxPasses () const
 Returns the maximum number of playback passes a repeat should be allowed. More...
 
bool GetThinInnerBracketReference () const
 Returns if the thin inner repeat barline should be used as bracket line reference. More...
 
bool GetShowOnTopStaffOnly () const
 Returns if "Show On Top Staff Only" is selected. More...
 
twobyte GetShowOnStaffListID () const
 Returns the selected staff list if "Show On Staff List" is selected. More...
 
void SetHeavyLineThickness (Efix16 value)
 Sets the thick line thickness for repeat barlines, in EFIXes. More...
 
void SetThinLineThickness (Efix16 value)
 Sets the thin line thickness for repeat barlines, in EFIXes. More...
 
void SetSpaceBetweenLines (Efix16 value)
 Sets the distance between lines in a repeat, in EFIXes. More...
 
void SetBackToBackStyle (REPEATBACKTOBACKSTYLES style)
 Returns the back-to-back line style. More...
 
void SetForwardSpace (Evpu32 value)
 Sets the space between repeat dot and repeat lines in forward repeats, in EVPUs. More...
 
void SetBackwardSpace (Evpu32 value)
 Sets the space between repeat dot and repeat lines in backward repeats, in EVPUs. More...
 
void SetVerticalTopDotAdjustment (Evpu32 value)
 Sets the top repeat dot adjustment, in EVPUs. More...
 
void SetVerticalBottomDotAdjustment (Evpu32 value)
 Sets the bottom repeat dot adjustment, in EVPUs. More...
 
void SetWingStyle (REPEATWINGSTYLES style)
 Returns the wing styles for repeats barlines. More...
 
void SetAfterClefSpace (Evpu32 value)
 Returns the "Forward repeat spacing - after clef signature" document setting, in EVPUs. More...
 
void SetAfterKeySpace (Evpu32 value)
 Returns the "Forward repeat spacing - after key signature" document setting, in EVPUs. More...
 
void SetAfterTimeSpace (Evpu32 value)
 Returns the "Forward repeat spacing - after time signature" document setting, in EVPUs. More...
 
void SetEndingBracketHeight (Evpu32 value)
 Sets the default height of repeat brackets, in EVPUs. More...
 
void SetEndingFrontHookLength (Evpu32 value)
 Sets the default length (height) of repeat front hooks, in EVPUs. More...
 
void SetEndingBackHookLength (Evpu32 value)
 Sets the default length (height) of back hooks, in EVPUs. More...
 
void SetEndingLineThickness (Evpu32 value)
 Sets the line thickness, in EFIXes. More...
 
void SetEndingInsetStart (Evpu32 value)
 Sets the inset for the starts of bracket. More...
 
void SetEndingInsetEnd (Evpu32 value)
 Sets the inset for the ends of bracket. More...
 
void SetEndingHorizontalText (Evpu32 value)
 Sets the default horizontal positioning for ending text. More...
 
void SetEndingVerticalText (Evpu32 value)
 Sets default vertical positioning for ending text. More...
 
void SetDotAfterNumber (bool state)
 Sets if the repeat number automatically should display with a period dot at the end, or not. More...
 
void SetMaxPasses (int value)
 Sets the maximum number of playback passes a repeat should be allowed. More...
 
void SetThinInnerBracketReference (bool state)
 Sets if the thin inner repeat barline should be used as bracket line reference. More...
 
void SetShowOnTopStaffOnly (bool state)
 Sets if "Show On Top Staff Only" is selected. More...
 
void SetShowOnStaffListID (twobyte value)
 Sets the selected staff list for "Show On Staff List". More...
 
- Public Member Functions inherited from __FCPrefsBase
bool Reload () override
 Overridden version of Reload(), that handles prefs from multiple sources. More...
 
virtual bool Load (twobyte prefsno=1)
 The default Load method for preference data. All preference data loading must go through here at some point. More...
 
bool Save () override
 Saves the currently loaded to its current location. More...
 
bool LoadFirst () override
 Loads the very first element in the database, if any. More...
 
int GetItemNo () const
 Returns the prefs number for the loaded data. More...
 
- Public Member Functions inherited from __FCBaseData
EDOCID GetConnectedDocID () const
 Returns the document ID that was connected to the last load/save of the data. More...
 
bool VerifyConnectedDocID ()
 Checks that the stored document ID for the data object matches the current document's ID. More...
 
virtual EVERSION EnigmaVersion () const
 The Enigma version for save/load/create/delete operations. More...
 
virtual int DataSizeSave () const
 Returns the data size for the data structure that should be saved or created. More...
 
void _CloneFrom (__FCBaseData *pSource)
 For internal use only. Copies object data (except data block) from another object. More...
 
const EDataID * _GetDataID ()
 Intended ONLY for the _CloneFrom implementation. More...
 
int _GetLoadedSize () const
 Intended ONLY for the _CloneFrom implementation. More...
 
const void * GetDataBlock ()
 Intended ONLY for the _CloneFrom implementation. More...
 
EXTAG GetCustomTag () const
 Returns the custom Enigma tag, if any. More...
 
void SetCustomTag (EXTAG tag)
 Sets the custom Enigma tag, for classes that support multiple Enigma tags. More...
 
 __FCBaseData ()
 The constructor.
 
virtual ~__FCBaseData ()
 Virtual destructor.
 
virtual bool DeleteData ()
 Deletes the associated data from Finale's database. Be careful when deleting multiple objects. More...
 
virtual bool DeepDeleteData ()
 Deletes data and all data that's connected to the object. More...
 
virtual bool LoadLast ()
 Loads the very last element in the database, if any. More...
 
virtual bool LoadNext ()
 Loads the next element from the database, if any. More...
 
virtual bool LoadPrevious ()
 Loads the previous element in the database, if any. More...
 
bool RelinkToCurrentView ()
 Relinks the contents in the current view so that the score and part(s) match. More...
 
bool RelinkToScore ()
 Relinks all parts to the contents of the score. More...
 
__FCBaseDataCreateClone ()
 Creates an identical copy of an object. More...
 
void DebugDump () override
 Outputs the class data/information for debugging purposes. More...
 
void DebugDataDump () override
 Outputs a memory dump of the data block in the object for debugging purposes. More...
 
void DebugDataByteArrayDump () override
 Outputs a memory dump of the data block in the object for debugging purposes, as a C++ byte array. More...
 
void DebugDataOffsetDump (int offset, int size)
 For debug mode only. Dumps a data memory block at a specific offset and with a specific size.
 
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
virtual ~__FCBase ()
 Virtual destructor, so all inherited classes get the virtual destructor.
 
void DebugMsgInt (const char *pszPrefixText, int i)
 Creates a simple Message Box for debug purposes. The text appears with the extra digit (in decimal presentation) appearing afterwards. More...
 
void DebugMsgHex (const char *pszPrefixText, int i)
 Creates a simple Message Box for debug purposes. The text appears with the extra digit (as a hexadecimal number) appearing afterwards. More...
 
void DebugMsgString (const char *pszPrefixText, const char *thestring)
 Creates a simple Message Box for debug purposes. The text appears with the extra string appearing afterwards. More...
 
void DebugMsg (const char *pszMsg)
 Creates a simple Message Box for debug purposes with just one text string. More...
 
void DebugOutMenuInfo (FCUI *pUI, int menuixd_horiz, int menuixd_vert) const
 Outputs the menu command info for debugging purposes. More...
 
int DebugOutFormat (const char *fmt,...)
 Outputs debug text using C style "printf" syntax. More...
 
void Set16BitFlag (FLAG_16 *flag, FLAG_16 flagbits, bool state)
 Sets a 16 bit flag. More...
 
void Set32BitFlag (FLAG_32 *flag, FLAG_32 flagbits, bool state)
 Sets/resets a 32 bit flag, by using a bit mask. More...
 
bool GetBitFlag (FLAG_32 flag, FLAG_32 flagbits) const
 Gets a state from flag bits. Returns true if any bit in the mask is set. More...
 
int GetBitCount (FLAG_32 flag)
 Returns the total number of set bits in a 32-bit unsigned int.
 
void SetSpecific32Bit (FLAG_32 *flag, int bitnumber, bool state)
 Sets/resets a single bit in a 32 bit flag, by specifying one specific bit. More...
 
void SetUserData (void *pData)
 Sets the user data attached to the instance of an object. More...
 
void SetUserData2 (void *pData)
 Sets the additional user data attached to the instance of an object. More...
 
void * GetUserData () const
 Gets the user data attached to the instance of an object. More...
 
void * GetUserData2 () const
 Gets the additional user data attached to the instance of an object. More...
 
virtual bool IsIdentical (__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 DebugOutInt (const char *pszPrefixText, int i)
 Static method that outputs a line for debugging purposes. The text appears with the extra digit (in decimal presentation) appearing afterwards. More...
 
static void DebugOutFloat (const char *pszPrefixText, double f)
 Static method that outputs a line for debugging purposes. The text appears with the extra float value appearing afterwards. More...
 
static void DebugOutTag (const char *pszPrefixText, EXTAG extag)
 Static method that outputs a line for debugging purposes. The text appears with the EXTAG (in text) appearing afterwards. More...
 
static void DebugOutHex (const char *pszPrefixText, int i)
 Static method that outputs a line for debugging purposes. The text appears with the extra digit (in hexadecimal presentation) appearing afterwards. More...
 
static void DebugOutBin (const char *pszPrefixText, int i)
 Static method that outputs a line for debugging purposes. The text appears with the extra digit (in binary presentation) appearing afterwards. More...
 
static void DebugOutString (const char *pszPrefixText, const char *thestring)
 Static method that outputs a line for debugging purposes (C string version). The text appears with the extra string appearing afterwards. More...
 
static void DebugOutString (const char *pszPrefixText, FCString *pString)
 Static method that outputs a line for debugging purposes (FCString version). The text appears with the extra string appearing afterwards. More...
 
static void DebugOutBool (const char *pszPrefixText, bool state)
 Static method that outputs a line for debugging purposes. The boolean state appears afterwards as either "TRUE" or "FALSE". More...
 
static void DebugOutBlock (const void *pBuffer, int startoffset, int size)
 Static method that outputs a memory block for debugging purposes. Eight bytes per line will appear (as hex digits) until the whole memory block is dumped. More...
 
static void DebugOutByteArrayBlock (const void *pBuffer, int startoffset, int size)
 Static method that outputs a memory block for debugging purposes. Eight bytes per line will appear (as hex digits) as a C++ onebyte array, until the whole memory block is dumped. More...
 
static void DebugOut (const char *pszLine)
 Static method to output a line of text for debugging purposes. More...
 
- Protected Member Functions inherited from __FCPrefsBase
 __FCPrefsBase ()
 standard constructor
 
- Protected Member Functions inherited from __FCBaseData
virtual void 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.
 
void _TagDocumentID ()
 For internal use only. More...
 
- Protected Member Functions inherited from __FCBase
 __FCBase ()
 The constructor.
 
- Protected Attributes inherited from __FCBaseData
EDOCID _connecteddocID
 The "connected" document ID., which is the document the where the document was loaded (or last saved). This is for a mechanism to prevent resaving of certain data in other documents.
 
void * _datablock
 Pointer to the object's data block, the meaning is implementation-specific for each derived subclass.
 
bool _heapdatablock
 Variable that tells if _datablock is dynamically created on the heap (and should be deleted at object destruction).
 
int _loadedsize
 Loaded size of the data block for a loaded object, in bytes. Since the datablock is implementation-specific, the _loadedsize should be updated by child classes that create new data. More...
 
EDataID _dataid
 The EdataID for the last loaded/saved object.
 

Detailed Description

Class for repeat-related document preferences.

Member Enumeration Documentation

◆ REPEATBACKTOBACKSTYLES

The visual style when a back and forward repeat appears on the same barline.

Lua-supported.

Enumerator
REPBACKTOBACK_THIN 

Thin-thick-thin line combination.

REPBACKTOBACK_MIXED 

Thin-thick line combination.

REPBACKTOBACK_THICK 

Thick-thick line combination.

◆ REPEATWINGSTYLES

The repeat wing styles.

Lua-supported.

Enumerator
REPWING_NONE 

No repeat wings

REPWING_SINGLE 

Single (straight) wing lines.

REPWING_DOUBLE 

Double (straight) wing lines.

REPWING_CURVED 

Curved wings

Constructor & Destructor Documentation

◆ FCRepeatPrefs()

FCRepeatPrefs::FCRepeatPrefs ( )
inline

The constructor.

Lua-supported.

Member Function Documentation

◆ ClassName()

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

◆ GetAfterClefSpace()

Evpu16 FCRepeatPrefs::GetAfterClefSpace ( ) const
inline

Returns the "Forward repeat spacing - after clef" document setting, in EVPUs.

Lua-supported (also as property).

◆ GetAfterKeySpace()

Evpu32 FCRepeatPrefs::GetAfterKeySpace ( ) const
inline

Returns the "Forward repeat spacing - after key signature" document setting, in EVPUs.

Lua-supported (also as property).

◆ GetAfterTimeSpace()

Evpu32 FCRepeatPrefs::GetAfterTimeSpace ( ) const
inline

Returns the "Forward repeat spacing - after time signature" document setting, in EVPUs.

Lua-supported (also as property).

◆ GetBackToBackStyle()

REPEATBACKTOBACKSTYLES FCRepeatPrefs::GetBackToBackStyle ( ) const
inline

Returns the back-to-back line style.

Lua-supported (also as property).

Returns
Any of the REPBACKTOBACK_ constants.

◆ GetBackwardSpace()

Evpu32 FCRepeatPrefs::GetBackwardSpace ( ) const
inline

Returns the space between repeat dot and repeat lines in backward repeats, in EVPUs.

Lua-supported (also as property).

◆ GetClassID()

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

◆ GetDotAfterNumber()

bool FCRepeatPrefs::GetDotAfterNumber ( ) const
inline

Returns if the repeat number automatically should display with a period dot at the end.

Lua-supported (also as property).

◆ GetEndingBackHookLength()

Evpu32 FCRepeatPrefs::GetEndingBackHookLength ( ) const
inline

Return the default length (height) of back hooks, in EVPUs.

Lua-supported (also as property).

◆ GetEndingBracketHeight()

Evpu32 FCRepeatPrefs::GetEndingBracketHeight ( ) const
inline

Returns the default height of repeat brackets, in EVPUs.

Lua-supported (also as property).

◆ GetEndingFrontHookLength()

Evpu32 FCRepeatPrefs::GetEndingFrontHookLength ( ) const
inline

Returns the default length (height) of repeat front hooks, in EVPUs.

Lua-supported (also as property).

◆ GetEndingHorizontalText()

Evpu32 FCRepeatPrefs::GetEndingHorizontalText ( ) const
inline

Returns the default horizontal positioning for ending text.

Lua-supported (also as property).

◆ GetEndingInsetEnd()

Evpu32 FCRepeatPrefs::GetEndingInsetEnd ( ) const
inline

Returns the inset for the ends of bracket.

Lua-supported (also as property).

◆ GetEndingInsetStart()

Evpu32 FCRepeatPrefs::GetEndingInsetStart ( ) const
inline

Returns the inset for the starts of bracket.

Lua-supported (also as property).

◆ GetEndingLineThickness()

Efix16 FCRepeatPrefs::GetEndingLineThickness ( ) const
inline

Returns the line thickness, in EFIXes.

Lua-supported (also as property).

◆ GetEndingVerticalText()

Evpu16 FCRepeatPrefs::GetEndingVerticalText ( ) const
inline

Returns default vertical positioning for ending text.

Lua-supported (also as property).

◆ GetForwardSpace()

Evpu32 FCRepeatPrefs::GetForwardSpace ( ) const
inline

Returns the space between repeat dot and repeat lines in forward repeats, in EVPUs.

Lua-supported (also as property).

◆ GetHeavyLineThickness()

Efix16 FCRepeatPrefs::GetHeavyLineThickness ( ) const
inline

Returns the thick line thickness for repeat barlines, in EFIXes.

Lua-supported (also as property).

◆ GetMaxPasses()

int FCRepeatPrefs::GetMaxPasses ( ) const
inline

Returns the maximum number of playback passes a repeat should be allowed.

Lua-supported (also as property).

◆ GetShowOnStaffListID()

twobyte FCRepeatPrefs::GetShowOnStaffListID ( ) const
inline

Returns the selected staff list if "Show On Staff List" is selected.

If this value is non-zero, GetShowOnTopStaffOnly should be false.

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

◆ GetShowOnTopStaffOnly()

bool FCRepeatPrefs::GetShowOnTopStaffOnly ( ) const
inline

Returns if "Show On Top Staff Only" is selected.

If this value is true, GetShowOnStaffListID() should be 0.

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

◆ GetSpaceBetweenLines()

Efix16 FCRepeatPrefs::GetSpaceBetweenLines ( ) const
inline

Returns the distance between lines in a repeat, in EFIXes.

Lua-supported (also as property).

◆ GetThinInnerBracketReference()

bool FCRepeatPrefs::GetThinInnerBracketReference ( ) const

Returns if the thin inner repeat barline should be used as bracket line reference.

Lua-supported (also as property).

Returns
On earlier versions than Finale 25.1, this always returns false. On Finale 25.1 and later: true - bracket line should align to the thin inner repeat barline, false - bracket line should align to thick outer repeat barline

◆ GetThinLineThickness()

Efix16 FCRepeatPrefs::GetThinLineThickness ( ) const
inline

Returns the thin line thickness for repeat barlines, in EFIXes.

Lua-supported (also as property).

◆ GetVerticalBottomDotAdjustment()

Evpu32 FCRepeatPrefs::GetVerticalBottomDotAdjustment ( ) const
inline

Returns the bottom repeat dot adjustment, in EVPUs.

Lua-supported (also as property).

◆ GetVerticalTopDotAdjustment()

Evpu32 FCRepeatPrefs::GetVerticalTopDotAdjustment ( ) const
inline

Returns the top repeat dot adjustment, in EVPUs.

Lua-supported (also as property).

◆ GetWingStyle()

REPEATWINGSTYLES FCRepeatPrefs::GetWingStyle ( ) const
inline

Returns the wing styles for repeats barlines.

Lua-supported (also as property).

Returns
Any of the REPWING_ constants

◆ SetAfterClefSpace()

void FCRepeatPrefs::SetAfterClefSpace ( Evpu32  value)
inline

Returns the "Forward repeat spacing - after clef signature" document setting, in EVPUs.

Lua-supported (also as property).

◆ SetAfterKeySpace()

void FCRepeatPrefs::SetAfterKeySpace ( Evpu32  value)
inline

Returns the "Forward repeat spacing - after key signature" document setting, in EVPUs.

Lua-supported (also as property).

◆ SetAfterTimeSpace()

void FCRepeatPrefs::SetAfterTimeSpace ( Evpu32  value)
inline

Returns the "Forward repeat spacing - after time signature" document setting, in EVPUs.

Lua-supported (also as property).

◆ SetBackToBackStyle()

void FCRepeatPrefs::SetBackToBackStyle ( REPEATBACKTOBACKSTYLES  style)
inline

Returns the back-to-back line style.

Lua-supported (also as property).

Parameters
styleAny of the REPBACKTOBACK_ constants.

◆ SetBackwardSpace()

void FCRepeatPrefs::SetBackwardSpace ( Evpu32  value)
inline

Sets the space between repeat dot and repeat lines in backward repeats, in EVPUs.

Lua-supported (also as property).

◆ SetDotAfterNumber()

void FCRepeatPrefs::SetDotAfterNumber ( bool  state)
inline

Sets if the repeat number automatically should display with a period dot at the end, or not.

Lua-supported (also as property).

◆ SetEndingBackHookLength()

void FCRepeatPrefs::SetEndingBackHookLength ( Evpu32  value)
inline

Sets the default length (height) of back hooks, in EVPUs.

Lua-supported (also as property).

◆ SetEndingBracketHeight()

void FCRepeatPrefs::SetEndingBracketHeight ( Evpu32  value)
inline

Sets the default height of repeat brackets, in EVPUs.

Lua-supported (also as property).

◆ SetEndingFrontHookLength()

void FCRepeatPrefs::SetEndingFrontHookLength ( Evpu32  value)
inline

Sets the default length (height) of repeat front hooks, in EVPUs.

Lua-supported (also as property).

◆ SetEndingHorizontalText()

void FCRepeatPrefs::SetEndingHorizontalText ( Evpu32  value)
inline

Sets the default horizontal positioning for ending text.

Lua-supported (also as property).

◆ SetEndingInsetEnd()

void FCRepeatPrefs::SetEndingInsetEnd ( Evpu32  value)
inline

Sets the inset for the ends of bracket.

Lua-supported (also as property).

◆ SetEndingInsetStart()

void FCRepeatPrefs::SetEndingInsetStart ( Evpu32  value)
inline

Sets the inset for the starts of bracket.

Lua-supported (also as property).

◆ SetEndingLineThickness()

void FCRepeatPrefs::SetEndingLineThickness ( Evpu32  value)
inline

Sets the line thickness, in EFIXes.

Lua-supported (also as property).

◆ SetEndingVerticalText()

void FCRepeatPrefs::SetEndingVerticalText ( Evpu32  value)
inline

Sets default vertical positioning for ending text.

Lua-supported (also as property).

◆ SetForwardSpace()

void FCRepeatPrefs::SetForwardSpace ( Evpu32  value)
inline

Sets the space between repeat dot and repeat lines in forward repeats, in EVPUs.

Lua-supported (also as property).

◆ SetHeavyLineThickness()

void FCRepeatPrefs::SetHeavyLineThickness ( Efix16  value)
inline

Sets the thick line thickness for repeat barlines, in EFIXes.

Lua-supported (also as property).

◆ SetMaxPasses()

void FCRepeatPrefs::SetMaxPasses ( int  value)
inline

Sets the maximum number of playback passes a repeat should be allowed.

Lua-supported (also as property).

◆ SetShowOnStaffListID()

void FCRepeatPrefs::SetShowOnStaffListID ( twobyte  value)
inline

Sets the selected staff list for "Show On Staff List".

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

Parameters
valueif non-zero, GetShowOnTopStaffOnly is also set to false.

◆ SetShowOnTopStaffOnly()

void FCRepeatPrefs::SetShowOnTopStaffOnly ( bool  state)
inline

Sets if "Show On Top Staff Only" is selected.

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

Parameters
stateif true, GetShowOnStaffListID() is also set to 0.

◆ SetSpaceBetweenLines()

void FCRepeatPrefs::SetSpaceBetweenLines ( Efix16  value)
inline

Sets the distance between lines in a repeat, in EFIXes.

Lua-supported (also as property).

◆ SetThinInnerBracketReference()

void FCRepeatPrefs::SetThinInnerBracketReference ( bool  state)

Sets if the thin inner repeat barline should be used as bracket line reference.

Lua-supported (also as property).

Parameters
[in]stateOn earlier versions than Finale 25.1, this method does nothing. On Finale 25.1 and later: true - bracket line should align to the thin inner repeat barline, false - bracket line should align to thick outer repeat barline.

◆ SetThinLineThickness()

void FCRepeatPrefs::SetThinLineThickness ( Efix16  value)
inline

Sets the thin line thickness for repeat barlines, in EFIXes.

Lua-supported (also as property).

◆ SetVerticalBottomDotAdjustment()

void FCRepeatPrefs::SetVerticalBottomDotAdjustment ( Evpu32  value)
inline

Sets the bottom repeat dot adjustment, in EVPUs.

Lua-supported (also as property).

◆ SetVerticalTopDotAdjustment()

void FCRepeatPrefs::SetVerticalTopDotAdjustment ( Evpu32  value)
inline

Sets the top repeat dot adjustment, in EVPUs.

Lua-supported (also as property).

◆ SetWingStyle()

void FCRepeatPrefs::SetWingStyle ( REPEATWINGSTYLES  style)
inline

Returns the wing styles for repeats barlines.

Lua-supported (also as property).

Parameters
styleAny of the REPWING_ constants