11#include "ff_basecollection.h"
22 const char*
ClassName()
const override {
return "__FCGlobals"; }
32 bool Load(twobyte globalnumber);
52 EDTClefDef _clefdefold;
53#if FXT_VERSION >= FINALEVERSION_2012
54 EDTClefDef2012 _clefdef2012;
57#ifndef DOXYGEN_SHOULD_IGNORE_THIS
58 bool _Use2012Version()
const;
60 EXTAG
Tag()
const override {
return gb_ClefDef; }
63 EVERSION
EnigmaVersion()
const override {
return _Use2012Version() ? FINALEVERSION_2012 : FINALEVERSION_2010; }
79#ifndef DOXYGEN_SHOULD_IGNORE_THIS
80 const char*
ClassName()
const override {
return "FCClefDef"; }
89 void* _GetClefDef() {
return Allocate(); }
159 memset(&_clefdefold, 0,
sizeof(_clefdefold));
160#if FXT_VERSION >= FINALEVERSION_2012
161 memset(&_clefdef2012, 0,
sizeof(_clefdef2012));
224#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
226 luabridge::RefCountedPtr<FCFontInfo> CreateEffectiveFontInfo_GC()
const
317#ifndef DOXYGEN_SHOULD_IGNORE_THIS
327 const char*
ClassName()
const override {
return "FCClefDefs"; }
Base class for all data-related classes (that handles Finale data).
Definition ff_base.h:676
virtual __FCBaseData * CreateObject()=0
Creates a new instance of the object.
const PDKFRAMEWORK_CLASSID GetClassID() const override=0
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
EDataID _dataid
The EdataID for the last loaded/saved object.
Definition ff_base.h:712
void * _datablock
Pointer to the object's data block, the meaning is implementation-specific for each derived subclass.
Definition ff_base.h:695
virtual EVERSION EnigmaVersion() const
The Enigma version for save/load/create/delete operations.
Definition ff_base.h:812
virtual int DataSizeLoad() const =0
Returns the data size for the data structure that should be loaded.
virtual EXTAG Tag() const =0
The Enigma tag for the derived class.
virtual void CloneMemoryFrom(__FCBaseData *pSource)
Definition finaleframework.cpp:838
virtual void * Allocate()=0
int _loadedsize
Loaded size of the data block for a loaded object, in bytes. Since the datablock is implementation-sp...
Definition ff_base.h:708
PDKFRAMEWORK_CLASSID
Constants for the GetClassID method.
Definition ff_base.h:84
Base class for "Global" data.
Definition ff_basecollection.h:864
__FCBase * GetItemAt(int index) const
Returns the object at the index position. Index is 0-based.
Definition finaleframework.cpp:13767
Base class for all data that use the global part of the EDataID.
Definition ff_globals.h:20
bool LoadNext() override
Loads the next element from the database, if any.
Definition ff_globals.h:40
bool Load(twobyte globalnumber)
Loads a single member from the globals data storage.
Definition finaleframework.cpp:21659
bool LoadFirst() override
Loads first member from the globals data storage.
Definition ff_globals.h:38
__FCGlobals()
The constructor.
Definition ff_globals.h:26
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition ff_globals.h:22
Data class for the global clef definitions.
Definition ff_globals.h:51
void SetFontInfo(FCFontInfo *pFontInfo)
Sets the font for the clef definition.
Definition finaleframework.cpp:21795
CMPER GetClefIndex() const
Returns the 0-based clef index/ID.
Definition ff_globals.h:234
void SetUseCustomFont(bool state)
Sets the custom font state.
Definition finaleframework.cpp:21827
DEFAULTCLEFIDS
Default GetClefIndex values. If the clefs have not been modified in the clef designer,...
Definition ff_globals.h:97
@ DEFAULTCLEFID_PERCUSSION
Definition ff_globals.h:111
@ DEFAULTCLEFID_ALTO
Definition ff_globals.h:102
@ DEFAULTCLEFID_TREBLE8VB
Definition ff_globals.h:114
@ DEFAULTCLEFID_ALTPERCUSSION
Definition ff_globals.h:135
@ DEFAULTCLEFID_BARITONEC
Definition ff_globals.h:126
@ DEFAULTCLEFID_TREBLE
Definition ff_globals.h:99
@ DEFAULTCLEFID_TREBLE8VA
Definition ff_globals.h:138
@ DEFAULTCLEFID_BASS8VB
Definition ff_globals.h:117
@ DEFAULTCLEFID_BASS
Definition ff_globals.h:108
@ DEFAULTCLEFID_FRENCHVIOLIN
Definition ff_globals.h:123
@ DEFAULTCLEFID_BLANK
Definition ff_globals.h:144
@ DEFAULTCLEFID_TAB1
Definition ff_globals.h:147
@ DEFAULTCLEFID_SOPRANO
Definition ff_globals.h:132
@ DEFAULTCLEFID_BARITONE
Definition ff_globals.h:120
@ DEFAULTCLEFID_BASS8VA
Definition ff_globals.h:141
@ DEFAULTCLEFID_MEZZOSOPRANO
Definition ff_globals.h:129
@ DEFAULTCLEFID_TENOR
Definition ff_globals.h:105
@ DEFAULTCLEFID_TAB2
Definition ff_globals.h:150
void SetShapeID(twobyte shapeID)
Sets the shape ID for the clef.
Definition finaleframework.cpp:21813
Efix16 GetBaselineOffset() const
Returns the baseline offset, as an EFIX value.
Definition finaleframework.cpp:21713
bool GetIsShape() const
Returns true if a shape is used as clef.
Definition finaleframework.cpp:21911
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 s...
Definition finaleframework.cpp:21781
void SetVerticalAdjust(twobyte value)
Sets the vertical adjustment (related to middle C) of the clef.
Definition finaleframework.cpp:21841
twobyte GetShapeID() const
Returns the shape ID (if any) for the clef. 0 if there is no shape clef.
Definition finaleframework.cpp:21922
void SetBaselineOffset(Efix16 value)
Sets the baseline offset, as an EFIX value.
Definition finaleframework.cpp:21855
bool GetUseCustomFont() const
Returns true if a custom font is used.
Definition finaleframework.cpp:21746
twobyte GetVerticalAdjust() const
Returns the vertical adjustment (related to middle C) of the clef.
Definition finaleframework.cpp:21702
FCClefDef()
The constructor.
Definition ff_globals.h:157
void SetClefPosition(twobyte clefpos)
Sets the vertical Clef Position.
Definition finaleframework.cpp:21883
void SetSymbol(eUniChar32 symbolchar)
Sets the symbol character for the clef definition.
Definition finaleframework.cpp:21869
twobyte GetClefPosition() const
Returns the vertical Clef Position.
Definition finaleframework.cpp:21735
bool GetFontInfo(FCFontInfo *pFontInfo) const
Gets the custom font for the clef.
Definition finaleframework.cpp:21757
eUniChar32 GetSymbol() const
Returns the symbol character for the clef definition.
Definition finaleframework.cpp:21724
void SetIsShape(bool state)
Sets if a shape is used as clef or not.
Definition finaleframework.cpp:21897
Collection class for FCClefDef class objects.
Definition ff_globals.h:315
FCClefDef * GetItemAt(int index) const
Overridden GetItemAt() method.
Definition ff_globals.h:333
FCClefDefs()
The constructor.
Definition ff_globals.h:325
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition ff_globals.h:327
Class for document-independent font information.
Definition ff_base.h:1138