Encapsulates a note entry from an owner class (for example FCNoteEntryCell, FCNoteEntryLayer) class. More...

#include <ff_noteframe.h>

Inheritance diagram for FCNoteEntry:

Public Types
enum	ENTRY_DURATIONS { BREVE = 8192 , WHOLE_NOTE = 4096 , NOTE_WHOLE = 4096 , HALF_NOTE = 2048 , NOTE_HALF = 2048 , QUARTER_NOTE = 1024 , NOTE_QUARTER = 1024 , EIGHTH_NOTE = 512 , NOTE_8TH = 512 , SIXTEENTH_NOTE = 256 , NOTE_16TH = 256 , THIRTYSECOND_NOTE = 128 , NOTE_32ND = 128 , SIXTYFOURTH_NOTE = 64 , NOTE_64TH = 64 , NOTE_128TH = 32 }
	Defintions of common note durations, for use with any operation where the TimeEdu32 type is used. 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
FCNote *	GetItemAt (int index) const
	Overload version of GetItemAt(), which returns a note object (if available) for the note entry.

const char *	ClassName () const override
	Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child class.

	FCNoteEntry (EXENTRY pEntry, EXTGF2005a pFrame, FCNoteEntry *pPrevious)
	The constructor.

virtual	~FCNoteEntry ()

FCNote *	FindNoteID (twobyte noteID)

void	SetRestDisplacement (twobyte value)
	Sets the displacement for a rest entry.

twobyte	GetRestDisplacement ()
	Returns the rest displacement.

FCNoteEntry *	Previous ()
	Returns the previous note entry in the linked collection (layer or cell).

FCNoteEntry *	PreviousInFrame ()
	Returns the previous note entry in the linked collection (layer or cell), but only within the frame.

FCNoteEntry *	PreviousSameVInFrame ()
	Returns the previous note entry in the same V1 or V2 within the current frame. If the current instance of FCNoteEntry is V2, only the current V2 launch is searched.

FCNoteEntry *	NextInBeamedGroup ()
	Returns the next note entry in a beamed group or NULL if there is none.

FCNoteEntry *	PreviousInBeamedGroup ()
	Returns the previous note entry in a beamed group or NULL if there is none.

FCArticulations *	CreateArticulations ()
	Creates a collection for all the articulations attached to the note entry.

FCNoteheadMods *	CreateNoteheadMods ()
	Creates a collection for all the notehead modifications attached to the note entry.

FCPerformanceMods *	CreatePerformanceMods ()
	Creates a collection for all the MIDI performance modifications attached to the note entry.

FCTuplets *	CreateTuplets ()
	Creates a collection for all the tuplets connected to the note entry.

ENTNUM	GetEntryNumber () const
	Returns the internal entry number (ID) for the note entry.

bool	RelinkToCurrentView ()
	Relinks the unlinkable items in the current view so that the score and part(s) match.

bool	RelinkToScore ()
	Relinks the unlinkable items in all parts to the contents of the score.

void	SetNoteFlag (bool state)
	Sets if the entry is a note or a rest.

void	SetPlayback (bool state)
	Sets the playback state of the note entry.

void	SetCombineRests (bool state)
	Sets the flag for if the rest should combine.

void	SetFlipTie (bool state)
	Sets the "flip tie" of the note entry.

void	SetSpacing (bool state)
	Sets the music spacing state of the note entry.

void	SetVisible (bool state)
	Sets the visibility state of the note entry.

void	SetGraceNote (bool state)
	Sets the grace note state of the note entry.

void	SetSplitRest (bool state)
	Sets the split rest state of the note entry. (Applies if note entry is a rest.)

void	SetVoice2 (bool state)
	Sets the voice 2 status for the entry.

void	SetVoice2Launch (bool state)
	Sets the entry that controls the launch of voice 2.

void	SetGraceNoteSlash (bool state)
	Sets the slashed state for a grace note entry.

void	SetCrossStaff (bool state)
	Sets the cross staff state for the entry.

void	SetBeamBeat (bool state)
	Sets the "beam/beat" state of the entry.

void	SetFreezeBeam (bool state)
	Sets the freeze state for the "beam/beat".

void	SetFlatBeam (bool state)
	Sets the "flat beam" state of the entry.

void	SetLedgerLines (bool state)
	Sets the ledger line state for the note entry.

void	SetFreezeStem (bool state)
	Sets the "Freeze Stem" state for the note entry.

void	SetReverseUpStem (bool state)
	Sets the reverse stem setting for up stem.

void	SetReverseDownStem (bool state)
	Sets the reverse stem setting for down stem.

void	SetSplitStem (bool state)
	Sets the "Split Stem" state for the note entry.

void	SetCheckAccidentals (bool state)
	Marks the entry that the accidentals should be verified when the frame is saved.

void	SetLegality (bool state)
	Sets the legality bit, marking that the entry is valid.

void	SetManualPosition (Evpu16 pos)
	Sets the manual positioning of the entry.

void	SetClefIndex (eClef clef)
	Sets the clef index for the entry.

void	SetStemUp (bool state)
	Sets the "stem up" flag for the entry.

void	SetDuration (TimeEdu32 duration)
	Sets the symbolic duration of the note. For tuplet entries, the symbolic duration would be different from the actual duration.

void	SetFloatingRest (bool state)
	Sets the floating rest status of the entry.

void	SetNoteDetailFlag (bool state)
	Sets the flag state for note detail records.

void	SetPerformanceDataFlag (bool state)
	Sets the flag state for performance data records.

void	SetSpecialAltsFlag (bool state)
	Sets the flag state for special alteration records.

void	SetArticulationFlag (bool state)
	Sets the flag that marks that an articulation is attached to the entry.

void	SetSmartShapeFlag (bool state)
	Sets the flag that marks that a smart shape is attached to the entry.

void	SetTupletStartFlag (bool state)
	Sets the flag that marks that a tuplet starts on the entry.

void	SetLyricFlag (bool state)
	Sets the flag that marks that an entry has syllable attached to it.

void	SetStemDetailFlag (bool state)
	Sets the flag state for stem detail records.

void	SetSecondaryBeamFlag (bool state)
	Sets the flag state for secondary beam detail records.

void	SetBeamExtensionFlag (bool state)
	Sets the flag state for beam extension detail records.

void	SetActualDuration (TimeEdu32 value)
	Sets the actual duration for the entry.

void	SetMeasurePos (TimeEdu32 value)
	Sets the elapsed position in the measure for the entry.

bool	GetBeamBeat () const
	Gets the "beam/beat" flag state of the entry.

bool	GetCheckAccidentals () const
	Returns the accidental "refresh" flag.

bool	GetLedgerLines () const
	Gets the ledger line state for the note entry.

bool	GetFreezeStem () const
	Gets the "Freeze Stem" state for the note entry.

bool	GetReverseUpStem () const
	Gets the reverse stem setting for up stem.

bool	GetReverseDownStem () const
	Gets the reverse stem setting for down stem.

bool	GetSplitStem () const
	Gets the "Split Stem" state for the note entry.

bool	GetLegality () const
	Gets the legality bit, that marks that the entry is valid.

bool	GetFreezeBeam () const
	Gets the freeze state for the "beam/beat".

bool	GetFlatBeam () const
	Gets the "flat beam" state of the entry.

bool	GetPlayback () const
	Gets the playback state of the note entry.

bool	GetCombineRests () const
	Returns the flag for if the rest should combine.

bool	GetFlipTie () const
	Gets the "flip tie" state of the note entry.

bool	GetSpacing () const
	Gets the music spacing state of the note entry.

bool	GetVisible () const
	Gets the visibility state of the note entry.

bool	GetGraceNote () const
	Gets the grace note state of the note entry.

bool	GetSplitRest () const
	Gets the split rest state of the note entry. (Applies if note entry is a rest.)

bool	GetGraceNoteSlash () const
	Gets the grace note slash state of the note entry.

bool	GetVoice2 () const
	Returns true if it's a voice 2 entry.

bool	GetVoice2Launch () const
	Returns true if the entry launches voice 2.

bool	GetStemUp () const
	Returns the state of the "up" bit for the entry. This is NOT the same as the true direction for the stem!

bool	GetCrossStaff () const
	Returns the cross staff state for the entry.

TimeEdu32	GetDuration () const
	Gets the symbolic duration of the entry. For tuplet entries, the symbolic duration would be different from the actual duration. Compare with the GetActualDuration method.

bool	GetFloatingRest () const
	Gets the floating rest status of the entry.

TimeEdu32	GetActualDuration () const
	Gets the actual duration of the entry. For tuplet entries, the symbolic duration would be different from the actual duration. Compare with the GetDuration method.

TimeEdu32	CalcNondottedDuration ()
	Returns the non-dotted symbolic duration of the entry.

twobyte	CalcDots ()
	Returns the number of dots for a dotted entry.

bool	CalcUniquePitchString (FCString *pString)
	Creates a "pitch ID" string for the entry.

twobyte	GetLayerNumber () const
	Returns the 1-based layer number that the entry belongs to.

Evpu16	GetManualPosition () const
	Gets the manual positioning of the entry.

eClef	GetClefIndex () const
	Gets the clef that's used for the entry.

int	CalcGraceNoteIndex ()
	Returns the grace note index for the entry.

int	CalcNumberOfVisibleNotes () const
	Calculates the number of notes visible in the current score or part view, taking into account any that may not be displayed due to voiced part settings. (See FCPartStaffVoicing.)

bool	CalcDisplaysAsRest () const
	Calculates if this entry displays as a rest in the current score or part view, taking into account the FCPartStaffVoicing settings for a voiced part (if any).

twobyte	CalcHighestStaffPosition ()
	Calculates the highest staff position for a note in the entry's chord.

twobyte	CalcLowestStaffPosition ()
	Calculates the lowest staff position for a note in the entry's chord.

twobyte	CalcHighestDisplacement ()
	Calculates the highest displacement value found in the entry's chord.

twobyte	CalcLowestDisplacement ()
	Calculates the lowest displacement value found in the entry's chord.

twobyte	CalcDisplacementRange ()
	Calculates the range of the highest and lowest note in a chord.

twobyte	CalcBeamCount ()
	Returns the number of beams/flags for the entry, based on the duration.

bool	CalcMultiLayeredCell ()
	Returns true if the entry is in a cell with multiple layers of music.

int	CalcDisplacementMatchCount (FCNoteEntry *pCompareEntry)
	Calculates the number of matching note displacements between the entries.

FCNote *	CalcHighestNote (FCNote *pCeiling=NULL)
	Finds the note with the highest pitch in the chord.

FCNote *	CalcLowestNote (FCNote *pFloor=NULL)
	Finds the note with the lowest pitch in the chord.

bool	CalcHiddenThroughAltNotation ()
	Calculates if entry is hidden through alternate notation.

FCNote *	CalcHighestPercussionNote ()
	For percussion notation, calculates the topmost percussion note.

FCNote *	CalcLowestPercussionNote ()
	For percussion notation, calculates the bottommost percussion note.

bool	HasSameNotes (FCNoteEntry *pEntry)
	Compares the notes with the notes in another note entry.

FCNote *	FindDisplacement (twobyte displacement)
	Tries to finds a note in the chord with a specific displacement value.

FCNote *	FindPitch (FCNote *pPitchNote)
	Tries to finds a note in the chord with the identical pitch as the suppied note.

TimeEdu32	GetMeasurePos () const
	Returns the elapsed duration position in the measure for the entry.

bool	GetNoteDetailFlag () const
	Returns true for existing note detail records.

bool	GetPerformanceDataFlag () const
	Returns true for existing performance data records.

bool	GetSpecialAltsFlag () const
	Returns true for existing special alteration records.

bool	GetTupletStartFlag () const
	Returns true if the entry is marked to start a tuplet.

bool	GetLyricFlag () const
	Returns the flag that marks that an entry has syllable attached to it.

bool	GetStemDetailFlag () const
	Gets the flag state for stem detail records.

bool	GetSecondaryBeamFlag () const
	Returns true for secondary beam detail records.

bool	GetBeamExtensionFlag () const
	Returns true for beam extension detail records.

bool	GetArticulationFlag () const
	Returns true if the entry is marked to contain articulations.

bool	GetSmartShapeFlag () const
	Returns true if the entry is marked to contain smart shapes.

twobyte	GetMeasure () const
	Returns the entry's measure.

twobyte	GetStaff () const
	Returns the entry's staff.

FCNoteEntry *	Next ()
	Returns the next entry in the loaded entry chain (within the same layer).

FCNoteEntry *	NextInFrame ()
	Returns the next note entry in the linked collection (layer or cell), but only within the frame.

FCNoteEntry *	NextSameVInFrame ()
	Returns the next note entry in the same V1 or V2 within the current frame. If the current instance of FCNoteEntry is V2, only the current V2 launch is searched.

bool	IsNote ()
	Returns true if entry is a note.

bool	IsRest () const
	Returns true if entry is a rest.

bool	IsDotted ()
	Returns true if it's a dotted entry.

bool	IsStartOfTuplet ()
	Returns true if the entry is the start of a tuplet.

bool	IsSameMeasurePosAs (FCNoteEntry *pCompareEntry)
	Returns true if the compared entry is at the same measure/measure position as the object.

bool	IsStartOfTupletParam (TupletInfo *pInfoStorage=NULL)
	Returns true if the entry is the start of a tuplet (parameter version).

bool	IsPartOfTuplet ()
	Returns true if the entry is part of a tuplet.

bool	IsOverlappedEntry (FCNoteEntry *pTestEntry)
	Returns true if the test entry is at least partly overlapping the current entry.

bool	IsPartOfTupletParam (TupletInfo *pInfoStorage=NULL)
	Returns true if the entry is part of a tuplet (parameter version).

bool	IsLastInMeasure ()
	Returns true if it's the last entry in the measure frame.

FCNoteEntry *	CalcLastTupletEntry (FCTuplet *pTuplet)
	Scans forward and returns the end entry of a tuplet that's connected to this entry object.

bool	CalcFlippable ()
	Signals if the entry would flip when the up/down state is changed.

bool	CalcBeamedGroupEnd ()
	Returns true if it's the end entry in a beamed group.

bool	CalcUnbeamedNote ()
	Returns true if the entry is a non-beamed note (=not part of a beamed group.)

FCNoteEntry *	CalcBeamStartEntry ()
	Returns the start entry of the beamed group where the entry belongs. If the "Extend beams over rests" option is set, this method might return a rest.

int	CalcLowestBeamStart ()
	Returns the lowest beam number starting at this entry, where 1 = 8th note beam, 2 = 16th note beam, etc.

int	CalcLowestBeamEnd ()
	Returns the lowest beam number ending at this entry, where 1 = 8th note beam, 2 = 16th note beam, etc.

int	CalcLowestBeamStub ()
	Returns the lowest beam number that is a stand-alone beam stub. 1 = 8th note beam, 2 = 16th note beam, etc.

bool	CalcLargestNoteheadResize (FCNumber pLargestFontSize, FCNumber pLargestResize)
	Calculates the largest point size and the largest notehead % resize for the entry.

bool	CalcSmallestNoteheadResize (FCNumber pSmallestFontSize, FCNumber pSmallestResize)
	Calculates the smallest point size and the smallest notehead % resize for the entry.

twobyte	CalcWidestNoteheadWidth ()
	Returns the widest width of a notehead in the entry, as the non-printing width.

bool	CalcStemUp ()
	Returns the direction of the beam.

twobyte	CalcResize ()
	Calculates the resize percent for the note entry.

twobyte	CalcStemLength ()
	Calculates the stem length, based on the entry metrics.

bool	IsTied ()
	Returns true if any of the notes in the chord is tied to the next entry.

bool	IsTiedBackwards ()
	Returns true if any of the notes in the chord is flagged to be tied from the previous entry.

bool	IsTiedToPrevious ()
	Return true if the previous entry has a tie to this entry.

bool	IsAllTied ()
	Returns true if all of the notes in the chord is tied to the next entry.

bool	IsAllTiedBackwards ()
	Returns true if all of the notes in the chord has a flagged to be tied from the previous entry.

void	ClearPitches ()
	Clears all pitches from the entry, to prepare to add new notes.

FCNote *	AddNewNote ()
	Adds a new note to the chord.

int	AddPitches (FCNoteEntry *pSourceEntry, bool unique, bool settie=false)
	Adds (appends to the existing notes) all notes from another entry.

int	AddPitches (FCNotePitches *pPitches, bool unique)
	Adds (appends to the existing notes) all notes from a pith collection.

int	AddPitch (FCNote *pNote)
	Adds a note to a chord.

int	AddArticulations (FCNoteEntry *pSourceEntry, bool bNoDuplicates=true)
	Adds (appends to the existing ones) all articulations from another entry.

void	TieAll (bool bTie)
	Ties or unties all chord notes for the entry.

void	SetAccidentals (bool bAccidental)
	Sets/removes accidental display for all chord notes in the entry.

void	CopyNotes (FCNoteEntry *pFrom)
	Copies all pitches and other note information from another entry. The old notes for the entry will be erased. The tie information and other note flags will also be identical to the source.

void	CopyNote (FCNote *pFrom)
	Copies all pitches and other note information from one single note. The old notes for the entry will be erased. The tie information and other note flags will also be identical to the source.

void	CopyEntry (FCNoteEntry *pFromEntry)
	Copies the duration and notes (or rest) from the source entry.

void	CopyEntryDetails (FCNoteEntry *pFromEntry, bool copytuplets)
	Copies note-related data from another entry.

void	CopyEntryPercussionDetails (FCNoteEntry *pFromEntry)
	Copies note-related data between percussion entries.

bool	DeleteNote (FCNote *pNote)
	Deletes a note from a chord. The note collection is rebuilt after the deletion.

void	CacheArticulations ()
	Stores the available articulations in a cache memory.

bool	IsRestMovable ()
	Returns true if it's a movable rest.

void	MakeRest ()
	Turns the entry into a rest (without any displacement).

void	MakeMovableRest ()
	Turns the entry into a movable rest.

void	MakeNote ()
	Turns the entry into a note.

FCNoteEntry *	CreateShallowClone ()
	Creates a shallow copy of the note entry, meaning that the reference to the entry, TGF and notes are the same. The object instance is new, though.

FCNotePitches *	CreateNotePitches ()
	Create local copies of the note pitches in a collection.

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.

Static Public Member Functions
static void	MarkEntryMetricsForUpdate ()
	Static method that mark that the entry-related layout info needs to be rebuilt (for CalcStemUp(), for example).

static TimeEdu32	CalcNondottedDurationForDuration (TimeEdu32 duration)
	Static method that truncates duration to give only return the non-dotted duration value.

static int	CalcDotsForDuration (TimeEdu32 duration)
	Static method that calculates the number of dots a specific duration would get.

static bool	IsValidDuration (TimeEdu32 duration)
	Static method that evaluates the validity of a duration value.

static TimeEdu32	CalcValidDuration (TimeEdu32 duration)
	Static method that calculates a valid note duration value by truncating the value if necessary.

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

Detailed Description

Encapsulates a note entry from an owner class (for example FCNoteEntryCell, FCNoteEntryLayer) class.

This class requires PDK_FRAMEWORK_ENTRIES to be defined.

The class is also a collection of notes (of the FCNote class).

When a note entry that uses standard notation is loaded from Finale, the notes are sorted in pitch order from lowest to highest. For percussion and tabulature notation however, there is no relation between displayed position and order in the entry. It's safest to not assume that entries are sorted.

Member Enumeration Documentation

◆ ENTRY_DURATIONS

enum FCNoteEntry::ENTRY_DURATIONS

Defintions of common note durations, for use with any operation where the TimeEdu32 type is used.

Lua-supported.

Constructor & Destructor Documentation

◆ ~FCNoteEntry()

FCNoteEntry::~FCNoteEntry ( )

virtual

The destructor

Member Function Documentation

◆ AddArticulations()

int FCNoteEntry::AddArticulations	(	FCNoteEntry *	pSourceEntry,
		bool	bNoDuplicates = true )

Adds (appends to the existing ones) all articulations from another entry.

It's the caller's responsibility that the both source and destination entries are in the same document.

If the source entry has an articulation cache, that will be used as source. Otherwise, the articulations will load from the Finale database.

If articulations were added, the articulation flag is set for the entry. (The entry has to be saved separately through the TGF frame.)

Lua-supported.

Parameters

pSourceEntry	The entry to copy from.
bNoDuplicates	If true (default), articulations duplicates will not be copied.

Returns: Number of articulation added to the entry. If the note entry doesn't have an entry number to add the articulations to, 0 will be returned.

◆ AddNewNote()

FCNote * FCNoteEntry::AddNewNote ( )

Adds a new note to the chord.

Lua-supported.

Returns: NULL if no note could be added. Otherwise, the note object that was added to the collection.

◆ AddPitch()

int FCNoteEntry::AddPitch ( FCNote * pNote )

Adds a note to a chord.

Method will not do anything on rests.

Lua-supported.

Parameters

pNote The note to copy from.

Returns: Number of notes added to the chord. (Either 0 or 1.)

◆ AddPitches() [1/2]

int FCNoteEntry::AddPitches	(	FCNoteEntry *	pSourceEntry,
		bool	unique,
		bool	settie = false )

Adds (appends to the existing notes) all notes from another entry.

This method will not do anything on rests.

March 10, 2013: Changed so the full entry is now automatically set to update the accidentals for the frame.

Lua-supported.

Parameters

pSourceEntry	The entry to copy from.
unique	If true, only add note pitches that don't exist.
settie	If true, copy the tie state.

Returns: Number of notes added to the chord.

◆ AddPitches() [2/2]

int FCNoteEntry::AddPitches	(	FCNotePitches *	pPitches,
		bool	unique )

Adds (appends to the existing notes) all notes from a pith collection.

Method will not do anything on rests.

Parameters

pPitches	The pitch collection to copy from.
unique	If true, only add note pitches that don't exist.

Returns: Number of notes added to the chord.

◆ CacheArticulations()

void FCNoteEntry::CacheArticulations ( )

Stores the available articulations in a cache memory.

This is for the instances where the entry has been removed from the document (and the articulation data gets removed as well).

A cache will not be created if there isn't any articulations attached to the note.

If a articulation cache is available, it's used by the AddArticulations method.

Lua-supported.

◆ CalcBeamCount()

twobyte FCNoteEntry::CalcBeamCount ( )

inline

Returns the number of beams/flags for the entry, based on the duration.

This method will handle dotted values.

Lua-supported.

Returns: A quarter note will return 0, an eighth note will return 1, 16th note will return 2, etc.

◆ CalcBeamedGroupEnd()

bool FCNoteEntry::CalcBeamedGroupEnd ( )

Returns true if it's the end entry in a beamed group.

If the document preferences is set to extend beams over rests, rests might end beams.

Remarks: Beamed groups can be nested. Examples of nested beams are V2 beams nested inside V1 beams and grace note beams nested inside either of those. You can use CalcBeamStartEntry to find the first entry when CalcBeamedGroupEnd is true. You can use NextInBeamedGroup to iterate the entries in a beam from first to last entry.

This method requires that PDK_FRAMEWORK_PREFS is defined.

Lua-supported.

◆ CalcBeamStartEntry()

FCNoteEntry * FCNoteEntry::CalcBeamStartEntry ( )

Returns the start entry of the beamed group where the entry belongs. If the "Extend beams over rests" option is set, this method might return a rest.

This method requires that PDK_FRAMEWORK_PREFS is defined.

Returns: NULL if not part of a beamed group.

Lua-supported.

◆ CalcDisplacementMatchCount()

int FCNoteEntry::CalcDisplacementMatchCount ( FCNoteEntry * pCompareEntry )

Calculates the number of matching note displacements between the entries.

This method only checks matching displacements. (Keys, accidentals and everything else might differ between the entries.)

Lua-supported.

Parameters

[in] pCompareEntry The entry containing the notes to compare.

Returns: The number of displacement matches between the entries.

◆ CalcDisplacementRange()

twobyte FCNoteEntry::CalcDisplacementRange ( )

Calculates the range of the highest and lowest note in a chord.

Starting in v0.65, this method skips any notes that are suppressed due to voiced parts. (See FCPartStaffVoicing.) If you wish to process all notes, switch to the score before calling this function. (See FCPart::SwitchTo.)

Lua-supported.

Returns: 0 for single notes and rests. Otherwise, the range of the chord (normally in steps).

◆ CalcDisplaysAsRest()

bool FCNoteEntry::CalcDisplaysAsRest ( ) const

inline

Calculates if this entry displays as a rest in the current score or part view, taking into account the FCPartStaffVoicing settings for a voiced part (if any).

Note that Finale may combine several entries into a single displayed rest if all the notes have been suppressed in the current voiced part. There is no straightforward or reliable way to detect the actual displayed rest in this case.

Lua-supported (0.65)

◆ CalcDots()

twobyte FCNoteEntry::CalcDots ( )

inline

Returns the number of dots for a dotted entry.

Lua-supported.

◆ CalcDotsForDuration()

int FCNoteEntry::CalcDotsForDuration ( TimeEdu32 duration )

static

Static method that calculates the number of dots a specific duration would get.

Lua-supported.

Parameters

duration The duration in EDUs.

Returns: The number of dots that the duration would need. 0 for undotted duration values.

◆ CalcFlippable()

bool FCNoteEntry::CalcFlippable ( )

Signals if the entry would flip when the up/down state is changed.

Remarks: This function is more of a test to see if the entry breaks a beam than if it actually flips. However, rests get some special handling. For processing beams, you may be better off using CalcBeamStartEntry, CalcUnbeamedNote, and/or CalcBeamedGroupEnd.

Returns: True if the entry would flip (first in a beamed group or a single note), otherwise false. Rests are always false if FCMiscDocPrefs::GetExtendBeamsOverRests is false.

If the document preferences is set to extend beams over rests, rests might end beams.

This method requires that PDK_FRAMEWORK_PREFS is defined.

Lua-supported.

◆ CalcGraceNoteIndex()

int FCNoteEntry::CalcGraceNoteIndex ( )

Returns the grace note index for the entry.

The leftmost grace note in a grace note group has index 0, the second in the same group has index 1, and so on.

Lua-supported.

Returns: -1 if it isn't a grace note. Otherwise, the 0-based index.

◆ CalcHiddenThroughAltNotation()

bool FCNoteEntry::CalcHiddenThroughAltNotation ( )

Calculates if entry is hidden through alternate notation.

Since alternate notation might show the notes in different layers dependent on the settings, this method verifies if the entry really is hidden.

Lua-supported.

Returns: For an entry with normal notation, false is always returned. Otherwise, true if alternate notation hides the entry.

◆ CalcHighestDisplacement()

twobyte FCNoteEntry::CalcHighestDisplacement ( )

Calculates the highest displacement value found in the entry's chord.

Starting in v0.65, this method skips any notes that are suppressed due to voiced parts. (See FCPartStaffVoicing.) If you wish to process all notes, switch to the score before calling this function. (See FCPart::SwitchTo.)

Lua-supported.

Returns: 0 for rests. Otherwise, the highest displacement found in the entry's chord.

◆ CalcHighestNote()

FCNote * FCNoteEntry::CalcHighestNote ( FCNote * pCeiling = NULL )

Finds the note with the highest pitch in the chord.

Starting in v0.65, this method skips any notes that are suppressed due to voiced parts. (See FCPartStaffVoicing.) If you wish to process all notes, switch to the score before calling this function. (See FCPart::SwitchTo.)

Lua-supported.

Parameters

pCeiling If NULL, the highest pitch in the whole chord will be returned. Otherwise, the highest pitch that's lower than the "ceiling note" is returned. This note doesn't need to belong to the entry.

Returns: NULL for rests or if all pitches are suppressed in a voiced part. Otherwise the note object that contains the highest pitch. If there's no note lower than the ceiling note, NULL is also returned.

◆ CalcHighestPercussionNote()

FCNote * FCNoteEntry::CalcHighestPercussionNote ( )

For percussion notation, calculates the topmost percussion note.

Starting in v0.65, this method skips any notes that are suppressed due to voiced parts. (See FCPartStaffVoicing.) If you wish to process all notes, switch to the score before calling this function. (See FCPart::SwitchTo.)

Lua-supported.

◆ CalcHighestStaffPosition()

twobyte FCNoteEntry::CalcHighestStaffPosition ( )

Calculates the highest staff position for a note in the entry's chord.

Starting in v0.65, this method skips any notes that are suppressed due to voiced parts. (See FCPartStaffVoicing.) If you wish to process all notes, switch to the score before calling this function. (See FCPart::SwitchTo.)

Lua-supported.

Returns: 0 for rests. Otherwise, the highest staff position for a note in the entry's chord.

◆ CalcLargestNoteheadResize()

bool FCNoteEntry::CalcLargestNoteheadResize	(	FCNumber *	pLargestFontSize,
		FCNumber *	pLargestResize )

Calculates the largest point size and the largest notehead % resize for the entry.

This method requires that PDK_FRAMEWORK_PREFS are defined.

Lua-supported.

Parameters

pLargestFontSize	Pointer to FCNumber object where the largest font size will be stored.
pLargestResize	Pointer to FCNumber where the largest % resize will be stored.

Returns: true if the pointers have been filled with correct data. false on error or if it's a rest or if any of the pointers are NULL.

◆ CalcLastTupletEntry()

FCNoteEntry * FCNoteEntry::CalcLastTupletEntry ( FCTuplet * pTuplet )

Scans forward and returns the end entry of a tuplet that's connected to this entry object.

Lua-supported.

Returns: NULL on error, or if the end entry isn't found.

◆ CalcLowestBeamEnd()

int FCNoteEntry::CalcLowestBeamEnd ( )

Returns the lowest beam number ending at this entry, where 1 = 8th note beam, 2 = 16th note beam, etc.

This method requires that PDK_FRAMEWORK_PREFS is defined.

Returns: 0 if not beamed or no beam ends on this entry; 1 if the primary (8th note) beam ends on this entry; 2 or higher if a secondary beam ends on this entry.

Lua-supported (0.74).

◆ CalcLowestBeamStart()

int FCNoteEntry::CalcLowestBeamStart ( )

Returns the lowest beam number starting at this entry, where 1 = 8th note beam, 2 = 16th note beam, etc.

This method requires that PDK_FRAMEWORK_PREFS is defined.

Returns: 0 if not beamed or no beam starts on this entry; 1 if the primary (8th note) beam starts on this entry; 2 or higher if a secondary beam starts on this entry.

Lua-supported (0.74).

◆ CalcLowestBeamStub()

int FCNoteEntry::CalcLowestBeamStub ( )

Returns the lowest beam number that is a stand-alone beam stub. 1 = 8th note beam, 2 = 16th note beam, etc.

This method requires that PDK_FRAMEWORK_PREFS is defined.

Returns: 0 if not beamed or no beam stub exists on this entry; 1 if the primary (8th note) beam is a beam stub; 2 or higher if a secondary beam is a beam stub.

Lua-supported (0.74).

◆ CalcLowestDisplacement()

twobyte FCNoteEntry::CalcLowestDisplacement ( )

Calculates the lowest displacement value found in the entry's chord.

Starting in v0.65, this method skips any notes that are suppressed due to voiced parts. (See FCPartStaffVoicing.) If you wish to process all notes, switch to the score before calling this function. (See FCPart::SwitchTo.)

Lua-supported (0.55).

Returns: 0 for rests. Otherwise, the lowest displacement found in the entry's chord.

◆ CalcLowestNote()

FCNote * FCNoteEntry::CalcLowestNote ( FCNote * pFloor = NULL )

Finds the note with the lowest pitch in the chord.

Starting in v0.65, this method skips any notes that are suppressed due to voiced parts. (See FCPartStaffVoicing.) If you wish to process all notes, switch to the score before calling this function. (See FCPart::SwitchTo.)

Lua-supported.

Parameters

pFloor If NULL, the lowest pitch in the whole chord will be returned. Otherwise, the lowest pitch that's higher than the "floor note" is returned. This note doesn't need to belong to the entry.

Returns: NULL for rests or if all pitches are suppressed in a voiced part. Otherwise the note object that contains the lowest pitch. If there's no note higher than the floor note, NULL is also returned.

◆ CalcLowestPercussionNote()

FCNote * FCNoteEntry::CalcLowestPercussionNote ( )

For percussion notation, calculates the bottommost percussion note.

Starting in v0.65, this method skips any notes that are suppressed due to voiced parts. (See FCPartStaffVoicing.) If you wish to process all notes, switch to the score before calling this function. (See FCPart::SwitchTo.)

Lua-supported.

◆ CalcLowestStaffPosition()

twobyte FCNoteEntry::CalcLowestStaffPosition ( )

Calculates the lowest staff position for a note in the entry's chord.

Starting in v0.65, this method skips any notes that are suppressed due to voiced parts. (See FCPartStaffVoicing.) If you wish to process all notes, switch to the score before calling this function. (See FCPart::SwitchTo.)

Lua-supported (0.55).

Returns: 0 for rests. Otherwise, the lowest staff position for a note in the entry's chord.

◆ CalcMultiLayeredCell()

bool FCNoteEntry::CalcMultiLayeredCell ( )

Returns true if the entry is in a cell with multiple layers of music.

Lua-supported.

◆ CalcNondottedDuration()

TimeEdu32 FCNoteEntry::CalcNondottedDuration ( )

inline

Returns the non-dotted symbolic duration of the entry.

Example: A double-dotted quarter note will be returned as QUARTER_NOTE.

(Was earlier called 'GetNondottedDuration')

Lua-supported.

Returns: The non-dotted duration of the entry.

◆ CalcNondottedDurationForDuration()

TimeEdu32 FCNoteEntry::CalcNondottedDurationForDuration ( TimeEdu32 duration )

static

Static method that truncates duration to give only return the non-dotted duration value.

Lua-supported.

Parameters

duration Any input duration in EDUs.

Returns: The truncated duration in EDUs.

◆ CalcNumberOfVisibleNotes()

int FCNoteEntry::CalcNumberOfVisibleNotes ( ) const

Calculates the number of notes visible in the current score or part view, taking into account any that may not be displayed due to voiced part settings. (See FCPartStaffVoicing.)

Lua-supported (0.65)

◆ CalcResize()

twobyte FCNoteEntry::CalcResize ( )

Calculates the resize percent for the note entry.

This method loads the FCEntryAlterMod data for the note entry. It's provided as a more convenient approach to resized entries.

Lua-supported.

Returns: The resize value in percents.

◆ CalcSmallestNoteheadResize()

bool FCNoteEntry::CalcSmallestNoteheadResize	(	FCNumber *	pSmallestFontSize,
		FCNumber *	pSmallestResize )

Calculates the smallest point size and the smallest notehead % resize for the entry.

This method requires that PDK_FRAMEWORK_PREFS are defined.

Lua-supported.

Parameters

pSmallestFontSize	Pointer to FCNumber object where the smallest font size will be stored.
pSmallestResize	Pointer to FCNumber where the smallest % resize will be stored.

Returns: true if the pointers have been filled with correct data. false on error or if it's a rest or if any of the pointers are NULL.

◆ CalcStemLength()

twobyte FCNoteEntry::CalcStemLength ( )

Calculates the stem length, based on the entry metrics.

Call the MarkEntryMetricsForUpdate method if the entry-related layout info needs to be rebuilt.

Lua-supported.

Returns: -1 on error or if it's a rest. Otherwise, the stem length in EVPUs.

◆ CalcStemUp()

bool FCNoteEntry::CalcStemUp ( )

Returns the direction of the beam.

Call the MarkEntryMetricsForUpdate static method if the entry-related layout info needs to be rebuilt.

Lua-supported.

Returns: True if stem goes up. False if stem goes down.

◆ CalcUnbeamedNote()

bool FCNoteEntry::CalcUnbeamedNote ( )

Returns true if the entry is a non-beamed note (=not part of a beamed group.)

This method requires that PDK_FRAMEWORK_PREFS is defined.

Lua-supported.

◆ CalcUniquePitchString()

bool FCNoteEntry::CalcUniquePitchString ( FCString * pString )

Creates a "pitch ID" string for the entry.

The ID calculation itself is arbitrary, so don't use it for anything else than equal/not equal comparisons.
The idea is that a chord with the same pitch content should have the same ID.

Parameters

[in] pString The string buffer (a FCString object).

Returns: True on success.

◆ CalcValidDuration()

TimeEdu32 FCNoteEntry::CalcValidDuration ( TimeEdu32 duration )

static

Static method that calculates a valid note duration value by truncating the value if necessary.

If only non-dotted is required, use CalcNondottedDurationForDuration instead.

Lua-supported.

Parameters

duration A duration in EDUs to test.

Returns: 0 on error. Otherwise a valid (non-dotted or dotted) note duration.

◆ CalcWidestNoteheadWidth()

twobyte FCNoteEntry::CalcWidestNoteheadWidth ( )

Returns the widest width of a notehead in the entry, as the non-printing width.

The left side of the widest notehead is (kind of) a connection point for articulations on up-stem notes using stem side placement.

Lua-supported.

◆ ClassName()

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

◆ ClearPitches()

void FCNoteEntry::ClearPitches ( )

Clears all pitches from the entry, to prepare to add new notes.

This method will not turn the entry into a rest! Use this method rather than ClearAll().

Lua-supported.

◆ CopyEntry()

void FCNoteEntry::CopyEntry ( FCNoteEntry * pFromEntry )

Copies the duration and notes (or rest) from the source entry.

Flags for individual notes in the entry are copied, but the note entry flags (such as beam/beat and attachment flags) are not copied.

Lua-supported.

◆ CopyEntryDetails()

void FCNoteEntry::CopyEntryDetails	(	FCNoteEntry *	pFromEntry,
		bool	copytuplets )

Copies note-related data from another entry.

Entry details that are dependent on stem/beam direction are NOT copied.

These details are copied:

Articulations
Tuplets (optionally)
Note entry resize
Notehead mods
Accidental mods
Dot mods
MIDI performance data
Tie start mods
Tie end mods

FCArticulations * FCNoteEntry::CreateArticulations ( )

Creates a collection for all the articulations attached to the note entry.

The caller must delete the collection from the heap after use. (Not necessary with Lua.)

Lua-supported.

Returns: A collection with the articulations of the FCArticulations class.

◆ CreateNoteheadMods()

FCNoteheadMods * FCNoteEntry::CreateNoteheadMods ( )

Creates a collection for all the notehead modifications attached to the note entry.

The caller must delete the collection from the heap after use. (Not necessary with Lua.)

Lua-supported.

Returns: A collection with the notehead modifications of the FCNoteheadMods class.

◆ CreateNotePitches()

FCNotePitches * FCNoteEntry::CreateNotePitches ( )

Create local copies of the note pitches in a collection.

Returns: Pointer to the collection of note pitches. The pointer must be deleted from the heap after use.

◆ CreatePerformanceMods()

FCPerformanceMods * FCNoteEntry::CreatePerformanceMods ( )

Creates a collection for all the MIDI performance modifications attached to the note entry.

The caller must delete the collection from the heap after use. (Not necessary with Lua.)

Lua-supported.

Returns: A collection with the MIDI performance modifications of the FCPerformanceMods class.

◆ CreateTuplets()

FCTuplets * FCNoteEntry::CreateTuplets ( )

Creates a collection for all the tuplets connected to the note entry.

The caller must delete the collection from the heap after use. (Not necessary with Lua.)

Lua-supported.

Returns: A collection with the tuplets of the FCTuplets class.

◆ DeleteNote()

bool FCNoteEntry::DeleteNote ( FCNote * pNote )

Deletes a note from a chord. The note collection is rebuilt after the deletion.

Make sure to note make any assumption about the note states or positions within the entry after the delete.

Lua-supported.

Parameters

pNote Pointer to the note object to delete.

Returns: True if successful. False if the note wasn't found in the entry.

◆ FindDisplacement()

FCNote * FCNoteEntry::FindDisplacement ( twobyte displacement )

Tries to finds a note in the chord with a specific displacement value.

Lua-supported.

Parameters

[in] displacement The displacement value to match.

Returns: NULL for rests or if a matching note wasn't found. Otherwise the note object that contains the displacement value.

◆ FindNoteID()

FCNote * FCNoteEntry::FindNoteID ( twobyte noteID )

Finds the FCNote object that matches a specific note ID.

Lua-supported.

Parameters

[in] noteID The note ID to search for.

Returns: The pointer to the found note object. NULL if not found.

◆ FindPitch()

FCNote * FCNoteEntry::FindPitch ( FCNote * pPitchNote )

Tries to finds a note in the chord with the identical pitch as the suppied note.

Lua-supported.

Parameters

[in] pPitchNote Pointer to the note that should be matched in pitch.

Returns: NULL for rests or if a matching note wasn't found. Otherwise the note object that contains the identical pitch.

◆ GetActualDuration()

TimeEdu32 FCNoteEntry::GetActualDuration ( ) const

inline

Gets the actual duration of the entry. For tuplet entries, the symbolic duration would be different from the actual duration. Compare with the GetDuration method.

Lua-supported (also as property).

Returns: The actual of the entry.

◆ GetArticulationFlag()

bool FCNoteEntry::GetArticulationFlag ( ) const

inline

Returns true if the entry is marked to contain articulations.

Lua-supported (also as property).

◆ GetBeamBeat()

bool FCNoteEntry::GetBeamBeat ( ) const

inline

Gets the "beam/beat" flag state of the entry.

Lua-supported (also as property).

Returns: True if the entry is not a continuation of a beamed group.

◆ GetBeamExtensionFlag()

bool FCNoteEntry::GetBeamExtensionFlag ( ) const

inline

Returns true for beam extension detail records.

Lua-supported (also as property).

Returns: True = there is beam extension detail data.

◆ GetCheckAccidentals()

bool FCNoteEntry::GetCheckAccidentals ( ) const

Returns the accidental "refresh" flag.

Lua-supported (also as property).

◆ GetClefIndex()

eClef FCNoteEntry::GetClefIndex ( ) const

inline

Gets the clef that's used for the entry.

Use the FCClefDef class to load information about the clef.

Lua-supported (also as property).

Returns: The clef index.

◆ GetCombineRests()

bool FCNoteEntry::GetCombineRests ( ) const

Returns the flag for if the rest should combine.

Available only on Finale 2014 and above.

Returns: Always returns false on Finale versions lower than Finale 2014.

◆ GetCrossStaff()

bool FCNoteEntry::GetCrossStaff ( ) const

inline

Returns the cross staff state for the entry.

Lua-supported (also as property).

Returns
True if the entry contains a cross staff note.

◆ GetDuration()

TimeEdu32 FCNoteEntry::GetDuration ( ) const

inline

Gets the symbolic duration of the entry. For tuplet entries, the symbolic duration would be different from the actual duration. Compare with the GetActualDuration method.

Lua-supported (also as property).

Returns: The duration of the entry.

◆ GetEntryNumber()

ENTNUM FCNoteEntry::GetEntryNumber ( ) const

inline

Returns the internal entry number (ID) for the note entry.

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

◆ GetFlatBeam()

bool FCNoteEntry::GetFlatBeam ( ) const

inline

Gets the "flat beam" state of the entry.

The beam is only visually affected if the entry is first in a beamed group.

Lua-supported (also as property).

Returns: True if the entry has a flat beam.

◆ GetFlipTie()

bool FCNoteEntry::GetFlipTie ( ) const

inline

Gets the "flip tie" state of the note entry.

Lua-supported (also as property).

◆ GetFloatingRest()

bool FCNoteEntry::GetFloatingRest ( ) const

inline

Gets the floating rest status of the entry.

Lua-supported (also as property).

Returns: True = Floating rest, false = vertically moved rest.

◆ GetFreezeBeam()

bool FCNoteEntry::GetFreezeBeam ( ) const

inline

Gets the freeze state for the "beam/beat".

Lua-supported (also as property).

◆ GetFreezeStem()

bool FCNoteEntry::GetFreezeStem ( ) const

inline

Gets the "Freeze Stem" state for the note entry.

Lua-supported (also as property).

◆ GetGraceNote()

bool FCNoteEntry::GetGraceNote ( ) const

inline

Gets the grace note state of the note entry.

Lua-supported (also as property).

Returns: True if the entry is a grace note, false for normal note.

◆ GetGraceNoteSlash()

bool FCNoteEntry::GetGraceNoteSlash ( ) const

inline

Gets the grace note slash state of the note entry.

Lua-supported (also as property).

Returns: True if the grace note should be slashed, false if it shouldn't have slash.

◆ GetItemAt()

FCNote * FCNoteEntry::GetItemAt ( int index ) const

inline

Overload version of GetItemAt(), which returns a note object (if available) for the note entry.

Lua-supported.

◆ GetLayerNumber()

twobyte FCNoteEntry::GetLayerNumber ( ) const

inline

Returns the 1-based layer number that the entry belongs to.

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

◆ GetLedgerLines()

bool FCNoteEntry::GetLedgerLines ( ) const

inline

Gets the ledger line state for the note entry.

Lua-supported (also as property).

Returns: True if ledger lines are used for the entry.

◆ GetLegality()

bool FCNoteEntry::GetLegality ( ) const

inline

Gets the legality bit, that marks that the entry is valid.

All entries should have this bit set to be valid to Finale.

Lua-supported (also as property).

◆ GetLyricFlag()

bool FCNoteEntry::GetLyricFlag ( ) const

inline

Returns the flag that marks that an entry has syllable attached to it.

Lua-supported.

◆ GetManualPosition()

Evpu16 FCNoteEntry::GetManualPosition ( ) const

inline

Gets the manual positioning of the entry.

Lua-supported (also as property).

◆ GetMeasure()

twobyte FCNoteEntry::GetMeasure ( ) const

inline

Returns the entry's measure.

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

Returns: The measure that the entry belongs to.

◆ GetMeasurePos()

TimeEdu32 FCNoteEntry::GetMeasurePos ( ) const

inline

Returns the elapsed duration position in the measure for the entry.

First entry in measure starts at 0. Please note that the position is based on duration, not on measurement.

Lua-supported (also as property).

Returns: The elapsed position for the note entry, in EDUs.

◆ GetNoteDetailFlag()

bool FCNoteEntry::GetNoteDetailFlag ( ) const

inline

Returns true for existing note detail records.

Lua-supported (also as property).

Returns: True = there are available note detail data.

◆ GetPerformanceDataFlag()

bool FCNoteEntry::GetPerformanceDataFlag ( ) const

inline

Returns true for existing performance data records.

Use the FCPerformanceMod class to access the performance data.

Lua-supported (also as property).

Returns: True = there are available performance data.

◆ GetPlayback()

bool FCNoteEntry::GetPlayback ( ) const

inline

Gets the playback state of the note entry.

Lua-supported (also as property).

Returns: True to allow playback, false to mute.

◆ GetRestDisplacement()

twobyte FCNoteEntry::GetRestDisplacement ( )

Returns the rest displacement.

Lua-supported.

Returns: 0 if the rest is non-movable or if it's a note. Otherwise, the displacement for the rest.

◆ GetReverseDownStem()

bool FCNoteEntry::GetReverseDownStem ( ) const

inline

Gets the reverse stem setting for down stem.

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

◆ GetReverseUpStem()

bool FCNoteEntry::GetReverseUpStem ( ) const

inline

Gets the reverse stem setting for up stem.

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

◆ GetSecondaryBeamFlag()

bool FCNoteEntry::GetSecondaryBeamFlag ( ) const

inline

Returns true for secondary beam detail records.

Lua-supported (also as property).

Returns: True = there is secondary beam detail data.

◆ GetSmartShapeFlag()

bool FCNoteEntry::GetSmartShapeFlag ( ) const

inline

Returns true if the entry is marked to contain smart shapes.

Lua-supported (also as property).

◆ GetSpacing()

bool FCNoteEntry::GetSpacing ( ) const

inline

Gets the music spacing state of the note entry.

Lua-supported (also as property).

Returns: True includes it in music spacing, false excludes it from spacing.

◆ GetSpecialAltsFlag()

bool FCNoteEntry::GetSpecialAltsFlag ( ) const

inline

Returns true for existing special alteration records.

Lua-supported (also as property).

Returns: True = there are available special alteration data.

◆ GetSplitRest()

bool FCNoteEntry::GetSplitRest ( ) const

inline

Gets the split rest state of the note entry. (Applies if note entry is a rest.)

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

Returns: True if the rest splits from other layers, false if it combines.

◆ GetSplitStem()

bool FCNoteEntry::GetSplitStem ( ) const

inline

Gets the "Split Stem" state for the note entry.

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

◆ GetStaff()

twobyte FCNoteEntry::GetStaff ( ) const

inline

Returns the entry's staff.

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

Returns: The staff that the entry belongs to.

◆ GetStemDetailFlag()

bool FCNoteEntry::GetStemDetailFlag ( ) const

inline

Gets the flag state for stem detail records.

Lua-supported (also as property).

Returns: True = there is stem detail data.

◆ GetStemUp()

bool FCNoteEntry::GetStemUp ( ) const

inline

Returns the state of the "up" bit for the entry. This is NOT the same as the true direction for the stem!

To get the true direction of a stem for an entry, use the CalcStemUp method.

Lua-supported (also as property).

Returns: True if the "up" bit is set.

◆ GetTupletStartFlag()

bool FCNoteEntry::GetTupletStartFlag ( ) const

inline

Returns true if the entry is marked to start a tuplet.

Lua-supported (also as property).

◆ GetVisible()

bool FCNoteEntry::GetVisible ( ) const

inline

Gets the visibility state of the note entry.

Lua-supported (also as property).

Returns: True shows the entry, false hides it.

◆ GetVoice2()

bool FCNoteEntry::GetVoice2 ( ) const

inline

Returns true if it's a voice 2 entry.

Lua-supported (also as property).

◆ GetVoice2Launch()

bool FCNoteEntry::GetVoice2Launch ( ) const

inline

Returns true if the entry launches voice 2.

Lua-supported (also as property).

◆ HasSameNotes()

bool FCNoteEntry::HasSameNotes ( FCNoteEntry * pEntry )

Compares the notes with the notes in another note entry.

Lua-supported.

Returns: True if all notes matches between the entries, or if both entries are rests.

◆ IsAllTied()

bool FCNoteEntry::IsAllTied ( )

Returns true if all of the notes in the chord is tied to the next entry.

Lua-supported.

Returns: Always returns false if the entry is a rest.

◆ IsAllTiedBackwards()

bool FCNoteEntry::IsAllTiedBackwards ( )

Returns true if all of the notes in the chord has a flagged to be tied from the previous entry.

Lua-supported.

Returns: Always returns false if the entry is a rest.

◆ IsDotted()

bool FCNoteEntry::IsDotted ( )

Returns true if it's a dotted entry.

Lua-supported.

◆ IsLastInMeasure()

bool FCNoteEntry::IsLastInMeasure ( )

inline

Returns true if it's the last entry in the measure frame.

Lua-supported.

◆ IsNote()

bool FCNoteEntry::IsNote ( )

inline

Returns true if entry is a note.

Lua-supported.

Returns: True if it's a note, false if entry is a rest.

◆ IsOverlappedEntry()

bool FCNoteEntry::IsOverlappedEntry ( FCNoteEntry * pTestEntry )

Returns true if the test entry is at least partly overlapping the current entry.

The method checks the left/right overlap only. Entries can be placed on different staves and still overlap.

Lua-supported.

Parameters

pTestEntry Entry to test against.

◆ IsPartOfTuplet()

bool FCNoteEntry::IsPartOfTuplet ( )

Returns true if the entry is part of a tuplet.

This method only works correctly if the frame has been accurately saved.

Lua-supported.

◆ IsPartOfTupletParam()

bool FCNoteEntry::IsPartOfTupletParam ( TupletInfo * pInfoStorage = NULL )

Returns true if the entry is part of a tuplet (parameter version).

This method only works correctly if the frame has been accurately saved.

Parameters

pInfoStorage The optional pointer to where information about the matching tuplet should be copied.

◆ IsRest()

bool FCNoteEntry::IsRest ( ) const

inline

Returns true if entry is a rest.

Lua-supported.

Returns: True if it's a rest, false if entry is a note.

◆ IsRestMovable()

bool FCNoteEntry::IsRestMovable ( )

Returns true if it's a movable rest.

Lua-supported.

◆ IsStartOfTuplet()

bool FCNoteEntry::IsStartOfTuplet ( )

Returns true if the entry is the start of a tuplet.

This method only works correctly if the frame has been accurately saved. It goes deeper than just looking at the entry's tuplet flag.

Lua-supported.

◆ IsStartOfTupletParam()

bool FCNoteEntry::IsStartOfTupletParam ( TupletInfo * pInfoStorage = NULL )

Returns true if the entry is the start of a tuplet (parameter version).

This method only works correctly if the frame has been accurately saved. It goes deeper than just looking at the entry's tuplet flag.

Parameters

pInfoStorage The optional pointer to where information about the matching tuplet should be copied.

◆ IsTied()

bool FCNoteEntry::IsTied ( )

Returns true if any of the notes in the chord is tied to the next entry.

Lua-supported.

Returns: Always returns false if the entry is a rest.

◆ IsTiedBackwards()

bool FCNoteEntry::IsTiedBackwards ( )

Returns true if any of the notes in the chord is flagged to be tied from the previous entry.

Lua-supported.

Returns: Always returns false if the entry is a rest.

◆ IsTiedToPrevious()

bool FCNoteEntry::IsTiedToPrevious ( )

Return true if the previous entry has a tie to this entry.

This method will not scan past the layer/cell boundaries. If the previous entry is further away than 1 measure, it's not considered to be a tie.

Lua-supported.

◆ IsValidDuration()

bool FCNoteEntry::IsValidDuration ( TimeEdu32 duration )

static

Static method that evaluates the validity of a duration value.

Lua-supported.

Parameters

duration A duration in EDUs to test.

Returns: Returns true if the duration can correctly be notated as a non-dotted or dotted note.

◆ MakeMovableRest()

void FCNoteEntry::MakeMovableRest ( )

Turns the entry into a movable rest.

Lua-supported.

◆ MakeNote()

void FCNoteEntry::MakeNote ( )

Turns the entry into a note.

Lua-supported.

◆ MakeRest()

void FCNoteEntry::MakeRest ( )

Turns the entry into a rest (without any displacement).

By design, this function sets the following properties to false:

SetNoteFlag
SetNoteDetailFlag
SetSpecialAltsFlag
SetArticulationFlag

If you want to preserve them, you must save and restore them. Otherwise, be sure to delete any of these items before calling MakeRest.

Lua-supported.

◆ MarkEntryMetricsForUpdate()

static void FCNoteEntry::MarkEntryMetricsForUpdate ( )

inlinestatic

Static method that mark that the entry-related layout info needs to be rebuilt (for CalcStemUp(), for example).

It will also set the flag to rebuild the cell metrics, since that is used for some entry-related calculations. This flag is cleared once the metrics has been rebuilt internally.

Lua-supported.

◆ Next()

FCNoteEntry * FCNoteEntry::Next ( )

inline

Returns the next entry in the loaded entry chain (within the same layer).

Please note that what this method will return is dependent on how the owner loaded the TGF data.

Lua-supported.

Returns: The pointer to the next object in the chain. NULL if the entry is in the end of the chain.

◆ NextInBeamedGroup()

FCNoteEntry * FCNoteEntry::NextInBeamedGroup ( )

inline

Returns the next note entry in a beamed group or NULL if there is none.

You can use this function to iterate the entries in a beamed group. Frequently you will start with an entry returned by CalcBeamStartEntry, but this is not required. This function skips over nested beams and iterates through only the entries associated with the beam that contains the current instance of FCNoteEntry. (See CalcBeamedGroupEnd for additional comments about nested beams.)

This method requires that PDK_FRAMEWORK_PREFS is defined.

Lua-supported (0.72).

Returns: the next entry is the beamed group or NULL if this entry is not beamed or is the last in the beam.

◆ NextInFrame()

FCNoteEntry * FCNoteEntry::NextInFrame ( )

inline

Returns the next note entry in the linked collection (layer or cell), but only within the frame.

Lua-supported (0.72).

Returns: NULL if it's the last entry, or if the next linked entry belongs to another measure or TGF layer.

◆ NextSameVInFrame()

FCNoteEntry * FCNoteEntry::NextSameVInFrame ( )

Returns the next note entry in the same V1 or V2 within the current frame. If the current instance of FCNoteEntry is V2, only the current V2 launch is searched.

Lua-supported (0.72).

Returns: NULL if no next note entry found in the current frame with matching V1 or V2.

◆ Previous()

FCNoteEntry * FCNoteEntry::Previous ( )

inline

Returns the previous note entry in the linked collection (layer or cell).

This method looks past frames, if the owner collection supports it.

Lua-supported.

Returns: NULL if it's the first entry.

◆ PreviousInBeamedGroup()

FCNoteEntry * FCNoteEntry::PreviousInBeamedGroup ( )

inline

Returns the previous note entry in a beamed group or NULL if there is none.

You can use this function to iterate the entries in a beamed group. Frequently you will start with an entry where by CalcBeamedGroupEnd is true, but this is not required. This function skips over nested beams and iterates through only the entries associated with the beam that contains the current instance of FCNoteEntry. (See CalcBeamedGroupEnd for additional comments about nested beams.)

This method requires that PDK_FRAMEWORK_PREFS is defined.

Lua-supported (0.72).

Returns: the previous entry is the beamed group or NULL if this entry is not beamed or is the first in the beam.

◆ PreviousInFrame()

FCNoteEntry * FCNoteEntry::PreviousInFrame ( )

inline

Returns the previous note entry in the linked collection (layer or cell), but only within the frame.

Lua-supported.

Returns: NULL if it's the first entry, or if the previous linked entry belongs to another measure or TGF layer.

◆ PreviousSameVInFrame()

FCNoteEntry * FCNoteEntry::PreviousSameVInFrame ( )

Returns the previous note entry in the same V1 or V2 within the current frame. If the current instance of FCNoteEntry is V2, only the current V2 launch is searched.

Lua-supported (0.72).

Returns: NULL if no previous note entry found in the current frame with matching V1 or V2.

◆ RelinkToCurrentView()

bool FCNoteEntry::RelinkToCurrentView ( )

Relinks the unlinkable items in the current view so that the score and part(s) match.

If the current edit focus is the score, the parts are relinked to the score. If the current edit focus is a part, all parts and score are linked with the values in the current part.

You do not need to save the FCNoteEntry for the relink to take effect. Lua scripts may use either eachentry, eachentrysaved, or any other iteration technique, and the relink still happens.

As of Finale 27.3, the following properties are unlinkable in FCNoteEntry:

GetFreezeStem
GetManualPosition
GetStemUp

This function relinks them all. Finale provides no means for a plugin to relink them selectively. That said, you can relink them all and then re-unlink the items yourself that you want to keep unlinked. For this to work, you need to use eachentrysaved. Here is an example of how relink feeze stems while keeping manual positioning unlinked. (Run it with the part in edit focus.)

-- start with the part in edit focus
for entry in eachentrysaved(finenv.Region()) do
    -- save the unlinked manual positioning
    local manpos = entry.ManualPosition
    -- relink all unlinkable entry values to the score values
    entry:RelinkToScore()
    -- restore the unlinked manual positioning, which also unlinks it if the part is in edit focus.
    entry.ManualPosition = manpos
end

Lua-supported (0.67).

Returns: success if true

◆ RelinkToScore()

bool FCNoteEntry::RelinkToScore ( )

Relinks the unlinkable items in all parts to the contents of the score.

See additional comments at RelinkToCurrentView.

Lua-supported (0.67).

Returns: success if true

◆ SetAccidentals()

void FCNoteEntry::SetAccidentals ( bool bAccidental )

Sets/removes accidental display for all chord notes in the entry.

This method doesn't affect rests.

Lua-supported.

Parameters

bAccidental true - puts accidentals on all chord notes for the note entry. false - remove accidentals for all chord notes.

void FCNoteEntry::SetClefIndex ( eClef clef )

inline

Sets the clef index for the entry.

Note that this value is not saved. By rights, ClefIndex should be a read-only property, but the setter exists for backwards compatibility. The class instance remembers the changed value but it isn't saved and has no effect. Use FCCellFrameHold to change the clef.

Lua-supported (also as property).

◆ SetCombineRests()

void FCNoteEntry::SetCombineRests ( bool state )

Sets the flag for if the rest should combine.

Available only on Finale 2014 and above (will do nothing on pre-Fin2014).

Lua-supported (also as property).

◆ SetCrossStaff()

void FCNoteEntry::SetCrossStaff ( bool state )

inline

Sets the cross staff state for the entry.

Generally speaking you do not need to use this method to create cross-staff notes. Instead, create the note's FCCrossStaffMod. Saving it sets all the required flags automatically.

Lua-supported (also as property).

Parameters

state Set to true if the entry contains a cross staff note.

◆ SetDuration()

void FCNoteEntry::SetDuration ( TimeEdu32 duration )

inline

Sets the symbolic duration of the note. For tuplet entries, the symbolic duration would be different from the actual duration.

Lua-supported (also as property).

Parameters

duration The duration of the entry.

◆ SetFlatBeam()

void FCNoteEntry::SetFlatBeam ( bool state )

inline

Sets the "flat beam" state of the entry.

The beam is only affected if the entry is first in a beamed group.

Lua-supported (also as property).

Parameters

void FCNoteEntry::SetFreezeStem ( bool state )

inline

Sets the "Freeze Stem" state for the note entry.

Remarks: If you flip the stem from its current direction using SetFreezeStem or any other mechanism, you must save all entries and rebuild metrics (MarkEntryMetricsForUpdate) before creating or modifying any of the entry mods that depend on stem direction. Examples of entry mods that depend on stem direction include FCBeamMod, FCCustomStemMod, and FCBeamExtensionMod.

Lua-supported (also as property).

◆ SetGraceNote()

void FCNoteEntry::SetGraceNote ( bool state )

inline

Sets the grace note state of the note entry.

Lua-supported (also as property).

Parameters

state True for grace note, false for normal note.

◆ SetGraceNoteSlash()

void FCNoteEntry::SetGraceNoteSlash ( bool state )

inline

Sets the slashed state for a grace note entry.

Lua-supported (also as property).

Parameters

state True for a grace note slash, false for no slash.

◆ SetLedgerLines()

void FCNoteEntry::SetLedgerLines ( bool state )

inline

Sets the ledger line state for the note entry.

Lua-supported (also as property).

Parameters

state True to turn on ledger lines for the entry.

◆ SetLegality()

void FCNoteEntry::SetLegality ( bool state )

inline

Sets the legality bit, marking that the entry is valid.

All entries should have this bit set to be valid to Finale.

Lua-supported (also as property).

Parameters

state True to set the entry as valid.

◆ SetLyricFlag()

void FCNoteEntry::SetLyricFlag ( bool state )

inline

Sets the flag that marks that an entry has syllable attached to it.

Lua-supported (also as property).

◆ SetManualPosition()

void FCNoteEntry::SetManualPosition ( Evpu16 pos )

inline

Sets the manual positioning of the entry.

Lua-supported (also as property).

◆ SetMeasurePos()

void FCNoteEntry::SetMeasurePos ( TimeEdu32 value )

inline

Sets the elapsed position in the measure for the entry.

First entry in measure starts at 0. This is a diagnostic value only, but for some future calculations this value can be good to set when changing durations of previous entries.

USE WITH CARE!

Lua-supported (also as property).

Parameters

value The ellapsed position for the note entry, in EDUs.

◆ SetNoteDetailFlag()

void FCNoteEntry::SetNoteDetailFlag ( bool state )

inline

Sets the flag state for note detail records.

Lua-supported (also as property).

Parameters

state True = there are available note detail data.

void FCNoteEntry::SetRestDisplacement ( twobyte value )

Sets the displacement for a rest entry.

If the rest isn't movable, it's changed to a movable rest. This method does nothing for non-rests.

Lua-supported.

◆ SetReverseDownStem()

void FCNoteEntry::SetReverseDownStem ( bool state )

inline

Sets the reverse stem setting for down stem.

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

◆ SetReverseUpStem()

void FCNoteEntry::SetReverseUpStem ( bool state )

inline

Sets the reverse stem setting for up stem.

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

◆ SetSecondaryBeamFlag()

void FCNoteEntry::SetSecondaryBeamFlag ( bool state )

inline

Sets the flag state for secondary beam detail records.

Lua-supported (also as property).

Parameters

void FCNoteEntry::SetSplitStem ( bool state )

inline

Sets the "Split Stem" state for the note entry.

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

◆ SetStemDetailFlag()

void FCNoteEntry::SetStemDetailFlag ( bool state )

inline

Sets the flag state for stem detail records.

Lua-supported (also as property).

Parameters

state True = there is stem detail data.

◆ SetStemUp()

void FCNoteEntry::SetStemUp ( bool state )

inline

Sets the "stem up" flag for the entry.

The stem will use this setting if it is a "beam/beat" entry (in other words, if it is not a continuation of a beamed group).

Remarks: See comments at SetFreezeStem about flipping the current stem direction. If you want the up/down status here to stick, you must also set SetFreezeStem to true.

Lua-supported (also as property).

Parameters

state True to put the stems up.

◆ SetTupletStartFlag()

void FCNoteEntry::SetTupletStartFlag ( bool state )

inline

Sets the flag that marks that a tuplet starts on the entry.

Lua-supported (also as property).

◆ SetVisible()

void FCNoteEntry::SetVisible ( bool state )

inline

Sets the visibility state of the note entry.

Lua-supported (also as property).

Parameters

state True to show the entry, false to hide it.

◆ SetVoice2()

void FCNoteEntry::SetVoice2 ( bool state )

inline

Sets the voice 2 status for the entry.

Lua-supported (also as property).

◆ SetVoice2Launch()

void FCNoteEntry::SetVoice2Launch ( bool state )

inline

Sets the entry that controls the launch of voice 2.

Lua-supported (also as property).

◆ TieAll()

void FCNoteEntry::TieAll ( bool bTie )

Ties or unties all chord notes for the entry.

This method doesn't affect rests.

Lua-supported.

Parameters

bTie	true - tie all chord notes for the note entry. false - untie all chord notes.

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ENTRY_DURATIONS

Constructor & Destructor Documentation

◆ ~FCNoteEntry()

Member Function Documentation

◆ AddArticulations()

◆ AddNewNote()

◆ AddPitch()

◆ AddPitches() [1/2]

◆ AddPitches() [2/2]

◆ CacheArticulations()

◆ CalcBeamCount()

◆ CalcBeamedGroupEnd()

◆ CalcBeamStartEntry()

◆ CalcDisplacementMatchCount()

◆ CalcDisplacementRange()

◆ CalcDisplaysAsRest()

◆ CalcDots()

◆ CalcDotsForDuration()

◆ CalcFlippable()

◆ CalcGraceNoteIndex()

◆ CalcHiddenThroughAltNotation()

◆ CalcHighestDisplacement()

◆ CalcHighestNote()

◆ CalcHighestPercussionNote()

◆ CalcHighestStaffPosition()

◆ CalcLargestNoteheadResize()

◆ CalcLastTupletEntry()

◆ CalcLowestBeamEnd()

◆ CalcLowestBeamStart()

◆ CalcLowestBeamStub()

◆ CalcLowestDisplacement()

◆ CalcLowestNote()

◆ CalcLowestPercussionNote()

◆ CalcLowestStaffPosition()

◆ CalcMultiLayeredCell()

◆ CalcNondottedDuration()

◆ CalcNondottedDurationForDuration()

◆ CalcNumberOfVisibleNotes()

◆ CalcResize()

◆ CalcSmallestNoteheadResize()

◆ CalcStemLength()

◆ CalcStemUp()

◆ CalcUnbeamedNote()

◆ CalcUniquePitchString()

◆ CalcValidDuration()

◆ CalcWidestNoteheadWidth()

◆ ClassName()

◆ ClearPitches()

◆ CopyEntry()

◆ CopyEntryDetails()

◆ CopyEntryPercussionDetails()

◆ CopyNote()

◆ CopyNotes()

◆ CreateArticulations()

◆ CreateNoteheadMods()

◆ CreateNotePitches()

◆ CreatePerformanceMods()

◆ CreateTuplets()

◆ DeleteNote()

◆ FindDisplacement()

◆ FindNoteID()

◆ FindPitch()

◆ GetActualDuration()

◆ GetArticulationFlag()

◆ GetBeamBeat()

◆ GetBeamExtensionFlag()

◆ GetCheckAccidentals()

◆ GetClefIndex()

◆ GetCombineRests()

◆ GetCrossStaff()

◆ GetDuration()

◆ GetEntryNumber()

◆ GetFlatBeam()

◆ GetFlipTie()