8#ifndef FF_ENTRYDETAILS_H
9#define FF_ENTRYDETAILS_H
11#include "ff_noteframe.h"
15#ifdef PDK_FRAMEWORK_ENTRIES
28#ifndef DOXYGEN_SHOULD_SKIP_THIS
29 bool _RawRelink()
override
47 bool _HasAnyMod(
FCNote* pNote);
52#ifndef DOXYGEN_SHOULD_IGNORE_THIS
54 void _DecreaseInci() {
_dataid.entryDetail.inci--; }
62 _dataid.entryDetail.entryNumber = 0;
65 const char*
ClassName()
const override {
return "__FCEntryDetail"; }
70 _dataid.entryDetail.entryNumber = entnum;
71 _dataid.entryDetail.inci = inci;
78 virtual bool Load(ENTNUM entnum, twobyte inci);
90 bool SaveAs(ENTNUM entnum, twobyte inci);
101 if (!_pMappedEntry)
return false;
118 _pMappedEntry = pEntry;
166#ifndef DOXYGEN_SHOULD_SKIP_THIS
173#ifndef DOXYGEN_SHOULD_SKIP_THIS
179 virtual void _SetEntryFlag(
FCNoteEntry* pNoteEntry,
bool state)
185#ifdef PDK_FRAMEWORK_DEBUG
208#ifndef DOXYGEN_SHOULD_SKIP_THIS
217 EINCI _ScanForNoteID(
FCNoteEntry* pEntry, twobyte noteid);
226 const char*
ClassName()
const override {
return "__FCEntryDetailNoteID"; }
276#ifndef DOXYGEN_SHOULD_SKIP_THIS
287 virtual void SetNoteID(twobyte
id) = 0;
300 virtual bool _IsNoteIDMatch(
void *pBuffer, twobyte
id) = 0;
309 virtual void _SetEntryFlagN(
FCNote* pNote,
bool state)
311 pNote->_SetNoteDetailEntryFlag(state);
321 virtual bool _GetEntryFlagN(
FCNote* pNote)
323 return pNote->_GetNoteDetailEntryFlag();
339#ifndef DOXYGEN_SHOULD_IGNORE_THIS
340 EDTNoteheadMods2002 _noteheadmod;
342#if FXT_VERSION >= FINALEVERSION_2012
343 EDTNoteheadMods2012 _noteheadmod2012;
346 bool _Use2012Version()
const;
348 const twobyte* _GetHorizontalPosPtr()
const
350#if FXT_VERSION >= FINALEVERSION_2012
351 if (_Use2012Version())
return &_noteheadmod2012.horizpos;
353 return &_noteheadmod.horizpos;
356 const twobyte* _GetVerticalPosPtr()
const
358#if FXT_VERSION >= FINALEVERSION_2012
359 if (_Use2012Version())
return &_noteheadmod2012.vertpos;
361 return &_noteheadmod.vertpos;
364 const FLAG_16* _GetFlagPtr()
const
366#if FXT_VERSION >= FINALEVERSION_2012
367 if (_Use2012Version())
return &_noteheadmod2012.flag;
369 return &_noteheadmod.flag;
372 const FLAG_16* _GetEfxPtr()
const
374#if FXT_VERSION >= FINALEVERSION_2012
375 if (_Use2012Version())
return &_noteheadmod2012.efx;
377 return &_noteheadmod.efx;
380 const twobyte* _GetFontSizePtr()
const
382#if FXT_VERSION >= FINALEVERSION_2012
383 if (_Use2012Version())
return &_noteheadmod2012.fontsize;
385 return &_noteheadmod.fontsize;
388 const twobyte* _GetResizePercentPtr()
const
390#if FXT_VERSION >= FINALEVERSION_2012
391 if (_Use2012Version())
return &_noteheadmod2012.resizepercent;
393 return &_noteheadmod.resizepercent;
396 const twobyte* _GetFontIDPtr()
const
398#if FXT_VERSION >= FINALEVERSION_2012
399 if (_Use2012Version())
return &_noteheadmod2012.fontID;
401 return &_noteheadmod.fontID;
404 const twobyte* _GetNoteIDPtr()
const
406#if FXT_VERSION >= FINALEVERSION_2012
407 if (_Use2012Version())
return &_noteheadmod2012.noteID;
409 return &_noteheadmod.noteID;
412 mutable EFONTNAME _fontname;
413#if FXT_VERSION >= FINALEVERSION_25
414 mutable EnigmaFontName _fontnameUTF16;
417 EXTAG
Tag()
const override {
return ed_NoteheadMods2002; }
423 if (_Use2012Version())
return FINALEVERSION_2012;
424 return FXT_VERSION_2K2_BASE;
442 const char*
ClassName()
const override {
return "FCNoteheadMod"; }
445#ifndef DOXYGEN_SHOULD_IGNORE_THIS
450 void* _GetNoteheadMod()
452#if FXT_VERSION >= FINALEVERSION_2012
453 if (_Use2012Version())
456 return &_noteheadmod2012;
459 return &_noteheadmod;
497 return *_GetVerticalPosPtr();
510 return *_GetVerticalPosPtr();
520 return GetBitFlag(*_GetFlagPtr(), NOTEHEAD_ALLOW_VERTPOS);
533#if FXT_VERSION >= FINALEVERSION_2012
534 if (_Use2012Version())
return _noteheadmod2012.fontchar;
536 return _noteheadmod.fontchar;
545#if FXT_VERSION >= FINALEVERSION_2012
546 if (_Use2012Version())
return (_noteheadmod2012.fontchar != 0);
548 return (_noteheadmod.fontchar != 0);
559 return *_GetResizePercentPtr();
569 return GetBitFlag(*_GetFlagPtr(), NOTEHEAD_CUSTOMFONT);
583 FX_FontNumToName(*_GetFontIDPtr(), &_fontname);
584 return (
const char*) &_fontname;
587#if FXT_VERSION >= FINALEVERSION_25
598 FX_FontNumToName_UTF16(*_GetFontIDPtr(), _fontnameUTF16, DIM(_fontnameUTF16));
599 return _fontnameUTF16;
612 return *_GetFontSizePtr();
640 pInfo->
SetSize(*_GetFontSizePtr());
653 return GetBitFlag(*_GetFlagPtr(), NOTEHEAD_ENHARMONIC_FLIP);
663 twobyte* pValue = (twobyte*) _GetHorizontalPosPtr();
679 twobyte* pValue = (twobyte*) _GetVerticalPosPtr();
694 Set16BitFlag((FLAG_16*) _GetFlagPtr(), NOTEHEAD_ALLOW_VERTPOS, status);
718 twobyte* pValue = (twobyte*) _GetResizePercentPtr();
731 Set16BitFlag((FLAG_16*) _GetFlagPtr(), NOTEHEAD_CUSTOMFONT, status);
756 twobyte fontnum = FX_FontNameToNum((EFONTNAME*) pszFont);
757 twobyte* pValue = (twobyte*) _GetFontIDPtr();
761#if FXT_VERSION >= FINALEVERSION_25
772 twobyte fontnum = FX_FontNameToNum_UTF16(pszFont);
773 twobyte* pValue = (twobyte*) _GetFontIDPtr();
790 twobyte* pValue = (twobyte*) _GetFontSizePtr();
801 twobyte* pValue = (twobyte*) _GetEfxPtr();
813 twobyte* pEfx = (twobyte*) _GetEfxPtr();
815 twobyte* pFontSize = (twobyte*) _GetFontSizePtr();
817 twobyte* pFontID = (twobyte*) _GetFontIDPtr();
832#if FXT_VERSION >= FINALEVERSION_2012
833 if (_Use2012Version())
835 _noteheadmod2012.fontchar = ch;
839 _noteheadmod.fontchar = 0xff00 | (ch & 0x00ff);
885 Set16BitFlag((FLAG_16*) _GetFlagPtr(), NOTEHEAD_ENHARMONIC_FLIP, status);
896#if FXT_VERSION >= FINALEVERSION_2012
897 if (_Use2012Version())
899 _noteheadmod2012.fontchar = 0;
903 _noteheadmod.fontchar = 0;
913 twobyte* pValue = (twobyte*) _GetNoteIDPtr();
917#ifndef DOXYGEN_SHOULD_IGNORE_THIS
918 bool _IsNoteIDMatch(
void *pBuffer, twobyte
id)
override
920#if FXT_VERSION >= FINALEVERSION_2012
921 if (_Use2012Version())
923 return (((EDTNoteheadMods2012*) pBuffer)->noteID ==
id);
926 return (((EDTNoteheadMods2002*) pBuffer)->noteID ==
id);
941#ifndef DOXYGEN_SHOULD_IGNORE_THIS
945 EXTAG
Tag()
const override {
return ed_DotMods; }
946 int DataSizeLoad()
const override {
return sizeof(EDTDotMods); }
947 int DataSizeSave()
const override {
return sizeof(EDTDotMods); }
948 void*
Allocate()
override {
return (
void*) &_dotmod; }
956 memcpy(&_dotmod, ((
FCDotMod*)pSource)->_GetDotMod(),
sizeof(_dotmod));
965 const char*
ClassName()
const override {
return "FCDotMod"; }
968#ifndef DOXYGEN_SHOULD_IGNORE_THIS
973 EDTDotMods* _GetDotMod() {
return &_dotmod; }
982 memset(&_dotmod, 0,
sizeof(_dotmod));
1037 void SetNoteID(twobyte
id)
override { _dotmod.noteID = id; }
1051#ifndef DOXYGEN_SHOULD_IGNORE_THIS
1052 bool _IsNoteIDMatch(
void *pBuffer, twobyte
id)
override
1054 return (((EDTDotMods*) pBuffer)->noteID ==
id);
1061 void _SetEntryFlagN(
FCNote* pNote,
bool state)
override
1063 pNote->_SetSpecialAltsEntryFlag(state);
1070 bool _GetEntryFlagN(
FCNote* pNote)
override
1072 return pNote->_GetSpecialAltsEntryFlag();
1088#ifndef DOXYGEN_SHOULD_IGNORE_THIS
1089 EDTCrossStaff _crossstaff;
1092 EXTAG
Tag()
const override {
return ed_CrossStaff; }
1093 int DataSizeLoad()
const override {
return sizeof(EDTCrossStaff); }
1094 int DataSizeSave()
const override {
return sizeof(EDTCrossStaff); }
1095 void*
Allocate()
override {
return (
void*) &_crossstaff; }
1103 memcpy(&_crossstaff, ((
FCCrossStaffMod*)pSource)->_GetCrossStaff(),
sizeof(_crossstaff));
1112 const char*
ClassName()
const override {
return "FCCrossStaffMod"; }
1115#ifndef DOXYGEN_SHOULD_IGNORE_THIS
1120 EDTCrossStaff* _GetCrossStaff() {
return &_crossstaff; }
1129 memset(&_crossstaff, 0,
sizeof(_crossstaff));
1140 twobyte
GetStaff()
const {
return _crossstaff.instrument; }
1148 void SetStaff(eStaff staff) { _crossstaff.instrument = staff; }
1155 void SetNoteID(twobyte
id)
override { _crossstaff.noteID = id; }
1157#ifndef DOXYGEN_SHOULD_IGNORE_THIS
1158 bool _IsNoteIDMatch(
void *pBuffer, twobyte
id)
override
1160 return (((EDTCrossStaff*) pBuffer)->noteID ==
id);
1167 void _SetEntryFlagN(
FCNote* pNote,
bool state)
override
1169 pNote->_SetCrossStaffEntryFlag(state);
1177 bool _GetEntryFlagN(
FCNote* pNote)
override
1179 return pNote->_GetCrossStaffEntryFlag();
1198#ifndef DOXYGEN_SHOULD_IGNORE_THIS
1199 EDTSecondaryBeamBreakMods _secondarybeambreakmod;
1202 int DataSizeLoad()
const override {
return sizeof(EDTSecondaryBeamBreakMods); }
1203 int DataSizeSave()
const override {
return sizeof(EDTSecondaryBeamBreakMods); }
1204 void*
Allocate()
override {
return (
void*) &_secondarybeambreakmod; }
1212 memcpy(&_secondarybeambreakmod, ((
FCSecondaryBeamBreakMod*)pSource)->_GetSecondaryBeamBreakMod(),
sizeof(_secondarybeambreakmod));
1221 const char*
ClassName()
const override {
return "FCSecondaryBeamBreakMod"; }
1224#ifndef DOXYGEN_SHOULD_IGNORE_THIS
1229 EDTSecondaryBeamBreakMods* _GetSecondaryBeamBreakMod() {
return &_secondarybeambreakmod; }
1239 memset(&_secondarybeambreakmod, 0,
sizeof(_secondarybeambreakmod));
1251 if (beamindex < 0)
return;
1252 if (beamindex > 8)
return;
1253 _secondarybeambreakmod.breaks[beamindex] = value ? 1 : 0;
1264 for (
int i = 0; i < 9; i++)
SetBreak(i, value);
1275 for (
int beamindex = 0; beamindex < 9; beamindex++)
1276 if (_secondarybeambreakmod.breaks[beamindex])
return beamindex;
1288 if (beamindex < 0)
return false;
1289 if (beamindex > 8)
return false;
1290 return (_secondarybeambreakmod.breaks[beamindex] != 0);
1383#ifndef DOXYGEN_SHOULD_IGNORE_THIS
1388 void _SetEntryFlag(
FCNoteEntry* pNoteEntry,
bool state)
override
1411#ifndef DOXYGEN_SHOULD_IGNORE_THIS
1412 EDTBeamExtMods _beamextensionmod;
1417 int DataSizeLoad()
const override {
return sizeof(_beamextensionmod); }
1419 void*
Allocate()
override {
return (
void*) &_beamextensionmod; }
1428 if (!pSourceMod)
return;
1429 memcpy(&_beamextensionmod, pSourceMod->_GetBeamExtensionMod(),
DataSizeLoad());
1430 _upstemuse = pSourceMod->_upstemuse;
1439 const char*
ClassName()
const override {
return "FCBeamExtensionMod"; }
1442#ifndef DOXYGEN_SHOULD_IGNORE_THIS
1447 EDTBeamExtMods* _GetBeamExtensionMod() {
return &_beamextensionmod; }
1458 memset(&_beamextensionmod, 0,
sizeof(_beamextensionmod));
1485 SetCustomTag(useupstem ? ed_BeamExtAboveMods : ed_BeamExtBelowMods);
1486 _upstemuse = useupstem;
1533 if (beamindex < 0)
return;
1534 if (beamindex > 9)
return;
1537 _beamextensionmod.beams |= (FCNoteEntry::NOTE_8TH >> beamindex);
1538 _beamextensionmod.beams |= BMEXT_HAS_BMEXT;
1542 _beamextensionmod.beams &= ~(FCNoteEntry::NOTE_8TH >> beamindex);
1543 if (! (_beamextensionmod.beams & BMEXT_BEAM_MASK))
1544 _beamextensionmod.beams &= ~BMEXT_HAS_BMEXT;
1556 for (
int i = 0; i <= 9; i++)
SetExtend(i, value);
1567 if (beamindex < 0)
return false;
1568 if (beamindex > 9)
return false;
1569 if (!
GetBitFlag(_beamextensionmod.beams, BMEXT_HAS_BMEXT))
return false;
1570 return ((_beamextensionmod.beams & (FCNoteEntry::NOTE_8TH >> beamindex)) != 0);
1681#ifndef DOXYGEN_SHOULD_IGNORE_THIS
1686 void _SetEntryFlag(
FCNoteEntry* pNoteEntry,
bool state)
override
1703#ifndef DOXYGEN_SHOULD_IGNORE_THIS
1704 EDTStemMods _stemmod;
1708 int DataSizeLoad()
const override {
return sizeof(EDTStemMods); }
1709 int DataSizeSave()
const override {
return sizeof(EDTStemMods); }
1710 void*
Allocate()
override {
return (
void*) &_stemmod; }
1718 memcpy(&_stemmod, ((
FCStemMod*)pSource)->_GetStemMod(),
sizeof(_stemmod));
1727 const char*
ClassName()
const override {
return "FCStemMod"; }
1730#ifndef DOXYGEN_SHOULD_IGNORE_THIS
1735 EDTStemMods* _GetStemMod() {
return &_stemmod; }
1742 memset(&_stemmod, 0,
sizeof(_stemmod));
1746 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
1751 void _SetEntryFlag(
FCNoteEntry* pNoteEntry,
bool state)
override
1802 _stemmod.horizAdjust = MAKE_TWOBYTE(_stemmod.horizAdjust & 0x00ff, adjust);
1813 _stemmod.horizAdjust = MAKE_TWOBYTE(adjust, _stemmod.horizAdjust & 0x00ff);
1840#ifndef DOXYGEN_SHOULD_IGNORE_THIS
1841#if FXT_VERSION >= FINALEVERSION_26
1842 typedef EDTArticulation25_6 CurrEDTArticulation;
1843#elif FXT_VERSION >= FINALEVERSION_2014B
1844 typedef EDTArticulation2014b CurrEDTArticulation;
1846 typedef EDTArticulation CurrEDTArticulation;
1848 CurrEDTArticulation _articulationCurr;
1855 {
return (
void*) &_articulationCurr; }
1868 EXTAG
Tag()
const override {
return ed_Articulation; }
1869 const char*
ClassName()
const override {
return "FCArticulation"; }
1877 ARTICPLACEMENT_AUTOMATIC = 0,
1878 ARTICPLACEMENT_ABOVE,
1879 ARTICPLACEMENT_BELOW
1887 ARTICSTACKING_USEDEFINITION = 0,
1891#ifndef DOXYGEN_SHOULD_IGNORE_THIS
1892#if FXT_VERSION >= FINALEVERSION_26
1896 _articulationCurr.numSlursAvoided = -1;
1908#ifndef DOXYGEN_SHOULD_IGNORE_THIS
1913 void _SetEntryFlag(
FCNoteEntry* pNoteEntry,
bool state)
override
1936 void SetID(CMPER cmper) { _articulationCurr.imrkdef = cmper; }
1945 _articulationCurr.posadd = pos;
1955 _articulationCurr.posadder = pos;
1964 _articulationCurr.noteadd = pos;
1973 _articulationCurr.lonoadd = pos;
2000#ifndef PDK_FRAMEWORK_LUAFRIENDLY
2016#ifndef PDK_FRAMEWORK_LUAFRIENDLY
2032#ifndef PDK_FRAMEWORK_LUAFRIENDLY
2049#ifndef PDK_FRAMEWORK_LUAFRIENDLY
2090 twobyte
GetID()
const {
return _articulationCurr.imrkdef; }
2102#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
2104 luabridge::RefCountedPtr<FCArticulationDef> CreateArticulationDef_GC()
2133#ifdef PDK_FRAMEWORK_DEBUG
2154#ifndef DOXYGEN_SHOULD_IGNORE_THIS
2155 EDTTuplet2005 _tuplet;
2158 int DataSizeLoad()
const override {
return sizeof(EDTTuplet2005); }
2159 int DataSizeSave()
const override {
return sizeof(EDTTuplet2005); }
2160 void*
Allocate()
override {
return (
void*) &_tuplet; }
2168 memcpy(&_tuplet, ((
FCTuplet*)pSource)->_GetTuplet(),
sizeof(_tuplet));
2179 EXTAG
Tag()
const override {
return ed_Tuplet; }
2187 TUPLETPLACEMENT_MANUAL = 0,
2188 TUPLETPLACEMENT_STEMSIDE,
2189 TUPLETPLACEMENT_NOTESIDE,
2190 TUPLETPLACEMENT_ABOVE,
2191 TUPLETPLACEMENT_BELOW
2201 TUPLETNUMBER_NONE = 0,
2202 TUPLETNUMBER_REGULAR,
2204 TUPLETNUMBER_RATIOANDNOTE,
2205 TUPLETNUMBER_RATIOANDNOTE_BOTH
2214 TUPLETSHAPE_NONE = 0,
2215 TUPLETSHAPE_BRACKET,
2225 TUPLETBRACKET_ALWAYS = 0,
2226 TUPLETBRACKET_UNBEAMEDONLY,
2227 TUPLETBRACKET_NEVERBEAMEDONBEAMSIDE
2230 const char*
ClassName()
const override {
return "FCTuplet"; }
2233#ifndef DOXYGEN_SHOULD_IGNORE_THIS
2238 EDTTuplet2005* _GetTuplet() {
return &_tuplet; }
2247 memset(&_tuplet, 0,
sizeof(_tuplet));
2270#ifdef PDK_FRAMEWORK_PREFS
2317#ifndef PDK_FRAMEWORK_LUAFRIENDLY
2357#ifndef PDK_FRAMEWORK_LUAFRIENDLY
2371#ifndef PDK_FRAMEWORK_LUAFRIENDLY
2391#ifndef PDK_FRAMEWORK_LUAFRIENDLY
2532#ifndef PDK_FRAMEWORK_LUAFRIENDLY
2573#ifndef PDK_FRAMEWORK_LUAFRIENDLY
2588#ifndef PDK_FRAMEWORK_LUAFRIENDLY
2608#ifndef PDK_FRAMEWORK_LUAFRIENDLY
2715#ifndef DOXYGEN_SHOULD_IGNORE_THIS
2720 void _SetEntryFlag(
FCNoteEntry* pNoteEntry,
bool state)
override
2728#ifdef PDK_FRAMEWORK_DEBUG
2735 case TUPLETPLACEMENT_MANUAL:
2736 DebugOut(
"Placement mode: Manual");
2738 case TUPLETPLACEMENT_STEMSIDE:
2739 DebugOut(
"Placement mode: Stem/Beam Side");
2741 case TUPLETPLACEMENT_NOTESIDE:
2742 DebugOut(
"Placement mode: Note Side");
2744 case TUPLETPLACEMENT_ABOVE:
2747 case TUPLETPLACEMENT_BELOW:
2757 case TUPLETNUMBER_NONE:
2758 DebugOut(
"Number appearance: None");
2760 case TUPLETNUMBER_REGULAR:
2761 DebugOut(
"Number appearance: Number");
2763 case TUPLETNUMBER_RATIO:
2764 DebugOut(
"Number appearance: Ratio");
2766 case TUPLETNUMBER_RATIOANDNOTE:
2767 DebugOut(
"Number appearance: 7:8q");
2769 case TUPLETNUMBER_RATIOANDNOTE_BOTH:
2770 DebugOut(
"Number appearance: 7q:8q");
2775 case TUPLETSHAPE_NONE:
2776 DebugOut(
"Shape appearance: None");
2778 case TUPLETSHAPE_BRACKET:
2779 DebugOut(
"Shape appearance: Bracket");
2781 case TUPLETSHAPE_SLUR:
2782 DebugOut(
"Shape appearance: Slur");
2789 case TUPLETBRACKET_ALWAYS:
2790 DebugOut(
"Always use specified shape");
2792 case TUPLETBRACKET_UNBEAMEDONLY:
2793 DebugOut(
"Bracket unbeamed notes only");
2795 case TUPLETBRACKET_NEVERBEAMEDONBEAMSIDE:
2796 DebugOut(
"Never bracket beamed notes on beam side");
2822#undef __SHOULD_INCLUDE_SYLLABLE_CODE
2824#if (FXT_VERSION > FINALEVERSION_2012)
2825#define __SHOULD_INCLUDE_SYLLABLE_CODE 1
2828#ifdef DOXYGEN_SHOULD_SKIP_THIS
2829#define __SHOULD_INCLUDE_SYLLABLE_CODE 1
2832#ifdef __SHOULD_INCLUDE_SYLLABLE_CODE
2847#ifndef DOXYGEN_SHOULD_IGNORE_THIS
2848 EDTLyric2011 _syllable;
2851 int _CalcStringPos(twobyte syllablepos)
const;
2854 FCFontInfo* _CreateFontInfo(twobyte syllablenumber)
const;
2856 int DataSizeLoad()
const override {
return sizeof(EDTLyric2011); }
2857 int DataSizeSave()
const override {
return sizeof(EDTLyric2011); }
2858 void*
Allocate()
override {
return (
void*) &_syllable; }
2866 memcpy(&_syllable, ((
FCSyllableBase*)pSource)->_GetSyllable(),
sizeof(_syllable));
2876 EXTAG
Tag()
const override = 0;
2880#ifndef DOXYGEN_SHOULD_IGNORE_THIS
2885 EDTLyric2011* _GetSyllable() {
return &_syllable; }
2893 memset(&_syllable, 0,
sizeof(_syllable));
2903 _syllable.horzOff = offset;
2912 _syllable.vertOff = offset;
2923 _syllable.syll = number;
2932 _syllable.rawTextNum = rawtextid;
2943 _syllable.wext = smartshapeID;
2952 Set16BitFlag((FLAG_16*) &_syllable.lyrFlags, EDTLYRDATA_DISPLAY_VERSENUM, state);
2963 _syllable.floatingHorzOff = offset;
2973 return _syllable.horzOff;
2982 return _syllable.vertOff;
2991 return _syllable.syll;
3002 return _syllable.rawTextNum;
3013 return _syllable.wext;
3022 return GetBitFlag(_syllable.lyrFlags, EDTLYRDATA_DISPLAY_VERSENUM);
3031 return _syllable.floatingHorzOff;
3042 NULL, 0, NULL, NULL, NULL, NULL) != 0;
3069 tbool hyphen =
false;
3071 NULL, 0, NULL, NULL, &hyphen, NULL) == 0)
return false;
3105#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
3107 luabridge::RefCountedPtr<__FCLyricsBase> CreateLyricText_GC()
const
3121#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
3123 luabridge::RefCountedPtr<FCFontInfo> CreateFontInfo_GC()
const
3137#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
3139 luabridge::RefCountedPtr<FCFontInfo> CreateNextFontInfo_GC()
const
3171#ifndef DOXYGEN_SHOULD_IGNORE_THIS
3176 void _SetEntryFlag(
FCNoteEntry* pNoteEntry,
bool state)
override
3183#ifdef PDK_FRAMEWORK_DEBUG
3206 const char*
ClassName()
const override {
return "FCVerseSyllable"; }
3226 const char*
ClassName()
const override {
return "FCChorusSyllable"; }
3245 const char*
ClassName()
const override {
return "FCSectionSyllable"; }
3266#ifndef DOXYGEN_SHOULD_IGNORE_THIS
3267 EDTLyricEntryInfo _lyricinfo;
3269 EXTAG
Tag()
const override {
return ed_LyricEntryInfo; }
3270 int DataSizeLoad()
const override {
return sizeof(EDTLyricEntryInfo); }
3271 int DataSizeSave()
const override {
return sizeof(EDTLyricEntryInfo); }
3272 void*
Allocate()
override {
return (
void*) &_lyricinfo; }
3280 memcpy(&_lyricinfo, ((
FCSyllableEntryMod*)pSource)->_GetSyllableEntryMod(),
sizeof(_lyricinfo));
3328 const char*
ClassName()
const override {
return "FCSyllableEntryMod"; }
3331#ifndef DOXYGEN_SHOULD_IGNORE_THIS
3336 EDTLyricEntryInfo* _GetSyllableEntryMod() {
return &_lyricinfo; }
3346 memset(&_lyricinfo, 0,
sizeof(_lyricinfo));
3351#ifndef DOXYGEN_SHOULD_IGNORE_THIS
3356 void _SetEntryFlag(
FCNoteEntry* pNoteEntry,
bool state)
override
3368#ifndef PDK_FRAMEWORK_LUAFRIENDLY
3375 return (
SYLLABLEALIGNS) ((_lyricinfo.flag & LyricEntryInfo_AlignBits) / 0x100);
3384#ifndef PDK_FRAMEWORK_LUAFRIENDLY
3402#ifndef PDK_FRAMEWORK_LUAFRIENDLY
3409 FLAG_16 bitflag = (FLAG_16) value;
3410 bitflag = bitflag & 3;
3412 _lyricinfo.flag &= ~LyricEntryInfo_AlignBits;
3413 _lyricinfo.flag |= bitflag;
3423#ifndef PDK_FRAMEWORK_LUAFRIENDLY
3431 FLAG_16 bitflag = (FLAG_16) value;
3432 bitflag = bitflag & 3;
3433 _lyricinfo.flag &= ~LyricEntryInfo_JustifyBits;
3434 _lyricinfo.flag |= bitflag;
3438#if PDK_FRAMEWORK_DEBUG
3460#ifndef DOXYGEN_SHOULD_IGNORE_THIS
3464 EXTAG
Tag()
const override {
return ed_Alter; }
3465 int DataSizeLoad()
const override {
return sizeof(EDTAlter); }
3466 int DataSizeSave()
const override {
return sizeof(EDTAlter); }
3467 void*
Allocate()
override {
return (
void*) &_alter; }
3475 memcpy(&_alter, ((
FCEntryAlterMod*)pSource)->_GetAlterMod(),
sizeof(_alter));
3484 const char*
ClassName()
const override {
return "FCEntryAlterMod"; }
3487#ifndef DOXYGEN_SHOULD_IGNORE_THIS
3492 EDTAlter* _GetAlterMod() {
return &_alter; }
3502 memset(&_alter, 0,
sizeof(_alter));
3503 _alter.percent = 100;
3508#ifndef DOXYGEN_SHOULD_IGNORE_THIS
3513 void _SetEntryFlag(
FCNoteEntry* pNoteEntry,
bool state)
override
3526 if (value == 0) value = 100;
3527 _alter.percent = value;
3537 if (_alter.percent == 0)
return 100;
3538 return _alter.percent;
3541#if PDK_FRAMEWORK_DEBUG
3561#ifndef DOXYGEN_SHOULD_IGNORE_THIS
3562 EDTAccidentalMods2001 _accidentalmod;
3564#if FXT_VERSION >= FINALEVERSION_2012
3565 EDTAccidentalMods2012 _accidentalmod2012;
3568 bool _Use2012Version()
const;
3570 const twobyte* _GetHorizontalPosPtr()
const
3572#if FXT_VERSION >= FINALEVERSION_2012
3573 if (_Use2012Version())
return &_accidentalmod2012.horizpos;
3575 return &_accidentalmod.horizpos;
3578 const twobyte* _GetVerticalPosPtr()
const
3580#if FXT_VERSION >= FINALEVERSION_2012
3581 if (_Use2012Version())
return &_accidentalmod2012.vertpos;
3583 return &_accidentalmod.vertpos;
3586 const FLAG_16* _GetFlagPtr()
const
3588#if FXT_VERSION >= FINALEVERSION_2012
3589 if (_Use2012Version())
return &_accidentalmod2012.flag;
3591 return &_accidentalmod.flag;
3594 const FLAG_16* _GetEfxPtr()
const
3596#if FXT_VERSION >= FINALEVERSION_2012
3597 if (_Use2012Version())
return &_accidentalmod2012.efx;
3599 return (FLAG_16*) &_accidentalmod.efx;
3602 const twobyte* _GetFontSizePtr()
const
3604#if FXT_VERSION >= FINALEVERSION_2012
3605 if (_Use2012Version())
return &_accidentalmod2012.fontsize;
3607 return &_accidentalmod.fontsize;
3610 const twobyte* _GetResizePercentPtr()
const
3612#if FXT_VERSION >= FINALEVERSION_2012
3613 if (_Use2012Version())
return &_accidentalmod2012.resizepercent;
3615 return &_accidentalmod.resizepercent;
3618 const twobyte* _GetFontIDPtr()
const
3620#if FXT_VERSION >= FINALEVERSION_2012
3621 if (_Use2012Version())
return &_accidentalmod2012.fontID;
3623 return &_accidentalmod.fontID;
3626 const twobyte* _GetNoteIDPtr()
const
3628#if FXT_VERSION >= FINALEVERSION_2012
3629 if (_Use2012Version())
return &_accidentalmod2012.noteID;
3631 return &_accidentalmod.noteID;
3634 mutable EFONTNAME _fontname;
3635#if FXT_VERSION >= FINALEVERSION_25
3636 mutable EnigmaFontName _fontnameUTF16;
3639 EXTAG
Tag()
const override {
return ed_AccidentalMods2001; }
3645 if (_Use2012Version())
return FINALEVERSION_2012;
3646 return FXT_VERSION_2K2_BASE;
3664 const char*
ClassName()
const override {
return "FCAccidentalMod"; }
3667#ifndef DOXYGEN_SHOULD_IGNORE_THIS
3672 void* _GetAccidentalMod()
3674#if FXT_VERSION >= FINALEVERSION_2012
3675 if (_Use2012Version())
return &_accidentalmod2012;
3677 return &_accidentalmod;
3711 return *_GetVerticalPosPtr();
3720 return *_GetVerticalPosPtr();
3729 return GetBitFlag(*_GetFlagPtr(), ACCIMODS_VERTICAL_POS);
3742#if FXT_VERSION >= FINALEVERSION_2012
3743 if (_Use2012Version())
return _accidentalmod2012.fontchar;
3745 return _accidentalmod.fontchar;
3754#if FXT_VERSION >= FINALEVERSION_2012
3755 if (_Use2012Version())
return (_accidentalmod2012.fontchar != 0);
3757 return (_accidentalmod.fontchar != 0);
3768 return *_GetResizePercentPtr();
3777 return GetBitFlag(*_GetFlagPtr(), ACCIMODS_CUSTOM_FONT);
3791 FX_FontNumToName(*_GetFontIDPtr(), &_fontname);
3792 return (
const char*) &_fontname;
3795#if FXT_VERSION >= FINALEVERSION_25
3808 FX_FontNumToName_UTF16(*_GetFontIDPtr(), _fontnameUTF16, DIM(_fontnameUTF16));
3810 return _fontnameUTF16;
3823 return *_GetFontSizePtr();
3849 pInfo->
SetSize(*_GetFontSizePtr());
3861 twobyte* pValue = (twobyte*) _GetHorizontalPosPtr();
3877 twobyte* pValue = (twobyte*) _GetVerticalPosPtr();
3892 Set16BitFlag((FLAG_16*) _GetFlagPtr(), ACCIMODS_VERTICAL_POS, status);
3915 twobyte* pValue = (twobyte*) _GetResizePercentPtr();
3928 Set16BitFlag((FLAG_16*) _GetFlagPtr(), ACCIMODS_CUSTOM_FONT, status);
3953 twobyte fontnum = FX_FontNameToNum((EFONTNAME*) pszFont);
3954 twobyte* pValue = (twobyte*) _GetFontIDPtr();
3958#if FXT_VERSION >= FINALEVERSION_25
3971 twobyte fontnum = FX_FontNameToNum_UTF16(pszFont);
3972 twobyte* pValue = (twobyte*) _GetFontIDPtr();
3989 twobyte* pValue = (twobyte*) _GetFontSizePtr();
4000 twobyte* pValue = (twobyte*) _GetEfxPtr();
4012 twobyte* pEfx = (twobyte*) _GetEfxPtr();
4014 twobyte* pFontSize = (twobyte*) _GetFontSizePtr();
4015 *pFontSize = pInfo->
GetSize();
4016 twobyte* pFontID = (twobyte*) _GetFontIDPtr();
4031#if FXT_VERSION >= FINALEVERSION_2012
4032 if (_Use2012Version())
4034 _accidentalmod2012.fontchar = ch;
4038 _accidentalmod.fontchar = 0xff00 | (ch & 0x00ff);
4049#if FXT_VERSION >= FINALEVERSION_2012
4050 if (_Use2012Version())
4052 _accidentalmod2012.fontchar = 0;
4056 _accidentalmod.fontchar = 0;
4066 twobyte* pValue = (twobyte*) _GetNoteIDPtr();
4070#ifndef DOXYGEN_SHOULD_IGNORE_THIS
4071 bool _IsNoteIDMatch(
void *pBuffer, twobyte
id)
override
4073#if FXT_VERSION >= FINALEVERSION_2012
4074 if (_Use2012Version())
4076 return (((EDTAccidentalMods2012*) pBuffer)->noteID ==
id);
4079 return (((EDTAccidentalMods2001*) pBuffer)->noteID ==
id);
4096#ifndef DOXYGEN_SHOULD_IGNORE_THIS
4097 EDTPercNoteCode _percnotemod;
4100 EXTAG
Tag()
const override {
return ed_PercNoteCode ; }
4101 int DataSizeLoad()
const override {
return sizeof(EDTPercNoteCode); }
4102 int DataSizeSave()
const override {
return sizeof(EDTPercNoteCode); }
4103 void*
Allocate()
override {
return (
void*) &_percnotemod; }
4111 memcpy(&_percnotemod, ((
FCPercussionNoteMod*)pSource)->_GetPercussionNoteMod(),
sizeof(_percnotemod));
4120 const char*
ClassName()
const override {
return "FCPercussionNoteMod"; }
4123#ifndef DOXYGEN_SHOULD_IGNORE_THIS
4128 EDTPercNoteCode* _GetPercussionNoteMod() {
return &_percnotemod; }
4138 memset(&_percnotemod, 0,
sizeof(_percnotemod));
4159 void SetNoteID(twobyte
id)
override { _percnotemod.noteID = id; }
4161#ifndef DOXYGEN_SHOULD_IGNORE_THIS
4162 bool _IsNoteIDMatch(
void *pBuffer, twobyte
id)
override
4164 return (((EDTPercNoteCode*) pBuffer)->noteID ==
id);
4178#ifndef DOXYGEN_SHOULD_IGNORE_THIS
4179 EDTCustomStemMods _customstemmod;
4183 int DataSizeLoad()
const override {
return sizeof(EDTCustomStemMods); }
4184 int DataSizeSave()
const override {
return sizeof(EDTCustomStemMods); }
4185 void*
Allocate()
override {
return (
void*) &_customstemmod; }
4187 EVERSION
EnigmaVersion()
const override {
return FXT_VERSION_2K5_BASE; }
4195 memcpy(&_customstemmod, ((
FCStemMod*)pSource)->_GetStemMod(),
sizeof(_customstemmod));
4204 const char*
ClassName()
const override {
return "FCCustomStemMod"; }
4207#ifndef DOXYGEN_SHOULD_IGNORE_THIS
4212 EDTCustomStemMods* _GetStemMod() {
return &_customstemmod; }
4222 memset(&_customstemmod, 0,
sizeof(_customstemmod));
4225#ifndef DOXYGEN_SHOULD_IGNORE_THIS
4230 void _SetEntryFlag(
FCNoteEntry* pNoteEntry,
bool state)
override
4280#ifndef DOXYGEN_SHOULD_IGNORE_THIS
4281 EDTBeamMods _beammod;
4283 twobyte _secondarybeamnumber;
4284 bool _secondarybeamuse;
4287 void _PreSaveSetup()
4289 if (_secondarybeamuse)
4291 _beammod.beamWidth = -1;
4292 if (_beammod.secondaryBeamEdu == 0)
4299 _beammod.secondaryBeamEdu = 0;
4305 int DataSizeLoad()
const override {
return sizeof(EDTBeamMods); }
4306 int DataSizeSave()
const override {
return sizeof(EDTBeamMods); }
4307 void*
Allocate()
override {
return (
void*) &_beammod; }
4309 EVERSION
EnigmaVersion()
const override {
return FXT_VERSION_2K5_BASE; }
4318 memcpy(&_beammod, pSourceMod->_GetBeamMod(),
sizeof(_beammod));
4322 _upstemuse = pSourceMod->
IsUpStem();
4327 void InitializeData()
4329 memset(&_beammod, 0,
sizeof(_beammod));
4332 #ifdef PDK_FRAMEWORK_PREFS
4341 const char*
ClassName()
const override {
return "FCBeamMod"; }
4344#ifndef DOXYGEN_SHOULD_IGNORE_THIS
4349 EDTBeamMods* _GetBeamMod() {
return &_beammod; }
4366 _secondarybeamuse = secondarybeam;
4368 _secondarybeamnumber = 2;
4369 SetCustomTag(_secondarybeamuse ? ed_BeamBelowModsSecondary : ed_BeamBelowMods);
4374#ifndef DOXYGEN_SHOULD_IGNORE_THIS
4379 void _SetEntryFlag(
FCNoteEntry* pNoteEntry,
bool state)
override
4385 bool Load(ENTNUM entnum, twobyte inci)
override
4390 EDTBeamMods tempbeammod;
4391 memcpy(&tempbeammod, &_beammod,
sizeof(_beammod));
4393 if (!returnval) memcpy(&_beammod, &tempbeammod,
sizeof(_beammod));
4435 if (_secondarybeamuse)
4438 SetCustomTag(useupstem ? ed_BeamAboveModsSecondary : ed_BeamBelowModsSecondary);
4443 SetCustomTag(useupstem ? ed_BeamAboveMods : ed_BeamBelowMods);
4445 _upstemuse = useupstem;
4481 _beammod.mode = mode;
4497 _beammod.startHorizAdjust = offset;
4508 _beammod.endHorizAdjust = offset;
4517 _beammod.startVertAdjust = offset;
4528 _beammod.endVertAdjust = offset;
4540 if (_secondarybeamuse)
return;
4541 _beammod.beamWidth = thickness;
4551 if (_secondarybeamuse)
return;
4552 _beammod.beamWidth = -1;
4555#ifdef PDK_FRAMEWORK_PREFS
4575 if (!_secondarybeamuse)
return;
4576 if (beamnumber <= 1)
return;
4577 _secondarybeamnumber = beamnumber;
4578 twobyte duration = FCNoteEntry::NOTE_8TH;
4579 for (
int i = 1; i < beamnumber; i++) duration /= 2;
4580 _beammod.secondaryBeamEdu = duration;
4589 return _beammod.startHorizAdjust;
4598 return _beammod.endHorizAdjust;
4607 return _beammod.startVertAdjust;
4616 return _beammod.endVertAdjust;
4640 if (!_secondarybeamuse)
return FCNoteEntry::EIGHTH_NOTE;
4641 return _beammod.secondaryBeamEdu;
4653 if (duration == 0)
return 0;
4654 if (duration > FCNoteEntry::EIGHTH_NOTE)
return 0;
4655 twobyte retvalue = 1;
4656 TimeEdu32 tryvalue = FCNoteEntry::EIGHTH_NOTE;
4659 if (tryvalue == duration)
return retvalue;
4676 if (_secondarybeamuse)
return -1;
4677 return _beammod.beamWidth;
4694 if (!_secondarybeamuse)
return 0;
4695 twobyte result = default_separation * (
GetBeamNumber() - 1);
4696 if (_upstemuse) result = -result;
4715 if (!_secondarybeamuse)
return 0;
4760#ifdef PDK_FRAMEWORK_DEBUG
4786#ifndef DOXYGEN_SHOULD_IGNORE_THIS
4787 EDTPerformanceData _performancedata;
4790 EXTAG
Tag()
const override {
return ed_PerformanceData; }
4791 int DataSizeLoad()
const override {
return sizeof(EDTPerformanceData); }
4792 int DataSizeSave()
const override {
return sizeof(EDTPerformanceData); }
4793 void*
Allocate()
override {
return (
void*) &_performancedata; }
4794 EVERSION
EnigmaVersion()
const override {
return FXT_VERSION_2K2_BASE; }
4802 memcpy(&_performancedata, ((
FCPerformanceMod*)pSource)->_GetPerformanceMod(),
sizeof(_performancedata));
4811 const char*
ClassName()
const override {
return "FCPerformanceMod"; }
4814#ifndef DOXYGEN_SHOULD_IGNORE_THIS
4819 EDTPerformanceData* _GetPerformanceMod() {
return &_performancedata; }
4829 memset(&_performancedata, 0,
sizeof(_performancedata));
4840 _performancedata.enadd = value;
4849 _performancedata.stadd = value;
4860 _performancedata.velocity = value;
4870 _performancedata.keyadd = value;
4879 return _performancedata.enadd;
4888 return _performancedata.stadd;
4898 return _performancedata.keyadd;
4909 return _performancedata.velocity;
4917 void SetNoteID(twobyte
id)
override { _performancedata.noteID = id; }
4919#ifndef DOXYGEN_SHOULD_IGNORE_THIS
4920 bool _IsNoteIDMatch(
void *pBuffer, twobyte
id)
override
4922 return (((EDTPerformanceData*) pBuffer)->noteID ==
id);
4932 void _SetEntryFlagN(
FCNote* pNote,
bool state)
override
4934 pNote->_SetPerformanceDataEntryFlag(state);
4944 bool _GetEntryFlagN(
FCNote* pNote)
override
4946 return pNote->_GetPerformanceDataEntryFlag();
4988#ifndef DOXYGEN_SHOULD_IGNORE_THIS
4994 int DataSizeLoad()
const override {
return sizeof(_tiemod); }
4996 void*
Allocate()
override {
return (
void*) &_tiemod; }
5005 memcpy(&_tiemod, pTieSource->_GetTieMod(),
sizeof(_tiemod));
5018 const char*
ClassName()
const override {
return "FCTieMod"; }
5021#ifndef DOXYGEN_SHOULD_IGNORE_THIS
5026 EDTTieMods* _GetTieMod() {
return &_tiemod; }
5133 static_assert(
TIEMODCNCT_SYSTEMSTART == (::TIE_NUM_CONNECTIONS-1),
"TIEMOD_CONNECTION_CODES does not contain all connection codes in the PDK.");
5135#ifndef DOXYGEN_SHOULD_IGNORE_THIS
5138 twobyte _Get3WayValue(
const FLAG_16 field,
const FLAG_16 localbit,
const FLAG_16 onbit)
const
5147 void _Set3WayValue(
const twobyte value, FLAG_16 &field,
const FLAG_16 localbit,
const FLAG_16 onbit)
5168 void _ActivatePlacementBits(FLAG_16 &epAdj,
bool forTieOver, FLAG_16 connectionCode)
5171 epAdj &= ~TIEPT_CONTEXT_DIR_MASK;
5176 epAdj &= ~TIEPT_ENTCNCT_MASK;
5177 epAdj |= (connectionCode & TIEPT_ENTCNCT_MASK);
5190#ifndef PDK_FRAMEWORK_LUAFRIENDLY
5198 memset(&_tiemod, 0,
sizeof(_tiemod));
5202 SetCustomTag(_starttie ? ed_TieModsStart : ed_TieModsEnd);
5231#ifndef PDK_FRAMEWORK_LUAFRIENDLY
5236 connectioncode, Evpu16 hoffset, Evpu16 voffset)
5238 _ActivatePlacementBits(_tiemod.stPtAdj, fortieover, connectioncode);
5239 _tiemod.xStart = hoffset;
5240 _tiemod.yStart = voffset;
5250 _tiemod.stPtAdj = 0;
5272#ifndef PDK_FRAMEWORK_LUAFRIENDLY
5277 connectioncode, Evpu16 hoffset, Evpu16 voffset)
5279 _ActivatePlacementBits(_tiemod.enPtAdj, fortieover, connectioncode);
5280 _tiemod.xEnd = hoffset;
5281 _tiemod.yEnd = voffset;
5291 _tiemod.enPtAdj = 0;
5294#ifdef PDK_FRAMEWORK_PREFS
5330 void ActivateContour(twobyte insetleft, twobyte heightleft, twobyte insetright, twobyte heightright,
bool fixedinset =
false)
5333 _tiemod.insetRatio1 = insetleft;
5334 _tiemod.height1 = heightleft;
5335 _tiemod.insetRatio2 = insetright;
5336 _tiemod.height2 = heightright;
5337 Set16BitFlag(&_tiemod.cpFlag, TIECTLPT_FIXED, fixedinset);
5473 if (!
GetBitFlag(_tiemod.flag, TIEFLG_FREEZE))
5505 twobyte
GetOuterPlacement()
const {
return _Get3WayValue(_tiemod.tiePlacementOpts, TIE_PLC_OUTER_LOCAL, TIE_PLC_OUTER_ON); }
5649 void SetOuterPlacement(twobyte value) { _Set3WayValue(value, _tiemod.tiePlacementOpts, TIE_PLC_OUTER_LOCAL, TIE_PLC_OUTER_ON); }
5662 void SetNoteID(twobyte
id)
override { _tiemod.noteID = id; }
5664#ifndef DOXYGEN_SHOULD_IGNORE_THIS
5665 bool _IsNoteIDMatch(
void *pBuffer, twobyte
id)
override
5667 return (((EDTTieMods*) pBuffer)->noteID ==
id);
5674 void _SetEntryFlagN(
FCNote* pNote,
bool state)
override
5676 pNote->_SetSpecialAltsEntryFlag(state);
5683 bool _GetEntryFlagN(
FCNote* pNote)
override
5685 return pNote->_GetSpecialAltsEntryFlag();
5697#ifndef DOXYGEN_SHOULD_IGNORE_THIS
5698 EDTBrokenBeamMods _brokenbeammod;
5701 EXTAG
Tag()
const override {
return ed_BrokenBeamMods; }
5702 int DataSizeLoad()
const override {
return sizeof(EDTBrokenBeamMods); }
5703 int DataSizeSave()
const override {
return sizeof(EDTBrokenBeamMods); }
5704 void*
Allocate()
override {
return (
void*) &_brokenbeammod; }
5712 memcpy(&_brokenbeammod, ((
FCBrokenBeamMod*)pSource)->_GetBrokenBeamMod(),
sizeof(_brokenbeammod));
5721 const char*
ClassName()
const override {
return "FCBrokenBeamMod"; }
5724#ifndef DOXYGEN_SHOULD_IGNORE_THIS
5729 EDTBrokenBeamMods* _GetBrokenBeamMod() {
return &_brokenbeammod; }
5739 memset(&_brokenbeammod, 0,
sizeof(_brokenbeammod));
5742#ifndef DOXYGEN_SHOULD_IGNORE_THIS
5747 void _SetEntryFlag(
FCNoteEntry* pNoteEntry,
bool state)
override
5765 _brokenbeammod.beamdir = leftdirection ? -1 : 0;
5776 return _brokenbeammod.beamdir != 0;
5793#ifndef DOXYGEN_SHOULD_IGNORE_THIS
5794 EDTTablatureMods _tablaturemod;
5797 EXTAG
Tag()
const override {
return ed_TablatureMods; }
5798 int DataSizeLoad()
const override {
return sizeof(EDTTablatureMods); }
5799 int DataSizeSave()
const override {
return sizeof(EDTTablatureMods); }
5800 void*
Allocate()
override {
return (
void*) &_tablaturemod; }
5808 memcpy(&_tablaturemod, ((
FCTablatureNoteMod*)pSource)->_GetTablatureMod(),
sizeof(_tablaturemod));
5817 const char*
ClassName()
const override {
return "FCTablatureNoteMod"; }
5820#ifndef DOXYGEN_SHOULD_IGNORE_THIS
5825 EDTTablatureMods* _GetTablatureMod() {
return &_tablaturemod; }
5831 memset(&_tablaturemod, 0,
sizeof(_tablaturemod));
5834 _tablaturemod.stringNumber = 1;
5845 return _tablaturemod.stringNumber;
5857 if (value < 1)
return;
5858 if (value > 24)
return;
5859 _tablaturemod.stringNumber = value;
5867 void SetNoteID(twobyte
id)
override { _tablaturemod.noteID = id; }
5870#ifndef DOXYGEN_SHOULD_IGNORE_THIS
5871 bool _IsNoteIDMatch(
void *pBuffer, twobyte
id)
override
5873 return (((EDTTablatureMods*) pBuffer)->noteID ==
id);
5880 void _SetEntryFlagN(
FCNote* pNote,
bool state)
override
5882 pNote->_SetNoteDetailEntryFlag(state);
5889 bool _GetEntryFlagN(
FCNote* pNote)
override
5891 return pNote->_GetNoteDetailEntryFlag();
Base class for all data-related classes (that handles Finale data).
Definition ff_base.h:676
virtual twobyte CalcLastInci()
For internal use only!
Definition ff_base.h:755
EXTAG GetCustomTag() const
Returns the custom Enigma tag, if any.
Definition ff_base.h:870
virtual __FCBaseData * CreateObject()=0
Creates a new instance of the object.
EDataID _dataid
The EdataID for the last loaded/saved object.
Definition ff_base.h:712
void SetCustomTag(EXTAG tag)
Sets the custom Enigma tag, for classes that support multiple Enigma tags.
Definition ff_base.h:882
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 int DataSizeSave() const
Returns the data size for the data structure that should be saved or created.
Definition finaleframework.cpp:916
virtual EXTAG Tag() const =0
The Enigma tag for the derived class.
virtual bool DeleteData()
Deletes the associated data from Finale's database. Be careful when deleting multiple objects.
Definition finaleframework.cpp:911
void DebugDump() override
Outputs the class data/information for debugging purposes.
Definition ff_base.h:1006
virtual void CloneMemoryFrom(__FCBaseData *pSource)
Definition finaleframework.cpp:838
virtual bool Save()
Saves the currently loaded to its current location.
Definition finaleframework.cpp:951
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
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 h...
Definition finaleframework.cpp:404
void Set16BitFlag(FLAG_16 *flag, FLAG_16 flagbits, bool state)
Sets a 16 bit flag.
Definition finaleframework.cpp:635
PDKFRAMEWORK_CLASSID
Constants for the GetClassID method.
Definition ff_base.h:84
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 d...
Definition finaleframework.cpp:335
static void DebugOut(const char *pszLine)
Static method to output a line of text for debugging purposes.
Definition finaleframework.cpp:526
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.
Definition ff_base.h:485
static void DebugOutBool(const char *pszPrefixText, bool state)
Static method that outputs a line for debugging purposes. The boolean state appears afterwards as eit...
Definition finaleframework.cpp:451
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 (a...
Definition finaleframework.cpp:458
Base class that provides the basic functionality for entry detail data (such as Special Tools modific...
Definition ff_entrydetails.h:27
virtual bool SaveNew()
Saves a new inci and sets the correct flag in the associated note entry.
Definition finaleframework.cpp:20636
virtual bool Load(ENTNUM entnum, twobyte inci)
Loads the data at the given entry number and inci.
Definition finaleframework.cpp:20594
virtual void SetNoteEntry(FCNoteEntry *pEntry)
Maps the data to an entry.
Definition ff_entrydetails.h:114
bool LoadFirst() override
Overloaded version of LoadFirst that will load the first inci for the entry. SetNoteEntry must be cal...
Definition ff_entrydetails.h:99
bool SaveAs(ENTNUM entnum, twobyte inci)
Saves the data at the given entry number and inci.
Definition finaleframework.cpp:20612
twobyte GetItemInci() const
Returns the inci number for the stored object.
Definition ff_entrydetails.h:134
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition ff_entrydetails.h:65
__FCEntryDetail()
The constructor.
Definition ff_entrydetails.h:59
FCNoteEntry * GetNoteEntry()
Returns a pointer to the mapped note entry.
Definition ff_entrydetails.h:128
void DebugDump() override
Outputs the class data/information for debugging purposes.
Definition ff_entrydetails.h:186
bool Reload() override
Overridden Reload() method, that supports complex (mixed) data.
Definition finaleframework.cpp:20600
ENTNUM GetItemEntryNumber() const
Returns the note entry number for the stored object.
Definition ff_entrydetails.h:140
void SetEntnumAndInci(ENTNUM entnum, twobyte inci)
Sets the entry number reference and inci for the object.
Definition ff_entrydetails.h:68
bool LoadNext() override
Overloaded version of LoadNext.
Definition finaleframework.cpp:20621
Base class that provide entry details that are based on noteIDs, such as notehead modifications,...
Definition ff_entrydetails.h:206
__FCEntryDetailNoteID()
The constructor.
Definition ff_entrydetails.h:224
bool LoadAt(FCNote *pNote)
Tries to find and load the note entry modifications based on the note ID.
Definition finaleframework.cpp:20816
bool EraseAt(FCNote *pNote)
Deletes the note entry modifications for a slot and adjusts the flag in the associated note entry.
Definition finaleframework.cpp:20825
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition ff_entrydetails.h:226
bool SaveNew() override
Overridden method for SaveNew()
Definition finaleframework.cpp:20841
bool SaveAt(FCNote *pNote)
Saves the note entry modifications in a slot and sets the correct flag in the associated note entry.
Definition finaleframework.cpp:20788
The base class for all lyrics text classes.
Definition ff_text.h:384
Class for acciental modifications (as in Finale's Special Tools).
Definition ff_entrydetails.h:3559
eUniChar32 GetCustomChar() const
Returns the custom accidental symbol, it any.
Definition ff_entrydetails.h:3740
twobyte GetVerticalPos() const
Returns the vertical position for the accidental.
Definition ff_entrydetails.h:3718
void SetUseCustomVerticalPos(bool status)
Marks if a custom vertical position should be used for the accidental or not.
Definition ff_entrydetails.h:3890
void ClearChar()
Clears the font character for the accidental to use the default accidental character.
Definition ff_entrydetails.h:4047
bool GetUseCustomChar() const
Returns true if there's a custom accidental symbol.
Definition ff_entrydetails.h:3752
void SetNoteID(twobyte id) override
Sets the note ID for the notehead, so it maps to the note.
Definition ff_entrydetails.h:4064
FCAccidentalMod()
The constructor.
Definition ff_entrydetails.h:3682
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition ff_entrydetails.h:3665
twobyte GetFontSize() const
Returns the custom font size.
Definition ff_entrydetails.h:3820
bool GetUseCustomFont() const
Returns if a custom font is used for the accidental or not.
Definition ff_entrydetails.h:3775
void SetFontInfo(FCFontInfo *pInfo)
Sets all the font info (name, style, size) to the info available in the FCFontInfo object.
Definition ff_entrydetails.h:4010
const eUniChar16 * GetFontNameUTF16() const
Gets the font name for the accidental.
Definition ff_entrydetails.h:3804
void SetFontNameUTF16(const eUniChar16 *pszFont)
Sets the font name for the accidental.
Definition ff_entrydetails.h:3968
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition ff_entrydetails.h:3664
bool GetFontInfo(FCFontInfo *pInfo)
Gets all the font info (name, style, size) into the FCFontInfo object.
Definition ff_entrydetails.h:3845
void SetUseDefaultFont(bool status)
The reverse functionality of FCAccidentalMod::SetUseCustomFont.
Definition ff_entrydetails.h:3937
void SetHorizontalPos(twobyte value)
Sets the horizontal position for the accidental.
Definition ff_entrydetails.h:3859
void SetVerticalPos(twobyte value)
Sets the vertical position for the accidental.
Definition ff_entrydetails.h:3875
void SetResize(twobyte value)
Sets the accidental resize in percent.
Definition ff_entrydetails.h:3913
void SetFontName(const char *pszFont)
Sets the font name for the accidental.
Definition ff_entrydetails.h:3951
twobyte GetVerticalPosIfPossible()
Returns the vertical position for the accidental, but only if the value has been enabled for Finale.
Definition ff_entrydetails.h:3708
void SetFontSize(twobyte fontsize)
Sets the font size for the accidental.
Definition ff_entrydetails.h:3987
void SetFontStyle(FCFontInfo *pInfo)
Sets the font style only (such as italics, bold, etc), based on the style info in the FCFontInfo obje...
Definition ff_entrydetails.h:3998
twobyte GetResize() const
Returns the accidental resize in percent.
Definition ff_entrydetails.h:3766
bool GetUseCustomVerticalPos() const
Returns true if vertical position can be set for the accidental.
Definition ff_entrydetails.h:3727
const char * GetFontName() const
Gets the font name for the accidental.
Definition ff_entrydetails.h:3788
void SetUseCustomFont(bool status)
Marks if a custom font should be used for the accidental or not.
Definition ff_entrydetails.h:3926
void SetCustomChar(eUniChar32 ch)
Sets the font character for the accidental.
Definition ff_entrydetails.h:4029
void SetUseDefaultVerticalPos(bool status)
Clears and uses the default vertical positioning.
Definition ff_entrydetails.h:3902
bool GetFontStyle(FCFontInfo *pInfo)
Gets the font style into the FCFontInfo object.
Definition ff_entrydetails.h:3832
twobyte GetHorizontalPos() const
Returns the horizontal position for the accidental.
Definition ff_entrydetails.h:3697
The class for an articulation definition. On Finale 2012 and above, this class supports the Unicode c...
Definition ff_other.h:12287
Class for attaching an articulation definition to an entry.
Definition ff_entrydetails.h:1839
EXTAG Tag() const override
The Enigma tag for the derived class.
Definition ff_entrydetails.h:1868
PLACEMENTMODE
The settings for flipped, above, below.
Definition ff_entrydetails.h:1876
FCArticulationDef * CreateArticulationDef()
Creates a articulation definition object for the articulation.
Definition finaleframework.cpp:21163
Evpu16 GetVerticalCopyToPos() const
Returns the point to which a cloned mark extends vertically, measured from the lowest note.
Definition ff_entrydetails.h:2080
bool CalcMetricPos(FCPoint *pPoint)
Calculate the metric position for an articulation.
Definition finaleframework.cpp:21174
bool GetVisible() const
Returns the visibility state of the articulation.
Definition finaleframework.cpp:21069
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition ff_entrydetails.h:1870
PLACEMENTMODE GetPlacementMode() const
Gets the setting for where the articulation should be placed compared to the note entry.
Definition finaleframework.cpp:21121
void SetArticulationDef(FCArticulationDef *pDef)
Assigns an articulation definition to the articulation instance.
Definition finaleframework.cpp:21056
STACKINGMODE
The settings for stacking for this assignment.
Definition ff_entrydetails.h:1886
void SetStackingMode(STACKINGMODE value)
Sets the stackable state of the articulation.
Definition finaleframework.cpp:21101
void ResetPos(FCArticulationDef *pDef)
Resets the articulation positioning based on the articulation definition. This method does not suppor...
Definition finaleframework.cpp:21247
void DebugDump() override
Outputs the class data/information for debugging purposes.
Definition ff_entrydetails.h:2134
STACKINGMODE GetStackingMode() const
Returns the stacking mode of the articulation.
Definition finaleframework.cpp:21091
Evpu16 GetVerticalPos() const
Returns the vertical position.
Definition ff_entrydetails.h:2073
void SetHorizontalPos(Evpu16 pos)
Sets the horizontal position.
Definition ff_entrydetails.h:1943
twobyte GetID() const
Returns the (1-based) articulation definition ID.
Definition ff_entrydetails.h:2090
void SetPlacementMode(PLACEMENTMODE value)
Sets where the articulation should be placed compared to the note entry.
Definition finaleframework.cpp:21133
Evpu16 GetHorizontalPos() const
Returns the horizontal position.
Definition ff_entrydetails.h:2060
Evpu16 GetHorizontalCopyToPos() const
Returns the point to which a cloned mark extends horizontal, measured from GetHorizontalPos.
Definition ff_entrydetails.h:2066
bool CalcFlippedSymbolUsed()
Returns true if the flipped version of the articulation is used (based on the entry metrics).
Definition finaleframework.cpp:21207
void SetVerticalCopyToPos(Evpu16 pos)
Sets the point to which a cloned mark extends vertically, measured from the lowest note.
Definition ff_entrydetails.h:1971
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition ff_entrydetails.h:1869
void SetID(CMPER cmper)
Sets the (1-based) articulation definition ID.
Definition ff_entrydetails.h:1936
void SetVerticalPos(Evpu16 pos)
Sets the vertical position.
Definition ff_entrydetails.h:1962
void SetHorizontalCopyToPos(Evpu16 pos)
Sets the point to which a cloned mark extends horizontally, measured from GetHorizontalPos.
Definition ff_entrydetails.h:1953
void SetVisible(bool state)
Sets the visibility state of the articulation.
Definition finaleframework.cpp:21078
FCArticulation()
The constructor.
Definition finaleframework.cpp:21028
Class for beam extensions (in Finale's Special Tools).
Definition ff_entrydetails.h:1410
FCBeamExtensionMod()
The constructor.
Definition ff_entrydetails.h:1454
void SetExtendAll(bool value)
Sets if all beams should extend or not.
Definition ff_entrydetails.h:1554
void SetExtend64th(bool state)
Sets if the 64th note beam should extend or not.
Definition ff_entrydetails.h:1640
void SetExtend(int beamindex, bool value)
Sets if a beam should be extended.
Definition ff_entrydetails.h:1531
bool GetExtend256th() const
Returns if the 256th note beam should extend or not.
Definition ff_entrydetails.h:1667
void SetExtend8th(bool state)
Sets if the 16th note beam should extend or not.
Definition ff_entrydetails.h:1586
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition ff_entrydetails.h:1440
void SetRightAdjustment(Evpu16 adjust)
Sets the right-side adjustment,.
Definition ff_entrydetails.h:1516
void SetLeftAdjustment(Evpu16 adjust)
Sets the left-side adjustment,.
Definition ff_entrydetails.h:1504
Evpu16 GetRightAdjustment() const
Gets the right-side adjustment,.
Definition ff_entrydetails.h:1522
void SetExtend256th(bool state)
Sets if the 256th note beam should extend or not.
Definition ff_entrydetails.h:1676
bool GetExtend32nd() const
Returns if the 32nd note beam should extend or not.
Definition ff_entrydetails.h:1613
void SetExtend16th(bool state)
Sets if the 16th note beam should extend or not.
Definition ff_entrydetails.h:1604
bool GetExtend16th() const
Returns if the 16th note beam should extend or not.
Definition ff_entrydetails.h:1595
void SetExtend128th(bool state)
Sets if the 128th note beam should extend or not.
Definition ff_entrydetails.h:1658
bool GetExtend128th() const
Returns if the 128th note beam should extend or not.
Definition ff_entrydetails.h:1649
bool GetExtend64th() const
Returns if the 64th note beam should extend or not.
Definition ff_entrydetails.h:1631
Evpu16 GetLeftAdjustment() const
Gets the left-side adjustment,.
Definition ff_entrydetails.h:1510
void SetNoteEntry(FCNoteEntry *pEntry) override
Overridden method to assign a note entry with the data.
Definition ff_entrydetails.h:1490
void SetExtend32nd(bool state)
Sets if the 32nd note beam should extend or not.
Definition ff_entrydetails.h:1622
bool GetExtend(int beamindex) const
Returns true if the beam should extend.
Definition ff_entrydetails.h:1565
bool GetExtend8th() const
Returns if the 16th note beam should extend or not.
Definition ff_entrydetails.h:1577
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition ff_entrydetails.h:1439
void UseUpStemData(bool useupstem)
Sets if upstem or downstem data should be loaded/saved. Finale stores upstem and downstem data in sep...
Definition ff_entrydetails.h:1483
Class for custom beam adjustments (in Finale's Special Tools).
Definition ff_entrydetails.h:4279
void SetRightVerticalOffset(twobyte offset)
Sets the vertical right-side offset.
Definition ff_entrydetails.h:4526
twobyte GetThickness() const
Returns the beam thickness. This can ONLY be set for primary beam data.
Definition ff_entrydetails.h:4674
void SetNoteEntry(FCNoteEntry *pEntry) override
Overridden method to assign a note entry with the data.
Definition ff_entrydetails.h:4449
twobyte GetRightHorizontalOffset() const
Returns the horizontal right-side offset.
Definition ff_entrydetails.h:4596
twobyte GetMode() const
Returns the Beaming Style mode where the beam data will be "active". This mode is controlled by Docum...
Definition ff_entrydetails.h:4630
twobyte GetRightVerticalOffset() const
Gets the vertical right-side offset.
Definition ff_entrydetails.h:4614
void SetThickness(twobyte thickness)
Sets the beam thickness. This can ONLY be set for primary beam data.
Definition ff_entrydetails.h:4538
void SetLeftVerticalOffset(twobyte offset)
Sets the vertical left-side offset.
Definition ff_entrydetails.h:4515
void SetDefaultMode()
Sets the beaming mode of the beam to document's default.
Definition finaleframework.cpp:20978
twobyte GetLeftHorizontalOffset() const
Returns the horizontal left-side offset.
Definition ff_entrydetails.h:4587
void SetLeftHorizontalOffset(twobyte offset)
Sets the horizontal left-side offset.
Definition ff_entrydetails.h:4495
void SetMode(twobyte mode)
Sets the Beaming Style mode where the beam data will be "active". This mode is controlled by Document...
Definition ff_entrydetails.h:4479
bool Load(ENTNUM entnum, twobyte inci) override
Loads the data at the given entry number and inci.
Definition ff_entrydetails.h:4385
twobyte CalcRightVerticalPos(twobyte default_separation)
Calculates the secondary beam's vertical right position compared to the primary beam's vertical right...
Definition ff_entrydetails.h:4713
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition ff_entrydetails.h:4342
bool IsUpStem()
Returns true if the data is connected to up-stem data, otherwise it's connected to down-stem data.
Definition ff_entrydetails.h:4731
twobyte GetLeftVerticalOffset() const
Returns the vertical left-side offset.
Definition ff_entrydetails.h:4605
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition ff_entrydetails.h:4341
bool Save() override
Overridden Save() method for FCBeamMod.
Definition ff_entrydetails.h:4398
void SetDefaultBeamThickness()
Sets the default (100%) beam thickness. This can ONLY be set for primary beam data.
Definition ff_entrydetails.h:4549
void SetBeamNumber(twobyte beamnumber)
Sets the 1-based beam that the data is connected to. Don't change this for loaded data.
Definition ff_entrydetails.h:4573
twobyte CalcLeftVerticalPos(twobyte default_separation)
Calculates the secondary beam's vertical left position compared to the primary beam's vertical left p...
Definition ff_entrydetails.h:4692
FCBeamMod(bool secondarybeam)
The constructor.
Definition ff_entrydetails.h:4361
bool LoadForBeamNumber(int beamnumber)
Loads the data for the specified 1-based beam number.
Definition ff_entrydetails.h:4744
twobyte GetBeamDuration() const
Gets the duration (in EDUs) of the beam.
Definition ff_entrydetails.h:4638
void SetRightHorizontalOffset(twobyte offset)
Sets the horizontal right-side offset.
Definition ff_entrydetails.h:4506
void UseUpStemData(bool useupstem)
Sets if upstem or downstem data should be loaded/saved. Finale stores upstem and downstem data in sep...
Definition ff_entrydetails.h:4433
twobyte GetBeamNumber()
Returns the 1-based number of the beam. 1 is the 8th-note beam.
Definition ff_entrydetails.h:4650
bool IsSecondaryBeam()
Returns true if the data is connected to a secondary beam, otherwise it's primary beam data.
Definition ff_entrydetails.h:4724
void DebugDump() override
Outputs the class data/information for debugging purposes.
Definition ff_entrydetails.h:4761
bool SaveNew() override
Overridden SaveNew() method for FCBeamMod.
Definition ff_entrydetails.h:4405
Class for manually broken beam adjustments (in Finale's Special Tools).
Definition ff_entrydetails.h:5696
FCBrokenBeamMod()
The constructor.
Definition ff_entrydetails.h:5736
bool GetLeftDirection() const
Gets the direction of the broken beam.
Definition ff_entrydetails.h:5772
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition ff_entrydetails.h:5721
void SetLeftDirection(bool leftdirection)
Sets the direction of the broken beam.
Definition ff_entrydetails.h:5761
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition ff_entrydetails.h:5722
The class for a chorus syllable.
Definition ff_entrydetails.h:3222
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition ff_entrydetails.h:3226
EXTAG Tag() const override
The Enigma tag for the derived class.
bool IsChorus() const override
Returns true if the syllable object is a chorus syllable.
Definition ff_entrydetails.h:3228
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition ff_entrydetails.h:3227
Class that specifies the cross-staff connection for a note.
Definition ff_entrydetails.h:1087
twobyte GetStaff() const
Returns the cross staff connected with the note.
Definition ff_entrydetails.h:1140
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition ff_entrydetails.h:1113
FCCrossStaffMod()
The constructor.
Definition ff_entrydetails.h:1127
void SetStaff(eStaff staff)
Sets the cross staff connected with the note.
Definition ff_entrydetails.h:1148
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition ff_entrydetails.h:1112
void SetNoteID(twobyte id) override
Sets the note ID for the cross staff note, so it maps to the note object.
Definition ff_entrydetails.h:1155
Class for custom stem shapes (in Finale's Special Tools). The data is connected to either an upstem o...
Definition ff_entrydetails.h:4177
twobyte GetShapeID() const
Returns the shape ID for the stem. If this value is zero, the stem is hidden.
Definition ff_entrydetails.h:4248
void UseUpStemData(bool useupstem)
Sets if beamed or non-beamed data should be loaded/saved.
Definition ff_entrydetails.h:4242
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition ff_entrydetails.h:4204
void SetShapeID(CMPER theid)
Sets the shape ID for the stem. If this value is zero, the stem is hidden.
Definition ff_entrydetails.h:4254
FCCustomStemMod()
The constructor.
Definition ff_entrydetails.h:4219
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition ff_entrydetails.h:4205
Class with adjustments to the augmentation dots (in Finale's Special Tools).
Definition ff_entrydetails.h:940
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition ff_entrydetails.h:966
void SetInterDotSpacing(twobyte space)
Sets the inter-dot spacing.
Definition ff_entrydetails.h:1030
bool LoadRestDotAt(FCNoteEntry *pEntry)
Tries to load a rest dot with the rest ID.
Definition finaleframework.cpp:20940
void SetVerticalPos(twobyte pos)
Sets the vertical position of the dot.
Definition ff_entrydetails.h:1017
twobyte GetHorizontalPos() const
Gets the vertical position of the dot.
Definition ff_entrydetails.h:993
twobyte GetInterDotSpacing() const
Returns the inter-dot spacing.
Definition ff_entrydetails.h:1024
twobyte GetVerticalPos() const
Gets the vertical position of the dot.
Definition ff_entrydetails.h:1001
void SetNoteID(twobyte id) override
Sets the note ID for the dot, so it maps to the note.
Definition ff_entrydetails.h:1037
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition ff_entrydetails.h:965
void SetHorizontalPos(twobyte pos)
Sets the vertical position of the dot.
Definition ff_entrydetails.h:1009
bool SaveRestDotAt(FCNoteEntry *pEntry)
Saves a rest dot with the rest ID.
Definition finaleframework.cpp:20948
FCDotMod()
The constructor.
Definition ff_entrydetails.h:980
Class for (what it seems) the sole purpose of note entry resize.
Definition ff_entrydetails.h:3459
void DebugDump() override
Outputs the class data/information for debugging purposes.
Definition ff_entrydetails.h:3542
void SetResize(twobyte value)
Sets the note entry resize value in percent.
Definition ff_entrydetails.h:3524
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition ff_entrydetails.h:3485
FCEntryAlterMod()
The constructor.
Definition ff_entrydetails.h:3500
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition ff_entrydetails.h:3484
twobyte GetResize() const
Returns the note entry resize value in percent.
Definition ff_entrydetails.h:3535
Class for document-independent font information.
Definition ff_base.h:1138
void SetNameByID(EFONTID id)
Sets the font name by using the document's internal Enigma font ID.
Definition finaleframework.cpp:3650
void SetSize(int fontsize)
Sets the font size as an integer value.
Definition ff_base.h:1546
FLAG_16 GetEnigmaStyles() const
Gets the font style as standard Enigma bit storage.
Definition ff_base.h:1358
int GetSize() const
Returns the font size as an integer number.
Definition ff_base.h:1289
void SetEnigmaStyles(FLAG_16 fontstyles)
Sets the font style as standard Enigma bit storage.
Definition ff_base.h:1469
EFONTID GetIDByName() const
Gets the internal Enigma font ID for the current document by searching for the font name....
Definition finaleframework.cpp:3558
Encapsulates a note entry from an owner class (for example FCNoteEntryCell, FCNoteEntryLayer) class.
Definition ff_noteframe.h:940
void SetStemDetailFlag(bool state)
Sets the flag state for stem detail records.
Definition ff_noteframe.h:1670
ENTNUM GetEntryNumber() const
Returns the internal entry number (ID) for the note entry.
Definition ff_noteframe.h:1319
void SetTupletStartFlag(bool state)
Sets the flag that marks that a tuplet starts on the entry.
Definition ff_noteframe.h:1656
void SetBeamExtensionFlag(bool state)
Sets the flag state for beam extension detail records.
Definition ff_noteframe.h:1686
void SetSecondaryBeamFlag(bool state)
Sets the flag state for secondary beam detail records.
Definition ff_noteframe.h:1678
bool CalcStemUp()
Returns the direction of the beam.
Definition finaleframework.cpp:17999
void SetArticulationFlag(bool state)
Sets the flag that marks that an articulation is attached to the entry.
Definition ff_noteframe.h:1644
void SetLyricFlag(bool state)
Sets the flag that marks that an entry has syllable attached to it.
Definition ff_noteframe.h:1662
void SetNoteDetailFlag(bool state)
Sets the flag state for note detail records.
Definition ff_noteframe.h:1620
Encapsulates one note in a note entry (from the FCNoteEntry class).
Definition ff_noteframe.h:29
void SetCrossStaff(bool state)
Sets the cross staff state for the note.
Definition ff_noteframe.h:471
Class for notehead modifications (as in Finale's Special Tools).
Definition ff_entrydetails.h:337
eUniChar32 GetCustomChar() const
Returns the custom notehead, it any.
Definition ff_entrydetails.h:531
twobyte GetFontSize() const
Returns the custom font size.
Definition ff_entrydetails.h:609
FCNoteheadMod()
The constructor.
Definition ff_entrydetails.h:468
void SetEnharmonicFlip(bool status)
Marks if the notehead should be enharmonically flipped.
Definition ff_entrydetails.h:883
bool GetFontInfo(FCFontInfo *pInfo)
Gets all the font info (name, style, size) into the FCFontInfo object, for custom fonts records.
Definition ff_entrydetails.h:636
const eUniChar16 * GetFontNameUTF16() const
Gets the font name for the notehead.
Definition ff_entrydetails.h:594
bool GetFontStyle(FCFontInfo *pInfo)
Gets only the font style (such as italics, bold etc) into the FCFontInfo object, for custom fonts rec...
Definition ff_entrydetails.h:622
twobyte GetVerticalPosIfPossible()
Returns the vertical position for the notehead, but only if the value has been enabled for Finale.
Definition ff_entrydetails.h:494
void SetFontSize(twobyte fontsize)
Sets the font size for the notehead.
Definition ff_entrydetails.h:788
void ClearChar()
Clears the font character for the notehead to use the default notehead character.
Definition ff_entrydetails.h:894
void SetFontStyle(FCFontInfo *pInfo)
Sets the font style only (such as italics, bold, etc), based on the style info in the FCFontInfo obje...
Definition ff_entrydetails.h:799
void SetUseCustomVerticalPos(bool status)
Marks if a custom vertical position should be used for the notehead or not.
Definition ff_entrydetails.h:692
bool GetUseCustomFont() const
Returns if a custom font is used for the notehead or not.
Definition ff_entrydetails.h:567
bool GetEnharmonicFlip() const
Returns if the notehead has been enharmonically flipped.
Definition ff_entrydetails.h:651
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition ff_entrydetails.h:442
bool GetUseCustomChar() const
Returns true if there's a custom notehead.
Definition ff_entrydetails.h:543
twobyte GetResize() const
Returns the notehead resize in percent.
Definition ff_entrydetails.h:557
void SetUseCustomFont(bool status)
Marks if a custom font should be used for the notehead or not.
Definition ff_entrydetails.h:729
void SetNoteID(twobyte id) override
Sets the note ID for the notehead, so it maps to the note.
Definition ff_entrydetails.h:911
void SetHorizontalPos(twobyte value)
Sets the horizontal position for the notehead.
Definition ff_entrydetails.h:661
bool GetUseCustomVerticalPos() const
Returns true if vertical position can be set.
Definition ff_entrydetails.h:518
const char * GetFontName() const
Gets the font name for the notehead.
Definition ff_entrydetails.h:580
void SetUseDefaultVerticalPos(bool status)
Clears and uses the default vertical positioning.
Definition ff_entrydetails.h:705
void SetCustomChar(eUniChar32 ch)
Sets the font character for the notehead.
Definition ff_entrydetails.h:830
void SetUseDefaultFont(bool status)
The reverse functionality of SetUseCustomFont.
Definition ff_entrydetails.h:740
void SetFontName(const char *pszFont)
Sets the font name for the notehead.
Definition ff_entrydetails.h:754
twobyte GetVerticalPos() const
Returns the vertical position for the notehead.
Definition ff_entrydetails.h:508
twobyte GetHorizontalPos() const
Returns the horizontal position for the notehead.
Definition ff_entrydetails.h:484
void SetFontNameUTF16(const eUniChar16 *pszFont)
Sets the font name for the notehead.
Definition ff_entrydetails.h:769
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition ff_entrydetails.h:443
void SetVerticalPos(twobyte value)
Sets the vertical position for the notehead.
Definition ff_entrydetails.h:677
void SetFontInfo(FCFontInfo *pInfo)
Sets all the font info (name, style, size) to the info available in the FCFontInfo object.
Definition ff_entrydetails.h:811
void SetResize(twobyte value)
Sets the notehead resize in percent.
Definition ff_entrydetails.h:716
Class for percussion note modification.
Definition ff_entrydetails.h:4094
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition ff_entrydetails.h:4121
void SetNoteID(twobyte id) override
Sets the note ID for the notehead, so it maps to the note.
Definition ff_entrydetails.h:4159
void SetNoteType(FLAG_16 value)
Sets the percussion note type.
Definition ff_entrydetails.h:4152
FLAG_16 GetNoteType() const
Returns the raw percussion note type.
Definition ff_entrydetails.h:4146
FCPercussionNoteMod()
The constructor.
Definition ff_entrydetails.h:4135
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition ff_entrydetails.h:4120
Simple class for the representation of x, y coordinates.
Definition ff_base.h:4892
Class for secondary beam breaks (in Finale's Special Tools).
Definition ff_entrydetails.h:1197
void SetBreak64th(bool state)
Sets if the 64th note beam should break or not.
Definition ff_entrydetails.h:1342
void SetBreak32nd(bool state)
Sets if the 32nd note beam should break or not.
Definition ff_entrydetails.h:1324
void SetBreakAll(bool value)
Sets if all secondary beams should break or not.
Definition ff_entrydetails.h:1262
bool GetBreak128th() const
Returns if the 128th note beam should break or not.
Definition ff_entrydetails.h:1351
bool GetBreak(int beamindex) const
Returns true if the secondary beam should break.
Definition ff_entrydetails.h:1286
FCSecondaryBeamBreakMod()
The constructor.
Definition ff_entrydetails.h:1236
void SetBreak256th(bool state)
Sets if the 256th note beam should break or not.
Definition ff_entrydetails.h:1378
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition ff_entrydetails.h:1221
void SetBreak128th(bool state)
Sets if the 128th note beam should break or not.
Definition ff_entrydetails.h:1360
void SetBreak16th(bool state)
Sets if the 16th note beam should break or not.
Definition ff_entrydetails.h:1306
bool GetBreak256th() const
Returns if the 256th note beam should break or not.
Definition ff_entrydetails.h:1369
void SetBreak(int beamindex, bool value)
Sets if a secondary beam should break or not.
Definition ff_entrydetails.h:1249
bool GetBreak32nd() const
Returns if the 32nd note beam should break or not.
Definition ff_entrydetails.h:1315
bool GetBreak64th() const
Returns if the 64th note beam should break or not.
Definition ff_entrydetails.h:1333
twobyte CalcLowestBreak() const
Returns the beam number (0-8 where 0 is the 16th note beam, 1 is the 32nd note beam,...
Definition ff_entrydetails.h:1273
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition ff_entrydetails.h:1222
bool GetBreak16th() const
Returns if the 16th note beam should break or not.
Definition ff_entrydetails.h:1297
The class for a section syllable.
Definition ff_entrydetails.h:3241
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition ff_entrydetails.h:3246
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition ff_entrydetails.h:3245
EXTAG Tag() const override
The Enigma tag for the derived class.
bool IsSection() const override
Returns true if the syllable object is a section syllable.
Definition ff_entrydetails.h:3247
Class for manual stem adjustments (in Finale's Special Tools).
Definition ff_entrydetails.h:1702
twobyte GetVerticalUpOffset() const
Returns the vertical adjustment for stems pointing up.
Definition ff_entrydetails.h:1761
twobyte GetHorizontalDownOffset() const
Returns the horizontal adjustment for stems pointing up.
Definition ff_entrydetails.h:1779
twobyte GetVerticalDownOffset() const
Returns the vertical adjustment for stems pointing down.
Definition ff_entrydetails.h:1767
void SetVerticalUpOffset(twobyte adjust)
Sets the vertical adjustment for stems pointing up.
Definition ff_entrydetails.h:1785
void SetVerticalDownOffset(twobyte adjust)
Sets the vertical adjustment for stems pointing down.
Definition ff_entrydetails.h:1791
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition ff_entrydetails.h:1728
void SetHorizontalDownOffset(twobyte adjust)
Sets the horizontal adjustment for stems pointing down.
Definition ff_entrydetails.h:1811
void UseBeamedData(bool usebeam)
Sets if beamed or non-beamed data should be loaded/saved.
Definition ff_entrydetails.h:1823
twobyte GetHorizontalUpOffset() const
Returns the horizontal adjustment for stems pointing up.
Definition ff_entrydetails.h:1773
FCStemMod()
The constructor.
Definition ff_entrydetails.h:1739
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition ff_entrydetails.h:1727
void SetHorizontalUpOffset(twobyte adjust)
Sets the horizontal adjustment for stems pointing up.
Definition ff_entrydetails.h:1800
Class that provides storage for text. This is to achieve platform-transparent text handling,...
Definition ff_base.h:1877
Base class for attaching an syllable to an entry.
Definition ff_entrydetails.h:2846
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition ff_entrydetails.h:2878
FCFontInfo * CreateNextFontInfo() const
Creates a font info object for the start of the next syllable.
void SetVerticalOffset(Evpu16 offset)
Sets the vertical offset relative to the default position.
Definition ff_entrydetails.h:2910
void SetIncludeLyricNumber(bool state)
Sets if the lyric number should be included/displayed with the syllable, or not.
Definition ff_entrydetails.h:2950
FCFontInfo * CreateFontInfo() const
Creates a font info object for the start of the syllable.
twobyte GetFloatingHorizontalOffset() const
Returns the additional horizontal offset, used for the floating lyrics spacing.
Definition ff_entrydetails.h:3029
void SetRawTextNumber(twobyte rawtextid)
Sets the raw text number that is mapped to the syllable.
Definition ff_entrydetails.h:2930
bool GetText(FCString *pString) const
Fills a string object with the syllable text (without formatting).
bool GetIncludeLyricNumber() const
Returns if the lyric number should be included/displayed with the syllable, or not.
Definition ff_entrydetails.h:3020
Evpu16 GetHorizontalOffset() const
Returns the horizontal offset relative to the EDU position. Positive values are to the right,...
Definition ff_entrydetails.h:2971
__FCLyricsBase * CreateLyricText() const
Creates and loads the lyric raw text block for the syllable.
bool GetRawText(FCString *pString) const
Fills a string object with the raw text (with Enigma formatting commands).
twobyte GetSyllableNumber() const
Returns the 1-based syllable number from the start of the text.
Definition ff_entrydetails.h:2989
void DebugDump() override
Outputs the class data/information for debugging purposes.
Definition ff_entrydetails.h:3184
twobyte GetWordExtensionID() const
Returns the smart shape ID for the word extension.
Definition ff_entrydetails.h:3011
void SetWordExtensionID(twobyte smartshapeID)
Sets the smart shape ID for the word extension.
Definition ff_entrydetails.h:2941
int CalcNextStringPos() const
Returns the 0-based string position in the raw string where the next syllable starts.
int CalcStringPos() const
Returns the 0-based string position in the raw string where the syllable starts.
EXTAG Tag() const override=0
The Enigma tag for the derived class.
bool CalcHyphen()
Returns true if the syllable ends with a hyphen.
Definition ff_entrydetails.h:3067
virtual bool IsVerse() const
Returns true if the syllable object is a verse syllable.
Definition ff_entrydetails.h:3049
void SetSyllableNumber(twobyte number)
Sets the 1-based syllable number from the start of the text.
Definition ff_entrydetails.h:2921
twobyte GetRawTextNumber() const
Returns the raw text number that is mapped to the syllable.
Definition ff_entrydetails.h:3000
virtual bool IsChorus() const
Returns true if the syllable object is a chorus syllable.
Definition ff_entrydetails.h:3055
Evpu16 GetVerticalOffset() const
Returns the vertical offset relative to the default position.
Definition ff_entrydetails.h:2980
virtual bool IsSection() const
Returns true if the syllable object is a section syllable.
Definition ff_entrydetails.h:3061
void SetHorizontalOffset(Evpu16 offset)
Sets the horizontal offset relative to the EDU position. Positive values are to the right,...
Definition ff_entrydetails.h:2901
bool IsValidSyllableNumber()
Returns true if the current syllable number for the object is valid. This also requires that the raw ...
Definition ff_entrydetails.h:3039
bool SaveRawText(FCString *pString)
Saves the raw syllable text to the full string.
void SetFloatingHorizontalOffset(Evpu16 offset)
Returns the additional horizontal offset, used for the floating lyrics spacing.
Definition ff_entrydetails.h:2961
FCSyllableBase()
The constructor.
Definition ff_entrydetails.h:2890
Class for controlling justification/alignment for all syllables that are connected to an entry.
Definition ff_entrydetails.h:3265
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition ff_entrydetails.h:3329
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition ff_entrydetails.h:3328
SYLLABLEJUSTIFICATIONS GetJustification() const
Returns the syllable justification value for the entry.
Definition ff_entrydetails.h:3389
SYLLABLEALIGNS GetAlignment() const
Returns the syllable alignment value for the entry.
Definition ff_entrydetails.h:3373
void SetJustification(SYLLABLEJUSTIFICATIONS value)
Sets the syllable justification value for the entry.
Definition ff_entrydetails.h:3422
SYLLABLEALIGNS
The 4 different entry syllable alignment values.
Definition ff_entrydetails.h:3314
@ SYLLALIGN_RIGHT
Definition ff_entrydetails.h:3325
@ SYLLALIGN_CENTER
Definition ff_entrydetails.h:3319
@ SYLLALIGN_LEFT
Definition ff_entrydetails.h:3322
@ SYLLALIGN_DEFAULT
Definition ff_entrydetails.h:3316
SYLLABLEJUSTIFICATIONS
The 4 different entry syllable justifications values.
Definition ff_entrydetails.h:3295
@ SYLLJUST_CENTER
Definition ff_entrydetails.h:3300
@ SYLLJUST_RIGHT
Definition ff_entrydetails.h:3306
@ SYLLJUST_DEFAULT
Definition ff_entrydetails.h:3297
@ SYLLJUST_LEFT
Definition ff_entrydetails.h:3303
void SetAlignment(SYLLABLEALIGNS value)
Sets the syllable alignment value for the entry.
Definition ff_entrydetails.h:3401
FCSyllableEntryMod()
The constructor.
Definition ff_entrydetails.h:3344
void DebugDump() override
Outputs the class data/information for debugging purposes.
Definition ff_entrydetails.h:3439
Class with info about one tablature note.
Definition ff_entrydetails.h:5792
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition ff_entrydetails.h:5817
FCTablatureNoteMod()
The constructor.
Definition ff_entrydetails.h:5829
twobyte GetStringNumber() const
Returns the 1-based string number for the note.
Definition ff_entrydetails.h:5843
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition ff_entrydetails.h:5818
void SetStringNumber(twobyte value)
Sets the 1-based string number for the note.
Definition ff_entrydetails.h:5855
void SetNoteID(twobyte id) override
Sets the note ID for the notehead, so it maps to the note.
Definition ff_entrydetails.h:5867
Class with adjustments to the ties (in Finale's Special Tools).
Definition ff_entrydetails.h:4987
void LocalizeFromPreferences()
Localizes all settings for this FCTieMod from FCTiePrefs.
Definition finaleframework.cpp:20993
bool GetAvoidStaffLines() const
Returns the Avoid Staff Lines selection.
Definition ff_entrydetails.h:5513
twobyte GetEndVerticalPos() const
Gets the vertical offset of the end point.
Definition ff_entrydetails.h:5400
TIEMOD_CONNECTION_CODES
Tie Connection Codes. These are used to activate Start Point and End Point fields....
Definition ff_entrydetails.h:5080
@ TIEMODCNCT_ENTRYLEFT_NOTECENTER
Definition ff_entrydetails.h:5085
@ TIEMODCNCT_ENTRYRIGHT_NOTECENTER
Definition ff_entrydetails.h:5088
@ TIEMODCNCT_ACCILEFT_NOTECENTER
Definition ff_entrydetails.h:5106
@ TIEMODCNCT_NONE
Definition ff_entrydetails.h:5082
@ TIEMODCNCT_SYSTEMEND
Definition ff_entrydetails.h:5127
@ TIEMODCNCT_NOTERIGHT_NOTEBOTTOM
Definition ff_entrydetails.h:5118
@ TIEMODCNCT_NOTECENTER_NOTEBOTTOM
Definition ff_entrydetails.h:5097
@ TIEMODCNCT_NOTELEFT_NOTEBOTTOM
Definition ff_entrydetails.h:5115
@ TIEMODCNCT_NOTELEFT_NOTECENTER
Definition ff_entrydetails.h:5091
@ TIEMODCNCT_ENTRYCENTER_NOTETOP
Definition ff_entrydetails.h:5112
@ TIEMODCNCT_NOTELEFT_NOTETOP
Definition ff_entrydetails.h:5121
@ TIEMODCNCT_NOTECENTER_NOTETOP
Definition ff_entrydetails.h:5100
@ TIEMODCNCT_DOTRIGHT_NOTECENTER
Definition ff_entrydetails.h:5103
@ TIEMODCNCT_SYSTEMSTART
Definition ff_entrydetails.h:5130
@ TIEMODCNCT_NOTERIGHT_NOTECENTER
Definition ff_entrydetails.h:5094
@ TIEMODCNCT_NOTERIGHT_NOTETOP
Definition ff_entrydetails.h:5124
@ TIEMODCNCT_ENTRYCENTER_NOTEBOTTOM
Definition ff_entrydetails.h:5109
bool IsStartTie() const
Returns true if the FCTieMod instance is for regular start tie settings (defined as a parameter to th...
Definition ff_entrydetails.h:5210
twobyte GetStartHorizontalPos() const
Gets the horizonal offset of the start point.
Definition ff_entrydetails.h:5379
void DeactivateContour()
Deactivates the contour adjustment fields and initializes them with zero.
Definition ff_entrydetails.h:5344
void SetEndHorizontalPos(twobyte pos)
Sets the horizontal offset of the end point.
Definition ff_entrydetails.h:5553
TIEMOD_TIETYPES
TieMod types.
Definition ff_entrydetails.h:5034
@ TIEMODTYPE_TIEEND
Definition ff_entrydetails.h:5036
@ TIEMODTYPE_TIESTART
Definition ff_entrydetails.h:5039
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition ff_entrydetails.h:5018
void SetBreakForTimeSignature(twobyte value)
Sets the Break for Time Signature selection.
Definition ff_entrydetails.h:5631
void DeactivateEndPoint()
Deactivates the end placement fields and initializes them with zero.
Definition ff_entrydetails.h:5288
void ActivateContour(twobyte insetleft, twobyte heightleft, twobyte insetright, twobyte heightright, bool fixedinset=false)
Activates the contour adjustment fields and initializes them with the input values.
Definition ff_entrydetails.h:5330
twobyte GetTieDirection() const
Returns the tie direction selection.
Definition ff_entrydetails.h:5471
twobyte GetRightHeight() const
Gets the right height contour value for the tie.
Definition ff_entrydetails.h:5438
twobyte GetBreakForTimeSignature() const
Returns the Break for Time Signature selection.
Definition ff_entrydetails.h:5486
void SetLeftInset(twobyte value)
Sets the left inset contour value for the tie.
Definition ff_entrydetails.h:5587
void SetFixedInsetStyle(bool value)
Sets the local fixed inset style for the tie. This value overrides the style value in FCTiePrefs::Get...
Definition ff_entrydetails.h:5561
void ActivateStartPoint(bool fortieover, TIEMOD_CONNECTION_CODES connectioncode, Evpu16 hoffset, Evpu16 voffset)
Activates the start placement fields and initializes them with the input values.
Definition ff_entrydetails.h:5230
twobyte GetRightInset() const
Gets the right inset contour value for the tie.
Definition ff_entrydetails.h:5463
void SetStartHorizontalPos(twobyte pos)
Sets the horizontal offset of the start point.
Definition ff_entrydetails.h:5533
twobyte GetLeftInset() const
Gets the left inset contour value for the tie.
Definition ff_entrydetails.h:5451
twobyte GetOuterPlacement() const
Returns the Outer Placement selection.
Definition ff_entrydetails.h:5505
bool IsStartPointActive() const
Returns true if the start point is active.
Definition ff_entrydetails.h:5216
twobyte GetStartVerticalPos() const
Gets the vertical offset of the tie start.
Definition ff_entrydetails.h:5369
void SetEndVerticalPos(twobyte pos)
Sets the vertical offset of the end point.
Definition ff_entrydetails.h:5543
bool IsEndPointActive() const
Returns true if the end point is active.
Definition ff_entrydetails.h:5257
twobyte GetLeftHeight() const
Gets the left height contour value for the tie.
Definition ff_entrydetails.h:5428
TIEMOD_DIRECTION
Tie Direction: Automatic, Over, Under.
Definition ff_entrydetails.h:5063
@ TIEMODDIR_UNDER
Definition ff_entrydetails.h:5071
@ TIEMODDIR_OVER
Definition ff_entrydetails.h:5068
@ TIEMODDIR_AUTOMATIC
Definition ff_entrydetails.h:5065
bool GetFixedInsetStyle() const
Gets the local fixed inset style for the tie.
Definition ff_entrydetails.h:5418
void SetNoteID(twobyte id) override
Sets the note ID for the tie, so it maps to the note.
Definition ff_entrydetails.h:5662
void ActivateEndPoint(bool fortieover, TIEMOD_CONNECTION_CODES connectioncode, Evpu16 hoffset, Evpu16 voffset)
Activates the end placement fields and initializes them with the input values.
Definition ff_entrydetails.h:5271
void SetRightInset(twobyte value)
Sets the right inset contour value for the tie.
Definition ff_entrydetails.h:5597
bool IsContourActive() const
Returns true if the tie contour adjustment fields are active.
Definition ff_entrydetails.h:5318
void DeactivateStartPoint()
Deactivates the start placement fields and initializes them with zero.
Definition ff_entrydetails.h:5247
twobyte GetEndHorizontalPos() const
Gets the horizontal offset of the end point.
Definition ff_entrydetails.h:5410
void SetBreakForKeySignature(twobyte value)
Sets the Break for Key Signature selection.
Definition ff_entrydetails.h:5639
FCTieMod(TIEMOD_TIETYPES tietype)
The constructor.
Definition ff_entrydetails.h:5189
void SetStartVerticalPos(twobyte pos)
Sets the vertical offset of the start point.
Definition ff_entrydetails.h:5523
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition ff_entrydetails.h:5019
TIEMOD_SELECTOR
Selector values: Default, On, Off.
Definition ff_entrydetails.h:5047
@ TIEMODSEL_DEFAULT
Definition ff_entrydetails.h:5049
@ TIEMODSEL_ON
Definition ff_entrydetails.h:5052
@ TIEMODSEL_OFF
Definition ff_entrydetails.h:5055
void SetOuterPlacement(twobyte value)
Sets the Outer Placement selection.
Definition ff_entrydetails.h:5649
void SetLeftHeight(twobyte value)
Sets the left height contour value for the tie.
Definition ff_entrydetails.h:5569
void SetRightHeight(twobyte value)
Sets the right height contour value for the tie.
Definition ff_entrydetails.h:5577
void SetAvoidStaffLines(bool value)
Sets the Avoid Staff Lines selection.
Definition ff_entrydetails.h:5655
int GetEndConnectionCode() const
Gets the connection code for the end point.
Definition ff_entrydetails.h:5387
void SetTieDirection(twobyte value)
Sets the tie direction selection.
Definition ff_entrydetails.h:5605
twobyte GetBreakForKeySignature() const
Returns the Break for Key Signature selection.
Definition ff_entrydetails.h:5494
int GetStartConnectionCode() const
Gets the connection code for the start point.
Definition ff_entrydetails.h:5356
Class for attaching an tuplet to an entry.
Definition ff_entrydetails.h:2153
FCTuplet()
The constructor.
Definition ff_entrydetails.h:2245
twobyte GetSlopeAdjust() const
Returns the "Manual Slope Adjustment" value.
Definition ff_entrydetails.h:2489
twobyte GetRightHookLength() const
Returns the right-side hook length of the bracket/slur shape in EVPUs.
Definition ff_entrydetails.h:2473
void SetVerticalShapeOffset(twobyte value)
Sets the vertical shape offset value (in EVPUs).
Definition ff_entrydetails.h:2661
void SetUseBottomNote(bool value)
Sets the "Use Bottom Note" setting for the tuplet.
Definition ff_entrydetails.h:2561
void SetShapeStyle(SHAPESTYLE value)
Sets the setting for which bracket shape the tuplet should use.
Definition finaleframework.cpp:21412
void SetBracketFullDuration(bool value)
Sets the "Bracket Full Duration" setting.
Definition ff_entrydetails.h:2625
twobyte GetRightExtension() const
Returns the right-side extension adjusment of the bracket/slur shape in EVPUs.
Definition ff_entrydetails.h:2483
twobyte GetReferenceNumber() const
Returns the reference number value.
Definition ff_entrydetails.h:2306
void DebugDump() override
Outputs the class data/information for debugging purposes.
Definition ff_entrydetails.h:2729
void SetLeftExtension(twobyte value)
Sets the left extension of the bracket/slur shape in EVPUs, compared to the left default position.
Definition ff_entrydetails.h:2683
twobyte GetVerticalShapeOffset() const
Returns the vertical bracket offset in EVPUs.
Definition ff_entrydetails.h:2444
TimeEdu32 CalcFullReferenceDuration()
Calculates the full reference duration of a tuplet, in EDUs.
Definition ff_entrydetails.h:2259
bool GetAllowHorizontalDrag() const
Returns the "Allow Horizontal Drag" setting for the tuplet.
Definition ff_entrydetails.h:2340
bool GetUseBottomNote() const
Returns the "Use Bottom Note" setting for the tuplet.
Definition ff_entrydetails.h:2346
bool GetBracketFullDuration() const
Returns the "Bracket Full Duration" setting.
Definition ff_entrydetails.h:2408
void SetBracketMode(BRACKETMODE value)
Sets when the slur/bracket shape should show.
Definition finaleframework.cpp:21438
twobyte GetLeftHookLength() const
Returns the left-side hook length of the bracket/slur shape in EVPUs.
Definition ff_entrydetails.h:2456
bool GetIgnoreNumberOffset() const
Returns the "Ignore Number Offset" setting.
Definition ff_entrydetails.h:2432
bool GetAlwaysFlat() const
Returns the "Always Flat" setting.
Definition ff_entrydetails.h:2402
void SetEngraverTuplet(bool value)
Sets the "engraver tuplet" setting for the tuplet.
Definition ff_entrydetails.h:2543
twobyte GetHorizontalShapeOffset() const
Returns the horizontal bracket offset in EVPUs.
Definition ff_entrydetails.h:2438
void SetSymbolicDuration(twobyte value)
Sets the symbolic duration value (in EDUs).
Definition ff_entrydetails.h:2509
twobyte GetVerticalOffset() const
Returns the vertical tuplet offset in EVPUs.
Definition ff_entrydetails.h:2420
void SetVerticalOffset(twobyte value)
Sets the vertical tuplet offset in EVPUs.
Definition ff_entrydetails.h:2637
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition ff_entrydetails.h:2231
void SetMatchHookLengths(bool value)
Sets the "Match Hook Lengths" setting.
Definition ff_entrydetails.h:2667
SHAPESTYLE GetShapeStyle() const
Returns the setting for which bracket shape the tuplet should use.
Definition finaleframework.cpp:21320
bool GetVisible() const
Returns the visibility setting for the tuplet.
Definition ff_entrydetails.h:2495
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition ff_entrydetails.h:2230
void SetBreakSlurBracket(bool value)
Definition ff_entrydetails.h:2599
void SetAllowHorizontalDrag(bool value)
Sets the "Allow Horizontal Drag" setting for the tuplet.
Definition ff_entrydetails.h:2555
void SetHorizontalOffset(twobyte value)
Sets the horizontal tuplet offset in EVPUs.
Definition ff_entrydetails.h:2631
BRACKETMODE
The settings for when the bracket shape should show.
Definition ff_entrydetails.h:2224
bool GetAvoidStaff() const
Returns the "Avoid Staff" setting for the tuplet.
Definition ff_entrydetails.h:2334
void SetReferenceNumber(twobyte value)
Sets the reference number value.
Definition ff_entrydetails.h:2515
void SetAvoidStaff(bool value)
Sets the "Avoid Staff" setting for the tuplet.
Definition ff_entrydetails.h:2549
void SetHorizontalShapeOffset(twobyte value)
Sets the horizontal shape offset value (in EVPUs).
Definition ff_entrydetails.h:2655
void SetIgnoreNumberOffset(bool value)
Sets the "Ignore Number Offset" setting.
Definition ff_entrydetails.h:2649
PLACEMENTMODE
The settings for where the tuplet should be placed compared to the note entry.
Definition ff_entrydetails.h:2186
bool GetEngraverTuplet() const
Returns the "engraver tuplet" setting for the tuplet.
Definition ff_entrydetails.h:2328
twobyte GetLeftExtension() const
Returns the left-side extension adjusment of the bracket/slur shape in EVPUs.
Definition ff_entrydetails.h:2465
PLACEMENTMODE GetPlacementMode() const
Gets the settings for where the tuplet should be placed compared to the note entry.
Definition finaleframework.cpp:21275
void SetAlwaysFlat(bool value)
Sets the "Always Flat" setting.
Definition ff_entrydetails.h:2619
NUMBERSTYLE GetNumberStyle() const
Returns the settings for the number style that should be used by the tuplet.
Definition finaleframework.cpp:21297
void SetPlacementMode(PLACEMENTMODE value)
Sets where the tuplet should be placed compared to the note entry.
Definition finaleframework.cpp:21349
twobyte GetHorizontalOffset() const
Returns the horizontal tuplet offset in EVPUs.
Definition ff_entrydetails.h:2414
SHAPESTYLE
The setting for which bracket shape the tuplet should use.
Definition ff_entrydetails.h:2213
void SetCenterUsingDuration(bool value)
Sets the "Center Using Duration" setting.
Definition ff_entrydetails.h:2643
void PrefsReset(bool resetposition)
Resets the tuplet settings to the current preference defaults.
Definition finaleframework.cpp:21470
twobyte GetReferenceDuration() const
Returns the reference duration value (in EDUs).
Definition ff_entrydetails.h:2300
void SetNumberStyle(NUMBERSTYLE value)
Sets the setting for the number style that should be used by the tuplet.
Definition finaleframework.cpp:21380
void SetLeftHookLength(twobyte value)
Sets the left hook length of the bracket/slur shape in EVPUs.
Definition ff_entrydetails.h:2674
bool GetCenterUsingDuration() const
Returns the "Center Using Duration" setting.
Definition ff_entrydetails.h:2426
void SetRightExtension(twobyte value)
Sets the right extension of the bracket/slur shape in EVPUs, compared to the right-side default posit...
Definition ff_entrydetails.h:2700
twobyte GetSymbolicNumber() const
Returns the symbolic number of the tuplet.
Definition ff_entrydetails.h:2294
BRACKETMODE GetBracketMode() const
Returns the settings for when the bracket/slur shape should show.
Definition finaleframework.cpp:21339
void SetSlopeAdjust(twobyte value)
Sets the "Manual Slope Adjustment" value.
Definition ff_entrydetails.h:2706
NUMBERSTYLE
The settings for the number style that should be used by the tuplet.
Definition ff_entrydetails.h:2200
twobyte GetSymbolicDuration() const
Returns the symbolic duration value (in EDUs).
Definition ff_entrydetails.h:2286
void SetReferenceDuration(twobyte value)
Sets the reference duration value (in EDUs).
Definition ff_entrydetails.h:2521
void SetVisible(bool value)
Sets the visibility state of the tuplet.
Definition ff_entrydetails.h:2712
bool GetMatchHookLengths() const
Returns the "Match Hook Lengths" setting.
Definition ff_entrydetails.h:2450
void SetRightHookLength(twobyte value)
Sets the right hook length of the bracket/slur shape in EVPUs.
Definition ff_entrydetails.h:2691
TimeEdu32 CalcFullSymbolicDuration()
Calculates the symbolic duration of a tuplet, in edus.
Definition ff_entrydetails.h:2268
bool GetBreakSlurBracket() const
Returns the setting for if the slur/bracket should be broken around the number.
Definition ff_entrydetails.h:2383
void SetSymbolicNumber(twobyte value)
Sets the symbolic number of the tuplet.
Definition ff_entrydetails.h:2503
EXTAG Tag() const override
The Enigma tag for the derived class.
Definition ff_entrydetails.h:2179
The class for a verse syllable.
Definition ff_entrydetails.h:3202
bool IsVerse() const override
Returns true if the syllable object is a verse syllable.
Definition ff_entrydetails.h:3209
EXTAG Tag() const override
The Enigma tag for the derived class.
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition ff_entrydetails.h:3206
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition ff_entrydetails.h:3207