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

The class for a fretboard style definition, which reflects the content the "Fretboard Style" dialog box in Finale. More...

#include <ff_other.h>

Inheritance diagram for FCFretboardStyleDef:
__FCNoInciOther __FCOther __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...
 
 FCFretboardStyleDef ()
 The constructor. More...
 
void GetName (FCString *pString)
 Copies the style name to a FCString object. More...
 
Efix32 GetStringSpacing () const
 Returns the string spacing, in EFIXes. More...
 
Efix32 GetStringThickness () const
 Returns the string thickness, in EFIXes. More...
 
Efix32 GetFretSpacing () const
 Returns the fret spacing, in EFIXes. More...
 
Efix32 GetFretThickness () const
 Returns the fret thickness, in EFIXes. More...
 
Efix32 GetNutThickness () const
 Returns the nut thickness, in EFIXes. More...
 
Efix32 GetHorizontalFingeringOffset () const
 Returns the horizontal offset for fingering numbers, in EFIXes. More...
 
Efix32 GetVerticalFingeringOffset () const
 Returns the vertical offset for fingering numbers, in EFIXes. More...
 
Efix32 GetFingeringWhiteout () const
 Returns the whiteout for fingering numbers, in EFIXes. More...
 
Efix32 GetHorizontalHandleOffset () const
 Returns the horizontal handle offset, in EFIXes. More...
 
Efix32 GetVerticalHandleOffset () const
 Returns the vertical handle offset, in EFIXes. More...
 
void GetFretNumberText (FCString *pString)
 Copies the fret number text to a FCString object. More...
 
Efix32 GetHorizontalFretNumberOffset () const
 Returns the horizontal text offset for fret number text, in EFIXes. More...
 
Efix32 GetVerticalFretNumberOffset () const
 Returns the vertical text offset for fret number text, in EFIXes. More...
 
int GetFretCountDefault () const
 Returns the default number of frets for the style. More...
 
bool GetShowLastFret () const
 Returns if the last fret should be shown when drawing the fretboards, or not. More...
 
bool GetRotate () const
 Returns if the fret should be rotated or not. More...
 
bool GetDrawFingeringWhite () const
 Returns if the fingering numbers should be drawn in white. More...
 
twobyte GetFingeredShapeID () const
 Returns the shape ID of the "fingered" shape. More...
 
twobyte GetOpenStringShapeID () const
 Returns the shape ID of the "open string" shape. More...
 
twobyte GetMuteStringShapeID () const
 Returns the shape ID of the "mute string" shape. More...
 
twobyte GetBarreShapeID () const
 Returns the shape ID of the "barre" shape. More...
 
twobyte GetCustomShapeID () const
 Returns the shape ID of the "custom" shape. More...
 
void GetFingeringFontInfo (FCFontInfo *pFontInfo)
 Copies the fingering font information to a FCFontInfo object. More...
 
void GetFretNumberFontInfo (FCFontInfo *pFontInfo)
 Copies the fret number font information to a FCFontInfo object. More...
 
void SetName (FCString *pString)
 Sets the style name, by using a FCString object. More...
 
void SetStringSpacing (Efix32 value)
 Sets the string spacing, in EFIXes. More...
 
void SetStringThickness (Efix32 value)
 Sets the string thickness, in EFIXes. More...
 
void SetFretSpacing (Efix32 value)
 Sets the fret spacing, in EFIXes. More...
 
void SetFretThickness (Efix32 value)
 Sets the fret thickness, in EFIXes. More...
 
void SetNutThickness (Efix32 value)
 Sets the nut thickness, in EFIXes. More...
 
void SetHorizontalFingeringOffset (Efix32 value)
 Sets the horizontal offset for fingering numbers, in EFIXes. More...
 
void SetVerticalFingeringOffset (Efix32 value)
 Sets the vertical offset for fingering numbers, in EFIXes. More...
 
void SetFingeringWhiteout (Efix32 value)
 Sets the whiteout for fingering numbers, in EFIXes. More...
 
void SetHorizontalHandleOffset (Efix32 value)
 Sets the horizontal handle offset, in EFIXes. More...
 
void SetVerticalHandleOffset (Efix32 value)
 Sets the vertical handle offset, in EFIXes. More...
 
void SetFretNumberText (FCString *pString)
 Sets the fret number text, using a FCString object. More...
 
void SetHorizontalFretNumberOffset (Efix32 value)
 Sets the horizontal text offset for fret number text, in EFIXes. More...
 
void SetVerticalFretNumberOffset (Efix32 value)
 Sets the vertical text offset for fret number text, in EFIXes. More...
 
void SetFretCountDefault (int value)
 Sets the default number of frets for the style. More...
 
void SetShowLastFret (bool state)
 Sets if the last fret should be shown when drawing the fretboards, or not. More...
 
void SetRotate (bool state)
 Sets if the fret should be rotated or not. More...
 
void SetDrawFingeringWhite (bool state)
 Sets if the fingering numbers should be drawn in white. More...
 
void SetFingeredShapeID (twobyte value)
 Sets the shape ID of the "fingered" shape. More...
 
void SetOpenStringShapeID (twobyte value)
 Sets the shape ID of the "open string" shape. More...
 
void SetMuteStringShapeID (twobyte value)
 Sets the shape ID of the "mute string" shape. More...
 
void SetBarreShapeID (twobyte value)
 Sets the shape ID of the "barre" shape. More...
 
void SetCustomShapeID (twobyte value)
 Sets the shape ID of the "custom" shape. More...
 
void SetFingeringFontInfo (FCFontInfo *pFontInfo)
 Copies the fingering font information from a FCFontInfo object. More...
 
void SetFretNumberFontInfo (FCFontInfo *pFontInfo)
 Copies the fret number font information fro a FCFontInfo object. More...
 
virtual void DebugDump ()
 Outputs the class data/information for debugging purposes. More...
 
- Public Member Functions inherited from __FCNoInciOther
 __FCNoInciOther ()
 The constructor.
 
virtual bool Load (CMPER itemno)
 Loads the indicated item. More...
 
virtual bool Reload ()
 Overridden Reload() method to support complex data types.
 
virtual bool SaveAs (CMPER itemno)
 Saves the data under another item number. The object will now be connected to the new item number. More...
 
virtual bool DeepSaveAs (CMPER itemno)
 Saves the data under another item number, but also makes a deep copy of the object. More...
 
virtual bool DeepDeleteData ()
 Deletes the data and all related data available in other data structures. More...
 
virtual bool SaveNew ()
 Creates the data as completely new item number. The object will now be connected to the new item number. More...
 
virtual CMPER GetItemNo () const
 Returns the item number. This typically points to items such as a page number, a measure number, a 1-based expression definition number, etc. More...
 
void SetItemNo (CMPER cmper)
 Sets the item number. Use with extreme care! This is mostly intended for situations when creating new records isn't supported by Finale (preventing SaveAs to work). More...
 
virtual bool LoadFirst ()
 Loads the first element of 1-based data. More...
 
- Public Member Functions inherited from __FCOther
void SetCmperAndInci (CMPER cmper, twobyte inci)
 Sets both the CMPER and the incident number in the dataID record. Mainly for internal use.
 
 __FCOther ()
 The constructor.
 
bool IsIdenticalRecord (__FCOther *pCompare)
 Compares an object to see if both objects point to the same data record. 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 Save ()
 Saves the currently loaded to its current location. More...
 
virtual bool DeleteData ()
 Deletes the associated data from Finale's database. Be careful when deleting multiple objects. 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

The class for a fretboard style definition, which reflects the content the "Fretboard Style" dialog box in Finale.

This class mapped to the fretboard ID in a FCChord.

Constructor & Destructor Documentation

FCFretboardStyleDef::FCFretboardStyleDef ( )
inline

The constructor.

Lua-supported.

Member Function Documentation

virtual const char* FCFretboardStyleDef::ClassName ( )
inlinevirtual

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

Lua-supported.

Reimplemented from __FCNoInciOther.

virtual void FCFretboardStyleDef::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 __FCNoInciOther.

twobyte FCFretboardStyleDef::GetBarreShapeID ( ) const
inline

Returns the shape ID of the "barre" shape.

Lua-supported (also as property).

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

twobyte FCFretboardStyleDef::GetCustomShapeID ( ) const
inline

Returns the shape ID of the "custom" shape.

Lua-supported (also as property).

bool FCFretboardStyleDef::GetDrawFingeringWhite ( ) const
inline

Returns if the fingering numbers should be drawn in white.

Currently not available in Finale.

twobyte FCFretboardStyleDef::GetFingeredShapeID ( ) const
inline

Returns the shape ID of the "fingered" shape.

Lua-supported (also as property).

void FCFretboardStyleDef::GetFingeringFontInfo ( FCFontInfo pFontInfo)
inline

Copies the fingering font information to a FCFontInfo object.

Lua-supported.

\param pString The #FCFontInfo object that should contain the fingering font information.
Efix32 FCFretboardStyleDef::GetFingeringWhiteout ( ) const
inline

Returns the whiteout for fingering numbers, in EFIXes.

Lua-supported (also as property).

int FCFretboardStyleDef::GetFretCountDefault ( ) const
inline

Returns the default number of frets for the style.

Lua-supported (also as property).

void FCFretboardStyleDef::GetFretNumberFontInfo ( FCFontInfo pFontInfo)
inline

Copies the fret number font information to a FCFontInfo object.

Lua-supported.

\param pString The #FCFontInfo object that should contain the fret number font information.
void FCFretboardStyleDef::GetFretNumberText ( FCString pString)
inline

Copies the fret number text to a FCString object.

This method currently doesn't support the Unicode character set.

Lua-supported.

\param pString The #FCString object that should contain the fret number text.
Efix32 FCFretboardStyleDef::GetFretSpacing ( ) const
inline

Returns the fret spacing, in EFIXes.

Lua-supported (also as property).

Efix32 FCFretboardStyleDef::GetFretThickness ( ) const
inline

Returns the fret thickness, in EFIXes.

Lua-supported (also as property).

Efix32 FCFretboardStyleDef::GetHorizontalFingeringOffset ( ) const
inline

Returns the horizontal offset for fingering numbers, in EFIXes.

Lua-supported (also as property).

Efix32 FCFretboardStyleDef::GetHorizontalFretNumberOffset ( ) const
inline

Returns the horizontal text offset for fret number text, in EFIXes.

Lua-supported (also as property).

Efix32 FCFretboardStyleDef::GetHorizontalHandleOffset ( ) const
inline

Returns the horizontal handle offset, in EFIXes.

Lua-supported (also as property).

twobyte FCFretboardStyleDef::GetMuteStringShapeID ( ) const
inline

Returns the shape ID of the "mute string" shape.

Lua-supported (also as property).

void FCFretboardStyleDef::GetName ( FCString pString)
inline

Copies the style name to a FCString object.

This method currently doesn't support the Unicode character set.

\param pString The #FCString object that should contain the style name.
Efix32 FCFretboardStyleDef::GetNutThickness ( ) const
inline

Returns the nut thickness, in EFIXes.

Lua-supported (also as property).

twobyte FCFretboardStyleDef::GetOpenStringShapeID ( ) const
inline

Returns the shape ID of the "open string" shape.

Lua-supported (also as property).

bool FCFretboardStyleDef::GetRotate ( ) const
inline

Returns if the fret should be rotated or not.

When rotated, the fretboard diagram is drawn so the nut is on the left.

Currently not available in Finale.

bool FCFretboardStyleDef::GetShowLastFret ( ) const
inline

Returns if the last fret should be shown when drawing the fretboards, or not.

Lua-supported (also as property).

Efix32 FCFretboardStyleDef::GetStringSpacing ( ) const
inline

Returns the string spacing, in EFIXes.

Lua-supported (also as property).

Efix32 FCFretboardStyleDef::GetStringThickness ( ) const
inline

Returns the string thickness, in EFIXes.

Lua-supported (also as property).

Efix32 FCFretboardStyleDef::GetVerticalFingeringOffset ( ) const
inline

Returns the vertical offset for fingering numbers, in EFIXes.

Lua-supported (also as property).

Efix32 FCFretboardStyleDef::GetVerticalFretNumberOffset ( ) const
inline

Returns the vertical text offset for fret number text, in EFIXes.

Lua-supported (also as property).

Efix32 FCFretboardStyleDef::GetVerticalHandleOffset ( ) const
inline

Returns the vertical handle offset, in EFIXes.

Lua-supported (also as property).

void FCFretboardStyleDef::SetBarreShapeID ( twobyte  value)
inline

Sets the shape ID of the "barre" shape.

Lua-supported (also as property).

void FCFretboardStyleDef::SetCustomShapeID ( twobyte  value)
inline

Sets the shape ID of the "custom" shape.

Lua-supported (also as property).

void FCFretboardStyleDef::SetDrawFingeringWhite ( bool  state)
inline

Sets if the fingering numbers should be drawn in white.

Currently not available in Finale.

void FCFretboardStyleDef::SetFingeredShapeID ( twobyte  value)
inline

Sets the shape ID of the "fingered" shape.

Lua-supported (also as property).

void FCFretboardStyleDef::SetFingeringFontInfo ( FCFontInfo pFontInfo)
inline

Copies the fingering font information from a FCFontInfo object.

Lua-suported.

Parameters
pFontInfoThe FCFontInfo object that has the fingering font information.
void FCFretboardStyleDef::SetFingeringWhiteout ( Efix32  value)
inline

Sets the whiteout for fingering numbers, in EFIXes.

Lua-supported (also as property).

void FCFretboardStyleDef::SetFretCountDefault ( int  value)
inline

Sets the default number of frets for the style.

Lua-supported (also as property).

void FCFretboardStyleDef::SetFretNumberFontInfo ( FCFontInfo pFontInfo)
inline

Copies the fret number font information fro a FCFontInfo object.

Lua-supported.

Parameters
pFontInfoThe FCFontInfo object that has the fret number font information.
void FCFretboardStyleDef::SetFretNumberText ( FCString pString)
inline

Sets the fret number text, using a FCString object.

This method currently doesn't support the Unicode character set.

Lua-supported.

Parameters
pStringThe FCString object that contains the fret number text.
void FCFretboardStyleDef::SetFretSpacing ( Efix32  value)
inline

Sets the fret spacing, in EFIXes.

Lua-supported (also as property).

void FCFretboardStyleDef::SetFretThickness ( Efix32  value)
inline

Sets the fret thickness, in EFIXes.

Lua-supported (also as property).

void FCFretboardStyleDef::SetHorizontalFingeringOffset ( Efix32  value)
inline

Sets the horizontal offset for fingering numbers, in EFIXes.

Lua-supported (also as property).

void FCFretboardStyleDef::SetHorizontalFretNumberOffset ( Efix32  value)
inline

Sets the horizontal text offset for fret number text, in EFIXes.

Lua-supported (also as property).

void FCFretboardStyleDef::SetHorizontalHandleOffset ( Efix32  value)
inline

Sets the horizontal handle offset, in EFIXes.

Lua-supported (also as property).

void FCFretboardStyleDef::SetMuteStringShapeID ( twobyte  value)
inline

Sets the shape ID of the "mute string" shape.

Lua-supported (also as property).

void FCFretboardStyleDef::SetName ( FCString pString)
inline

Sets the style name, by using a FCString object.

This method currently doesn't support the Unicode character set.

Lua-supported.

Parameters
pStringThe FCString object that contains the style name.
void FCFretboardStyleDef::SetNutThickness ( Efix32  value)
inline

Sets the nut thickness, in EFIXes.

Lua-supported (also as property).

void FCFretboardStyleDef::SetOpenStringShapeID ( twobyte  value)
inline

Sets the shape ID of the "open string" shape.

Lua-supported (also as property).

void FCFretboardStyleDef::SetRotate ( bool  state)
inline

Sets if the fret should be rotated or not.

When rotated, the fretboard diagram is drawn so the nut is on the left.

Currently not available in Finale.

void FCFretboardStyleDef::SetShowLastFret ( bool  state)
inline

Sets if the last fret should be shown when drawing the fretboards, or not.

Lua-supported (also as property).

void FCFretboardStyleDef::SetStringSpacing ( Efix32  value)
inline

Sets the string spacing, in EFIXes.

Lua-supported (also as property).

void FCFretboardStyleDef::SetStringThickness ( Efix32  value)
inline

Sets the string thickness, in EFIXes.

Lua-supported (also as property).

void FCFretboardStyleDef::SetVerticalFingeringOffset ( Efix32  value)
inline

Sets the vertical offset for fingering numbers, in EFIXes.

Lua-supported (also as property).

void FCFretboardStyleDef::SetVerticalFretNumberOffset ( Efix32  value)
inline

Sets the vertical text offset for fret number text, in EFIXes.

Lua-supported (also as property).

void FCFretboardStyleDef::SetVerticalHandleOffset ( Efix32  value)
inline

Sets the vertical handle offset, in EFIXes.

Lua-supported (also as property).