FCClefDef Class Reference

Data class for the global clef definitions. More...

#include <ff_globals.h>

Inheritance diagram for FCClefDef:

Public Types
enum	DEFAULTCLEFIDS {   DEFAULTCLEFID_TREBLE = CLEF_TREBLE , DEFAULTCLEFID_ALTO = CLEF_ALTO , DEFAULTCLEFID_TENOR = CLEF_TENOR , DEFAULTCLEFID_BASS = CLEF_BASS ,   DEFAULTCLEFID_PERCUSSION = CLEF_PERCUSSION , DEFAULTCLEFID_TREBLE8VB = CLEF_TREBLE8VB , DEFAULTCLEFID_BASS8VB = CLEF_BASS8VB , DEFAULTCLEFID_BARITONE = CLEF_BARITONE ,   DEFAULTCLEFID_FRENCHVIOLIN = CLEF_FRENCHVIOLIN , DEFAULTCLEFID_BARITONEC = CLEF_BARITONEC , DEFAULTCLEFID_MEZZOSOPRANO = CLEF_MEZZOSOPRANO , DEFAULTCLEFID_SOPRANO = CLEF_SOPRANO ,   DEFAULTCLEFID_ALTPERCUSSION = CLEF_ALTPERCUSSION , DEFAULTCLEFID_TREBLE8VA = CLEF_TREBLE8VA , DEFAULTCLEFID_BASS8VA = CLEF_BASS8VA , DEFAULTCLEFID_BLANK = CLEF_BLANK ,   DEFAULTCLEFID_TAB1 = CLEF_TAB1 , DEFAULTCLEFID_TAB2 = CLEF_TAB2 }
	Default GetClefIndex values. If the clefs have not been modified in the clef designer, their indices match these values. 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
	FCClefDef ()
	The constructor. More...
twobyte	GetVerticalAdjust () const
	Returns the vertical adjustment (related to middle C) of the clef. More...
Efix16	GetBaselineOffset () const
	Returns the baseline offset, as an EFIX value. More...
eUniChar32	GetSymbol () const
	Returns the symbol character for the clef definition. More...
twobyte	GetClefPosition () const
	Returns the vertical Clef Position. More...
bool	GetUseCustomFont () const
	Returns true if a custom font is used. More...
bool	GetFontInfo (FCFontInfo *pFontInfo) const
	Gets the custom font for the clef. More...
FCFontInfo *	CreateEffectiveFontInfo () const
	Creates the effective font for the clef. If the clef does not use a custom font or if the clef is a shape clef, it returns the document's default font for clefs (FCFontPrefs::FONTPREF_CLEF). More...
CMPER	GetClefIndex () const
	Returns the 0-based clef index/ID. More...
void	SetFontInfo (FCFontInfo *pFontInfo)
	Sets the font for the clef definition. More...
void	SetShapeID (twobyte shapeID)
	Sets the shape ID for the clef. More...
void	SetUseCustomFont (bool state)
	Sets the custom font state. More...
void	SetVerticalAdjust (twobyte value)
	Sets the vertical adjustment (related to middle C) of the clef. More...
void	SetBaselineOffset (Efix16 value)
	Sets the baseline offset, as an EFIX value. More...
void	SetSymbol (eUniChar32 symbolchar)
	Sets the symbol character for the clef definition. More...
void	SetClefPosition (twobyte clefpos)
	Sets the vertical Clef Position. More...
void	SetIsShape (bool state)
	Sets if a shape is used as clef or not. More...
bool	GetIsShape () const
	Returns true if a shape is used as clef. More...
twobyte	GetShapeID () const
	Returns the shape ID (if any) for the clef. 0 if there is no shape clef. More...
Public Member Functions inherited from __FCGlobals
const char *	ClassName () const override
	Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child class. More...
	__FCGlobals ()
	The constructor.
bool	Load (twobyte globalnumber)
	Loads a single member from the globals data storage. More...
bool	LoadFirst () override
	Loads first member from the globals data storage. More...
bool	LoadNext () override
	Loads the next element from the database, if any. More...
Public Member Functions inherited from __FCBaseData
const PDKFRAMEWORK_CLASSID	GetClassID () const override=0
	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. More...
EDOCID	GetConnectedDocID () const
	Returns the document ID that was connected to the last load/save of the data. More...
bool	VerifyConnectedDocID ()
	Checks that the stored document ID for the data object matches the current document's ID. More...
virtual EXTAG	Tag () const =0
	The Enigma tag for the derived class. More...
virtual EVERSION	EnigmaVersion () const
	The Enigma version for save/load/create/delete operations. More...
virtual int	DataSizeLoad () const =0
	Returns the data size for the data structure that should be loaded. More...
virtual int	DataSizeSave () const
	Returns the data size for the data structure that should be saved or created. More...
void	_CloneFrom (__FCBaseData *pSource)
	For internal use only. Copies object data (except data block) from another object. More...
virtual void	CloneMemoryFrom (__FCBaseData *pSource)
const EDataID *	_GetDataID ()
	Intended ONLY for the _CloneFrom implementation. More...
int	_GetLoadedSize () const
	Intended ONLY for the _CloneFrom implementation. More...
const void *	GetDataBlock ()
	Intended ONLY for the _CloneFrom implementation. More...
EXTAG	GetCustomTag () const
	Returns the custom Enigma tag, if any. More...
void	SetCustomTag (EXTAG tag)
	Sets the custom Enigma tag, for classes that support multiple Enigma tags. More...
	__FCBaseData ()
	The constructor.
virtual	~__FCBaseData ()
	Virtual destructor.
virtual bool	Save ()
	Saves the currently loaded to its current location. More...
virtual bool	Reload ()
	Refreshes the data for the object, to synch the data with Finale's current data. More...
virtual bool	DeleteData ()
	Deletes the associated data from Finale's database. Be careful when deleting multiple objects. More...
virtual bool	DeepDeleteData ()
	Deletes data and all data that's connected to the object. More...
virtual bool	LoadLast ()
	Loads the very last element in the database, if any. More...
virtual bool	LoadPrevious ()
	Loads the previous element in the database, if any. More...
bool	RelinkToCurrentView ()
	Relinks the contents in the current view so that the score and part(s) match. More...
bool	RelinkToScore ()
	Relinks all parts to the contents of the score. More...
__FCBaseData *	CreateClone ()
	Creates an identical copy of an object. More...
void	DebugDump () override
	Outputs the class data/information for debugging purposes. More...
void	DebugDataDump () override
	Outputs a memory dump of the data block in the object for debugging purposes. More...
void	DebugDataByteArrayDump () override
	Outputs a memory dump of the data block in the object for debugging purposes, as a C++ byte array. More...
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. More...
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. More...
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. More...
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. More...
void	DebugMsg (const char *pszMsg)
	Creates a simple Message Box for debug purposes with just one text string. More...
void	DebugOutMenuInfo (FCUI *pUI, int menuixd_horiz, int menuixd_vert) const
	Outputs the menu command info for debugging purposes. More...
int	DebugOutFormat (const char *fmt,...)
	Outputs debug text using C style "printf" syntax. More...
void	Set16BitFlag (FLAG_16 *flag, FLAG_16 flagbits, bool state)
	Sets a 16 bit flag. More...
void	Set32BitFlag (FLAG_32 *flag, FLAG_32 flagbits, bool state)
	Sets/resets a 32 bit flag, by using a bit mask. More...
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. More...
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. More...
void	SetUserData (void *pData)
	Sets the user data attached to the instance of an object. More...
void	SetUserData2 (void *pData)
	Sets the additional user data attached to the instance of an object. More...
void *	GetUserData () const
	Gets the user data attached to the instance of an object. More...
void *	GetUserData2 () const
	Gets the additional user data attached to the instance of an object. More...
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. More...
void	StoreXML_String (tinyxml2::XMLElement *pParentNode, const char *pszElementName, FCString *pStringValue)
	Helper function to store FCString objects in the XML file. More...
void	StoreXML_Integer (tinyxml2::XMLElement *pParentNode, const char *pszElementName, int value)
	Helper function to store integer objects in the XML file. More...
void	StoreXML_Bool (tinyxml2::XMLElement *pParentNode, const char *pszElementName, bool value)
	Helper function to store boolean objects in the XML file. More...
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. More...
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. More...
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. More...
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. More...
virtual void	StoreToXML (tinyxml2::XMLElement *pParentNode)
	Virtual method that is used to store an object's data. More...
bool	ReadXML_String (tinyxml2::XMLElement *pParentNode, const char *pszElementName, FCString *pStringValue)
	Helper method to read FCString objects from the XML file. More...
bool	ReadXML_Integer (tinyxml2::XMLElement *pParentNode, const char *pszElementName, int *pValue)
	Helper method to read integer objects from the XML file. More...
bool	ReadXML_Bool (tinyxml2::XMLElement *pParentNode, const char *pszElementName, bool *pValue)
	Helper method to read boolean objects from the XML file. More...
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. More...
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. More...
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. More...
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. More...
virtual bool	ReadFromXML (tinyxml2::XMLElement *pParentNode)
	Virtual method that is used to read object data. More...

Additional Inherited Members
Static Public Member Functions inherited from __FCBase
static void	DebugOutPtr (const char *pszPrefixText, void *ptr)
	Static method that outputs a line for debugging purposes. The prefix text appears with the extra ptr (in hexadeximal representation) appearing afterwards. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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". More...
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. More...
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. More...
static void	DebugOut (const char *pszLine)
	Static method to output a line of text for debugging purposes. More...
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! More...
virtual __FCBaseData *	CreateObject ()=0
	Creates a new instance of the object. More...
bool	DataIsLoaded () const
	Returns true is any data has been loaded into the object.
void	_TagDocumentID ()
	For internal use only. More...
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. More...
EDataID	_dataid
	The EdataID for the last loaded/saved object.

Detailed Description

Data class for the global clef definitions.

The first clef definition is stored at position 0.

Member Enumeration Documentation

DEFAULTCLEFIDS

enum FCClefDef::DEFAULTCLEFIDS

Default GetClefIndex values. If the clefs have not been modified in the clef designer, their indices match these values.

Lua-supported (0.72)

Enumerator
DEFAULTCLEFID_TREBLE	treble clef
DEFAULTCLEFID_ALTO	alto clef
DEFAULTCLEFID_TENOR	tenor clef
DEFAULTCLEFID_BASS	tenor clef
DEFAULTCLEFID_PERCUSSION	percussion clef
DEFAULTCLEFID_TREBLE8VB	treble 8vb clef
DEFAULTCLEFID_BASS8VB	bass 8vb clef
DEFAULTCLEFID_BARITONE	baritone clef
DEFAULTCLEFID_FRENCHVIOLIN	French violin clef
DEFAULTCLEFID_BARITONEC	baritone C clef
DEFAULTCLEFID_MEZZOSOPRANO	mezzosoprano clef
DEFAULTCLEFID_SOPRANO	soprano clef
DEFAULTCLEFID_ALTPERCUSSION	alternate percussion clef
DEFAULTCLEFID_TREBLE8VA	treble 8va clef
DEFAULTCLEFID_BASS8VA	bass 8va clef
DEFAULTCLEFID_BLANK	blank clef
DEFAULTCLEFID_TAB1	TAB 1 clef
DEFAULTCLEFID_TAB2	TAB 2 clef

Constructor & Destructor Documentation

FCClefDef()

FCClefDef::FCClefDef ( )

inline

The constructor.

Lua-supported.

Member Function Documentation

CreateEffectiveFontInfo()

FCFontInfo * FCClefDef::CreateEffectiveFontInfo

(

)

const

Creates the effective font for the clef. If the clef does not use a custom font or if the clef is a shape clef, it returns the document's default font for clefs (FCFontPrefs::FONTPREF_CLEF).

C callers must free the return value, either with delete or with a smart pointer.

Lua-supported (0.72)

Returns

effective font info for the clef or NULL if error or no open document.

GetBaselineOffset()

Efix16 FCClefDef::GetBaselineOffset

(

)

const

Returns the baseline offset, as an EFIX value.

Lua-supported (also as property).

GetClefIndex()

CMPER FCClefDef::GetClefIndex ( ) const

inline

Returns the 0-based clef index/ID.

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

GetClefPosition()

twobyte FCClefDef::GetClefPosition

(

)

const

Returns the vertical Clef Position.

Lua-supported (also as property).

Returns

The value is the number of harmonic levels from the top line of the staff to the musical baseline of the clef.

GetFontInfo()

bool FCClefDef::GetFontInfo

(

FCFontInfo *

pFontInfo

)

const

Gets the custom font for the clef.

Lua-supported.

Returns

True on success. Method does not do anything with shape clefs or if custom font isn't used (and returns false).

GetIsShape()

bool FCClefDef::GetIsShape

(

)

const

Returns true if a shape is used as clef.

Lua-supported (also as property).

GetShapeID()

twobyte FCClefDef::GetShapeID

(

)

const

Returns the shape ID (if any) for the clef. 0 if there is no shape clef.

Lua-supported (also as property).

GetSymbol()

eUniChar32 FCClefDef::GetSymbol

(

)

const

Returns the symbol character for the clef definition.

Lua-supported (also as property).

GetUseCustomFont()

bool FCClefDef::GetUseCustomFont

(

)

const

Returns true if a custom font is used.

Lua-supported (also as property).

GetVerticalAdjust()

twobyte FCClefDef::GetVerticalAdjust

(

)

const

Returns the vertical adjustment (related to middle C) of the clef.

Lua-supported (also as property).

Returns

The amount of steps that the clef will reposition notes vertically.

SetBaselineOffset()

void FCClefDef::SetBaselineOffset

(

Efix16

value

)

Sets the baseline offset, as an EFIX value.

Lua-supported (also as property).

SetClefPosition()

void FCClefDef::SetClefPosition

(

twobyte

clefpos

)

Sets the vertical Clef Position.

The value is the number of harmonic levels from the top line of the staff to the musical baseline of the clef.

Lua-supported (also as property).

SetFontInfo()

void FCClefDef::SetFontInfo

(

FCFontInfo *

pFontInfo

)

Sets the font for the clef definition.

Please note that this method doesn't set that the custom font should be used. (Use SetUseCustomFont for that.)

Lua-supported.

SetIsShape()

void FCClefDef::SetIsShape

(

bool

state

)

Sets if a shape is used as clef or not.

Lua-supported (also as property).

SetShapeID()

void FCClefDef::SetShapeID

(

twobyte

shapeID

)

Sets the shape ID for the clef.

Lua-supported (also as property).

SetSymbol()

void FCClefDef::SetSymbol

(

eUniChar32

symbolchar

)

Sets the symbol character for the clef definition.

Lua-supported (also as property).

SetUseCustomFont()

void FCClefDef::SetUseCustomFont

(

bool

state

)

Sets the custom font state.

Lua-supported (also as property).

SetVerticalAdjust()

void FCClefDef::SetVerticalAdjust

(

twobyte

value

)

Sets the vertical adjustment (related to middle C) of the clef.

Lua-supported (also as property).

Parameters

value

The amount of steps that the clef will reposition notes vertically.