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:

Public Member Functions
const char *	ClassName () const override
	Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child class.
const PDKFRAMEWORK_CLASSID	GetClassID () const override
	Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has problems to resolve the true classes of inherited objects.
	FCFretboardStyleDef ()
	The constructor.
void	GetName (FCString *pString) const
	Copies the style name to a FCString object.
Efix32	GetStringSpacing () const
	Returns the string spacing, in EFIXes.
Efix32	GetStringThickness () const
	Returns the string thickness, in EFIXes.
Efix32	GetFretSpacing () const
	Returns the fret spacing, in EFIXes.
Efix32	GetFretThickness () const
	Returns the fret thickness, in EFIXes.
Efix32	GetNutThickness () const
	Returns the nut thickness, in EFIXes.
Efix32	GetHorizontalFingeringOffset () const
	Returns the horizontal offset for fingering numbers, in EFIXes.
Efix32	GetVerticalFingeringOffset () const
	Returns the vertical offset for fingering numbers, in EFIXes.
Efix32	GetFingeringWhiteout () const
	Returns the whiteout for fingering numbers, in EFIXes.
Efix32	GetHorizontalHandleOffset () const
	Returns the horizontal handle offset, in EFIXes.
Efix32	GetVerticalHandleOffset () const
	Returns the vertical handle offset, in EFIXes.
void	GetFretNumberText (FCString *pString) const
	Copies the fret number text to a FCString object.
Efix32	GetHorizontalFretNumberOffset () const
	Returns the horizontal text offset for fret number text, in EFIXes.
Efix32	GetVerticalFretNumberOffset () const
	Returns the vertical text offset for fret number text, in EFIXes.
int	GetFretCountDefault () const
	Returns the default number of frets for the style.
bool	GetShowLastFret () const
	Returns if the last fret should be shown when drawing the fretboards, or not.
bool	GetRotate () const
	Returns if the fret should be rotated or not.
bool	GetDrawFingeringWhite () const
	Returns if the fingering numbers should be drawn in white.
twobyte	GetFingeredShapeID () const
	Returns the shape ID of the "fingered" shape.
twobyte	GetOpenStringShapeID () const
	Returns the shape ID of the "open string" shape.
twobyte	GetMuteStringShapeID () const
	Returns the shape ID of the "mute string" shape.
twobyte	GetBarreShapeID () const
	Returns the shape ID of the "barre" shape.
twobyte	GetCustomShapeID () const
	Returns the shape ID of the "custom" shape.
void	GetFingeringFontInfo (FCFontInfo *pFontInfo)
	Copies the fingering font information to a FCFontInfo object.
void	GetFretNumberFontInfo (FCFontInfo *pFontInfo)
	Copies the fret number font information to a FCFontInfo object.
void	SetName (const FCString *pString)
	Sets the style name, by using a FCString object.
void	SetStringSpacing (Efix32 value)
	Sets the string spacing, in EFIXes.
void	SetStringThickness (Efix32 value)
	Sets the string thickness, in EFIXes.
void	SetFretSpacing (Efix32 value)
	Sets the fret spacing, in EFIXes.
void	SetFretThickness (Efix32 value)
	Sets the fret thickness, in EFIXes.
void	SetNutThickness (Efix32 value)
	Sets the nut thickness, in EFIXes.
void	SetHorizontalFingeringOffset (Efix32 value)
	Sets the horizontal offset for fingering numbers, in EFIXes.
void	SetVerticalFingeringOffset (Efix32 value)
	Sets the vertical offset for fingering numbers, in EFIXes.
void	SetFingeringWhiteout (Efix32 value)
	Sets the whiteout for fingering numbers, in EFIXes.
void	SetHorizontalHandleOffset (Efix32 value)
	Sets the horizontal handle offset, in EFIXes.
void	SetVerticalHandleOffset (Efix32 value)
	Sets the vertical handle offset, in EFIXes.
void	SetFretNumberText (const FCString *pString)
	Sets the fret number text, using a FCString object.
void	SetHorizontalFretNumberOffset (Efix32 value)
	Sets the horizontal text offset for fret number text, in EFIXes.
void	SetVerticalFretNumberOffset (Efix32 value)
	Sets the vertical text offset for fret number text, in EFIXes.
void	SetFretCountDefault (int value)
	Sets the default number of frets for the style.
void	SetShowLastFret (bool state)
	Sets if the last fret should be shown when drawing the fretboards, or not.
void	SetRotate (bool state)
	Sets if the fret should be rotated or not.
void	SetDrawFingeringWhite (bool state)
	Sets if the fingering numbers should be drawn in white.
void	SetFingeredShapeID (twobyte value)
	Sets the shape ID of the "fingered" shape.
void	SetOpenStringShapeID (twobyte value)
	Sets the shape ID of the "open string" shape.
void	SetMuteStringShapeID (twobyte value)
	Sets the shape ID of the "mute string" shape.
void	SetBarreShapeID (twobyte value)
	Sets the shape ID of the "barre" shape.
void	SetCustomShapeID (twobyte value)
	Sets the shape ID of the "custom" shape.
void	SetFingeringFontInfo (FCFontInfo *pFontInfo)
	Copies the fingering font information from a FCFontInfo object.
void	SetFretNumberFontInfo (FCFontInfo *pFontInfo)
	Copies the fret number font information fro a FCFontInfo object.
void	DebugDump () override
	Outputs the class data/information for debugging purposes.
Public Member Functions inherited from __FCNoInciOther
	__FCNoInciOther ()
	The constructor.
virtual bool	Load (CMPER itemno)
	Loads the indicated item.
bool	Reload () override
	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.
virtual bool	DeepSaveAs (CMPER itemno)
	Saves the data under another item number, but also makes a deep copy of the object.
bool	DeepDeleteData () override
	Deletes the data and all related data available in other data structures.
virtual bool	SaveNew ()
	Creates the data as completely new item number. The object will now be connected to the new item number.
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.
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).
bool	LoadFirst () override
	Loads the first element of 1-based data.
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.
Public Member Functions inherited from __FCBaseData
EDOCID	GetConnectedDocID () const
	Returns the document ID that was connected to the last load/save of the data.
bool	VerifyConnectedDocID ()
	Checks that the stored document ID for the data object matches the current document's ID.
virtual EXTAG	Tag () const =0
	The Enigma tag for the derived class.
virtual EVERSION	EnigmaVersion () const
	The Enigma version for save/load/create/delete operations.
virtual int	DataSizeLoad () const =0
	Returns the data size for the data structure that should be loaded.
virtual int	DataSizeSave () const
	Returns the data size for the data structure that should be saved or created.
void	_CloneFrom (__FCBaseData *pSource)
	For internal use only. Copies object data (except data block) from another object.
virtual void	CloneMemoryFrom (__FCBaseData *pSource)
const EDataID *	_GetDataID ()
	Intended ONLY for the _CloneFrom implementation.
int	_GetLoadedSize () const
	Intended ONLY for the _CloneFrom implementation.
const void *	GetDataBlock ()
	Intended ONLY for the _CloneFrom implementation.
EXTAG	GetCustomTag () const
	Returns the custom Enigma tag, if any.
void	SetCustomTag (EXTAG tag)
	Sets the custom Enigma tag, for classes that support multiple Enigma tags.
	__FCBaseData ()
	The constructor.
virtual	~__FCBaseData ()
	Virtual destructor.
virtual bool	Save ()
	Saves the currently loaded to its current location.
virtual bool	DeleteData ()
	Deletes the associated data from Finale's database. Be careful when deleting multiple objects.
virtual bool	LoadLast ()
	Loads the very last element in the database, if any.
virtual bool	LoadNext ()
	Loads the next element from the database, if any.
virtual bool	LoadPrevious ()
	Loads the previous element in the database, if any.
bool	RelinkToCurrentView ()
	Relinks the contents in the current view so that the score and part(s) match.
bool	RelinkToScore ()
	Relinks all parts to the contents of the score.
__FCBaseData *	CreateClone ()
	Creates an identical copy of an object.
void	DebugDataDump () override
	Outputs a memory dump of the data block in the object for debugging purposes.
void	DebugDataByteArrayDump () override
	Outputs a memory dump of the data block in the object for debugging purposes, as a C++ byte array.
void	DebugDataOffsetDump (int offset, int size)
	For debug mode only. Dumps a data memory block at a specific offset and with a specific size.
FCNumbers *	CreateRawDataDump ()
	Creates a byte collection with the raw loaded data block for the object (if the object type supports single data blocks). This method is only intended for debug purposes.
Public Member Functions inherited from __FCBase
virtual	~__FCBase ()
	Virtual destructor, so all inherited classes get the virtual destructor.
void	DebugMsgInt (const char *pszPrefixText, int i)
	Creates a simple Message Box for debug purposes. The text appears with the extra digit (in decimal presentation) appearing afterwards.
void	DebugMsgHex (const char *pszPrefixText, int i)
	Creates a simple Message Box for debug purposes. The text appears with the extra digit (as a hexadecimal number) appearing afterwards.
void	DebugMsgString (const char *pszPrefixText, const char *thestring)
	Creates a simple Message Box for debug purposes. The text appears with the extra string appearing afterwards.
void	DebugMsg (const char *pszMsg)
	Creates a simple Message Box for debug purposes with just one text string.
void	DebugOutMenuInfo (FCUI *pUI, int menuixd_horiz, int menuixd_vert) const
	Outputs the menu command info for debugging purposes.
int	DebugOutFormat (const char *fmt,...)
	Outputs debug text using C style "printf" syntax.
void	Set16BitFlag (FLAG_16 *flag, FLAG_16 flagbits, bool state)
	Sets a 16 bit flag.
void	Set32BitFlag (FLAG_32 *flag, FLAG_32 flagbits, bool state)
	Sets/resets a 32 bit flag, by using a bit mask.
bool	GetBitFlag (FLAG_32 flag, FLAG_32 flagbits) const
	Gets a state from flag bits. Returns true if any bit in the mask is set.
int	GetBitCount (FLAG_32 flag)
	Returns the total number of set bits in a 32-bit unsigned int.
void	SetSpecific32Bit (FLAG_32 *flag, int bitnumber, bool state)
	Sets/resets a single bit in a 32 bit flag, by specifying one specific bit.
void	SetUserData (void *pData)
	Sets the user data attached to the instance of an object.
void	SetUserData2 (void *pData)
	Sets the additional user data attached to the instance of an object.
void *	GetUserData () const
	Gets the user data attached to the instance of an object.
void *	GetUserData2 () const
	Gets the additional user data attached to the instance of an object.
virtual bool	IsIdentical (const __FCBase *pCompareObject) const
	Returns true if the data in the passed object is considered to be identical to the current object, otherwise false.
void	StoreXML_String (tinyxml2::XMLElement *pParentNode, const char *pszElementName, FCString *pStringValue)
	Helper function to store FCString objects in the XML file.
void	StoreXML_Integer (tinyxml2::XMLElement *pParentNode, const char *pszElementName, int value)
	Helper function to store integer objects in the XML file.
void	StoreXML_Bool (tinyxml2::XMLElement *pParentNode, const char *pszElementName, bool value)
	Helper function to store boolean objects in the XML file.
void	StoreXML_StringAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, FCString *pStringValue)
	Helper function to store FCString objects in the XML file, as an attribute to a node.
void	StoreXML_IntegerAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, int value)
	Helper function to store integer objects in the XML file, as an attribute to a node.
void	StoreXML_BoolAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, bool value)
	Helper function to store boolean objects in the XML file, as an attribute to a node.
void	StoreXML_FloatAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, float value)
	Helper function to store floating point objects in the XML file, as an attribute to a node.
virtual void	StoreToXML (tinyxml2::XMLElement *pParentNode)
	Virtual method that is used to store an object's data.
bool	ReadXML_String (tinyxml2::XMLElement *pParentNode, const char *pszElementName, FCString *pStringValue)
	Helper method to read FCString objects from the XML file.
bool	ReadXML_Integer (tinyxml2::XMLElement *pParentNode, const char *pszElementName, int *pValue)
	Helper method to read integer objects from the XML file.
bool	ReadXML_Bool (tinyxml2::XMLElement *pParentNode, const char *pszElementName, bool *pValue)
	Helper method to read boolean objects from the XML file.
bool	ReadXML_StringAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, FCString *pStringValue)
	Helper method to read FCString objects from the XML file, as an attribute to a node.
bool	ReadXML_IntegerAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, int *pValue)
	Helper method to read integer objects from the XML file, as an attribute to a node.
bool	ReadXML_BoolAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, bool *pValue)
	Helper method to read boolean objects from the XML file, as an attribute to a node.
bool	ReadXML_FloatAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, float *pValue)
	Helper method to read floating point objects from the XML file, as an attribute to a node.
virtual bool	ReadFromXML (tinyxml2::XMLElement *pParentNode)
	Virtual method that is used to read object data.

Additional Inherited Members
Public Types inherited from __FCBase
enum	PDKFRAMEWORK_CLASSID {   FCID_UNKNOWN = 0 , FCID_ACCIDENTALMOD , FCID_ACTIVELYRIC , FCID_ALLOTMENT ,   FCID_ARTICULATION , FCID_ARTICULATIONDEF , FCID_BACKWARDREPEAT , FCID_BASELINE ,   FCID_BEAMMOD , FCID_BEATCHARTELEMENT , FCID_BOOKMARK , FCID_BROKENBEAMMOD ,   FCID_CATEGORYDEF , FCID_CELLCLEFCHANGE , FCID_CELLFRAMEHOLD , FCID_CELLGRAPHIC ,   FCID_CELLTEXT , FCID_CENTERSMARTSHAPE , FCID_CHORD , FCID_CHORDPREFS ,   FCID_CHORDSUFFIXELEMENT , FCID_CHORUSSYLLABLE , FCID_CLEFDEF , FCID_COMPOSITETIMESIGBOTTOMELEMENT ,   FCID_COMPOSITETIMESIGTOPELEMENT , FCID_CROSSSTAFFMOD , FCID_CUSTOMSMARTLINEDEF , FCID_CUSTOMSTEMMOD ,   FCID_DISTANCEPREFS , FCID_DOTMOD , FCID_ENCLOSURE , FCID_ENDINGREPEAT ,   FCID_ENIGMATEXTSTYLE , FCID_ENTRYALTERMOD , FCID_EXECUTABLESHAPEDEF , FCID_EXPRESSION ,   FCID_FONTINFO , FCID_FONTPREFS , FCID_FREEZESYSTEM , FCID_FRETBOARDSTYLEDEF ,   FCID_FRETBOARDSTYLEDEFS , FCID_FRETBOARDGROUPDEF , FCID_FRETBOARDGROUPDEFS , FCID_FRETINSTRUMENTDEF ,   FCID_GENERALPREFS , FCID_GRIDSGUIDESPREFS , FCID_GROUP , FCID_GROUPNAMEPOSITIONPREFS ,   FCID_HUMANPLAYBACKPREFS , FCID_INDEPENDENTCELLDETAIL , FCID_INSTRUMENTDEF , FCID_INSTRUMENTPLAYBACKDATA ,   FCID_KEYMODEDEF , FCID_KEYSIGNATURE , FCID_LAYERPREFS , FCID_LYRICSBASELINE ,   FCID_LYRICSPREFS , FCID_MEASURE , FCID_MEASURENUMBERREGION , FCID_METATOOLASSIGNMENT ,   FCID_MIDIEXPRESSION , FCID_MISCDOCPREFS , FCID_MULTIMEASUREREST , FCID_MULTIMEASURERESTPREFS ,   FCID_MULTISTAFFINSTRUMENT , FCID_MULTISTAFFINSTRUMENTS , FCID_MUSICCHARACTERPREFS , FCID_MUSICSPACINGPREFS ,   FCID_NUMBER , FCID_NOTEHEADMOD , FCID_OTHERINCI , FCID_PERCUSSIONLAYOUTNOTE ,   FCID_PERCUSSIONSTAFF , FCID_PERFORMANCEMOD , FCID_PAGE , FCID_PAGEFORMATPREFS ,   FCID_PAGEGRAPHIC , FCID_PAGETEXT , FCID_PART , FCID_PARTEXTRACTPREFS ,   FCID_PARTSCOPEPREFS , FCID_PARTSTAFFVOICING , FCID_PERCUSSIONNOTEMOD , FCID_PIANOBRACEPREFS ,   FCID_PLAYBACKPREFS , FCID_RAWTEXT , FCID_REPEATPREFS , FCID_SECONDARYBEAMBREAKMOD ,   FCID_BEAMEXTENSIONMOD , FCID_SECTIONSYLLABLE , FCID_SEPARATEMEASURENUMBER , FCID_SEPARATEPLACEMENT ,   FCID_SHAPEDEF , FCID_SHAPEEXPRESSIONDEF , FCID_SLURCONTOURPREFS , FCID_SIZEPREFS ,   FCID_SMARTSHAPE , FCID_SMARTSHAPEENTRYMARK , FCID_SMARTSHAPEMEASUREMARK , FCID_SMARTSHAPEPREFS ,   FCID_STAFF , FCID_STAFFLIST , FCID_STAFFNAMEPOSITION , FCID_STAFFNAMEPOSITIONPREFS ,   FCID_STAFFSTYLEASSIGN , FCID_STAFFSTYLEDEF , FCID_STAFFSYSTEM , FCID_STEMCONNECTIONTABLE ,   FCID_STEMMOD , FCID_STRING , FCID_SYLLABLEENTRYMOD , FCID_SYSTEMSTAFF ,   FCID_TABLATURENOTEMOD , FCID_TEMPOELEMENT , FCID_TEXTBLOCK , FCID_TEXTEXPRESSIONDEF ,   FCID_TEXTREPEAT , FCID_TEXTREPEATDEF , FCID_TIEMOD , FCID_TIEPREFS ,   FCID_TIECONTOURPREFS , FCID_TIEPLACEMENTPREFS , FCID_TIMESIGNATURE , FCID_TUPLET ,   FCID_TUPLETPREFS , FCID_VERSESYLLABLE }
	Constants for the GetClassID method. More...
enum	MEASUREMENTUNITS {   MEASUREMENTUNIT_DEFAULT = UNIT_DEFAULT , MEASUREMENTUNIT_EVPUS = UNIT_EVPUS , MEASUREMENTUNIT_INCHES = UNIT_INCHES , MEASUREMENTUNIT_CENTIMETERS = UNIT_CENTS ,   MEASUREMENTUNIT_POINTS = UNIT_POINTS , MEASUREMENTUNIT_PICAS = UNIT_PICAS , MEASUREMENTUNIT_SPACES = UNIT_SPACES , MEASUREMENTUNIT_MILLIMETERS = 100 }
	Constants for Finale's standard measurement units. More...
Static Public Member Functions inherited from __FCBase
static void	DebugOutPtr (const char *pszPrefixText, void *ptr)
	Static method that outputs a line for debugging purposes. The prefix text appears with the extra ptr (in hexadeximal representation) appearing afterwards.
static void	DebugOutInt (const char *pszPrefixText, int i)
	Static method that outputs a line for debugging purposes. The text appears with the extra digit (in decimal presentation) appearing afterwards.
static void	DebugOutFloat (const char *pszPrefixText, double f)
	Static method that outputs a line for debugging purposes. The text appears with the extra float value appearing afterwards.
static void	DebugOutTag (const char *pszPrefixText, EXTAG extag)
	Static method that outputs a line for debugging purposes. The text appears with the EXTAG (in text) appearing afterwards.
static void	DebugOutHex (const char *pszPrefixText, int i)
	Static method that outputs a line for debugging purposes. The text appears with the extra digit (in hexadecimal presentation) appearing afterwards.
static void	DebugOutBin (const char *pszPrefixText, int i)
	Static method that outputs a line for debugging purposes. The text appears with the extra digit (in binary presentation) appearing afterwards.
static void	DebugOutString (const char *pszPrefixText, const char *thestring)
	Static method that outputs a line for debugging purposes (C string version). The text appears with the extra string appearing afterwards.
static void	DebugOutString (const char *pszPrefixText, FCString *pString)
	Static method that outputs a line for debugging purposes (FCString version). The text appears with the extra string appearing afterwards.
static void	DebugOutBool (const char *pszPrefixText, bool state)
	Static method that outputs a line for debugging purposes. The boolean state appears afterwards as either "TRUE" or "FALSE".
static void	DebugOutBlock (const void *pBuffer, int startoffset, int size)
	Static method that outputs a memory block for debugging purposes. Eight bytes per line will appear (as hex digits) until the whole memory block is dumped.
static void	DebugOutByteArrayBlock (const void *pBuffer, int startoffset, int size)
	Static method that outputs a memory block for debugging purposes. Eight bytes per line will appear (as hex digits) as a C++ onebyte array, until the whole memory block is dumped.
static void	DebugOut (const char *pszLine)
	Static method to output a line of text for debugging purposes.
Protected Member Functions inherited from __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!
virtual __FCBaseData *	CreateObject ()=0
	Creates a new instance of the object.
bool	DataIsLoaded () const
	Returns true is any data has been loaded into the object.
void	_TagDocumentID ()
	For internal use only.
Protected Member Functions inherited from __FCBase
	__FCBase ()
	The constructor.
Protected Attributes inherited from __FCBaseData
EDOCID	_connecteddocID
	The "connected" document ID., which is the document the where the document was loaded (or last saved). This is for a mechanism to prevent resaving of certain data in other documents.
void *	_datablock
	Pointer to the object's data block, the meaning is implementation-specific for each derived subclass.
bool	_heapdatablock
	Variable that tells if _datablock is dynamically created on the heap (and should be deleted at object destruction).
int	_loadedsize
	Loaded size of the data block for a loaded object, in bytes. Since the datablock is implementation-specific, the _loadedsize should be updated by child classes that create new data.
EDataID	_dataid
	The EdataID for the last loaded/saved object.

Detailed Description

The 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::FCFretboardStyleDef ( )

inline

The constructor.

Lua-supported.

Member Function Documentation

ClassName()

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

DebugDump()

void FCFretboardStyleDef::DebugDump ( )

inlineoverridevirtual

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.

GetBarreShapeID()

twobyte FCFretboardStyleDef::GetBarreShapeID ( ) const

inline

Returns the shape ID of the "barre" shape.

Lua-supported (also as property).

GetClassID()

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

GetCustomShapeID()

twobyte FCFretboardStyleDef::GetCustomShapeID ( ) const

inline

Returns the shape ID of the "custom" shape.

Lua-supported (also as property).

GetDrawFingeringWhite()

bool FCFretboardStyleDef::GetDrawFingeringWhite ( ) const

inline

Returns if the fingering numbers should be drawn in white.

Currently not available in Finale.

GetFingeredShapeID()

twobyte FCFretboardStyleDef::GetFingeredShapeID ( ) const

inline

Returns the shape ID of the "fingered" shape.

Lua-supported (also as property).

GetFingeringFontInfo()

void FCFretboardStyleDef::GetFingeringFontInfo ( FCFontInfo * pFontInfo )

inline

Copies the fingering font information to a FCFontInfo object.

Lua-supported.

\param pFontInfo The #FCFontInfo object that should contain the fingering font information.

GetFingeringWhiteout()

Efix32 FCFretboardStyleDef::GetFingeringWhiteout ( ) const

inline

Returns the whiteout for fingering numbers, in EFIXes.

Lua-supported (also as property).

GetFretCountDefault()

int FCFretboardStyleDef::GetFretCountDefault ( ) const

inline

Returns the default number of frets for the style.

Lua-supported (also as property).

GetFretNumberFontInfo()

void FCFretboardStyleDef::GetFretNumberFontInfo ( FCFontInfo * pFontInfo )

inline

Copies the fret number font information to a FCFontInfo object.

Lua-supported.

\param pFontInfo The #FCFontInfo object that should contain the fret number font information.

GetFretNumberText()

void FCFretboardStyleDef::GetFretNumberText ( FCString * pString ) const

inline

Copies the fret number text to a FCString object.

Lua-supported.

\param pString The #FCString object that should contain the fret number text.

GetFretSpacing()

Efix32 FCFretboardStyleDef::GetFretSpacing ( ) const

inline

Returns the fret spacing, in EFIXes.

Lua-supported (also as property).

GetFretThickness()

Efix32 FCFretboardStyleDef::GetFretThickness ( ) const

inline

Returns the fret thickness, in EFIXes.

Lua-supported (also as property).

GetHorizontalFingeringOffset()

Efix32 FCFretboardStyleDef::GetHorizontalFingeringOffset ( ) const

inline

Returns the horizontal offset for fingering numbers, in EFIXes.

Lua-supported (also as property).

GetHorizontalFretNumberOffset()

Efix32 FCFretboardStyleDef::GetHorizontalFretNumberOffset ( ) const

inline

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

Lua-supported (also as property).

GetHorizontalHandleOffset()

Efix32 FCFretboardStyleDef::GetHorizontalHandleOffset ( ) const

inline

Returns the horizontal handle offset, in EFIXes.

Lua-supported (also as property).

GetMuteStringShapeID()

twobyte FCFretboardStyleDef::GetMuteStringShapeID ( ) const

inline

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

Lua-supported (also as property).

GetName()

void FCFretboardStyleDef::GetName ( FCString * pString ) const

inline

Copies the style name to a FCString object.

Lua-supported.

Parameters

pString

Copies the style name to a FCString object.

GetNutThickness()

Efix32 FCFretboardStyleDef::GetNutThickness ( ) const

inline

Returns the nut thickness, in EFIXes.

Lua-supported (also as property).

GetOpenStringShapeID()

twobyte FCFretboardStyleDef::GetOpenStringShapeID ( ) const

inline

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

Lua-supported (also as property).

GetRotate()

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.

GetShowLastFret()

bool FCFretboardStyleDef::GetShowLastFret ( ) const

inline

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

Lua-supported (also as property).

GetStringSpacing()

Efix32 FCFretboardStyleDef::GetStringSpacing ( ) const

inline

Returns the string spacing, in EFIXes.

Lua-supported (also as property).

GetStringThickness()

Efix32 FCFretboardStyleDef::GetStringThickness ( ) const

inline

Returns the string thickness, in EFIXes.

Lua-supported (also as property).

GetVerticalFingeringOffset()

Efix32 FCFretboardStyleDef::GetVerticalFingeringOffset ( ) const

inline

Returns the vertical offset for fingering numbers, in EFIXes.

Lua-supported (also as property).

GetVerticalFretNumberOffset()

Efix32 FCFretboardStyleDef::GetVerticalFretNumberOffset ( ) const

inline

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

Lua-supported (also as property).

GetVerticalHandleOffset()

Efix32 FCFretboardStyleDef::GetVerticalHandleOffset ( ) const

inline

Returns the vertical handle offset, in EFIXes.

Lua-supported (also as property).

SetBarreShapeID()

void FCFretboardStyleDef::SetBarreShapeID ( twobyte value )

inline

Sets the shape ID of the "barre" shape.

Lua-supported (also as property).

SetCustomShapeID()

void FCFretboardStyleDef::SetCustomShapeID ( twobyte value )

inline

Sets the shape ID of the "custom" shape.

Lua-supported (also as property).

SetDrawFingeringWhite()

void FCFretboardStyleDef::SetDrawFingeringWhite ( bool state )

inline

Sets if the fingering numbers should be drawn in white.

Currently not available in Finale.

SetFingeredShapeID()

void FCFretboardStyleDef::SetFingeredShapeID ( twobyte value )

inline

Sets the shape ID of the "fingered" shape.

Lua-supported (also as property).

SetFingeringFontInfo()

void FCFretboardStyleDef::SetFingeringFontInfo ( FCFontInfo * pFontInfo )

inline

Copies the fingering font information from a FCFontInfo object.

Lua-suported.

Parameters

pFontInfo

The FCFontInfo object that has the fingering font information.

SetFingeringWhiteout()

void FCFretboardStyleDef::SetFingeringWhiteout ( Efix32 value )

inline

Sets the whiteout for fingering numbers, in EFIXes.

Lua-supported (also as property).

SetFretCountDefault()

void FCFretboardStyleDef::SetFretCountDefault ( int value )

inline

Sets the default number of frets for the style.

Lua-supported (also as property).

SetFretNumberFontInfo()

void FCFretboardStyleDef::SetFretNumberFontInfo ( FCFontInfo * pFontInfo )

inline

Copies the fret number font information fro a FCFontInfo object.

Lua-supported.

Parameters

pFontInfo

The FCFontInfo object that has the fret number font information.

SetFretNumberText()

void FCFretboardStyleDef::SetFretNumberText ( const FCString * pString )

inline

Sets the fret number text, using a FCString object.

Lua-supported.

Parameters

pString

The FCString object that contains the fret number text.

SetFretSpacing()

void FCFretboardStyleDef::SetFretSpacing ( Efix32 value )

inline

Sets the fret spacing, in EFIXes.

Lua-supported (also as property).

SetFretThickness()

void FCFretboardStyleDef::SetFretThickness ( Efix32 value )

inline

Sets the fret thickness, in EFIXes.

Lua-supported (also as property).

SetHorizontalFingeringOffset()

void FCFretboardStyleDef::SetHorizontalFingeringOffset ( Efix32 value )

inline

Sets the horizontal offset for fingering numbers, in EFIXes.

Lua-supported (also as property).

SetHorizontalFretNumberOffset()

void FCFretboardStyleDef::SetHorizontalFretNumberOffset ( Efix32 value )

inline

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

Lua-supported (also as property).

SetHorizontalHandleOffset()

void FCFretboardStyleDef::SetHorizontalHandleOffset ( Efix32 value )

inline

Sets the horizontal handle offset, in EFIXes.

Lua-supported (also as property).

SetMuteStringShapeID()

void FCFretboardStyleDef::SetMuteStringShapeID ( twobyte value )

inline

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

Lua-supported (also as property).

SetName()

void FCFretboardStyleDef::SetName ( const FCString * pString )

inline

Sets the style name, by using a FCString object.

Lua-supported.

Parameters

pString

The FCString object that contains the style name.

SetNutThickness()

void FCFretboardStyleDef::SetNutThickness ( Efix32 value )

inline

Sets the nut thickness, in EFIXes.

Lua-supported (also as property).

SetOpenStringShapeID()

void FCFretboardStyleDef::SetOpenStringShapeID ( twobyte value )

inline

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

Lua-supported (also as property).

SetRotate()

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.

SetShowLastFret()

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

SetStringSpacing()

void FCFretboardStyleDef::SetStringSpacing ( Efix32 value )

inline

Sets the string spacing, in EFIXes.

Lua-supported (also as property).

SetStringThickness()

void FCFretboardStyleDef::SetStringThickness ( Efix32 value )

inline

Sets the string thickness, in EFIXes.

Lua-supported (also as property).

SetVerticalFingeringOffset()

void FCFretboardStyleDef::SetVerticalFingeringOffset ( Efix32 value )

inline

Sets the vertical offset for fingering numbers, in EFIXes.

Lua-supported (also as property).

SetVerticalFretNumberOffset()

void FCFretboardStyleDef::SetVerticalFretNumberOffset ( Efix32 value )

inline

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

Lua-supported (also as property).

SetVerticalHandleOffset()

void FCFretboardStyleDef::SetVerticalHandleOffset ( Efix32 value )

inline

Sets the vertical handle offset, in EFIXes.

Lua-supported (also as property).