Class for document-specific chord settings. Some additional chord-related settings are available in FCMiscDocPrefs. More...

#include <ff_prefs.h>

Inheritance diagram for FCChordPrefs:

Public Types
enum	CHORDSTYLES { CHRDSTYLE_NORMAL = CHORDSTYLE_NORMAL , CHRDSTYLE_ROMAN = CHORDSTYLE_ROMAN , CHRDSTYLE_NASHVILLE_A = CHORDSTYLE_NASHVILLE , CHRDSTYLE_GERMAN = CHORDSTYLE_GERMAN , CHRDSTYLE_SOLFEGGIO = CHORDSTYLE_SOLFEGGIO , CHRDSTYLE_EUROPEAN = CHORDSTYLE_EUROPEAN , CHRDSTYLE_SCANDINAVIAN = CHORDSTYLE_SCANDINAVIAN , CHRDSTYLE_NASHVILLE_B = CHORDSTYLE_NASHVILLE_B }
	Chord styles for use with the FCChordPrefs::GetStyle() and FCChordPrefs::SetStyle() methods. 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_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...

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.

	FCChordPrefs ()
	The constructor.

bool	GetUseSimpleSpelling () const
	Returns if simplified chord spelling should be used or not.

void	SetUseSimpleSpelling (bool state)
	Sets if simplified chord spelling should be used or not.

bool	GetLeftAlignment () const
	Returns if the chords should be left aligned.

void	SetLeftAlignment (bool state)
	Sets if the chords should be left or center aligned.

Evpu16	GetSharpBaselineAdjustment () const
	Returns the "Chord Alteration Baseline Adjustment" for sharps (in EVPUs).

Evpu16	GetFlatBaselineAdjustment () const
	Returns the "Chord Alteration Baseline Adjustment" for flats (in EVPUs).

Evpu16	GetNaturalBaselineAdjustment () const
	Returns the "Chord Alteration Baseline Adjustment" for naturals (in EVPUs).

void	SetSharpBaselineAdjustment (Evpu16 value)
	Sets the "Chord Alteration Baseline Adjustment" for sharps (in EVPUs).

void	SetFlatBaselineAdjustment (Evpu16 value)
	Sets the "Chord Alteration Baseline Adjustment" for flats (in EVPUs).

void	SetNaturalBaselineAdjustment (Evpu16 value)
	Sets the "Chord Alteration Baseline Adjustment" for naturals (in EVPUs).

CHORDSTYLES	GetStyle () const
	Returns the chord style to use for the document.

void	SetStyle (CHORDSTYLES style)
	Sets the chord style to use for the document.

double	GetScaleFretboardsBy () const
	Returns the "Scale All Fretboards By" setting in Document Options - Chords.

void	SetScaleFretboardsBy (double value)
	Sets the "Scale All Fretboards By" setting in Document Options - Chords.

double	GetScaleChordsBy () const
	Returns the "Scale All Chords By" setting in Document Options - Chords.

void	SetScaleChordsBy (double value)
	Sets the "Scale All Chords By" setting in Document Options - Chords.

bool	GetShowFretboards () const
	Returns the "Show Fretboards" (in the Chord menu).

void	SetShowFretboards (bool state)
	Sets the "Show Fretboards" (in the Chord menu).

bool	GetMultipleItemsPerString () const
	Returns the "Multiple Items Per String" setting in the Fretboard Editor.

void	SetMultipleItemsPerString (bool state)
	Sets the "Multiple Items Per String" setting in the Fretboard Editor.

bool	GetItalicizeCapoChords () const
	Returns the "Italicize Capo Chords" setting (in the Chord menu).

void	SetItalicizeCapoChords (bool state)
	Sets the "Italicize Capo Chords" setting (in the Chord menu).

bool	GetEnableChordPlayback () const
	Returns if chord playback is enabled.

void	SetEnableChordPlayback (bool state)
	Sets if chord playback is enabled.

CMPER	GetDefaultFretboardStyleID () const
	Returns the default FCFretboardStyleDef ID. (See SetDefaultFretboardStyleID for more info.)

void	SetDefaultFretboardStyleID (CMPER value)
	Sets the default FCFretboardStyleDef ID. This is equivalent to "Set As Default" in the Fretboard Styles dialog.

CMPER	GetDefaultFretInstrumentID () const
	Gets the default FCFretInstrumentDef ID. (See SetDefaultFretInstrumentID for more info.)

void	SetDefaultFretInstrumentID (CMPER value)
	Sets the default SetDefaultFretInstrumentID ID. This is equivalent to "Set As Default" in the Fret Instrument Definition dialog.

Public Member Functions inherited from __FCPrefsBase
bool	Reload () override
	Overridden version of Reload(), that handles prefs from multiple sources.

virtual bool	Load (twobyte prefsno=1)
	The default Load method for preference data. All preference data loading must go through here at some point.

bool	Save () override
	Saves the currently loaded to its current location.

bool	LoadFirst () override
	Loads the very first element in the database, if any.

int	GetItemNo () const
	Returns the prefs number for the loaded data.

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 EVERSION	EnigmaVersion () const
	The Enigma version for save/load/create/delete operations.

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.

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	DeleteData ()
	Deletes the associated data from Finale's database. Be careful when deleting multiple objects.

virtual bool	DeepDeleteData ()
	Deletes data and all data that's connected to the object.

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	DebugDump () override
	Outputs the class data/information for debugging purposes.

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
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 __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!

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

Class for document-specific chord settings. Some additional chord-related settings are available in FCMiscDocPrefs.

Member Enumeration Documentation

◆ CHORDSTYLES

enum FCChordPrefs::CHORDSTYLES

Chord styles for use with the FCChordPrefs::GetStyle() and FCChordPrefs::SetStyle() methods.

Lua-supported.

Enumerator
CHRDSTYLE_NORMAL	Chord roots as letters
CHRDSTYLE_ROMAN	Chord roots as roman numerals.
CHRDSTYLE_NASHVILLE_A	"Nashville A": Chord roots as scale degrees. Accidentals preceed root.
CHRDSTYLE_GERMAN	Chord root in German style. (H for B. B for B flat.)
CHRDSTYLE_SOLFEGGIO	Display roots as Solfeggio (Do, Re, Mi, etc.)
CHRDSTYLE_EUROPEAN	Chord root in European style (display natural sign on B naturals).
CHRDSTYLE_SCANDINAVIAN	Chord root in Scandinavian style (H for B. Force accidental on B naturals.)
CHRDSTYLE_NASHVILLE_B	"Nashville A": Chord roots as scale degrees. Accidentals follow root.

Constructor & Destructor Documentation

◆ FCChordPrefs()

FCChordPrefs::FCChordPrefs ( )

inline

The constructor.

Lua-supported.

Member Function Documentation

◆ ClassName()

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

◆ GetClassID()

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

◆ GetDefaultFretboardStyleID()

CMPER FCChordPrefs::GetDefaultFretboardStyleID ( ) const

inline

Returns the default FCFretboardStyleDef ID. (See SetDefaultFretboardStyleID for more info.)

Lua-supported (also as property) (0.72)

◆ GetDefaultFretInstrumentID()

CMPER FCChordPrefs::GetDefaultFretInstrumentID ( ) const

inline

Gets the default FCFretInstrumentDef ID. (See SetDefaultFretInstrumentID for more info.)

Lua-supported (also as property) (0.72)

◆ GetEnableChordPlayback()

bool FCChordPrefs::GetEnableChordPlayback ( ) const

inline

Returns if chord playback is enabled.

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

◆ GetFlatBaselineAdjustment()

Evpu16 FCChordPrefs::GetFlatBaselineAdjustment ( ) const

inline

Returns the "Chord Alteration Baseline Adjustment" for flats (in EVPUs).

Lua-supported (also as property).

◆ GetItalicizeCapoChords()

bool FCChordPrefs::GetItalicizeCapoChords ( ) const

inline

Returns the "Italicize Capo Chords" setting (in the Chord menu).

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

◆ GetLeftAlignment()

bool FCChordPrefs::GetLeftAlignment ( ) const

inline

Returns if the chords should be left aligned.

Lua-supported (also as property).

Returns: True - left-align chords. False - center-align chords.

◆ GetMultipleItemsPerString()

bool FCChordPrefs::GetMultipleItemsPerString ( ) const

inline

Returns the "Multiple Items Per String" setting in the Fretboard Editor.

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

◆ GetNaturalBaselineAdjustment()

Evpu16 FCChordPrefs::GetNaturalBaselineAdjustment ( ) const

inline

Returns the "Chord Alteration Baseline Adjustment" for naturals (in EVPUs).

Lua-supported (also as property).

◆ GetScaleChordsBy()

double FCChordPrefs::GetScaleChordsBy ( ) const

inline

Returns the "Scale All Chords By" setting in Document Options - Chords.

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

Returns: fractional percentage: a value of 50.7 is 50.7%.

◆ GetScaleFretboardsBy()

double FCChordPrefs::GetScaleFretboardsBy ( ) const

inline

Returns the "Scale All Fretboards By" setting in Document Options - Chords.

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

Returns: fractional percentage: a value of 50.7 is 50.7%.

◆ GetSharpBaselineAdjustment()

Evpu16 FCChordPrefs::GetSharpBaselineAdjustment ( ) const

inline

Returns the "Chord Alteration Baseline Adjustment" for sharps (in EVPUs).

Lua-supported (also as property).

◆ GetShowFretboards()

bool FCChordPrefs::GetShowFretboards ( ) const

inline

Returns the "Show Fretboards" (in the Chord menu).

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

◆ GetStyle()

CHORDSTYLES FCChordPrefs::GetStyle ( ) const

inline

Returns the chord style to use for the document.

Lua-supported (also as property).

Returns: Any of the CHRDSTYLE_ constants in the CHORDSTYLES enum.

◆ GetUseSimpleSpelling()

bool FCChordPrefs::GetUseSimpleSpelling ( ) const

inline

Returns if simplified chord spelling should be used or not.

Lua-supported (also as property).

◆ SetDefaultFretboardStyleID()

void FCChordPrefs::SetDefaultFretboardStyleID ( CMPER value )

inline

Sets the default FCFretboardStyleDef ID. This is equivalent to "Set As Default" in the Fretboard Styles dialog.

Lua-supported (also as property) (0.72)

◆ SetDefaultFretInstrumentID()

void FCChordPrefs::SetDefaultFretInstrumentID ( CMPER value )

inline

Sets the default SetDefaultFretInstrumentID ID. This is equivalent to "Set As Default" in the Fret Instrument Definition dialog.

Lua-supported (also as property) (0.72)

◆ SetEnableChordPlayback()

void FCChordPrefs::SetEnableChordPlayback ( bool state )

inline

Sets if chord playback is enabled.

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

◆ SetFlatBaselineAdjustment()

void FCChordPrefs::SetFlatBaselineAdjustment ( Evpu16 value )

inline

Sets the "Chord Alteration Baseline Adjustment" for flats (in EVPUs).

Lua-supported (also as property).

◆ SetItalicizeCapoChords()

void FCChordPrefs::SetItalicizeCapoChords ( bool state )

inline

Sets the "Italicize Capo Chords" setting (in the Chord menu).

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

◆ SetLeftAlignment()

void FCChordPrefs::SetLeftAlignment ( bool state )

inline

Sets if the chords should be left or center aligned.

Lua-supported (also as property).

Parameters

state True - left-align chords. False - center-align chords.

◆ SetMultipleItemsPerString()

void FCChordPrefs::SetMultipleItemsPerString ( bool state )

inline

Sets the "Multiple Items Per String" setting in the Fretboard Editor.

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

◆ SetNaturalBaselineAdjustment()

void FCChordPrefs::SetNaturalBaselineAdjustment ( Evpu16 value )

inline

Sets the "Chord Alteration Baseline Adjustment" for naturals (in EVPUs).

Lua-supported (also as property).

◆ SetScaleChordsBy()

void FCChordPrefs::SetScaleChordsBy ( double value )

inline

Sets the "Scale All Chords By" setting in Document Options - Chords.

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

Parameters

value fractional percentage: a value of 50.7 is 50.7%. This value may not be less than 10.

◆ SetScaleFretboardsBy()

void FCChordPrefs::SetScaleFretboardsBy ( double value )

inline

Sets the "Scale All Fretboards By" setting in Document Options - Chords.

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

Parameters

value fractional percentage: a value of 50.7 is 50.7%. This value may not be less than 10.

◆ SetSharpBaselineAdjustment()

void FCChordPrefs::SetSharpBaselineAdjustment ( Evpu16 value )

inline

Sets the "Chord Alteration Baseline Adjustment" for sharps (in EVPUs).

Lua-supported (also as property).

◆ SetShowFretboards()

void FCChordPrefs::SetShowFretboards ( bool state )

inline

Sets the "Show Fretboards" (in the Chord menu).

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

◆ SetStyle()

void FCChordPrefs::SetStyle ( CHORDSTYLES style )

inline

Sets the chord style to use for the document.

Lua-supported (also as property).

Parameters

style Any of the CHRDSTYLE_ constants in the CHORDSTYLES enum.

◆ SetUseSimpleSpelling()

void FCChordPrefs::SetUseSimpleSpelling ( bool state )

inline

Sets if simplified chord spelling should be used or not.

Lua-supported (also as property).

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ CHORDSTYLES

Constructor & Destructor Documentation

◆ FCChordPrefs()

Member Function Documentation

◆ ClassName()

◆ GetClassID()

◆ GetDefaultFretboardStyleID()

◆ GetDefaultFretInstrumentID()

◆ GetEnableChordPlayback()

◆ GetFlatBaselineAdjustment()

◆ GetItalicizeCapoChords()

◆ GetLeftAlignment()

◆ GetMultipleItemsPerString()

◆ GetNaturalBaselineAdjustment()

◆ GetScaleChordsBy()

◆ GetScaleFretboardsBy()

◆ GetSharpBaselineAdjustment()

◆ GetShowFretboards()

◆ GetStyle()

◆ GetUseSimpleSpelling()

◆ SetDefaultFretboardStyleID()

◆ SetDefaultFretInstrumentID()

◆ SetEnableChordPlayback()

◆ SetFlatBaselineAdjustment()

◆ SetItalicizeCapoChords()

◆ SetLeftAlignment()

◆ SetMultipleItemsPerString()

◆ SetNaturalBaselineAdjustment()

◆ SetScaleChordsBy()

◆ SetScaleFretboardsBy()

◆ SetSharpBaselineAdjustment()

◆ SetShowFretboards()

◆ SetStyle()

◆ SetUseSimpleSpelling()