8#ifndef FF_DETAILSCOLLECTION_H
9#define FF_DETAILSCOLLECTION_H
11#include "ff_details.h"
12#include "ff_basecollection.h"
27#ifndef DOXYGEN_SHOULD_IGNORE_THIS
31 const char*
ClassName()
const override {
return "FCGroups"; }
48 twobyte startmeasure = 1)
55#if FXT_VERSION >= FINALEVERSION_2011
94#ifndef DOXYGEN_SHOULD_IGNORE_THIS
102 void _SetGlobal(
bool state) { _loadglobal = state; }
105 const char*
ClassName()
const override {
return "FCBaselines"; }
131#ifndef PDK_FRAMEWORK_LUAFRIENDLY
153#ifndef PDK_FRAMEWORK_LUAFRIENDLY
175#ifndef PDK_FRAMEWORK_LUAFRIENDLY
193#ifndef PDK_FRAMEWORK_LUAFRIENDLY
218 for (
int i = 0; i <
GetCount(); i++)
221 if (pBaseline->
GetStaff() == staffno)
return pBaseline;
238 for (
int i = 0; i <
GetCount(); i++)
241 if (pBaseline->
GetStaff() != staffnumber)
continue;
271#ifndef PDK_FRAMEWORK_LUAFRIENDLY
301#ifndef PDK_FRAMEWORK_LUAFRIENDLY
333#ifndef PDK_FRAMEWORK_LUAFRIENDLY
366#ifndef PDK_FRAMEWORK_LUAFRIENDLY
381#if FXT_VERSION >= FINALEVERSION_2012
391 const char*
ClassName()
const override {
return "__FCFretItemsBase"; }
405 const char*
ClassName()
const override {
return "FCFretItems"; }
419 if (item.
IsBarre())
return false;
438 const char*
ClassName()
const override {
return "FCFretBarreItems"; }
452 if (!item.
IsBarre())
return false;
467#if FXT_VERSION >= FINALEVERSION_2012
477 CMPER _fretboardGroupID;
478 twobyte _fretboardGroupInci;
481 const char*
ClassName()
const override {
return "FCFretboardGroup"; }
505 bool LoadAllForItem(CMPER fretboardGroupID, twobyte fretboardGroupInci);
523 bool SaveAllForItem(CMPER fretboardGroupID, twobyte fretboardGroupInci);
Base class for all data-related classes (that handles Finale data).
Definition ff_base.h:676
Base class specially designed for collections of detail classes.
Definition ff_basecollection.h:880
Base class for all collection classes. A collection is a storage that can store multiple objects of s...
Definition ff_basecollection.h:26
void Add(__FCBase *pNewItem)
Adds an element to the end of the collection.
Definition finaleframework.cpp:13726
int GetCount() const
Returns the number of elements of the collection.
Definition ff_basecollection.h:102
__FCBase * GetItemAt(int index) const
Returns the object at the index position. Index is 0-based.
Definition finaleframework.cpp:13767
Base class specially designed for collections of detail classes that doesn't use the inci.
Definition ff_basecollection.h:919
bool IsBarre() const
returns true if this item is a barre rather than a fret symbol.
Definition ff_details.h:1794
Base collection class of FCFretItem class objects. Inherit from this to get get FCFretItems or FCFret...
Definition ff_detailscollection.h:389
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition ff_detailscollection.h:391
__FCFretItemsBase()
Definition ff_detailscollection.h:394
Encapsulates baselines offset values for lyrics, expressions, fretboards and chords.
Definition ff_details.h:1096
eStaff GetStaff() const
Returns the staff number ID for the baseline.
Definition ff_details.h:1255
BASELINEMODES
The mode constants of the object, used for both loading and saving objects.
Definition ff_details.h:1105
twobyte GetLyricNumber() const
Returns the connected lyric number for the baseline.
Definition ff_details.h:1210
Collection class for FCBaseline class objects.
Definition ff_detailscollection.h:93
int LoadAllForSystemStaff(FCBaseline::BASELINEMODES mode, eSsys systemno, eStaff staffno)
Loads all baseline objects for the staff system in a single staff. These objects are part-specific....
Definition finaleframework.cpp:35586
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition ff_detailscollection.h:105
int LoadAllDefaultsForLyrics(FCBaseline::BASELINEMODES mode)
Loads default baseline values for all lyric numbers that have them. You can also call this for non-ly...
Definition finaleframework.cpp:35625
FCBaseline * AssureSavedLyricNumberForPiece(FCBaseline::BASELINEMODES mode, eStaff staffnumber, eLyric lyricnumber)
Makes sure that there is a global lyric number base line (for a specific staff and lyric number) in t...
Definition finaleframework.cpp:35640
FCBaseline * FindStaff(eStaff staffno)
Finds an object with a specific staff number in the collection.
Definition ff_detailscollection.h:216
FCBaseline * FindLyricNumber(eStaff staffnumber, eLyric lyricnumber)
Finds an object with a specific lyric númber and staff number in the collection.
Definition ff_detailscollection.h:236
FCBaseline * AssureSavedStaffForPiece(FCBaseline::BASELINEMODES mode, eStaff staffnumber)
Makes sure that there is a non-lyric global baseline (for a specific staff) in the collection....
Definition finaleframework.cpp:35676
int LoadAllForSystem(FCBaseline::BASELINEMODES mode, eSsys systemno)
Loads all baseline objects for the staff system. These objects are part-specific.
Definition ff_detailscollection.h:152
FCBaseline * AssureSavedLyricNumber(FCBaseline::BASELINEMODES mode, eSsys systemnumber, eStaff staffnumber, eLyric lyricnumber)
Makes sure that there is a lyric number baseline (for a specific staff/system) in the collection....
Definition finaleframework.cpp:35718
int LoadAllForPiece(FCBaseline::BASELINEMODES mode)
Loads all baseline objects that controls independent staves throughout the entire piece.
Definition finaleframework.cpp:35610
FCBaseline * GetItemAt(int index) const
Overridden GetItemAt() method.
Definition ff_detailscollection.h:206
FCBaseline * AssureSavedStaff(FCBaseline::BASELINEMODES mode, eSsys systemnumber, eStaff staffnumber)
Makes sure that there is a non-lyric baseline (for a specific staff/system) in the collection....
Definition finaleframework.cpp:35756
FCBaselines()
The constructor.
Definition ff_detailscollection.h:111
Class that describes a single fret item on a fret and string.
Definition ff_details.h:1948
Collection class of FCFretItem class objects that are barres.
Definition ff_detailscollection.h:436
bool AddFretItem(const FCFretBarreItem &item)
Adds a FCFretItem to the collection if it is the correct type for the collection (barre or non-barre)...
Definition ff_detailscollection.h:450
FCFretBarreItem * GetItemAt(int index) const
Overridden version of GetItemAt()
Definition ff_detailscollection.h:461
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition ff_detailscollection.h:438
FCFretBarreItems()
internal constructor
Definition ff_detailscollection.h:441
Class that describes a single fret item on a fret and string.
Definition ff_details.h:1809
Collection class of FCFretItem class objects that are not barres.
Definition ff_detailscollection.h:403
FCFretItem * GetItemAt(int index) const
Overridden version of GetItemAt()
Definition ff_detailscollection.h:428
FCFretItems()
internal constructor
Definition ff_detailscollection.h:408
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition ff_detailscollection.h:405
bool AddFretItem(const FCFretItem &item)
Adds a FCFretItem to the collection if it is the correct type for the collection (barre or non-barre)...
Definition ff_detailscollection.h:417
Class that represents a fretboard group. A correctly constructed fretboard group has exactly 12 FCFre...
Definition ff_detailscollection.h:476
bool LoadAllForItem(CMPER fretboardGroupID, twobyte fretboardGroupInci)
Loads the fretboard group for the given key pair.
Definition finaleframework.cpp:35807
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition ff_detailscollection.h:481
bool DeleteDataForItem(CMPER fretboardGroupID, twobyte fretboardGroupInci)
Deletes all items for the given FCFretboardGroupDef key pair. (Does not affect the data in the collec...
Definition finaleframework.cpp:35825
FCFretboardGroup()
Constructor.
Definition ff_detailscollection.h:487
bool SaveAllForItem(CMPER fretboardGroupID, twobyte fretboardGroupInci)
Saves a loaded or newly constructed fretboard group to a new FCFretboardGroupDef.
Definition finaleframework.cpp:35851
FCFretboardGroupItem * GetItemAt(int index) const
Overridden version of GetItemAt()
Definition ff_detailscollection.h:494
bool SaveAll()
Saves a loaded fretboard group.
Definition finaleframework.cpp:35838
Class that represents a single fretboard group item. The fretboard group item has a header and a list...
Definition ff_details.h:2023
Encapsulates a staff group.
Definition ff_details.h:79
twobyte GetStartStaff() const
Returns the start staff number for the group.
Definition ff_details.h:499
twobyte GetEndStaff() const
Returns the end staff number for the group.
Definition ff_details.h:437
twobyte GetStartMeasure() const
Returns the start measure for the group (for Finale 2011 and later)
Definition ff_details.h:661
Collection class for FCGroup class objects.
Definition ff_detailscollection.h:25
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition ff_detailscollection.h:31
FCGroup * GetItemAt(int index) const
Overridden GetItemAt() method.
Definition ff_detailscollection.h:68
FCGroups()
The constructor.
Definition ff_detailscollection.h:37
FCGroup * Find(CMPER startstaff, CMPER endstaff, twobyte startmeasure=1)
Tries to find a matching group in the collection.
Definition ff_detailscollection.h:46