FCNoteheadMod Class Reference

Class for notehead modifications (as in Finale's Special Tools). More...

#include <ff_entrydetails.h>

Inheritance diagram for FCNoteheadMod:

Public Member Functions
const char *	ClassName () const override
	Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child class.
const PDKFRAMEWORK_CLASSID	GetClassID () const override
	Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has problems to resolve the true classes of inherited objects.
	FCNoteheadMod ()
	The constructor.
twobyte	GetHorizontalPos () const
	Returns the horizontal position for the notehead.
twobyte	GetVerticalPosIfPossible ()
	Returns the vertical position for the notehead, but only if the value has been enabled for Finale.
twobyte	GetVerticalPos () const
	Returns the vertical position for the notehead.
bool	GetUseCustomVerticalPos () const
	Returns true if vertical position can be set.
eUniChar32	GetCustomChar () const
	Returns the custom notehead, it any.
bool	GetUseCustomChar () const
	Returns true if there's a custom notehead.
twobyte	GetResize () const
	Returns the notehead resize in percent.
bool	GetUseCustomFont () const
	Returns if a custom font is used for the notehead or not.
const char *	GetFontName () const
	Gets the font name for the notehead.
const eUniChar16 *	GetFontNameUTF16 () const
	Gets the font name for the notehead.
twobyte	GetFontSize () const
	Returns the custom font size.
bool	GetFontStyle (FCFontInfo *pInfo)
	Gets only the font style (such as italics, bold etc) into the FCFontInfo object, for custom fonts records.
bool	GetFontInfo (FCFontInfo *pInfo)
	Gets all the font info (name, style, size) into the FCFontInfo object, for custom fonts records.
bool	GetEnharmonicFlip () const
	Returns if the notehead has been enharmonically flipped.
void	SetHorizontalPos (twobyte value)
	Sets the horizontal position for the notehead.
void	SetVerticalPos (twobyte value)
	Sets the vertical position for the notehead.
void	SetUseCustomVerticalPos (bool status)
	Marks if a custom vertical position should be used for the notehead or not.
void	SetUseDefaultVerticalPos (bool status)
	Clears and uses the default vertical positioning.
void	SetResize (twobyte value)
	Sets the notehead resize in percent.
void	SetUseCustomFont (bool status)
	Marks if a custom font should be used for the notehead or not.
void	SetUseDefaultFont (bool status)
	The reverse functionality of SetUseCustomFont.
void	SetFontName (const char *pszFont)
	Sets the font name for the notehead.
void	SetFontNameUTF16 (const eUniChar16 *pszFont)
	Sets the font name for the notehead.
void	SetFontSize (twobyte fontsize)
	Sets the font size for the notehead.
void	SetFontStyle (FCFontInfo *pInfo)
	Sets the font style only (such as italics, bold, etc), based on the style info in the FCFontInfo object.
void	SetFontInfo (FCFontInfo *pInfo)
	Sets all the font info (name, style, size) to the info available in the FCFontInfo object.
void	SetCustomChar (eUniChar32 ch)
	Sets the font character for the notehead.
void	SetEnharmonicFlip (bool status)
	Marks if the notehead should be enharmonically flipped.
void	ClearChar ()
	Clears the font character for the notehead to use the default notehead character.
void	SetNoteID (twobyte id) override
	Sets the note ID for the notehead, so it maps to the note.
Public Member Functions inherited from __FCEntryDetailNoteID
	__FCEntryDetailNoteID ()
	The constructor.
bool	SaveNew () override
	Overridden method for SaveNew()
bool	SaveAt (FCNote *pNote)
	Saves the note entry modifications in a slot and sets the correct flag in the associated note entry.
bool	LoadAt (FCNote *pNote)
	Tries to find and load the note entry modifications based on the note ID.
bool	EraseAt (FCNote *pNote)
	Deletes the note entry modifications for a slot and adjusts the flag in the associated note entry.
Public Member Functions inherited from __FCEntryDetail
	__FCEntryDetail ()
	The constructor.
void	SetEntnumAndInci (ENTNUM entnum, twobyte inci)
	Sets the entry number reference and inci for the object.
virtual bool	Load (ENTNUM entnum, twobyte inci)
	Loads the data at the given entry number and inci.
bool	Reload () override
	Overridden Reload() method, that supports complex (mixed) data.
bool	SaveAs (ENTNUM entnum, twobyte inci)
	Saves the data at the given entry number and inci.
bool	LoadFirst () override
	Overloaded version of LoadFirst that will load the first inci for the entry. SetNoteEntry must be called first.
bool	LoadNext () override
	Overloaded version of LoadNext.
virtual void	SetNoteEntry (FCNoteEntry *pEntry)
	Maps the data to an entry.
FCNoteEntry *	GetNoteEntry ()
	Returns a pointer to the mapped note entry.
twobyte	GetItemInci () const
	Returns the inci number for the stored object.
ENTNUM	GetItemEntryNumber () const
	Returns the note entry number for the stored object.
void	DebugDump () override
	Outputs the class data/information for debugging purposes.
Public Member Functions inherited from __FCBaseData
EDOCID	GetConnectedDocID () const
	Returns the document ID that was connected to the last load/save of the data.
bool	VerifyConnectedDocID ()
	Checks that the stored document ID for the data object matches the current document's ID.
virtual EXTAG	Tag () const =0
	The Enigma tag for the derived class.
virtual EVERSION	EnigmaVersion () const
	The Enigma version for save/load/create/delete operations.
virtual int	DataSizeLoad () const =0
	Returns the data size for the data structure that should be loaded.
virtual int	DataSizeSave () const
	Returns the data size for the data structure that should be saved or created.
void	_CloneFrom (__FCBaseData *pSource)
	For internal use only. Copies object data (except data block) from another object.
virtual void	CloneMemoryFrom (__FCBaseData *pSource)
const EDataID *	_GetDataID ()
	Intended ONLY for the _CloneFrom implementation.
int	_GetLoadedSize () const
	Intended ONLY for the _CloneFrom implementation.
const void *	GetDataBlock ()
	Intended ONLY for the _CloneFrom implementation.
EXTAG	GetCustomTag () const
	Returns the custom Enigma tag, if any.
void	SetCustomTag (EXTAG tag)
	Sets the custom Enigma tag, for classes that support multiple Enigma tags.
	__FCBaseData ()
	The constructor.
virtual	~__FCBaseData ()
	Virtual destructor.
virtual bool	Save ()
	Saves the currently loaded to its current location.
virtual bool	DeleteData ()
	Deletes the associated data from Finale's database. Be careful when deleting multiple objects.
virtual bool	DeepDeleteData ()
	Deletes data and all data that's connected to the object.
virtual bool	LoadLast ()
	Loads the very last element in the database, if any.
virtual bool	LoadPrevious ()
	Loads the previous element in the database, if any.
bool	RelinkToCurrentView ()
	Relinks the contents in the current view so that the score and part(s) match.
bool	RelinkToScore ()
	Relinks all parts to the contents of the score.
__FCBaseData *	CreateClone ()
	Creates an identical copy of an object.
void	DebugDataDump () override
	Outputs a memory dump of the data block in the object for debugging purposes.
void	DebugDataByteArrayDump () override
	Outputs a memory dump of the data block in the object for debugging purposes, as a C++ byte array.
void	DebugDataOffsetDump (int offset, int size)
	For debug mode only. Dumps a data memory block at a specific offset and with a specific size.
FCNumbers *	CreateRawDataDump ()
	Creates a byte collection with the raw loaded data block for the object (if the object type supports single data blocks). This method is only intended for debug purposes.
Public Member Functions inherited from __FCBase
virtual	~__FCBase ()
	Virtual destructor, so all inherited classes get the virtual destructor.
void	DebugMsgInt (const char *pszPrefixText, int i)
	Creates a simple Message Box for debug purposes. The text appears with the extra digit (in decimal presentation) appearing afterwards.
void	DebugMsgHex (const char *pszPrefixText, int i)
	Creates a simple Message Box for debug purposes. The text appears with the extra digit (as a hexadecimal number) appearing afterwards.
void	DebugMsgString (const char *pszPrefixText, const char *thestring)
	Creates a simple Message Box for debug purposes. The text appears with the extra string appearing afterwards.
void	DebugMsg (const char *pszMsg)
	Creates a simple Message Box for debug purposes with just one text string.
void	DebugOutMenuInfo (FCUI *pUI, int menuixd_horiz, int menuixd_vert) const
	Outputs the menu command info for debugging purposes.
int	DebugOutFormat (const char *fmt,...)
	Outputs debug text using C style "printf" syntax.
void	Set16BitFlag (FLAG_16 *flag, FLAG_16 flagbits, bool state)
	Sets a 16 bit flag.
void	Set32BitFlag (FLAG_32 *flag, FLAG_32 flagbits, bool state)
	Sets/resets a 32 bit flag, by using a bit mask.
bool	GetBitFlag (FLAG_32 flag, FLAG_32 flagbits) const
	Gets a state from flag bits. Returns true if any bit in the mask is set.
int	GetBitCount (FLAG_32 flag)
	Returns the total number of set bits in a 32-bit unsigned int.
void	SetSpecific32Bit (FLAG_32 *flag, int bitnumber, bool state)
	Sets/resets a single bit in a 32 bit flag, by specifying one specific bit.
void	SetUserData (void *pData)
	Sets the user data attached to the instance of an object.
void	SetUserData2 (void *pData)
	Sets the additional user data attached to the instance of an object.
void *	GetUserData () const
	Gets the user data attached to the instance of an object.
void *	GetUserData2 () const
	Gets the additional user data attached to the instance of an object.
virtual bool	IsIdentical (const __FCBase *pCompareObject) const
	Returns true if the data in the passed object is considered to be identical to the current object, otherwise false.
void	StoreXML_String (tinyxml2::XMLElement *pParentNode, const char *pszElementName, FCString *pStringValue)
	Helper function to store FCString objects in the XML file.
void	StoreXML_Integer (tinyxml2::XMLElement *pParentNode, const char *pszElementName, int value)
	Helper function to store integer objects in the XML file.
void	StoreXML_Bool (tinyxml2::XMLElement *pParentNode, const char *pszElementName, bool value)
	Helper function to store boolean objects in the XML file.
void	StoreXML_StringAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, FCString *pStringValue)
	Helper function to store FCString objects in the XML file, as an attribute to a node.
void	StoreXML_IntegerAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, int value)
	Helper function to store integer objects in the XML file, as an attribute to a node.
void	StoreXML_BoolAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, bool value)
	Helper function to store boolean objects in the XML file, as an attribute to a node.
void	StoreXML_FloatAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, float value)
	Helper function to store floating point objects in the XML file, as an attribute to a node.
virtual void	StoreToXML (tinyxml2::XMLElement *pParentNode)
	Virtual method that is used to store an object's data.
bool	ReadXML_String (tinyxml2::XMLElement *pParentNode, const char *pszElementName, FCString *pStringValue)
	Helper method to read FCString objects from the XML file.
bool	ReadXML_Integer (tinyxml2::XMLElement *pParentNode, const char *pszElementName, int *pValue)
	Helper method to read integer objects from the XML file.
bool	ReadXML_Bool (tinyxml2::XMLElement *pParentNode, const char *pszElementName, bool *pValue)
	Helper method to read boolean objects from the XML file.
bool	ReadXML_StringAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, FCString *pStringValue)
	Helper method to read FCString objects from the XML file, as an attribute to a node.
bool	ReadXML_IntegerAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, int *pValue)
	Helper method to read integer objects from the XML file, as an attribute to a node.
bool	ReadXML_BoolAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, bool *pValue)
	Helper method to read boolean objects from the XML file, as an attribute to a node.
bool	ReadXML_FloatAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, float *pValue)
	Helper method to read floating point objects from the XML file, as an attribute to a node.
virtual bool	ReadFromXML (tinyxml2::XMLElement *pParentNode)
	Virtual method that is used to read object data.

Additional Inherited Members
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...
Static Public Member Functions inherited from __FCBase
static void	DebugOutPtr (const char *pszPrefixText, void *ptr)
	Static method that outputs a line for debugging purposes. The prefix text appears with the extra ptr (in hexadeximal representation) appearing afterwards.
static void	DebugOutInt (const char *pszPrefixText, int i)
	Static method that outputs a line for debugging purposes. The text appears with the extra digit (in decimal presentation) appearing afterwards.
static void	DebugOutFloat (const char *pszPrefixText, double f)
	Static method that outputs a line for debugging purposes. The text appears with the extra float value appearing afterwards.
static void	DebugOutTag (const char *pszPrefixText, EXTAG extag)
	Static method that outputs a line for debugging purposes. The text appears with the EXTAG (in text) appearing afterwards.
static void	DebugOutHex (const char *pszPrefixText, int i)
	Static method that outputs a line for debugging purposes. The text appears with the extra digit (in hexadecimal presentation) appearing afterwards.
static void	DebugOutBin (const char *pszPrefixText, int i)
	Static method that outputs a line for debugging purposes. The text appears with the extra digit (in binary presentation) appearing afterwards.
static void	DebugOutString (const char *pszPrefixText, const char *thestring)
	Static method that outputs a line for debugging purposes (C string version). The text appears with the extra string appearing afterwards.
static void	DebugOutString (const char *pszPrefixText, FCString *pString)
	Static method that outputs a line for debugging purposes (FCString version). The text appears with the extra string appearing afterwards.
static void	DebugOutBool (const char *pszPrefixText, bool state)
	Static method that outputs a line for debugging purposes. The boolean state appears afterwards as either "TRUE" or "FALSE".
static void	DebugOutBlock (const void *pBuffer, int startoffset, int size)
	Static method that outputs a memory block for debugging purposes. Eight bytes per line will appear (as hex digits) until the whole memory block is dumped.
static void	DebugOutByteArrayBlock (const void *pBuffer, int startoffset, int size)
	Static method that outputs a memory block for debugging purposes. Eight bytes per line will appear (as hex digits) as a C++ onebyte array, until the whole memory block is dumped.
static void	DebugOut (const char *pszLine)
	Static method to output a line of text for debugging purposes.
Protected Member Functions inherited from __FCBaseData
virtual void *	Allocate ()=0
virtual void	Deallocate ()
virtual bool	IsDynamicSize ()
bool	LoadDataBlock ()
	Loads the data. If the object is of dynamic size, the old memory block is freed and a new is allocated.
void	ClearData ()
virtual twobyte	CalcLastInci ()
	For internal use only!
virtual __FCBaseData *	CreateObject ()=0
	Creates a new instance of the object.
bool	DataIsLoaded () const
	Returns true is any data has been loaded into the object.
void	_TagDocumentID ()
	For internal use only.
Protected Member Functions inherited from __FCBase
	__FCBase ()
	The constructor.
Protected Attributes inherited from __FCBaseData
EDOCID	_connecteddocID
	The "connected" document ID., which is the document the where the document was loaded (or last saved). This is for a mechanism to prevent resaving of certain data in other documents.
void *	_datablock
	Pointer to the object's data block, the meaning is implementation-specific for each derived subclass.
bool	_heapdatablock
	Variable that tells if _datablock is dynamically created on the heap (and should be deleted at object destruction).
int	_loadedsize
	Loaded size of the data block for a loaded object, in bytes. Since the datablock is implementation-specific, the _loadedsize should be updated by child classes that create new data.
EDataID	_dataid
	The EdataID for the last loaded/saved object.

Detailed Description

Class for notehead modifications (as in Finale's Special Tools).

This class requires PDK_FRAMEWORK_ENTRIES to be defined.

Constructor & Destructor Documentation

FCNoteheadMod()

FCNoteheadMod::FCNoteheadMod ( )

inline

The constructor.

Lua-supported.

Member Function Documentation

ClassName()

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

ClearChar()

void FCNoteheadMod::ClearChar ( )

inline

Clears the font character for the notehead to use the default notehead character.

Lua-supported.

GetClassID()

const PDKFRAMEWORK_CLASSID FCNoteheadMod::GetClassID ( ) const

inlineoverridevirtual

Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has problems to resolve the true classes of inherited objects.

This method must be overwritten by all child classes.

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

Implements __FCBaseData.

GetCustomChar()

eUniChar32 FCNoteheadMod::GetCustomChar ( ) const

inline

Returns the custom notehead, it any.

Use the GetUseCustomChar method to detect if there actually is a custom notehead character available.

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

GetEnharmonicFlip()

bool FCNoteheadMod::GetEnharmonicFlip ( ) const

inline

Returns if the notehead has been enharmonically flipped.

See remarks at SetEnharmonicFlip for more information about how to use this value.

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

GetFontInfo()

bool FCNoteheadMod::GetFontInfo ( FCFontInfo * pInfo )

inline

Gets all the font info (name, style, size) into the FCFontInfo object, for custom fonts records.

Lua-supported.

Returns

True if the font info was retrieved. False if the default font is used.

GetFontName()

const char * FCNoteheadMod::GetFontName ( ) const

inline

Gets the font name for the notehead.

If GetUseCustomFont returns false, the string is empty.

Lua-supported (also as property).

Returns

The font name (as a C string).

GetFontNameUTF16()

const eUniChar16 * FCNoteheadMod::GetFontNameUTF16 ( ) const

inline

Gets the font name for the notehead.

If GetUseCustomFont returns false, the string is empty.

Returns

The font name (as a UTF16 string).

GetFontSize()

twobyte FCNoteheadMod::GetFontSize ( ) const

inline

Returns the custom font size.

Lua-supported (also as property).

Returns

For default fonts, 0 is returned. Otherwise, the font size in points.

GetFontStyle()

bool FCNoteheadMod::GetFontStyle ( FCFontInfo * pInfo )

inline

Gets only the font style (such as italics, bold etc) into the FCFontInfo object, for custom fonts records.

Lua-supported.

Returns

True if the font style was retrieved. False if the default font is used.

GetHorizontalPos()

twobyte FCNoteheadMod::GetHorizontalPos ( ) const

inline

Returns the horizontal position for the notehead.

Lua-supported (also as property).

GetResize()

twobyte FCNoteheadMod::GetResize ( ) const

inline

Returns the notehead resize in percent.

Lua-supported (also as property).

Returns

The resize in percent. 100 means no resize.

GetUseCustomChar()

bool FCNoteheadMod::GetUseCustomChar ( ) const

inline

Returns true if there's a custom notehead.

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

GetUseCustomFont()

bool FCNoteheadMod::GetUseCustomFont ( ) const

inline

Returns if a custom font is used for the notehead or not.

Lua-supported (also as property).

GetUseCustomVerticalPos()

bool FCNoteheadMod::GetUseCustomVerticalPos ( ) const

inline

Returns true if vertical position can be set.

Lua-supported (also as property).

GetVerticalPos()

twobyte FCNoteheadMod::GetVerticalPos ( ) const

inline

Returns the vertical position for the notehead.

This method always returns the vertical value. However, Finale will decide if it's going to be used based on the GetUseCustomVerticalPos() value.

Lua-supported (also as property).

GetVerticalPosIfPossible()

twobyte FCNoteheadMod::GetVerticalPosIfPossible ( )

inline

Returns the vertical position for the notehead, but only if the value has been enabled for Finale.

Lua-supported.

Returns

Will be 0 if a custom vertical position can't be set (since the GetUseCustomVerticalPos returns false).

SetCustomChar()

void FCNoteheadMod::SetCustomChar ( eUniChar32 ch )

inline

Sets the font character for the notehead.

To clear a font character (to use the default notehead character), use ClearChar.

Lua-supported (also as property).

Parameters

ch	The font character.

SetEnharmonicFlip()

void FCNoteheadMod::SetEnharmonicFlip ( bool status )

inline

Marks if the notehead should be enharmonically flipped.

Setting this value to true by itself does not change the note spelling. This value is one of three steps that are necessary to create an unlinked enharmonic flip in a part. The following Lua code shows how to enharmonically flip all the notes in a selected region in a part and have them unlink from the score. It also shows how to revert and relink to score. Run this code with the part in edit focus.

-- The `DefaultEnharmonicTranspose` method emulates observed Finale behavior.
-- Only default enharmonic transpositions unlink. Any other transposition remains linked.
 
for entry in eachentrysaved(finenv.Region()) do
    for note in each(entry) do
        local note_mod = finale.FCNoteheadMod()
        note_mod:SetNoteEntry(entry)
        note_mod:LoadAt(note)
        note_mod.EnharmonicFlip = not note_mod.EnharmonicFlip
        if note_mod.EnharmonicFlip then
            note_mod:SaveAt(note)
            note:GetTransposer():DefaultEnharmonicTranspose()
        else
            note:MatchSpellingToScore()
            note_mod:RelinkToScore()
        end
    end
end
 
-- Resetting the StemUp properties may not be strictly necessary, but Finale does it.
-- This must be done in a separate loop so that the metrics are rebuilt from the saved changes above.
 
finale.FCEntryMetrics.MarkMetricsForRebuild()
for entry in eachentrysaved(finenv.Region()) do
    if not entry.FreezeStem then
        entry.StemUp = entry:CalcStemUp()
    end
end

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

SetFontInfo()

void FCNoteheadMod::SetFontInfo ( FCFontInfo * pInfo )

inline

Sets all the font info (name, style, size) to the info available in the FCFontInfo object.

Lua-supported.

SetFontName()

void FCNoteheadMod::SetFontName ( const char * pszFont )

inline

Sets the font name for the notehead.

To get the font to change, the method SetUseCustomFont must also be used to mark that the custom font should be used.

Lua-supported (also as property).

Parameters

pszFont

The font name (as a C string).

SetFontNameUTF16()

void FCNoteheadMod::SetFontNameUTF16 ( const eUniChar16 * pszFont )

inline

Sets the font name for the notehead.

To get the font to change, the method SetUseCustomFont must also be used to mark that the custom font should be used.

Parameters

pszFont

The font name (as a UTF16 string).

SetFontSize()

void FCNoteheadMod::SetFontSize ( twobyte fontsize )

inline

Sets the font size for the notehead.

To get the font size to change, the font name (using SetFontName) must also be set and SetUseCustomFont must be used to mark that the custom font should be used.

Lua-supported (also as property).

Parameters

fontsize

The font size in points.

SetFontStyle()

void FCNoteheadMod::SetFontStyle ( FCFontInfo * pInfo )

inline

Sets the font style only (such as italics, bold, etc), based on the style info in the FCFontInfo object.

Lua-supported.

SetHorizontalPos()

void FCNoteheadMod::SetHorizontalPos ( twobyte value )

inline

Sets the horizontal position for the notehead.

Lua-supported (also as property).

SetNoteID()

void FCNoteheadMod::SetNoteID ( twobyte id )

inlineoverride

Sets the note ID for the notehead, so it maps to the note.

Parameters

id	The note ID. This should be the same as the note ID in the FCNote class.

SetResize()

void FCNoteheadMod::SetResize ( twobyte value )

inline

Sets the notehead resize in percent.

Lua-supported (also as property).

Parameters

value

The resize in percent. 100 means no resize.

SetUseCustomFont()

void FCNoteheadMod::SetUseCustomFont ( bool status )

inline

Marks if a custom font should be used for the notehead or not.

Lua-supported (also as property).

Parameters

status

True = custom font data (font, font size, font effects) is used for the notehead. False = notehead uses the default font info.

SetUseCustomVerticalPos()

void FCNoteheadMod::SetUseCustomVerticalPos ( bool status )

inline

Marks if a custom vertical position should be used for the notehead or not.

Parameters

status

True = custom vertical position is used for the notehead. False = accidental uses the default vertical position.

Lua-supported (also as property).

SetUseDefaultFont()

void FCNoteheadMod::SetUseDefaultFont ( bool status )

inline

The reverse functionality of SetUseCustomFont.

This is implemented only to be able to make the code read more clear.

Lua-supported.

SetUseDefaultVerticalPos()

void FCNoteheadMod::SetUseDefaultVerticalPos ( bool status )

inline

Clears and uses the default vertical positioning.

This method is the reverse functionality of SetUseCustomVerticalPos. It's implemented only to be able to make the code read more clear.

Lua-supported.

SetVerticalPos()

void FCNoteheadMod::SetVerticalPos ( twobyte value )

inline

Sets the vertical position for the notehead.

Use the SetUseCustomVerticalPos method to enable this value.

Use the SetUseDefaultVerticalPos method as a quick method to use the default vertical positioning.

Lua-supported (also as property).