FCFontPrefs Class Reference

Font preferences data in the Document Options. More...

#include <ff_prefs.h>

Inheritance diagram for FCFontPrefs:

Public Types
enum	FONTPREF_CONSTANTS {   FONTPREF_MUSIC = DEFAULTFONT_MUSIC , FONTPREF_KEYSIG = DEFAULTFONT_KEY , FONTPREF_CLEF = DEFAULTFONT_CLEF , FONTPREF_TIMESIG = DEFAULTFONT_TIME ,   FONTPREF_CHORDSYMBOL = DEFAULTFONT_CHORD_SYMBOL , FONTPREF_CHORDALTERATION = DEFAULTFONT_CHORD_ALTERATION , FONTPREF_ENDING = DEFAULTFONT_ENDING , FONTPREF_TUPLET = DEFAULTFONT_TUPLET ,   FONTPREF_TEXTBLOCK = DEFAULTFONT_TEXTBLOCK , FONTPREF_LYRICSVERSE = DEFAULTFONT_LYRIC_VERSE , FONTPREF_LYRICSCHORUS = DEFAULTFONT_LYRIC_CHORUS , FONTPREF_LYRICSSECTION = DEFAULTFONT_LYRIC_SECTION ,   FONTPREF_MULTIMEASUREREST = DEFAULTFONT_MULTIREST , FONTPREF_CHORDSUFFIX = DEFAULTFONT_CHORD_SUFFIX , FONTPREF_EXPRESSION = DEFAULTFONT_EXPR , FONTPREF_REPEAT = DEFAULTFONT_REPEAT ,   FONTPREF_CHORDFRETBOARD = DEFAULTFONT_CHORD_FRETBOARD , FONTPREF_FLAG = DEFAULTFONT_FLAGS , FONTPREF_ACCIDENTAL = DEFAULTFONT_ACCIS , FONTPREF_ALTERNATESLASH = DEFAULTFONT_ALTNOTSLASH ,   FONTPREF_ALTERNATENUMBER = DEFAULTFONT_ALTNOTNUM , FONTPREF_REST = DEFAULTFONT_RESTS , FONTPREF_REPEATDOT = DEFAULTFONT_REPTDOTS , FONTPREF_NOTEHEAD = DEFAULTFONT_NOTEHEADS ,   FONTPREF_AUGMENTATIONDOT = DEFAULTFONT_AUGDOTS , FONTPREF_TIMESIGPLUS = DEFAULTFONT_TIMEPLUS , FONTPREF_ARTICULATION = DEFAULTFONT_ARTICULATION , FONTPREF_DEFTABLATURE = DEFAULTFONT_TABLATURE ,   FONTPREF_PERCUSSION = DEFAULTFONT_PERCUSSION , FONTPREF_8VA = DEFAULTFONT_SMARTSHAPE_8VA , FONTPREF_MEASURENUMBER = DEFAULTFONT_MEASNUMB , FONTPREF_STAFFNAME = DEFAULTFONT_STAFFNAMES ,   FONTPREF_ABRVSTAFFNAME = DEFAULTFONT_ABRVSTAFFNAMES , FONTPREF_GROUPNAME = DEFAULTFONT_GROUPNAMES , FONTPREF_8VB = DEFAULTFONT_SMARTSHAPE_8VB , FONTPREF_15MA = DEFAULTFONT_SMARTSHAPE_15MA ,   FONTPREF_15MB = DEFAULTFONT_SMARTSHAPE_15MB , FONTPREF_TR = DEFAULTFONT_SMARTSHAPE_TR , FONTPREF_WIGGLE = DEFAULTFONT_SMARTSHAPE_WIGGLE , FONTPREF_ABRVGROUPNAME = DEFAULTFONT_ABRVGROUPNAMES ,   FONTPREF_GUITARBENDFULL = DEFAULTFONT_GUITARBEND_FULL , FONTPREF_GUITARBENDNUMBER = DEFAULTFONT_GUITARBEND_NUMBER , FONTPREF_GUITARBENDFRACTION = DEFAULTFONT_GUITARBEND_FRACTION , FONTPREF_TIMESIG_PARTS = DEFAULTFONT_TIME_PARTS ,   FONTPREF_TIMESIGPLUS_PARTS = DEFAULTFONT_TIMEPLUS_PARTS }
	Constants for loading font preferences. More...
Public Types inherited from __FCBase
enum	PDKFRAMEWORK_CLASSID {   FCID_UNKNOWN = 0 , FCID_ACCIDENTALMOD , FCID_ACTIVELYRIC , FCID_ALLOTMENT ,   FCID_ARTICULATION , FCID_ARTICULATIONDEF , FCID_BACKWARDREPEAT , FCID_BASELINE ,   FCID_BEAMMOD , FCID_BEATCHARTELEMENT , FCID_BOOKMARK , FCID_BROKENBEAMMOD ,   FCID_CATEGORYDEF , FCID_CELLCLEFCHANGE , FCID_CELLFRAMEHOLD , FCID_CELLGRAPHIC ,   FCID_CELLTEXT , FCID_CENTERSMARTSHAPE , FCID_CHORD , FCID_CHORDPREFS ,   FCID_CHORDSUFFIXELEMENT , FCID_CHORUSSYLLABLE , FCID_CLEFDEF , FCID_COMPOSITETIMESIGBOTTOMELEMENT ,   FCID_COMPOSITETIMESIGTOPELEMENT , FCID_CROSSSTAFFMOD , FCID_CUSTOMSMARTLINEDEF , FCID_CUSTOMSTEMMOD ,   FCID_DISTANCEPREFS , FCID_DOTMOD , FCID_ENCLOSURE , FCID_ENDINGREPEAT ,   FCID_ENIGMATEXTSTYLE , FCID_ENTRYALTERMOD , FCID_EXECUTABLESHAPEDEF , FCID_EXPRESSION ,   FCID_FONTINFO , FCID_FONTPREFS , FCID_FREEZESYSTEM , FCID_FRETBOARDSTYLEDEF ,   FCID_FRETBOARDSTYLEDEFS , FCID_FRETBOARDGROUPDEF , FCID_FRETBOARDGROUPDEFS , FCID_FRETINSTRUMENTDEF ,   FCID_GENERALPREFS , FCID_GRIDSGUIDESPREFS , FCID_GROUP , FCID_GROUPNAMEPOSITIONPREFS ,   FCID_HUMANPLAYBACKPREFS , FCID_INDEPENDENTCELLDETAIL , FCID_INSTRUMENTDEF , FCID_INSTRUMENTPLAYBACKDATA ,   FCID_KEYMODEDEF , FCID_KEYSIGNATURE , FCID_LAYERPREFS , FCID_LYRICSBASELINE ,   FCID_LYRICSPREFS , FCID_MEASURE , FCID_MEASURENUMBERREGION , FCID_METATOOLASSIGNMENT ,   FCID_MIDIEXPRESSION , FCID_MISCDOCPREFS , FCID_MULTIMEASUREREST , FCID_MULTIMEASURERESTPREFS ,   FCID_MULTISTAFFINSTRUMENT , FCID_MULTISTAFFINSTRUMENTS , FCID_MUSICCHARACTERPREFS , FCID_MUSICSPACINGPREFS ,   FCID_NUMBER , FCID_NOTEHEADMOD , FCID_OTHERINCI , FCID_PERCUSSIONLAYOUTNOTE ,   FCID_PERCUSSIONSTAFF , FCID_PERFORMANCEMOD , FCID_PAGE , FCID_PAGEFORMATPREFS ,   FCID_PAGEGRAPHIC , FCID_PAGETEXT , FCID_PART , FCID_PARTEXTRACTPREFS ,   FCID_PARTSCOPEPREFS , FCID_PARTSTAFFVOICING , FCID_PERCUSSIONNOTEMOD , FCID_PIANOBRACEPREFS ,   FCID_PLAYBACKPREFS , FCID_RAWTEXT , FCID_REPEATPREFS , FCID_SECONDARYBEAMBREAKMOD ,   FCID_BEAMEXTENSIONMOD , FCID_SECTIONSYLLABLE , FCID_SEPARATEMEASURENUMBER , FCID_SEPARATEPLACEMENT ,   FCID_SHAPEDEF , FCID_SHAPEEXPRESSIONDEF , FCID_SLURCONTOURPREFS , FCID_SIZEPREFS ,   FCID_SMARTSHAPE , FCID_SMARTSHAPEENTRYMARK , FCID_SMARTSHAPEMEASUREMARK , FCID_SMARTSHAPEPREFS ,   FCID_STAFF , FCID_STAFFLIST , FCID_STAFFNAMEPOSITION , FCID_STAFFNAMEPOSITIONPREFS ,   FCID_STAFFSTYLEASSIGN , FCID_STAFFSTYLEDEF , FCID_STAFFSYSTEM , FCID_STEMCONNECTIONTABLE ,   FCID_STEMMOD , FCID_STRING , FCID_SYLLABLEENTRYMOD , FCID_SYSTEMSTAFF ,   FCID_TABLATURENOTEMOD , FCID_TEMPOELEMENT , FCID_TEXTBLOCK , FCID_TEXTEXPRESSIONDEF ,   FCID_TEXTREPEAT , FCID_TEXTREPEATDEF , FCID_TIEMOD , FCID_TIEPREFS ,   FCID_TIECONTOURPREFS , FCID_TIEPLACEMENTPREFS , FCID_TIMESIGNATURE , FCID_TUPLET ,   FCID_TUPLETPREFS , FCID_VERSESYLLABLE }
	Constants for the GetClassID method. More...
enum	MEASUREMENTUNITS {   MEASUREMENTUNIT_DEFAULT = UNIT_DEFAULT , MEASUREMENTUNIT_EVPUS = UNIT_EVPUS , MEASUREMENTUNIT_INCHES = UNIT_INCHES , MEASUREMENTUNIT_CENTIMETERS = UNIT_CENTS ,   MEASUREMENTUNIT_POINTS = UNIT_POINTS , MEASUREMENTUNIT_PICAS = UNIT_PICAS , MEASUREMENTUNIT_SPACES = UNIT_SPACES , MEASUREMENTUNIT_MILLIMETERS = 100 }
	Constants for Finale's standard measurement units. More...

Public Member Functions
const char *	ClassName () const override
	Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child class.
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.
	FCFontPrefs ()
	The constructor.
bool	GetFontInfo (FCFontInfo *pFontInfo)
	Gets the loaded font information.
FCFontInfo *	CreateFontInfo ()
	Creates a FCFontInfo object and initializes with the font preference data. If no data has been loaded to the preference storage, the method returns NULL.
bool	SetFontInfo (FCFontInfo *pFontInfo)
	Sets the loaded font information.
Public Member Functions inherited from __FCPrefsBase
bool	Reload () override
	Overridden version of Reload(), that handles prefs from multiple sources.
virtual bool	Load (twobyte prefsno=1)
	The default Load method for preference data. All preference data loading must go through here at some point.
bool	Save () override
	Saves the currently loaded to its current location.
bool	LoadFirst () override
	Loads the very first element in the database, if any.
int	GetItemNo () const
	Returns the prefs number for the loaded data.
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 EVERSION	EnigmaVersion () const
	The Enigma version for save/load/create/delete operations.
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.
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	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	LoadNext ()
	Loads the next element from 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	DebugDump () override
	Outputs the class data/information for debugging purposes.
void	DebugDataDump () override
	Outputs a memory dump of the data block in the object for debugging purposes.
void	DebugDataByteArrayDump () override
	Outputs a memory dump of the data block in the object for debugging purposes, as a C++ byte array.
void	DebugDataOffsetDump (int offset, int size)
	For debug mode only. Dumps a data memory block at a specific offset and with a specific size.
FCNumbers *	CreateRawDataDump ()
	Creates a byte collection with the raw loaded data block for the object (if the object type supports single data blocks). This method is only intended for debug purposes.
Public Member Functions inherited from __FCBase
virtual	~__FCBase ()
	Virtual destructor, so all inherited classes get the virtual destructor.
void	DebugMsgInt (const char *pszPrefixText, int i)
	Creates a simple Message Box for debug purposes. The text appears with the extra digit (in decimal presentation) appearing afterwards.
void	DebugMsgHex (const char *pszPrefixText, int i)
	Creates a simple Message Box for debug purposes. The text appears with the extra digit (as a hexadecimal number) appearing afterwards.
void	DebugMsgString (const char *pszPrefixText, const char *thestring)
	Creates a simple Message Box for debug purposes. The text appears with the extra string appearing afterwards.
void	DebugMsg (const char *pszMsg)
	Creates a simple Message Box for debug purposes with just one text string.
void	DebugOutMenuInfo (FCUI *pUI, int menuixd_horiz, int menuixd_vert) const
	Outputs the menu command info for debugging purposes.
int	DebugOutFormat (const char *fmt,...)
	Outputs debug text using C style "printf" syntax.
void	Set16BitFlag (FLAG_16 *flag, FLAG_16 flagbits, bool state)
	Sets a 16 bit flag.
void	Set32BitFlag (FLAG_32 *flag, FLAG_32 flagbits, bool state)
	Sets/resets a 32 bit flag, by using a bit mask.
bool	GetBitFlag (FLAG_32 flag, FLAG_32 flagbits) const
	Gets a state from flag bits. Returns true if any bit in the mask is set.
int	GetBitCount (FLAG_32 flag)
	Returns the total number of set bits in a 32-bit unsigned int.
void	SetSpecific32Bit (FLAG_32 *flag, int bitnumber, bool state)
	Sets/resets a single bit in a 32 bit flag, by specifying one specific bit.
void	SetUserData (void *pData)
	Sets the user data attached to the instance of an object.
void	SetUserData2 (void *pData)
	Sets the additional user data attached to the instance of an object.
void *	GetUserData () const
	Gets the user data attached to the instance of an object.
void *	GetUserData2 () const
	Gets the additional user data attached to the instance of an object.
virtual bool	IsIdentical (const __FCBase *pCompareObject) const
	Returns true if the data in the passed object is considered to be identical to the current object, otherwise false.
void	StoreXML_String (tinyxml2::XMLElement *pParentNode, const char *pszElementName, FCString *pStringValue)
	Helper function to store FCString objects in the XML file.
void	StoreXML_Integer (tinyxml2::XMLElement *pParentNode, const char *pszElementName, int value)
	Helper function to store integer objects in the XML file.
void	StoreXML_Bool (tinyxml2::XMLElement *pParentNode, const char *pszElementName, bool value)
	Helper function to store boolean objects in the XML file.
void	StoreXML_StringAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, FCString *pStringValue)
	Helper function to store FCString objects in the XML file, as an attribute to a node.
void	StoreXML_IntegerAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, int value)
	Helper function to store integer objects in the XML file, as an attribute to a node.
void	StoreXML_BoolAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, bool value)
	Helper function to store boolean objects in the XML file, as an attribute to a node.
void	StoreXML_FloatAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, float value)
	Helper function to store floating point objects in the XML file, as an attribute to a node.
virtual void	StoreToXML (tinyxml2::XMLElement *pParentNode)
	Virtual method that is used to store an object's data.
bool	ReadXML_String (tinyxml2::XMLElement *pParentNode, const char *pszElementName, FCString *pStringValue)
	Helper method to read FCString objects from the XML file.
bool	ReadXML_Integer (tinyxml2::XMLElement *pParentNode, const char *pszElementName, int *pValue)
	Helper method to read integer objects from the XML file.
bool	ReadXML_Bool (tinyxml2::XMLElement *pParentNode, const char *pszElementName, bool *pValue)
	Helper method to read boolean objects from the XML file.
bool	ReadXML_StringAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, FCString *pStringValue)
	Helper method to read FCString objects from the XML file, as an attribute to a node.
bool	ReadXML_IntegerAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, int *pValue)
	Helper method to read integer objects from the XML file, as an attribute to a node.
bool	ReadXML_BoolAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, bool *pValue)
	Helper method to read boolean objects from the XML file, as an attribute to a node.
bool	ReadXML_FloatAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, float *pValue)
	Helper method to read floating point objects from the XML file, as an attribute to a node.
virtual bool	ReadFromXML (tinyxml2::XMLElement *pParentNode)
	Virtual method that is used to read object data.

Additional Inherited Members
Static Public Member Functions inherited from __FCBase
static void	DebugOutPtr (const char *pszPrefixText, void *ptr)
	Static method that outputs a line for debugging purposes. The prefix text appears with the extra ptr (in hexadeximal representation) appearing afterwards.
static void	DebugOutInt (const char *pszPrefixText, int i)
	Static method that outputs a line for debugging purposes. The text appears with the extra digit (in decimal presentation) appearing afterwards.
static void	DebugOutFloat (const char *pszPrefixText, double f)
	Static method that outputs a line for debugging purposes. The text appears with the extra float value appearing afterwards.
static void	DebugOutTag (const char *pszPrefixText, EXTAG extag)
	Static method that outputs a line for debugging purposes. The text appears with the EXTAG (in text) appearing afterwards.
static void	DebugOutHex (const char *pszPrefixText, int i)
	Static method that outputs a line for debugging purposes. The text appears with the extra digit (in hexadecimal presentation) appearing afterwards.
static void	DebugOutBin (const char *pszPrefixText, int i)
	Static method that outputs a line for debugging purposes. The text appears with the extra digit (in binary presentation) appearing afterwards.
static void	DebugOutString (const char *pszPrefixText, const char *thestring)
	Static method that outputs a line for debugging purposes (C string version). The text appears with the extra string appearing afterwards.
static void	DebugOutString (const char *pszPrefixText, FCString *pString)
	Static method that outputs a line for debugging purposes (FCString version). The text appears with the extra string appearing afterwards.
static void	DebugOutBool (const char *pszPrefixText, bool state)
	Static method that outputs a line for debugging purposes. The boolean state appears afterwards as either "TRUE" or "FALSE".
static void	DebugOutBlock (const void *pBuffer, int startoffset, int size)
	Static method that outputs a memory block for debugging purposes. Eight bytes per line will appear (as hex digits) until the whole memory block is dumped.
static void	DebugOutByteArrayBlock (const void *pBuffer, int startoffset, int size)
	Static method that outputs a memory block for debugging purposes. Eight bytes per line will appear (as hex digits) as a C++ onebyte array, until the whole memory block is dumped.
static void	DebugOut (const char *pszLine)
	Static method to output a line of text for debugging purposes.
Protected Member Functions inherited from __FCPrefsBase
	__FCPrefsBase ()
	standard constructor
Protected Member Functions inherited from __FCBaseData
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!
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

Font preferences data in the Document Options.

When loading the preferences, use any of the FONTPREF_* font constants defined in this class, such as FONTPREF_TIMESIG, FONTPREF_TUPLET, etc

Member Enumeration Documentation

FONTPREF_CONSTANTS

enum FCFontPrefs::FONTPREF_CONSTANTS

Constants for loading font preferences.

Lua-supported.

Enumerator
FONTPREF_MUSIC	Default music font
FONTPREF_KEYSIG	Default time signature font
FONTPREF_CLEF	Default clef font
FONTPREF_TIMESIG	Default time signature font
FONTPREF_CHORDSYMBOL	Default chord symbol font
FONTPREF_CHORDALTERATION	Default chord symbol font (for alteration)
FONTPREF_ENDING	Default repeat ending font
FONTPREF_TUPLET	Default tuplet font
FONTPREF_TEXTBLOCK	Default text block font
FONTPREF_LYRICSVERSE	Default lyrics/verse font
FONTPREF_LYRICSCHORUS	Default Lyrics/Chorus font
FONTPREF_LYRICSSECTION	Default Lyrics/Section font
FONTPREF_MULTIMEASUREREST	Default multimeasure rest number font
FONTPREF_CHORDSUFFIX	Default chord suffix font
FONTPREF_EXPRESSION	Default expression font
FONTPREF_REPEAT	Default repeat font
FONTPREF_CHORDFRETBOARD	Default fretboard font
FONTPREF_FLAG	Default note flag font
FONTPREF_ACCIDENTAL	Default font for accidentals
FONTPREF_ALTERNATESLASH	Alternate notation: slash
FONTPREF_ALTERNATENUMBER	Alternate notation: number
FONTPREF_REST	Font for rests
FONTPREF_REPEATDOT	Font for the repeat dots
FONTPREF_NOTEHEAD	Default font for noteheads
FONTPREF_AUGMENTATIONDOT	Font for the augmentation dot
FONTPREF_TIMESIGPLUS	Font for the time signature "plus" sign
FONTPREF_ARTICULATION	Default font for articulations
FONTPREF_DEFTABLATURE	Default font for tablature
FONTPREF_PERCUSSION	Default percussion notation font
FONTPREF_8VA	Default font for smart shapes 8va symbols
FONTPREF_MEASURENUMBER	Default font for measure numbers
FONTPREF_STAFFNAME	Default font for full staff names
FONTPREF_ABRVSTAFFNAME	Default font for abbreviated staff names
FONTPREF_GROUPNAME	Default font for group names
FONTPREF_8VB	Font for smart shape 8vb symbols
FONTPREF_15MA	Font for smart shape 15ma symbols
FONTPREF_15MB	Font for smart shape 15mb symbols
FONTPREF_TR	Font for smart shape "trill" symbols
FONTPREF_WIGGLE	Font for smart shape wiggle symbol
FONTPREF_ABRVGROUPNAME	Default font for abbreviated group names
FONTPREF_GUITARBENDFULL	Default font for guitar bends/full
FONTPREF_GUITARBENDNUMBER	Default font for guitar bends/number
FONTPREF_GUITARBENDFRACTION	Default font for guitar bends/fraction
FONTPREF_TIMESIG_PARTS	Default font for time signature numbers in parts
FONTPREF_TIMESIGPLUS_PARTS	Default font for the time signature "plus" in parts

Constructor & Destructor Documentation

FCFontPrefs()

FCFontPrefs::FCFontPrefs ( )

inline

The constructor.

Lua-supported.

Member Function Documentation

ClassName()

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

CreateFontInfo()

FCFontInfo * FCFontPrefs::CreateFontInfo ( )

inline

Creates a FCFontInfo object and initializes with the font preference data. If no data has been loaded to the preference storage, the method returns NULL.

It's the caller's responsibility to delete the created object from the heap after use.

Lua-supported.

GetClassID()

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

GetFontInfo()

bool FCFontPrefs::GetFontInfo ( FCFontInfo * pFontInfo )

inline

Gets the loaded font information.

Lua-supported.

Parameters

pFontInfo

Pointer to the FCFontInfo object to copy the information to.

Returns

True if the font info was copied to the object.

SetFontInfo()

bool FCFontPrefs::SetFontInfo ( FCFontInfo * pFontInfo )

inline

Sets the loaded font information.

Lua-supported.

Parameters

pFontInfo

Pointer to the FCFontInfo object to copy the information from.

Returns

True if successful.