An object that contains one staff list section (out of 4). Before data is loaded/saved, the SetMode() method must be called. More...

#include <ff_other.h>

Inheritance diagram for FCStaffList:

Public Types
enum	STAFFLIST_MODES { SLMODE_SCORE = 0 , SLMODE_PARTS , SLMODE_FORCESCORE , SLMODE_FORCEPARTS , SLMODE_CATEGORY_SCORE , SLMODE_CATEGORY_PARTS , SLMODE_CATEGORY_FORCESCORE , SLMODE_CATEGORY_FORCEPARTS , SLMODE_ASSIGNMENT_SCORE , SLMODE_ASSIGNMENT_PARTS , SLMODE_ASSIGNMENT_FORCESCORE , SLMODE_ASSIGNMENT_FORCEPARTS }
	Modes for loading/saving the staff list. 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
	FCStaffList ()
	the constructor.

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.

void	SetMode (STAFFLIST_MODES mode)
	Sets the list of data that should be used when reading/saving the record.

void	DebugDump () override
	Outputs the class data/information for debugging purposes.

bool	Load (CMPER itemno) override
	Overridden Load() method, since the staff list is of dynamic size.

bool	SaveNew () override
	SaveNew() is not supported.

bool	Save () override
	Overridden Save method, since the staff list is of dynamic size.

bool	DeleteData () override
	DeleteData() is currently not supported.

bool	LoadNext () override
	Overridden LoadNext so the FCStaffLists collection work correctly.

int	GetElementCount () const
	Returns the number of elements in the staff list. Both staff numbers and top/bottom staff are included.

int	GetStaffCount () const
	Returns the number of staves that are part of the staff list. Top/bottom staff settings are not included in the count.

int	GetStaff (int index)
	Gets a staff number for a reference index.

bool	IsElementAvailable (twobyte stafflistelement)
	Returns true if the element (staff or top/bottom setting) is available.

bool	IncludesTopStaff ()
	Returns true if the "Top Staff" is included in the staff list.

bool	IncludesBottomStaff ()
	Returns true if the "Bottom Staff" is included in the staff list.

bool	IncludesStaff (twobyte staffnumber)
	Returns true if the staff number is included in the staff list.

FCString *	CreateNameString ()
	Loads the name of the staff list and puts it in an object.

bool	SaveNameString (FCString *pString)
	Saves the name of the staff list.

bool	AddElement (twobyte elementnumber)
	Adds an element to the staff list.

bool	AddStaff (twobyte staffnumber)
	Adds a staff number to the staff list.

bool	AddTopStaff ()
	Adds a "Top Staff" to the staff list.

bool	AddBottomStaff ()
	Adds a "Bottom Staff" to the staff list.

bool	RemoveElement (twobyte element)
	Removes an element from the staff list.

bool	RemoveTopStaff ()
	Removes a "Top Staff" from the staff list.

bool	RemoveBottomStaff ()
	Removes a "Bottom Staff" from the staff list.

bool	RemoveStaff (twobyte staffnumber)
	Removes a staff number from the staff list.

Public Member Functions inherited from __FCNoInciOther
	__FCNoInciOther ()
	The constructor.

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 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	LoadLast ()
	Loads the very last element in 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
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

An object that contains one staff list section (out of 4). Before data is loaded/saved, the SetMode() method must be called.

A complete staff list consists of 4 different different sections/modes: Score/part versions of the basic staff list and the forced staff list. The class FCStaffListLookup handles all 4 automatically.

In versions of Finale since Finale 2009, FCStaffList is only used for repeat endings and repeat prefs.

Member Enumeration Documentation

◆ STAFFLIST_MODES

enum FCStaffList::STAFFLIST_MODES

Modes for loading/saving the staff list.

Lua-supported.

Constructor & Destructor Documentation

◆ FCStaffList()

FCStaffList::FCStaffList ( )

inline

the constructor.

Lua-supported.

Member Function Documentation

◆ AddBottomStaff()

bool FCStaffList::AddBottomStaff ( )

inline

Adds a "Bottom Staff" to the staff list.

Lua-supported.

Returns: True if the "Bottom Staff" was added to the list. False if it already existed.

◆ AddElement()

bool FCStaffList::AddElement ( twobyte elementnumber )

Adds an element to the staff list.

Returns: True if the element was added. False if it already existed.

◆ AddStaff()

bool FCStaffList::AddStaff ( twobyte staffnumber )

inline

Adds a staff number to the staff list.

There is no validation made that the staffnumber actually exists in the document.

Lua-supported.

Returns: True if the staff was added to the list. False if the staff already existed in the list or if the staff number wasn't valid.

◆ AddTopStaff()

bool FCStaffList::AddTopStaff ( )

inline

Adds a "Top Staff" to the staff list.

Lua-supported.

Returns: True if the "Top Staff" was added to the list. False if it already existed.

◆ ClassName()

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

◆ CreateNameString()

FCString * FCStaffList::CreateNameString ( )

Loads the name of the staff list and puts it in an object.

It's the caller's responsibility to remove the string object from the heap after use.

Lua-supported.

Returns: If the SetMode method hasn't been called prior to this method, NULL is returned. Otherwise, the pointer to the created FCString object.

◆ DebugDump()

void FCStaffList::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.

◆ DeleteData()

bool FCStaffList::DeleteData ( )

inlineoverridevirtual

DeleteData() is currently not supported.

Reimplemented from __FCBaseData.

◆ GetClassID()

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

◆ GetElementCount()

int FCStaffList::GetElementCount ( ) const

inline

Returns the number of elements in the staff list. Both staff numbers and top/bottom staff are included.

Lua-supported.

◆ GetStaff()

int FCStaffList::GetStaff ( int index )

inline

Gets a staff number for a reference index.

Lua-supported.

Parameters

index The 0-based index to an available staff in the staff list.

Returns: If the index is out of range (less than 0 or more/equal to GetStaffCount), 0 is returned. Otherwise, the staff number.

◆ GetStaffCount()

int FCStaffList::GetStaffCount ( ) const

inline

Returns the number of staves that are part of the staff list. Top/bottom staff settings are not included in the count.

Lua-supported.

◆ IncludesBottomStaff()

bool FCStaffList::IncludesBottomStaff ( )

inline

Returns true if the "Bottom Staff" is included in the staff list.

Lua-supported.

◆ IncludesStaff()

bool FCStaffList::IncludesStaff ( twobyte staffnumber )

inline

Returns true if the staff number is included in the staff list.

Parameters

staffnumber The staff number to test for existence in the staff list.

Lua-supported.

◆ IncludesTopStaff()

bool FCStaffList::IncludesTopStaff ( )

inline

Returns true if the "Top Staff" is included in the staff list.

Lua-supported.

◆ IsElementAvailable()

bool FCStaffList::IsElementAvailable ( twobyte stafflistelement )

inline

Returns true if the element (staff or top/bottom setting) is available.

Parameters

stafflistelement The staff number or SLD_TOPSTAFF/SLD_BOTTOMSTAFF.

◆ Load()

bool FCStaffList::Load ( CMPER itemno )

overridevirtual

Overridden Load() method, since the staff list is of dynamic size.

Reimplemented from __FCNoInciOther.

◆ LoadNext()

bool FCStaffList::LoadNext ( )

inlineoverridevirtual

Overridden LoadNext so the FCStaffLists collection work correctly.

Reimplemented from __FCBaseData.

◆ RemoveBottomStaff()

bool FCStaffList::RemoveBottomStaff ( )

inline

Removes a "Bottom Staff" from the staff list.

Lua-supported.

Returns: True if the "Bottom Staff" was removed from the list.

◆ RemoveElement()

bool FCStaffList::RemoveElement ( twobyte element )

Removes an element from the staff list.

Returns: True if the element was removed.

◆ RemoveStaff()

bool FCStaffList::RemoveStaff ( twobyte staffnumber )

inline

Removes a staff number from the staff list.

Lua-supported.

Returns: True if the staff number was removed from the list.

◆ RemoveTopStaff()

bool FCStaffList::RemoveTopStaff ( )

inline

Removes a "Top Staff" from the staff list.

Lua-supported.

Returns: True if the "Top Staff" was removed from the list.

◆ Save()

bool FCStaffList::Save ( )

overridevirtual

Overridden Save method, since the staff list is of dynamic size.

Reimplemented from __FCBaseData.

◆ SaveNameString()

bool FCStaffList::SaveNameString ( FCString * pString )

Saves the name of the staff list.

Lua-supported.

Returns: True if successful.

◆ SaveNew()

bool FCStaffList::SaveNew ( )

inlineoverridevirtual

SaveNew() is not supported.

Reimplemented from __FCNoInciOther.

◆ SetMode()

void FCStaffList::SetMode ( STAFFLIST_MODES mode )

inline

Sets the list of data that should be used when reading/saving the record.

Lua-supported.

Parameters

mode

Any of these values:

SLMODE_SCORE - Basic staff list for the score
SLMODE_PARTS - Basic staff list for the parts
SLMODE_FORCESCORE - Forced staves for the score
SLMODE_FORCEPARTS - Forced staves for the parts
SLMODE_CATEGORY_SCORE - Basic category staff list for the score.
SLMODE_CATEGORY_PARTS - Basic category staff list for the parts.
SLMODE_CATEGORY_FORCESCORE - Forced category staff list for the score.
SLMODE_CATEGORY_FORCEPARTS - Forced category staff list for the parts.
SLMODE_ASSIGNMENT_SCORE - Basic assignment staff list for the score.
SLMODE_ASSIGNMENT_PARTS - Basic assignment staff list for the parts.
SLMODE_ASSIGNMENT_FORCESCORE - Forced assignment staff list for the score.
SLMODE_ASSIGNMENT_FORCEPARTS - Forced assignment staff list for the parts.

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ STAFFLIST_MODES

Constructor & Destructor Documentation

◆ FCStaffList()

Member Function Documentation

◆ AddBottomStaff()

◆ AddElement()

◆ AddStaff()

◆ AddTopStaff()

◆ ClassName()

◆ CreateNameString()

◆ DebugDump()

◆ DeleteData()

◆ GetClassID()

◆ GetElementCount()

◆ GetStaff()

◆ GetStaffCount()

◆ IncludesBottomStaff()

◆ IncludesStaff()

◆ IncludesTopStaff()

◆ IsElementAvailable()

◆ Load()

◆ LoadNext()

◆ RemoveBottomStaff()

◆ RemoveElement()

◆ RemoveStaff()

◆ RemoveTopStaff()

◆ Save()

◆ SaveNameString()

◆ SaveNew()

◆ SetMode()