FCCustomKeyModeSymbolList Class Reference

Class that encapsulates the list of accidental symbols for instances of FCCustomKeyModeDef. A single symbol list may be shared amongst multiple instances of FCCustomKeyModeDef, so these lists must be separately maintained. More...

#include <ff_other.h>

Inheritance diagram for FCCustomKeyModeSymbolList:

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.
	FCCustomKeyModeSymbolList ()
	the constructor.
bool	Load (CMPER itemno)
	Loads the data for a given item.
bool	LoadNext ()
	Loads the next item.
bool	LoadFirst ()
	Loads the first item.
bool	Save ()
	Saves the item.
bool	SaveAs (CMPER itemno)
	Saves the item with a new ID. If the ID exists, it will be overwritten with the list from this instance. If the ID does not exist, it will be created.
bool	DeleteData ()
	Delete the item from the Finale document.
CMPER	GetItemNo () const
	Gets the item number. This value is meaningless if the instance has neither been loaded or saved.
symbolMap	GetList () const
	Returns a list of strings that represent the symbols for each sharp, flat, or natural alteration.
void	SetList (symbolMap list)
	Sets a list of strings that represent the symbols for each sharp, flat, or natural alteration.
FCString *	CreateListString () const
	Returns a string of all the accidental symbol strings separated by spaces. This could be used as a description, for example.
bool	CalcIsDefaultList () const
	Calculates if this is equal to the default symbol list.
Public Member Functions inherited from __FCBase
virtual const PDKFRAMEWORK_CLASSID	GetClassID () const
	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.
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.
virtual void	DebugDump ()
	Outputs the class data/information for debugging purposes.
virtual void	DebugDataDump ()
	Outputs a memory dump of the data block in the object for debugging purposes.
virtual void	DebugDataByteArrayDump ()
	Outputs a memory dump of the data block in the object for debugging purposes, as a C++ byte array.
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.

Static Public Member Functions
static symbolMap	GetDefaultList ()
	Class function that returns a fully-populated default symbol list, based on the current document settings.
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.

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...
Protected Member Functions inherited from __FCBase
	__FCBase ()
	The constructor.

Detailed Description

Class that encapsulates the list of accidental symbols for instances of FCCustomKeyModeDef. A single symbol list may be shared amongst multiple instances of FCCustomKeyModeDef, so these lists must be separately maintained.

See comments at SetList for details on the how the list is stored.

Constructor & Destructor Documentation

FCCustomKeyModeSymbolList()

FCCustomKeyModeSymbolList::FCCustomKeyModeSymbolList ( )

inline

the constructor.

Lua-supported (0.72)

Member Function Documentation

CalcIsDefaultList()

bool FCCustomKeyModeSymbolList::CalcIsDefaultList

(

)

const

Calculates if this is equal to the default symbol list.

Lua-supported (0.72)

Returns

true if this instance is equal to the default list; false if it is not

ClassName()

const char * FCCustomKeyModeSymbolList::ClassName ( ) const

inlineoverridevirtual

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

Lua-supported.

Implements __FCBase.

CreateListString()

FCString * FCCustomKeyModeSymbolList::CreateListString

(

)

const

Returns a string of all the accidental symbol strings separated by spaces. This could be used as a description, for example.

Lua-supported (0.72)

DeleteData()

bool FCCustomKeyModeSymbolList::DeleteData

(

)

Delete the item from the Finale document.

Lua-supported (0.72)

GetDefaultList()

FCCustomKeyModeSymbolList::symbolMap FCCustomKeyModeSymbolList::GetDefaultList ( )

static

Class function that returns a fully-populated default symbol list, based on the current document settings.

C callers must dispose of the return value either with delete or a smart pointer.

Lua-supported (0.72)

Returns

symbol list populated with 15 values for common practice 12-EDO key signatures.

GetItemNo()

CMPER FCCustomKeyModeSymbolList::GetItemNo ( ) const

inline

Gets the item number. This value is meaningless if the instance has neither been loaded or saved.

Lua-supported (also as read-only property) (0.72)

GetList()

symbolMap FCCustomKeyModeSymbolList::GetList ( ) const

inline

Returns a list of strings that represent the symbols for each sharp, flat, or natural alteration.

See comments at SetList for a description of this value.

Lua-supported (also as property) (0.72)

Returns

table (Lua) or std::map (C++) of integer keys and utf8-encoded string values.

Load()

bool FCCustomKeyModeSymbolList::Load

(

CMPER

itemno

)

Loads the data for a given item.

Lua-supported (0.72)

LoadFirst()

bool FCCustomKeyModeSymbolList::LoadFirst

(

)

Loads the first item.

Lua-supported (0.72)

LoadNext()

bool FCCustomKeyModeSymbolList::LoadNext

(

)

Loads the next item.

Lua-supported (0.72)

Save()

bool FCCustomKeyModeSymbolList::Save

(

)

Saves the item.

If the item has never been loaded, it is saved with a new item number. Upon completion GetItemNo returns the new item number it was saved with.

Lua-supported (0.72)

SaveAs()

bool FCCustomKeyModeSymbolList::SaveAs ( CMPER itemno )

inline

Saves the item with a new ID. If the ID exists, it will be overwritten with the list from this instance. If the ID does not exist, it will be created.

Lua-supported (0.72)

SetList()

void FCCustomKeyModeSymbolList::SetList ( symbolMap list )

inline

Sets a list of strings that represent the symbols for each sharp, flat, or natural alteration.

Remarks

Finale supports 15 different key values that correspond to accidentals. They range from -7 to +7 steps including 0 (the natural accidental). When constructing a custom key mode, it is wise to define the accidental symbols (or symbol combinations) for all the 15 available accidentals from -7 to +7 steps. This is because if some accidentals are left undefined, they will not show in the score. If a note were inadvertently to receive an FCNote::GetRaiseLower value that has no accidental character associated with it, the note will look like it has no accidental even though its actual RaiseLower value is something different.

Lua-supported (also as property) (0.72)

Parameters

list	table (Lua) or std::map (C++) of integer keys ranging between -7..+7 (including 0) and utf8-encoded string values that represent the accidental symbols. Not all the key values must be present, but it is preferable to supply them all. (See remarks.)