Class that encapsulate a cell of note entries. More...

#include <ff_noteframe.h>

Inheritance diagram for FCNoteEntryCell:

Public Types
enum	LOADLAYERMODES { LLM_NONE = -3 , LLM_HIDDENLAYERS = -2 , LLM_EVERYLAYER = -1 , LLM_ALLVISIBILELAYERS = 0 }
	Special layer constants to be used with SetLoadLayerMode(). 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.

	FCNoteEntryCell (int measure, int staff)
	The constructor.

virtual	~FCNoteEntryCell ()
	The destructor.

FCNoteEntry *	AppendEntriesInLayer (int layerno, int noofentries)
	Adds empty entries to the the end of a specific layer in the cell. The note entry cell must be loaded before appending entries.

bool	MoveEntry (FCNoteEntry pEntry, FCNoteEntryCell pSourceEntryCell)
	Moves the entry from one cell to another. The entry number is preserved (so all note-attached will follow). USE WITH CARE! (see details).

bool	CalcAccidental (FCNoteEntry pEntry, FCNote pNote)
	Calculates the accidental state in the note entry cell. Only works on Finale 2014 and above.

bool	CalcEntriesInMultiLayers ()
	Returns true if the note entry cell contain entries from more than one layer.

bool	IsLayerContainingEntries (int layerno)
	Returns true if the indicated layer contains currently loaded note entries.

TimeEdu32	CalcLayerDuration (int layerno)
	Returns the duration of the indicated layer.

void	ClearFrame ()
	Clears the collection and frees the associated TGF frame data.

FCNoteEntry *	FindEntryStartPosition (TimeEdu32 pos, int layerno)
	Finds the entry that starts exacly at the indicated measure position in the indicated layer (or in any layer).

FCNoteEntry *	FindCoveredEntry (TimeEdu32 pos, int layerno)
	Finds the entry that is at the indicated measure position in the indicated layer.

FCNoteEntry *	FindClosestPos (TimeEdu32 pos)
	Finds the entry that is closest to the indicated duration position. All loaded layers will be scanned.

FCNoteEntry *	FindNextEntryPos (TimeEdu32 pos)
	Finds the first entry that appears after the indicated position. All loaded layers will be scanned.

FCNoteEntry *	FindPreviousEntryPos (TimeEdu32 pos)
	Finds the first entry that appears earlier than the indicated position. All loaded layers will be scanned.

bool	DeleteAllNullEntries ()
	Deletes all entries from the cell (and TGF) that are 0 in duration.

bool	DeleteEntry (FCNoteEntry *pEntry)
	Deletes an entry from the cell (and TGF).

bool	Load ()
	Loads the note entries for the cell. Which layers that will be loaded are controlled by the SetLoadLayerMode method. Mirrors are loaded if SetLoadMirrors isn't set to false.

bool	Save ()
	Saves the note entries for the cell. Mirror frames are never saved.

FCNoteEntry *	GetRegionItemAt (int index, FCMusicRegion *pRegion)
	Returns the entry item at the index position - but only if it's within the region.

bool	ReduceEntries ()
	Breaks or combines the entries for the current time signature for the measure based on the rules of standard notation. It also saves the FCNoteEntryCell instance. Mirror frames are never reduced.

int	GetLoadLayerMode () const
	Returns the "layer mode" that will be used for the object at a Load() call.

bool	GetLoadMirrors () const
	Returns the state of mirror frame loading that will be used for the object at a Load() call.

bool	GetFindVisible () const
	Sets if visible entries should be searched in the 'Find' methods, or not.

bool	GetFindHidden () const
	Returns if hidden entries should be searched in the 'Find' methods, or not.

bool	GetFindNotes () const
	Returns if note entries (=non-rests) should be searched in the 'Find' methods, or not.

bool	GetFindRests () const
	Returns if rest entries should be searched in the 'Find' methods, or not.

bool	GetFindAlternateNotation () const
	Returns if entries that are hidden by a staff definition or staff style should be searched in the 'Find' methods, or not.

bool	GetFindCutaway () const
	Returns if entries that are hidden by cutaway notation should be searched in the 'Find' methods, or not.

bool	GetFindVoice1 () const
	Returns if entries that marked as voice 1 should be searched in the 'Find' methods, or not.

bool	GetFindVoice2 () const
	Returns if entries that marked as voice 2 should be searched in the 'Find' methods, or not.

bool	GetFindVoice2Launch () const
	Returns if entries that marked as voice 2 start should be searched in the 'Find' methods, or not.

twobyte	GetMeasure () const
	Returns the measure that the cell belongs to.

twobyte	GetStaff () const
	Returns the staff that the cell belongs to.

void	SetLoadLayerMode (int mode)
	Sets the "layer mode" for the Load method. This must be called/st before any Load() call.

void	SetLoadMirrors (bool state)
	Sets if mirrors should be loaded as well. (The default is that mirrors are loaded.)

void	SetFindVisible (bool state)
	Sets if visible entries should be searched in the 'Find' methods, or not.

void	SetFindHidden (bool state)
	Sets if hidden entries should be searched in the 'Find' methods, or not.

void	SetFindNotes (bool state)
	Sets if note entries (=non-rests) should be searched in the 'Find' methods, or not.

void	SetFindRests (bool state)
	Sets if rest entries should be searched in the 'Find' methods, or not.

void	SetFindAlternateNotation (bool state)
	Sets if entries that are hidden by a staff definition or staff style should be searched in the 'Find' methods, or not.

void	SetFindCutaway (bool state)
	Sets if entries that are hidden by cutaway notation should be searched in the 'Find' methods, or not.

void	SetFindVoice1 (bool state)
	Sets if entries that marked as voice 1 should be searched in the 'Find' methods, or not.

void	SetFindVoice2 (bool state)
	Sets if entries that marked as voice 2 should be searched in the 'Find' methods, or not.

void	SetFindVoice2Launch (bool state)
	Sets if entries that marked as voice 2 start should be searched in the 'Find' methods, or not.

FCNoteEntry *	GetItemAt (int index) const
	Overridden version of the GetItemAt() method.

Public Member Functions inherited from __FCNoteEntryCollection
FCNoteEntry *	FindEntryNumber (ENTNUM entnum)
	Finds the entry item in the collection with the given note entry number.

FCNoteEntry *	GetItemAt (int index) const
	Overridden version of GetItemAt().

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

virtual	~__FCCollection ()
	The virtual destructor, which deallocates the array and also all its elements.

int	GetCount () const
	Returns the number of elements of the collection.

void	Add (__FCBase *pNewItem)
	Adds an element to the end of the collection.

bool	UniqueAdd (__FCBase *pNewItem)
	Adds an element to the end of the collection, but only if it doesn't exist in the collection before.

void	InsertItemAt (__FCBase *pNewItem, int index)
	Inserts an item into the collection.

bool	ElementExists (__FCBase *pQueryItem)
	Returns true if the element is found in the collection, otherwise false.

void	ClearAll ()
	Destroys all the objects in the collection and empties the collection.

void	DetachAll ()
	Removes all the objects from the collection, without freeing/destroying the objects.

__FCBase *	GetItemAt (int index) const
	Returns the object at the index position. Index is 0-based.

__FCBase *	GetLastItem () const
	Returns the last item in the collection.

__FCBase *	operator[] (int index) const
	Identical to the GetItemAt method.

int	GetIndexOf (__FCBase *pObject) const
	Returns the 0-based order index for the object within the collection.

__FCBase *	DetachItemAt (int index)
	Removes the object at the index position. Index is 0-based.

bool	ClearItemAt (int index)
	Deletes the object at the index position and disposes the object. Index is 0-based.

int	ToEndFrom (int index, FCIteratorHandler *pIterator)
	Processes one element after another and iterates from one specific index to the end of the collection.

int	ForEach (FCIteratorHandler *pIterator) override
	Processes all elements in the collection (starting with item 0), or until the iterator Iterate() returns false.

virtual int	ForEachIndex (FCIteratorHandler *pIterator)
	Same as ForEach, but the IterateIndex callback of the iterator handler is used instead.

__FCBase *	FindFirst (FCIteratorHandler *pIterator) override
	Process elements until a match is found.

__FCBase *	FindUserData (void *data_to_find)
	Returns the first element in the collection that has the indicated userdata.

bool	Sort (FCIteratorHandler *pIterator)
	Sorts the elements of.

bool	Swap (int index1, int index2)
	Swaps to items in the collection.

bool	IsEmpty () const
	Returns true if the collection contains no elements.

int	MoveFrom (__FCCollection *pOtherCollection, bool unique=false)
	Moves elements from another collection into this collection. The other will be empty after the operation.

bool	IsIdentical (const __FCBase *pCompareObject) const override
	Returns true if two collections are considered to be identical.

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

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

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

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 __FCBase
	__FCBase ()
	The constructor.

Detailed Description

Class that encapsulate a cell of note entries.

This class requires PDK_FRAMEWORK_ENTRIES to be defined.

The class contains the collection of entries as FCNoteEntry members.

Do NOT call ClearAll directly for this class! Instead use ClearFrame.

Supports <close> in Lua 5.4 (ClearFrame).

Member Enumeration Documentation

◆ LOADLAYERMODES

enum FCNoteEntryCell::LOADLAYERMODES

Special layer constants to be used with SetLoadLayerMode().

Lua-supported.

Enumerator
LLM_NONE	Load no layers.
LLM_HIDDENLAYERS	Load non-visible layers(s).
LLM_EVERYLAYER	All layers, regardless if they're visible or not
LLM_ALLVISIBILELAYERS	All visible layer(s). This is the default load mode.

Constructor & Destructor Documentation

◆ FCNoteEntryCell()

FCNoteEntryCell::FCNoteEntryCell	(	int	measure,
		int	staff )

inline

The constructor.

Lua-supported.

◆ ~FCNoteEntryCell()

virtual FCNoteEntryCell::~FCNoteEntryCell ( )

inlinevirtual

The destructor.

Clears the loaded entry frame data at cleanup.

Member Function Documentation

◆ AppendEntriesInLayer()

FCNoteEntry * FCNoteEntryCell::AppendEntriesInLayer	(	int	layerno,
		int	noofentries )

Adds empty entries to the the end of a specific layer in the cell. The note entry cell must be loaded before appending entries.

The complete entry collection for the note entry cell is rebuilt by the operation, so old pointers to entries will become invalid.

Lua-supported.

Parameters

layerno	1-based layer number.
noofentries	Number of entries to insert.

Returns: NULL on error. Otherwise, pointer to the first added note entry.

◆ CalcAccidental()

bool FCNoteEntryCell::CalcAccidental	(	FCNoteEntry *	pEntry,
		FCNote *	pNote )

Calculates the accidental state in the note entry cell. Only works on Finale 2014 and above.

It's the callers' responsibility to make sure that pEntry and pNote exist.

Returns: Always false on error. Otherwise the accidental's display state.

◆ CalcEntriesInMultiLayers()

bool FCNoteEntryCell::CalcEntriesInMultiLayers ( )

inline

Returns true if the note entry cell contain entries from more than one layer.

Lua-supported.

◆ CalcLayerDuration()

TimeEdu32 FCNoteEntryCell::CalcLayerDuration ( int layerno )

inline

Returns the duration of the indicated layer.

Lua-supported.

Parameters

layerno The 1-based entry layer number.

Returns: -1 on error.

◆ ClassName()

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

◆ ClearFrame()

void FCNoteEntryCell::ClearFrame ( )

inline

Clears the collection and frees the associated TGF frame data.

When running under Lua 5.4 or later, this function is the close function.

Lua-supported.

◆ DeleteAllNullEntries()

bool FCNoteEntryCell::DeleteAllNullEntries ( )

Deletes all entries from the cell (and TGF) that are 0 in duration.

This method NO LONGER requires that the cell contents has previously been saved (so each entry has an entry number).

The entries are deleted directly, there's no need to do a save afterwards (!!Is this really correct?!!)

Entries from mirror frames can't be deleted.

Lua-supported.

Returns: True if successful. False if entries without entry numbers are found.

◆ DeleteEntry()

bool FCNoteEntryCell::DeleteEntry ( FCNoteEntry * pEntry )

Deletes an entry from the cell (and TGF).

This method doesn't require that the TGF has existing entry numbers. Entries can not be deleted from mirror frames.

Lua-supported.

◆ FindClosestPos()

FCNoteEntry * FCNoteEntryCell::FindClosestPos ( TimeEdu32 pos )

Finds the entry that is closest to the indicated duration position. All loaded layers will be scanned.

The items that will be scanned can be controlled with SetFindVisible, SetFindHidden, SetFindNotes, SetFindRests, SetFindAlternateNotation, SetFindCutaway, SetFindVoice1, SetFindVoice2, SetFindVoice2Launch.

Lua-supported.

Parameters

pos	The duration position within the measure, in Enigma duration units.

Returns: NULL if no entry could be found. Otherwise, the entry that was closest to the position.

◆ FindCoveredEntry()

FCNoteEntry * FCNoteEntryCell::FindCoveredEntry	(	TimeEdu32	pos,
		int	layerno )

Finds the entry that is at the indicated measure position in the indicated layer.

The items that will be scanned can be controlled with SetFindVisible, SetFindHidden, SetFindNotes, SetFindRests, SetFindAlternateNotation, SetFindCutaway, SetFindVoice1, SetFindVoice2, SetFindVoice2Launch.

Lua-supported.

Parameters

pos	The position in EDUs.
layerno	The 1-based layer number

Returns: NULL if not found.

◆ FindEntryStartPosition()

FCNoteEntry * FCNoteEntryCell::FindEntryStartPosition	(	TimeEdu32	pos,
		int	layerno )

Finds the entry that starts exacly at the indicated measure position in the indicated layer (or in any layer).

If a grace note and main note appears on the same EDU, the main note is prioritized.

The items that will be scanned can be controlled with SetFindVisible, SetFindHidden, SetFindNotes, SetFindRests, SetFindAlternateNotation, SetFindCutaway, SetFindVoice1, SetFindVoice2, SetFindVoice2Launch.

Lua-supported.

Parameters

pos	The position in EDUs.
layerno	The 1-based layer number. If it's -1, the first entry match in any layer is returned.

Returns: NULL if not found.

◆ FindNextEntryPos()

FCNoteEntry * FCNoteEntryCell::FindNextEntryPos ( TimeEdu32 pos )

Finds the first entry that appears after the indicated position. All loaded layers will be scanned.

Grace notes will not be processed.

The items that will be scanned can be controlled with SetFindVisible, SetFindHidden, SetFindNotes, SetFindRests, SetFindAlternateNotation, SetFindCutaway, SetFindVoice1, SetFindVoice2, SetFindVoice2Launch.

Lua-supported.

Parameters

pos	The duration position within the measure, in Enigma duration units.

Returns: NULL if no entry could be found. Otherwise, the next entry that was found after the position. The returned value will never be at the same position as the pos parameter.

◆ FindPreviousEntryPos()

FCNoteEntry * FCNoteEntryCell::FindPreviousEntryPos ( TimeEdu32 pos )

Finds the first entry that appears earlier than the indicated position. All loaded layers will be scanned.

Grace notes will not be processed.

The items that will be scanned can be controlled with SetFindVisible, SetFindHidden, SetFindNotes, SetFindRests, SetFindAlternateNotation, SetFindCutaway, SetFindVoice1, SetFindVoice2, SetFindVoice2Launch.

Lua-supported.

Parameters

pos	The duration position within the measure, in Enigma duration units.

Returns: NULL if no entry could be found. Otherwise, the first entry that was found earlier than the position. The returned value will never be at the same position as the pos parameter.

◆ GetFindAlternateNotation()

bool FCNoteEntryCell::GetFindAlternateNotation ( ) const

inline

Returns if entries that are hidden by a staff definition or staff style should be searched in the 'Find' methods, or not.

This setting controls note entries hidden by any notation style other than normal notation.

This affects the following methods: FindCoveredEntry, FindClosestPos, FindEntryStartPosition, FindPreviousEntryPos, FindNextEntryPos

Lua-supported (also as property).

Returns: true - search entries hidden by staff style, false - don't search entries hidden by staff style

◆ GetFindCutaway()

bool FCNoteEntryCell::GetFindCutaway ( ) const

inline

Returns if entries that are hidden by cutaway notation should be searched in the 'Find' methods, or not.

This affects the following methods: FindCoveredEntry, FindClosestPos, FindEntryStartPosition, FindPreviousEntryPos, FindNextEntryPos

Lua-supported (also as property).

Returns: true - search entries hidden by staff style, false - don't search entries hidden by staff style

◆ GetFindHidden()

bool FCNoteEntryCell::GetFindHidden ( ) const

inline

Returns if hidden entries should be searched in the 'Find' methods, or not.

This affects the following methods: FindCoveredEntry, FindClosestPos, FindEntryStartPosition, FindPreviousEntryPos, FindNextEntryPos

Lua-supported (also as property).

Returns: true - search hidden entries, false - don't search hidden entries

◆ GetFindNotes()

bool FCNoteEntryCell::GetFindNotes ( ) const

inline

Returns if note entries (=non-rests) should be searched in the 'Find' methods, or not.

This affects the following methods: FindCoveredEntry, FindClosestPos, FindEntryStartPosition, FindPreviousEntryPos, FindNextEntryPos

Lua-supported (also as property).

Returns: true - search note entries, false - don't search note entries

◆ GetFindRests()

bool FCNoteEntryCell::GetFindRests ( ) const

inline

Returns if rest entries should be searched in the 'Find' methods, or not.

This affects the following methods: FindCoveredEntry, FindClosestPos, FindEntryStartPosition, FindPreviousEntryPos, FindNextEntryPos

Lua-supported (also as property).

Returns: true - search rest entries, false - don't search rest entries

◆ GetFindVisible()

bool FCNoteEntryCell::GetFindVisible ( ) const

inline

Sets if visible entries should be searched in the 'Find' methods, or not.

This affects the following methods: FindCoveredEntry, FindClosestPos, FindEntryStartPosition, FindPreviousEntryPos, FindNextEntryPos

Lua-supported (also as property).

Returns: True - search visible entries. False - don't search visible entries

◆ GetFindVoice1()

bool FCNoteEntryCell::GetFindVoice1 ( ) const

inline

Returns if entries that marked as voice 1 should be searched in the 'Find' methods, or not.

This affects the following methods: FindCoveredEntry, FindClosestPos, FindEntryStartPosition, FindPreviousEntryPos, FindNextEntryPos

Lua-supported (also as property).

Returns: true - search entries marked as voice 1, false - don't search entries marked as voice 1

◆ GetFindVoice2()

bool FCNoteEntryCell::GetFindVoice2 ( ) const

inline

Returns if entries that marked as voice 2 should be searched in the 'Find' methods, or not.

This affects the following methods: FindCoveredEntry, FindClosestPos, FindEntryStartPosition, FindPreviousEntryPos, FindNextEntryPos

Lua-supported (also as property).

Returns: true - search entries marked as voice 2, false - don't search entries marked as voice 2

◆ GetFindVoice2Launch()

bool FCNoteEntryCell::GetFindVoice2Launch ( ) const

inline

Returns if entries that marked as voice 2 start should be searched in the 'Find' methods, or not.

This affects the following methods: FindCoveredEntry, FindClosestPos, FindEntryStartPosition, FindPreviousEntryPos, FindNextEntryPos

Lua-supported (also as property).

Returns: true - search entries marked as voice 2 start, false - don't search entries marked as voice 2 start

◆ GetItemAt()

FCNoteEntry * FCNoteEntryCell::GetItemAt ( int index ) const

inline

Overridden version of the GetItemAt() method.

Lua-supported.

◆ GetLoadLayerMode()

int FCNoteEntryCell::GetLoadLayerMode ( ) const

inline

Returns the "layer mode" that will be used for the object at a Load() call.

Lua-supported (also as property).

Returns: Please refer to SetLoadLayerMode() for explanation on the return values.

◆ GetLoadMirrors()

bool FCNoteEntryCell::GetLoadMirrors ( ) const

inline

Returns the state of mirror frame loading that will be used for the object at a Load() call.

Lua-supported (also as property).

Returns: True - mirror frames are loaded. False - mirror frames are not loaded.

◆ GetMeasure()

twobyte FCNoteEntryCell::GetMeasure ( ) const

inline

Returns the measure that the cell belongs to.

Lua-supported (also as a read-only property).

Returns: The 1-based measure number for the note entry cell.

◆ GetRegionItemAt()

FCNoteEntry * FCNoteEntryCell::GetRegionItemAt	(	int	index,
		FCMusicRegion *	pRegion )

Returns the entry item at the index position - but only if it's within the region.

Lua-supported.

Parameters

index	The 0-based collection index.
pRegion	The region

Returns: NULL if the entry is outside the region, otherwise the entry item.

◆ GetStaff()

twobyte FCNoteEntryCell::GetStaff ( ) const

inline

Returns the staff that the cell belongs to.

Lua-supported (also as a read-only property).

Returns: The Staff ID for the note entry cell.

◆ IsLayerContainingEntries()

bool FCNoteEntryCell::IsLayerContainingEntries ( int layerno )

inline

Returns true if the indicated layer contains currently loaded note entries.

(Was previously known as 'CalcLayerContainsEntries'.)

Lua-supported.

Parameters

layerno The 1-based entry layer number.

◆ Load()

bool FCNoteEntryCell::Load ( )

Loads the note entries for the cell. Which layers that will be loaded are controlled by the SetLoadLayerMode method. Mirrors are loaded if SetLoadMirrors isn't set to false.

Lua-supported.

Returns: True on success.

◆ MoveEntry()

bool FCNoteEntryCell::MoveEntry	(	FCNoteEntry *	pEntry,
		FCNoteEntryCell *	pSourceEntryCell )

Moves the entry from one cell to another. The entry number is preserved (so all note-attached will follow). USE WITH CARE! (see details).

The entry must have an entry number.

Both the source and destination cells MUST be saved after the entry has been moved!

Lua-supported.

Parameters

pEntry	The pointer to the entry object.
pSourceEntryCell	The note entry cell that contains the pEntry.

Returns: True on a successful move.

◆ ReduceEntries()

bool FCNoteEntryCell::ReduceEntries ( )

inline

Breaks or combines the entries for the current time signature for the measure based on the rules of standard notation. It also saves the FCNoteEntryCell instance. Mirror frames are never reduced.

If you have added or deleted entries, you should save and reload the FCNoteEntryLayer before calling this function.

This function rebuilds the note entries, so old pointers to entries will no longer be valid. You should not call this function inside an entry processing loop.

Lua-supported (0.68)

Returns: the result of saving the FCNoteEntryCollection

◆ Save()

bool FCNoteEntryCell::Save ( )

Saves the note entries for the cell. Mirror frames are never saved.

Lua-supported.

Returns: True on success.

◆ SetFindAlternateNotation()

void FCNoteEntryCell::SetFindAlternateNotation ( bool state )

inline

Sets if entries that are hidden by a staff definition or staff style should be searched in the 'Find' methods, or not.

This setting controls note entries hidden by any notation style other than normal notation.

This affects the following methods: FindCoveredEntry, FindClosestPos, FindEntryStartPosition, FindPreviousEntryPos, FindNextEntryPos

The default is that entries are searched if they are hidden by a staff definition or staff style.

Lua-supported (also as property).

Parameters

state true - search entries hidden by staff style, false - don't search entries hidden by staff style

◆ SetFindCutaway()

void FCNoteEntryCell::SetFindCutaway ( bool state )

inline

Sets if entries that are hidden by cutaway notation should be searched in the 'Find' methods, or not.

This affects the following methods: FindCoveredEntry, FindClosestPos, FindEntryStartPosition, FindPreviousEntryPos, FindNextEntryPos

The default is that entries are searched even if they are hidden by a cutaway notation.

Lua-supported (also as property).

Parameters

[in] state true - search entries hidden by staff style, false - don't search entries hidden by staff style

◆ SetFindHidden()

void FCNoteEntryCell::SetFindHidden ( bool state )

inline

Sets if hidden entries should be searched in the 'Find' methods, or not.

This affects the following methods: FindCoveredEntry, FindClosestPos, FindEntryStartPosition, FindPreviousEntryPos, FindNextEntryPos

The default is that hidden entries are searched.

Lua-supported (also as property).

Parameters

state true - search hidden entries, false - don't search hidden entries

◆ SetFindNotes()

void FCNoteEntryCell::SetFindNotes ( bool state )

inline

Sets if note entries (=non-rests) should be searched in the 'Find' methods, or not.

This affects the following methods: FindCoveredEntry, FindClosestPos, FindEntryStartPosition, FindPreviousEntryPos, FindNextEntryPos

The default is that note entries are searched.

Lua-supported (also as property).

Parameters

state true - search note entries, false - don't search note entries

◆ SetFindRests()

void FCNoteEntryCell::SetFindRests ( bool state )

inline

Sets if rest entries should be searched in the 'Find' methods, or not.

This affects the following methods: FindCoveredEntry, FindClosestPos, FindEntryStartPosition, FindPreviousEntryPos, FindNextEntryPos

The default is that rest entries are searched.

Lua-supported (also as property).

Parameters

state true - search rest entries, false - don't search rest entries

◆ SetFindVisible()

void FCNoteEntryCell::SetFindVisible ( bool state )

inline

Sets if visible entries should be searched in the 'Find' methods, or not.

This affects the following methods: FindCoveredEntry, FindClosestPos, FindEntryStartPosition, FindPreviousEntryPos, FindNextEntryPos

The default is that visible entries are searched.

Lua-supported (also as property).

Parameters

state true - search visible entries, false - don't search visible entries

◆ SetFindVoice1()

void FCNoteEntryCell::SetFindVoice1 ( bool state )

inline

Sets if entries that marked as voice 1 should be searched in the 'Find' methods, or not.

This affects the following methods: FindCoveredEntry, FindClosestPos, FindEntryStartPosition, FindPreviousEntryPos, FindNextEntryPos

Lua-supported (also as property).

Parameters

[in] state true - search entries marked as voice 1, false - don't search entries marked as voice 1

◆ SetFindVoice2()

void FCNoteEntryCell::SetFindVoice2 ( bool state )

inline

Sets if entries that marked as voice 2 should be searched in the 'Find' methods, or not.

This affects the following methods: FindCoveredEntry, FindClosestPos, FindEntryStartPosition, FindPreviousEntryPos, FindNextEntryPos

Lua-supported (also as property).

Parameters

[in] state true - search entries marked as voice 2, false - don't search entries marked as voice 2

◆ SetFindVoice2Launch()

void FCNoteEntryCell::SetFindVoice2Launch ( bool state )

inline

Sets if entries that marked as voice 2 start should be searched in the 'Find' methods, or not.

This affects the following methods: FindCoveredEntry, FindClosestPos, FindEntryStartPosition, FindPreviousEntryPos, FindNextEntryPos

Lua-supported (also as property).

Parameters

[in] state true - search entries marked as voice 2 start, false - don't search entries marked as voice 2 start

◆ SetLoadLayerMode()

void FCNoteEntryCell::SetLoadLayerMode ( int mode )

inline

Sets the "layer mode" for the Load method. This must be called/st before any Load() call.

Lua-supported (also as property).

Parameters

mode

Any of the following values, which are used if shouldload is true:

LLM_NONE: Load no layers.
LLM_HIDDENLAYERS: The non-visible layers(s).
LLM_EVERYLAYER: All layers, regardless if they're visible or not
LLM_ALLVISIBILELAYERS : All visible layer(s). This is the default for this class.
1 through "maxlayers": Only the one-based layer number. The layer is loaded regardless of the layer visibility.
A mask combination of 0x100, 0x200, 0x400, 0x800: The layer 1-4 in any combination.

◆ SetLoadMirrors()

void FCNoteEntryCell::SetLoadMirrors ( bool state )

inline

Sets if mirrors should be loaded as well. (The default is that mirrors are loaded.)

Lua-supported (also as property).

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ LOADLAYERMODES

Constructor & Destructor Documentation

◆ FCNoteEntryCell()

◆ ~FCNoteEntryCell()

Member Function Documentation

◆ AppendEntriesInLayer()

◆ CalcAccidental()

◆ CalcEntriesInMultiLayers()

◆ CalcLayerDuration()

◆ ClassName()

◆ ClearFrame()

◆ DeleteAllNullEntries()

◆ DeleteEntry()

◆ FindClosestPos()

◆ FindCoveredEntry()

◆ FindEntryStartPosition()

◆ FindNextEntryPos()

◆ FindPreviousEntryPos()

◆ GetFindAlternateNotation()

◆ GetFindCutaway()

◆ GetFindHidden()

◆ GetFindNotes()

◆ GetFindRests()

◆ GetFindVisible()

◆ GetFindVoice1()

◆ GetFindVoice2()

◆ GetFindVoice2Launch()

◆ GetItemAt()

◆ GetLoadLayerMode()

◆ GetLoadMirrors()

◆ GetMeasure()

◆ GetRegionItemAt()

◆ GetStaff()

◆ IsLayerContainingEntries()

◆ Load()

◆ MoveEntry()

◆ ReduceEntries()

◆ Save()

◆ SetFindAlternateNotation()

◆ SetFindCutaway()

◆ SetFindHidden()

◆ SetFindNotes()

◆ SetFindRests()

◆ SetFindVisible()

◆ SetFindVoice1()

◆ SetFindVoice2()

◆ SetFindVoice2Launch()

◆ SetLoadLayerMode()

◆ SetLoadMirrors()