15 #ifdef PDK_FRAMEWORK_PREFS
17 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
30 #include "pragma_align_begin.h"
31 struct _FCEDTPlaybackPrefs
33 twobyte metronomeBeat;
37 twobyte metronomeSpeed;
42 twobyte baseKeyVelocity;
57 #include "pragma_align_end.h"
59 #include "pragma_align_begin.h"
60 struct _FCEDTDistancePrefs
62 twobyte acciVertSpace;
63 Evpu16 acciMultCharSpace;
65 Evpu16 acciMultiSpaces;
67 twobyte alterHalfDiamondBaseline;
69 twobyte alterWholeDiamondBaseline;
71 twobyte alterDblWholeDiamondBaseline;
74 Efix16 barlineDblSpace;
75 Efix16 barlineFinalSpace;
76 Evpu32 barlineDashSpace;
78 Evpu16 beamSecondarySepar;
79 twobyte beamMaxDistance;
81 twobyte graceNoteSpacing;
83 twobyte clefDefaultOffset;
88 twobyte dotSpaceBetweenDots;
89 twobyte dotVerticalAdjust;
90 twobyte dotFlagAdjust;
92 Evpu16 keysigSpaceBefore;
93 Evpu16 keysigSpaceAfter;
94 Evpu16 keysigSpaceAfterCancel;
95 Evpu16 keysigSpaceBetween;
97 Evpu16 musicSpaceBefore;
98 Evpu16 musicSpaceAfter;
100 Efix32 stemNoteheadOffset;
102 Evpu16 timesigAbbrSymbolVert;
104 Evpu16 timesigTopSymbolVert;
106 Evpu16 timesigBottomSymbolVert;
108 Evpu16 timesigSpaceBefore;
109 Evpu16 timesigSpaceAfter;
111 Evpu16 timesigPartsAbbrSymbolVert;
113 Evpu16 timesigPartsTopSymbolVert;
115 Evpu16 timesigPartsBottomSymbolVert;
117 Evpu16 timesigPartsSpaceBefore;
118 Evpu16 timesigPartsSpaceAfter;
120 twobyte groupbracketdefaulthorizontaldistance;
122 Evpu16 keysigTimeSpace;
124 Evpu16 clefTimeSpace;
127 #include "pragma_align_end.h"
130 #include "pragma_align_begin.h"
131 struct _FCEDTExtraTupletPrefs
134 twobyte horizDownstem;
135 Efix16 bracketThickness;
138 #include "pragma_align_end.h"
141 #include "pragma_align_begin.h"
142 struct _FCEDTLayoutDistancePrefs
144 Evpu16 partsFirstSysDistance;
145 Evpu16 scoreFirstSysDistance;
147 twobyte partsStaffHeight;
148 ePercent partsSystemScaling;
149 twobyte scoreStaffHeight;
150 ePercent scoreSystemScaling;
152 #include "pragma_align_end.h"
155 #include "pragma_align_begin.h"
156 struct _FCEDTPre2012MusicCharsPrefs
158 twobyte symbolcommontimesigscore;
159 twobyte symbolcuttimesigscore;
161 twobyte symbolWiggle;
167 #include "pragma_align_end.h"
170 #include "pragma_align_begin.h"
171 struct _FCEDTMusicCharsPrefsDistances
173 twobyte halfslashbaseline;
174 twobyte wholeslashbaseline;
175 twobyte brevisslashbaseline;
177 #include "pragma_align_end.h"
179 #include "pragma_align_begin.h"
180 struct _FCEDTSizePrefs
182 Efix16 barlineHeavyThickness;
183 Efix16 barlineThinThickness;
184 Evpu32 barlineDashLength;
186 Efix32 beamThickness;
187 Evpu16 beamBrokenLength;
189 ePercent graceNoteSize;
190 ePercent graceTablatureNoteSize;
191 Efix16 graceSlashThickness;
193 Efix16 enclosureThickness;
194 Efix16 staffLineThickness;
195 Efix16 ledgerThickness;
196 Evpu16 ledgerLeftHalf;
197 Evpu16 ledgerLeftHalfRest;
198 Evpu16 ledgerRightHalf;
199 Evpu16 ledgerRightHalfRest;
200 fourbyte shapeDesignerSlurTip;
202 Evpu16 stemNormalLength;
203 Evpu16 stemShortLength;
204 Evpu16 stemHalfLength;
205 Evpu16 stemReverseAdjust;
206 Efix16 stemThickness;
209 #include "pragma_align_end.h"
211 #include "pragma_align_begin.h"
212 struct _FCEDTMiscDocPrefs
214 tbool barlineDoubleAtKeySig;
215 tbool barlineDisplayAll;
216 tbool barlineCloseSys;
217 tbool barlineClosePiece;
218 tbool barlineFinalAtEnd;
219 tbool barlineLeftSingleStaff;
220 tbool barlineLeftMultStaves;
221 tbool barlineDefaultToNormal;
243 tbool clefOnlyOnFirstSys;
245 ePercent clefReduction;
247 twobyte curveResolution;
249 tbool dotAdjustForMultipleVoices;
251 twobyte gracePlaybackDur;
252 tbool graceAlwaysSlash;
254 tbool keysigOnlyOfFirstSys;
255 tbool keysigNaturalsInC;
256 tbool keysigModeChange;
257 tbool keysigCancelOutgoing;
258 tbool keysigCancelSwitchSharpsFlats;
259 tbool keysigPreserveOctave;
261 twobyte timesigCompMeterDeci;
262 tbool timesigAbbrCommonTime;
263 tbool timesigAbbrCutTime;
265 tbool stemUseConnections;
266 FLAG_16 courtesyFlags;
270 tbool secondsInTimeStamp;
272 twobyte textTabChars;
273 tbool scaleManualPos;
274 tbool crossStaffInOriginal;
277 TimeEdu16 pickupMeasure;
279 CMPER specialExtractedPartCmper;
280 tbool displayPartExpressions;
282 fourbyte PSUnderlineDepth;
283 fourbyte PSUnderlineThickness;
285 tbool chordItalicizeCapo;
286 FLAG_16 chordFretboardFlag;
287 fourbyte chordFretboardResize;
289 twobyte chordEnablePlayback;
292 tbool showactivelayeronly;
294 tbool consolidaterests;
296 tbool keepOctaveTranspositionInConcertPitch;
298 #include "pragma_align_end.h"
300 #include "pragma_align_begin.h"
301 struct _FCEDTPageFormatPrefs
305 ePercent pageScaling;
319 Evpu16 sysDistBetween;
321 tbool bFirstSysMargin;
327 #include "pragma_align_end.h"
329 #include "pragma_align_begin.h"
330 struct _FCEDTRepeatPrefs
334 Efix16 spaceBetweenLines;
335 FLAG_16 backToBackStyle;
337 Evpu16 backwardSpace;
338 Evpu16 upperVertAdjust;
339 Evpu16 lowerVertAdjust;
341 Evpu16 afterClefSpace;
342 Evpu16 afterKeySpace;
343 Evpu16 afterTimeSpace;
346 Evpu16 endingBracketHeight;
347 Evpu16 endingFrontHook;
348 Evpu16 endingBackHook;
349 Efix16 endingLineThickness;
350 twobyte endingInsetStart;
351 twobyte endingInsetEnd;
352 Evpu16 endingTextHoriz;
353 Evpu16 endingTextVert;
355 tbool dotafternumber;
358 tbool thinInnerBracketReference;
360 #include "pragma_align_end.h"
362 #include "pragma_align_begin.h"
363 struct _FCEDTPianoBracePrefs
366 fourbyte innerTipHoriz;
367 fourbyte innerTipVert;
368 fourbyte innerBodyHoriz;
369 fourbyte innerBodyVert;
370 fourbyte outerTipHoriz;
371 fourbyte outerTipVert;
372 fourbyte outerBodyHoriz;
373 fourbyte outerBodyVert;
375 fourbyte centerThickness;
376 fourbyte tipThickness;
378 #include "pragma_align_end.h"
380 #include "pragma_align_begin.h"
381 struct _FCEDTSmartShapePrefs
383 twobyte customLineStyle;
384 twobyte glissandoStyle;
385 twobyte tabSlideStyle;
386 twobyte guitarBendStyle;
387 Evpu16 crescDimOpening;
388 Evpu16 crescDimShortOpening;
389 twobyte crescDimMaxShortSpanLength;
390 Efix16 crescDimWidth;
391 tbool bCrescDimHorizontal;
392 Efix16 lineThickness;
398 tbool bUseEngraverSlurs;
399 twobyte engrMaxAngle;
400 twobyte engrSymmetry;
402 twobyte engrAcciMode;
403 Evpu16 engrAcciSpace;
404 tbool engrStretchFirst;
405 tbool engrStretchMode;
406 twobyte engrMaxStretchPrecent;
407 Efix32 engrMaxStretchFixed;
410 Evpu16 slurbrStaffLineAvoid;
411 Evpu16 slurbrStartAdjust;
412 Evpu16 slurbrEndAdjust;
414 fourbyte slurtipWidth;
415 tbool slurtipAvoidStaff;
416 Evpu16 slurtipAvoidStaffVal;
418 Evpu16 slurThicknessHorizLeft;
419 Evpu16 slurThicknessVertLeft;
420 Evpu16 slurThicknessHorizRight;
421 Evpu16 slurThicknessVertRight;
423 tbool bendParentheses;
424 tbool bendHideNumber;
425 tbool bendAutoGenerateText;
426 tbool bendReplaceWithFull;
428 #include "pragma_align_end.h"
430 #include "pragma_align_begin.h"
431 struct _FCEDTPartExtractPrefs
433 twobyte spacingMethod;
438 twobyte partNameHeaderHoriz;
439 twobyte partNameHeaderVert;
440 tbool newStaffPlacement;
442 Evpu16 newStaffDistance;
443 tbool removePageOneBlocks;
444 tbool removePageTwoPlusBlocks;
445 tbool removeStaffGroupNames;
449 twobyte measuresPerSystem;
450 twobyte promptForEachName;
451 tbool removeMultiPageBlocks;
452 tbool createPartNameHeader;
453 twobyte partNameHeaderResize;
454 twobyte partNameHeaderFromPage;
455 twobyte partNameHeaderToPage;
456 twobyte partNameHeaderFontID;
458 twobyte partNameHeaderFontSize;
459 twobyte partNameHeaderFontEfx;
460 tbool partNameHeaderUseFontID;
461 tbool openExtractedParts;
462 tbool spaceSystemsEvenly;
463 twobyte partNameHeaderAAAA;
464 twobyte partNameHeaderBBBB;
466 #include "pragma_align_end.h"
468 #include "pragma_align_begin.h"
469 struct _FCEDTTiePrefs
471 Evpu16 thicknessRight;
472 Evpu16 thicknessLeft;
473 tbool breakForTimeSigs;
474 tbool breakForKeySigs;
475 Evpu16 breakTimeSigLeftHOffset;
476 Evpu16 breakTimeSigRightHOffset;
477 Evpu16 breakKeySigLeftHOffset;
478 Evpu16 breakKeySigRightHOffset;
479 Evpu16 sysBreakLeftHAdj;
480 Evpu16 sysBreakRightHAdj;
481 tbool useOuterPlacement;
482 FLAG_16 secondsPlacement;
483 twobyte chordTieDirType;
484 tbool chordTieDirOpposingSeconds;
485 twobyte mixedStemDirection;
486 tbool afterSingleDot;
487 tbool afterMultipleDots;
488 tbool beforeAcciSingleNote;
489 FLAG_16 specialPosMode;
491 Evpu16 avoidStaffLinesDistance;
494 tbool useInterpolation;
496 tbool useTieEndCtlStyle;
497 tbool avoidStaffLinesOnly;
501 #include "pragma_align_end.h"
503 #include "pragma_align_begin.h"
504 struct _FCEDTMusicSpacingPrefs
510 Evpu16 minDistTiedNotes;
512 twobyte useAllotmentTables;
513 twobyte referenceDurationLow;
514 twobyte referenceDurationHigh;
515 twobyte referenceWidthLow;
516 twobyte referenceWidthHigh;
517 twobyte scalingFactorLow;
518 twobyte scalingFactorHigh;
519 twobyte graceNoteMinDistance;
520 twobyte graceNoteSpacingMode;
521 Evpu16 accidentalsGutter;
524 #include "pragma_align_end.h"
527 #include "pragma_align_begin.h"
528 struct _FCEDTLyricsPrefs
530 Evpu16 spaceBetweenHyphens;
531 Efix16 wordExtensionThickness;
533 twobyte useSmartHyphens;
534 twobyte hyphenSystemStart;
539 twobyte othersSyllAlign;
540 twobyte othersSyllJusti;
543 twobyte wordExtensionSyllAlign;
544 twobyte wordExtensionSyllJusti;
545 FLAG_16 wordExtensionSyllFlags;
547 twobyte firstSyllAlign;
548 twobyte firstSyllJusti;
549 FLAG_16 firstSyllFlags;
551 twobyte startSysSyllAlign;
552 twobyte startSysSyllJusti;
553 FLAG_16 startSysSyllFlags;
555 #include "pragma_align_end.h"
558 #include "pragma_align_begin.h"
559 struct _FCEDTMMRestDefaultsPrefs
565 twobyte startNumberingAt;
566 twobyte symbolMeasures;
567 Evpu16 spaceBetweenSymbols;
569 Evpu16 shpAdjustStart;
576 #include "pragma_align_end.h"
578 #include "pragma_align_begin.h"
579 struct _FCEDTPartScopePrefs
583 #include "pragma_align_end.h"
585 #include "pragma_align_begin.h"
586 struct _FCEDTGroupNamePosPrefs
592 #include "pragma_align_end.h"
596 const EXTAG _fcpf_DistancePrefs = MAKEEXTAG(edPrefs,
'D',
'P');
601 const EXTAG _fcpf_SizePrefs = MAKEEXTAG(edPrefs,
'S',
'I');
602 const EXTAG _fcpf_MiscDocPrefs = MAKEEXTAG(edPrefs,
'M',
'I');
603 const EXTAG _fcpf_RepeatPrefs = MAKEEXTAG(edPrefs,
'R',
'P');
604 const EXTAG _fcpf_PianoBracePrefs = MAKEEXTAG(edPrefs,
'P',
'B');
605 const EXTAG _fcpf_SmartShapePrefs = MAKEEXTAG(edPrefs,
'S',
'S');
606 const EXTAG _fcpf_PlaybackPrefs = MAKEEXTAG(edPrefs,
'P',
'L');
607 const EXTAG _fcpf_TiePrefs = MAKEEXTAG(edPrefs,
'T',
'I');
608 const EXTAG _fcpf_MusicSpacingPrefs = MAKEEXTAG(edPrefs,
'M',
'S');
609 const EXTAG _fcpf_PartExtractPrefs = MAKEEXTAG(edPrefs,
'E',
'X');
610 const EXTAG _fcpf_PageFormatPrefs = MAKEEXTAG(edPrefs,
'P',
'F');
611 const EXTAG _fcpf_LyricsPrefs = MAKEEXTAG(edPrefs,
'l',
'y');
612 const EXTAG _fcpf_MMRestDefaultPrefs = MAKEEXTAG(edPrefs,
'm',
'm');
613 const EXTAG _fcpf_PartScopePrefs = MAKEEXTAG(edPrefs,
'p',
'S');
614 const EXTAG _fcpf_GroupNamePosPrefs = MAKEEXTAG(edPrefs,
'G',
'p');
615 const EXTAG _fcpf_StaffNamePositionPrefs = MAKEEXTAG(edPrefs,
'S',
'p');
617 enum PREFMAP_ARRAY_CONVERSION
644 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
645 struct PREFERENCE_LOCATION_MAPRECORD
652 twobyte structOffset;
653 twobyte offsetInInci;
655 PREFMAP_ARRAY_CONVERSION conversion;
661 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
663 fourbyte MakePrefsFourbyte(
const twobyte inci0,
const twobyte inci1,
const PREFMAP_ARRAY_CONVERSION convType);
666 void MakePrefsTwobytes(
const fourbyte fb, twobyte *inci0, twobyte *inci1,
const PREFMAP_ARRAY_CONVERSION convType);
669 bool MapPrefStruct(EXTAG tag,
671 PREFERENCE_LOCATION_MAPRECORD **ppMapDef,
672 twobyte *noOfElements);
677 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
680 bool FragmentStructLoad(
void* pVoidBuffer, fourbyte *pSize,
681 PREFERENCE_LOCATION_MAPRECORD *pMapDef, twobyte noOfElements);
684 bool FragmentStructSave(
void* pVoidBuffer, fourbyte size,
685 PREFERENCE_LOCATION_MAPRECORD *pMapDef, twobyte noOfElements);
702 virtual bool Load(twobyte prefsno = 1);
722 _FCEDTPlaybackPrefs _prefsdata;
723 virtual EXTAG Tag() {
return _fcpf_PlaybackPrefs; }
725 virtual int DataSizeLoad() {
return sizeof(_FCEDTPlaybackPrefs); }
726 virtual void* Allocate() {
return (
void*) &_prefsdata; }
734 memcpy(&_prefsdata, ((
FCPlaybackPrefs*)pSource)->_GetPrefsData(),
sizeof(_prefsdata));
742 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
744 void* _GetPrefsData() {
return &_prefsdata; }
760 virtual const char*
ClassName() {
return "FCPlaybackPrefs"; }
795 twobyte
GetSwing()
const {
return _prefsdata.swing; }
851 void SetSwing(twobyte value) { _prefsdata.swing = value; }
875 mode) { _prefsdata.startAtMode = (twobyte) mode; }
885 _FCEDTDistancePrefs _prefsdata;
887 virtual EXTAG Tag() {
return _fcpf_DistancePrefs; }
889 virtual int DataSizeLoad() {
return sizeof(_FCEDTDistancePrefs); }
890 virtual void* Allocate() {
return (
void*) &_prefsdata; }
898 memcpy(&_prefsdata, ((
FCDistancePrefs*)pSource)->_GetPrefsData(),
sizeof(_prefsdata));
906 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
908 void* _GetPrefsData() {
return &_prefsdata; }
911 virtual const char*
ClassName() {
return "FCDistancePrefs"; }
920 memset(&_prefsdata, 0,
sizeof(_prefsdata));
1437 _FCEDTSizePrefs _prefsdata;
1438 virtual EXTAG Tag() {
return _fcpf_SizePrefs; }
1440 virtual int DataSizeLoad() {
return sizeof(_FCEDTSizePrefs); }
1441 virtual void* Allocate() {
return (
void*) &_prefsdata; }
1449 memcpy(&_prefsdata, ((
FCSizePrefs*)pSource)->_GetPrefsData(),
sizeof(_prefsdata));
1457 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
1459 void* _GetPrefsData() {
return &_prefsdata; }
1741 _FCEDTMiscDocPrefs _prefsdata;
1743 virtual EXTAG Tag() {
return _fcpf_MiscDocPrefs; }
1745 virtual int DataSizeLoad() {
return sizeof(_FCEDTMiscDocPrefs); }
1746 virtual void* Allocate() {
return (
void*) &_prefsdata; }
1754 memcpy(&_prefsdata, ((
FCMiscDocPrefs*)pSource)->_GetPrefsData(),
sizeof(_prefsdata));
1762 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
1764 void* _GetPrefsData() {
return &_prefsdata; }
1830 virtual const char*
ClassName() {
return "FCMiscDocPrefs"; }
1881 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
2015 return GetBitFlag(_prefsdata.chordFretboardFlag, 0x01);
2141 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
2228 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
2235 switch (_prefsdata.layoutFlags & LAYOUTFLG_ADJUST_PAGE_BITS)
2237 case LAYOUTFLG_ADJUST_PAGE_CUR:
2239 case LAYOUTFLG_ADJUST_PAGE_ALL:
2241 case LAYOUTFLG_ADJUST_PAGE_LR:
2243 case LAYOUTFLG_ADJUST_PAGE_RNG:
2323 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
2336 _prefsdata.beamStyle = (twobyte) mode;
2475 if (value < 1)
return;
2476 if (value > 128)
return;
2477 _prefsdata.curveResolution = value;
2582 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
2594 _prefsdata.dateFormat = dateformat;
2679 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
2690 _prefsdata.layoutFlags &= ~LAYOUTFLG_ADJUST_PAGE_BITS;
2691 _prefsdata.layoutFlags |= LAYOUTFLG_ADJUST_PAGE_CUR;
2694 _prefsdata.layoutFlags &= ~LAYOUTFLG_ADJUST_PAGE_BITS;
2695 _prefsdata.layoutFlags |= LAYOUTFLG_ADJUST_PAGE_ALL;
2698 _prefsdata.layoutFlags &= ~LAYOUTFLG_ADJUST_PAGE_BITS;
2699 _prefsdata.layoutFlags |= LAYOUTFLG_ADJUST_PAGE_LR;
2702 _prefsdata.layoutFlags &= ~LAYOUTFLG_ADJUST_PAGE_BITS;
2703 _prefsdata.layoutFlags |= LAYOUTFLG_ADJUST_PAGE_RNG;
2720 #ifdef PDK_FRAMEWORK_ENTRIES
2733 EDTTupletPrefs2005 _prefsdata;
2734 _FCEDTExtraTupletPrefs _extratupletprefs;
2735 virtual EXTAG Tag() {
return pf_TupletPrefs; }
2737 virtual int DataSizeLoad() {
return sizeof(EDTTupletPrefs); }
2738 virtual void* Allocate() {
return (
void*)&_prefsdata; }
2746 memcpy(&_prefsdata, ((
FCTupletPrefs*)pSource)->_GetPrefsData(),
sizeof(_prefsdata));
2756 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
2758 void* _GetPrefsData() {
return &_prefsdata; }
2776 virtual bool Load(twobyte prefsnumber = 1);
2784 virtual bool Save();
2816 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
2854 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
2867 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
2886 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
2984 return _extratupletprefs.horizUpstem;
2993 return _extratupletprefs.horizDownstem;
3002 return _extratupletprefs.bracketThickness;
3013 return _extratupletprefs.maxSlope;
3028 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
3068 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
3082 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
3104 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
3207 _extratupletprefs.horizUpstem = value;
3216 _extratupletprefs.horizDownstem = value;
3225 _extratupletprefs.bracketThickness = value;
3234 _extratupletprefs.maxSlope = value;
3237 #ifdef PDK_FRAMEWORK_DEBUG
3243 case FCTuplet::TUPLETPLACEMENT_MANUAL:
3244 DebugOut(
"Placement mode: Manual");
3246 case FCTuplet::TUPLETPLACEMENT_STEMSIDE:
3247 DebugOut(
"Placement mode: Stem/Beam Side");
3249 case FCTuplet::TUPLETPLACEMENT_NOTESIDE:
3250 DebugOut(
"Placement mode: Note Side");
3252 case FCTuplet::TUPLETPLACEMENT_ABOVE:
3255 case FCTuplet::TUPLETPLACEMENT_BELOW:
3265 case FCTuplet::TUPLETNUMBER_NONE:
3266 DebugOut(
"Number appearance: None");
3268 case FCTuplet::TUPLETNUMBER_REGULAR:
3269 DebugOut(
"Number appearance: Number");
3271 case FCTuplet::TUPLETNUMBER_RATIO:
3272 DebugOut(
"Number appearance: Ratio");
3274 case FCTuplet::TUPLETNUMBER_RATIOANDNOTE:
3275 DebugOut(
"Number appearance: 7:8q");
3277 case FCTuplet::TUPLETNUMBER_RATIOANDNOTE_BOTH:
3278 DebugOut(
"Number appearance: 7q:8q");
3283 case FCTuplet::TUPLETSHAPE_NONE:
3284 DebugOut(
"Shape appearance: None");
3286 case FCTuplet::TUPLETSHAPE_BRACKET:
3287 DebugOut(
"Shape appearance: Bracket");
3289 case FCTuplet::TUPLETSHAPE_SLUR:
3290 DebugOut(
"Shape appearance: Slur");
3297 case FCTuplet::TUPLETBRACKET_ALWAYS:
3298 DebugOut(
"Always use specified shape");
3300 case FCTuplet::TUPLETBRACKET_UNBEAMEDONLY:
3301 DebugOut(
"Bracket unbeamed notes only");
3303 case FCTuplet::TUPLETBRACKET_NEVERBEAMEDONBEAMSIDE:
3304 DebugOut(
"Never bracket beamed notes on beam side");
3326 #endif // PDK_FRAMEWORK_ENTRIES
3335 EDTPageFormatPrefs _prefsdata;
3336 twobyte _systemstaffheight;
3337 twobyte _systemscaling;
3338 twobyte _firstsysdistance;
3340 virtual EXTAG Tag() {
return pf_PageFormatPrefs; }
3342 virtual int DataSizeLoad() {
return sizeof(EDTPageFormatPrefs); }
3343 virtual void* Allocate() {
return (
void*) &_prefsdata; }
3352 memcpy(&_prefsdata, pSourceObj->_GetPrefsData(),
sizeof(_prefsdata));
3363 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
3365 void* _GetPrefsData() {
return &_prefsdata; }
3368 virtual const char*
ClassName() {
return "FCPageFormatPrefs"; }
3378 _systemstaffheight = 96 * 16;
3379 _systemscaling = 100;
3380 _firstsysdistance = 0;
3388 virtual bool Load(twobyte prefsno = 1);
3392 virtual bool Save();
3778 EDTGeneralPrefs2008 _prefsdata;
3779 virtual EXTAG Tag() {
return pf_GeneralPrefs; }
3781 virtual EVERSION EnigmaVersion() {
return FXT_VERSION_2K8_BASE; }
3782 virtual int DataSizeLoad() {
return sizeof(EDTGeneralPrefs2008); }
3783 virtual void* Allocate() {
return (
void*) &_prefsdata; }
3791 memcpy(&_prefsdata, ((
FCGeneralPrefs*)pSource)->_GetPrefsData(),
sizeof(_prefsdata));
3800 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
3802 void* _GetPrefsData() {
return &_prefsdata; }
3805 virtual const char*
ClassName() {
return "FCGeneralPrefs"; }
3843 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
4026 _FCEDTMusicSpacingPrefs _prefsdata;
4028 virtual EXTAG Tag() {
return _fcpf_MusicSpacingPrefs; }
4030 virtual int DataSizeLoad() {
return sizeof(_FCEDTMusicSpacingPrefs); }
4031 virtual void* Allocate() {
return (
void*) &_prefsdata; }
4040 memcpy(&_prefsdata, pOtherObject->_GetPrefsData(),
sizeof(_prefsdata));
4055 GRACESPMODE_RESETTOOFFSET = 0,
4056 GRACESPMODE_KEEPCURRENT = 1,
4057 GRACESPMODE_AUTOMATIC = 2
4066 MANUALPOS_CLEAR = 0,
4069 MANUALPOS_INCORPORATE = 1,
4070 MANUALPOS_IGNORE = 2
4080 UNISSPACE_DIFFERENTNOTEHEADS = 1,
4081 UNISSPACE_ALLNOTEHEADS = 2
4084 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
4086 void* _GetPrefsData() {
return &_prefsdata; }
4089 virtual const char*
ClassName() {
return "FCMusicSpacingPrefs"; }
4114 int returnvalue = _prefsdata.scalingFactorHigh * 0x10000;
4115 returnvalue += _prefsdata.scalingFactorLow;
4130 int returnvalue = _prefsdata.scalingFactorHigh * 0x10000;
4131 returnvalue += _prefsdata.scalingFactorLow;
4132 double floatresult = (double) returnvalue;
4133 return floatresult / 10000;
4221 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
4240 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
4247 if (
GetBitFlag(_prefsdata.flag, MSP_CLRPOSITS))
return MANUALPOS_CLEAR;
4248 if (
GetBitFlag(_prefsdata.flag, MSP_USEPOSITS))
return MANUALPOS_INCORPORATE;
4249 return MANUALPOS_IGNORE;
4258 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
4265 if (
GetBitFlag(_prefsdata.flag, MSP_AVCOLUNISONS_ALL))
return UNISSPACE_ALLNOTEHEADS;
4266 if (
GetBitFlag(_prefsdata.flag, MSP_AVCOLUNISONS_SAME))
return UNISSPACE_DIFFERENTNOTEHEADS;
4267 return UNISSPACE_NONE;
4293 #if OPERATING_SYSTEM == WINDOWS
4294 return GetBitFlag(_prefsdata.flag, MSP_USEPRINTER);
4308 return (_prefsdata.useAllotmentTables == 1);
4317 return MAKELONG(_prefsdata.referenceDurationLow, _prefsdata.referenceDurationHigh);
4326 return MAKELONG(_prefsdata.referenceWidthLow, _prefsdata.referenceWidthHigh);
4342 ufourbyte fbRatio = (ufourbyte) value;
4343 _prefsdata.scalingFactorLow = fbRatio & 0xffff;
4344 _prefsdata.scalingFactorHigh = (fbRatio & 0xffff0000) >> 16;
4360 ufourbyte fbRatio = (ufourbyte) ratio;
4361 _prefsdata.scalingFactorLow = fbRatio & 0xffff;
4362 _prefsdata.scalingFactorHigh = (fbRatio & 0xffff0000) >> 16;
4451 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
4457 ) { _prefsdata.graceNoteSpacingMode = (twobyte) value; }
4472 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
4482 case MANUALPOS_CLEAR:
4486 case MANUALPOS_INCORPORATE:
4490 case MANUALPOS_IGNORE:
4504 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
4514 case UNISSPACE_ALLNOTEHEADS:
4515 Set16BitFlag(&_prefsdata.flag, MSP_AVCOLUNISONS_ALL,
true);
4516 Set16BitFlag(&_prefsdata.flag, MSP_AVCOLUNISONS_SAME,
false);
4518 case UNISSPACE_DIFFERENTNOTEHEADS:
4519 Set16BitFlag(&_prefsdata.flag, MSP_AVCOLUNISONS_ALL,
false);
4520 Set16BitFlag(&_prefsdata.flag, MSP_AVCOLUNISONS_SAME,
true);
4522 case UNISSPACE_NONE:
4523 Set16BitFlag(&_prefsdata.flag, MSP_AVCOLUNISONS_ALL,
false);
4524 Set16BitFlag(&_prefsdata.flag, MSP_AVCOLUNISONS_SAME,
false);
4553 #if OPERATING_SYSTEM == WINDOWS
4554 return Set16BitFlag(&_prefsdata.flag, MSP_USEPRINTER, state);
4566 _prefsdata.useAllotmentTables = allotmenttable ? 1 : 0;
4575 _prefsdata.referenceDurationLow = LOWORD(duration);
4576 _prefsdata.referenceDurationHigh = HIWORD(duration);
4585 _prefsdata.referenceWidthLow = LOWORD(width);
4586 _prefsdata.referenceWidthHigh = HIWORD(width);
4603 EEnigmaFont _prefsdata;
4604 virtual EXTAG Tag() {
return pf_DefaultFontPrefs; }
4606 virtual int DataSizeLoad() {
return sizeof(EEnigmaFont); }
4607 virtual void* Allocate() {
return (
void*) &_prefsdata; }
4615 memcpy(&_prefsdata, ((
FCFontPrefs*)pSource)->_GetPrefsData(),
sizeof(_prefsdata));
4623 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
4625 void* _GetPrefsData() {
return &_prefsdata; }
4779 memset(&_prefsdata, 0,
sizeof(_prefsdata));
4794 pFontInfo->
SetSize(_prefsdata.size);
4813 pFontInfo->
SetSize(_prefsdata.size);
4818 #ifdef PDK_FRAMEWORK_LUAFRIENDLY
4836 _prefsdata.size = pFontInfo->
GetSize();
4853 _FCEDTMMRestDefaultsPrefs _prefsdata;
4855 virtual EXTAG Tag() {
return _fcpf_MMRestDefaultPrefs; }
4857 virtual int DataSizeLoad() {
return sizeof(_FCEDTMMRestDefaultsPrefs); }
4858 virtual void* Allocate() {
return (
void*) &_prefsdata; }
4874 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
4876 void* _GetPrefsData() {
return &_prefsdata; }
4879 virtual const char*
ClassName() {
return "FCMultiMeasureRestPrefs"; }
4889 memset(&_prefsdata, 0,
sizeof(_prefsdata));
4897 twobyte
GetWidth()
const {
return _prefsdata.measWidth; }
4969 void SetShapeID(twobyte shapeID) { _prefsdata.shapeID = shapeID; }
5022 void SetWidth(twobyte value) { _prefsdata.measWidth = value; }
5049 #ifdef PDK_FRAMEWORK_DEBUG
5067 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
5068 _FCEDTSmartShapePrefs _prefsdata;
5070 virtual EXTAG
Tag() {
return _fcpf_SmartShapePrefs; }
5072 virtual int DataSizeLoad() {
return sizeof(_FCEDTSmartShapePrefs); }
5073 virtual void*
Allocate() {
return (
void*) &_prefsdata; }
5081 memcpy(&_prefsdata, ((
FCSmartShapePrefs*)pSource)->_GetPrefsData(),
sizeof(_prefsdata));
5090 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
5092 void* _GetPrefsData() {
return &_prefsdata; }
5095 virtual const char*
ClassName() {
return "FCSmartShapePrefs"; }
5106 memset(&_prefsdata, 0,
sizeof(_prefsdata));
5119 return _prefsdata.customLineStyle;
5128 return _prefsdata.glissandoStyle;
5137 return _prefsdata.tabSlideStyle;
5146 return _prefsdata.guitarBendStyle;
5228 return _prefsdata.engrMaxAngle;
5237 return _prefsdata.engrSymmetry;
5246 return _prefsdata.engrSpace;
5256 return (_prefsdata.engrAcciMode == 2);
5267 return _prefsdata.engrAcciSpace;
5278 return (_prefsdata.engrStretchFirst != 0);
5289 return (_prefsdata.engrStretchMode != 0);
5298 return _prefsdata.engrMaxStretchPrecent;
5307 return _prefsdata.engrMaxStretchFixed;
5316 return _prefsdata.engrMaxLift;
5325 return _prefsdata.slurbrStaffLineAvoid;
5334 return _prefsdata.slurbrStartAdjust;
5343 return _prefsdata.slurbrEndAdjust;
5352 return _prefsdata.slurtipWidth;
5363 return (_prefsdata.slurtipAvoidStaff != 0);
5376 return _prefsdata.slurtipAvoidStaffVal - 1;
5385 return _prefsdata.slurThicknessHorizLeft;
5394 return _prefsdata.slurThicknessVertLeft;
5403 return _prefsdata.slurThicknessHorizRight;
5412 return _prefsdata.slurThicknessVertRight;
5421 return (_prefsdata.bendParentheses != 0);
5430 return (_prefsdata.bendHideNumber != 0);
5439 return (_prefsdata.bendAutoGenerateText != 0);
5450 return (_prefsdata.bendReplaceWithFull != 0);
5464 _prefsdata.customLineStyle = idvalue;
5473 _prefsdata.glissandoStyle = idvalue;
5482 _prefsdata.tabSlideStyle = idvalue;
5491 _prefsdata.guitarBendStyle = idvalue;
5572 _prefsdata.engrMaxAngle = value;
5581 _prefsdata.engrSymmetry = value;
5590 _prefsdata.engrSpace = spacevalue;
5599 _prefsdata.engrAcciMode = state ? 2 : 1;
5610 _prefsdata.engrAcciSpace = spacevalue;
5621 _prefsdata.engrStretchFirst = state ? 1 : 0;
5632 _prefsdata.engrStretchMode = state ? 1: 0;
5641 _prefsdata.engrMaxStretchPrecent = value;
5650 _prefsdata.engrMaxStretchFixed = maxvalue;
5659 _prefsdata.engrMaxLift = maxlift;
5668 _prefsdata.slurbrStaffLineAvoid = value;
5677 _prefsdata.slurbrStartAdjust = value;
5686 _prefsdata.slurbrEndAdjust = value;
5695 _prefsdata.slurtipWidth = value;
5706 _prefsdata.slurtipAvoidStaff = state ? 1 : 0;
5719 _prefsdata.slurtipAvoidStaffVal = value + 1;
5728 _prefsdata.slurThicknessHorizLeft = value;
5737 _prefsdata.slurThicknessVertLeft = value;
5746 _prefsdata.slurThicknessHorizRight = value;
5755 _prefsdata.slurThicknessVertRight = value;
5764 _prefsdata.bendParentheses = state ? 1 : 0;
5773 _prefsdata.bendHideNumber = state? 1 : 0;
5782 _prefsdata.bendAutoGenerateText = state ? 1 : 0;
5793 _prefsdata.bendReplaceWithFull = state ? 1 : 0;
5796 #ifdef PDK_FRAMEWORK_DEBUG
5807 EDTSlurContourPrefs _prefsdata;
5809 virtual EXTAG Tag() {
return pf_SlurContourPrefs; }
5811 virtual int DataSizeLoad() {
return sizeof(EDTSlurContourPrefs); }
5812 virtual void* Allocate() {
return (
void*) &_prefsdata; }
5820 memcpy(&_prefsdata, ((
FCSlurContourPrefs*)pSource)->_GetPrefsData(),
sizeof(_prefsdata));
5827 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
5829 void* _GetPrefsData() {
return &_prefsdata; }
5832 virtual const char*
ClassName() {
return "FCSlurContourPrefs"; }
5838 memset(&_prefsdata, 0,
sizeof(_prefsdata));
5850 if (slurlength <= _prefsdata.shortSpan.def)
return _prefsdata.shortSpan.inset;
5851 ESlurContourDefaults* pShorterDefaults = NULL;
5852 ESlurContourDefaults* pLongerDefaults = NULL;
5853 if (slurlength <= _prefsdata.mediumSpan.def)
5855 pShorterDefaults = &_prefsdata.shortSpan;
5856 pLongerDefaults = &_prefsdata.mediumSpan;
5858 else if (slurlength <= _prefsdata.longSpan.def)
5860 pShorterDefaults = &_prefsdata.mediumSpan;
5861 pLongerDefaults = &_prefsdata.longSpan;
5865 pShorterDefaults = &_prefsdata.longSpan;
5866 pLongerDefaults = &_prefsdata.extraLongSpan;
5870 int evpuoffset = slurlength - pShorterDefaults->def;
5871 int heigthspandiff = pLongerDefaults->inset - pShorterDefaults->inset;
5872 int evpuspan = pLongerDefaults->def - pShorterDefaults->def;
5873 return pShorterDefaults->inset + evpuoffset * heigthspandiff / evpuspan;
5885 if (slurlength <= _prefsdata.shortSpan.def)
return _prefsdata.shortSpan.height;
5886 ESlurContourDefaults* pShorterDefaults = NULL;
5887 ESlurContourDefaults* pLongerDefaults = NULL;
5888 if (slurlength <= _prefsdata.mediumSpan.def)
5890 pShorterDefaults = &_prefsdata.shortSpan;
5891 pLongerDefaults = &_prefsdata.mediumSpan;
5893 else if (slurlength <= _prefsdata.longSpan.def)
5895 pShorterDefaults = &_prefsdata.mediumSpan;
5896 pLongerDefaults = &_prefsdata.longSpan;
5900 pShorterDefaults = &_prefsdata.longSpan;
5901 pLongerDefaults = &_prefsdata.extraLongSpan;
5906 int evpuoffset = slurlength - pShorterDefaults->def;
5907 int heigthspandiff = pLongerDefaults->height - pShorterDefaults->height;
5908 int evpuspan = pLongerDefaults->def - pShorterDefaults->def;
5909 return pShorterDefaults->height + evpuoffset * heigthspandiff / evpuspan;
5915 return _prefsdata.shortSpan.def;
5921 return _prefsdata.mediumSpan.def;
5927 return _prefsdata.longSpan.def;
5933 return _prefsdata.extraLongSpan.def;
5936 #ifdef PDK_FRAMEWORK_DEBUG
5976 bool _ValidateIndex(
5977 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
5997 EDTTiePlacementPrefs _prefsdata;
5999 virtual EXTAG Tag() {
return pf_TiePlacementPrefs; }
6001 virtual int DataSizeLoad() {
return sizeof(EDTTiePlacementPrefs); }
6002 virtual void* Allocate() {
return (
void*)&_prefsdata; }
6010 memcpy(&_prefsdata, ((
FCTiePlacementPrefs*)pSource)->_GetPrefsData(),
sizeof(_prefsdata));
6020 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
6022 void* _GetPrefsData() {
return &_prefsdata; }
6025 virtual const char*
ClassName() {
return "FCTiePlacementPrefs"; }
6047 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
6055 if (!_ValidateIndex(placementtype))
return 0;
6056 return _prefsdata.placements[(int)placementtype].startHoriz;
6068 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
6076 if (!_ValidateIndex(placementtype))
return 0;
6077 return _prefsdata.placements[(int)placementtype].startVert;
6089 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
6097 if (!_ValidateIndex(placementtype))
return 0;
6098 return _prefsdata.placements[(int)placementtype].endHoriz;
6110 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
6118 if (!_ValidateIndex(placementtype))
return 0;
6119 return _prefsdata.placements[(int)placementtype].endVert;
6135 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
6140 placementtype, Evpu16 offsetvalue)
6142 if (!_ValidateIndex(placementtype))
return;
6143 _prefsdata.placements[(int)placementtype].startHoriz = offsetvalue;
6155 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
6160 placementtype, Evpu16 offsetvalue)
6162 if (!_ValidateIndex(placementtype))
return;
6163 _prefsdata.placements[(int)placementtype].startVert = offsetvalue;
6175 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
6180 placementtype, Evpu16 offsetvalue)
6182 if (!_ValidateIndex(placementtype))
return;
6183 _prefsdata.placements[(int)placementtype].endHoriz = offsetvalue;
6195 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
6200 placementtype, Evpu16 offsetvalue)
6202 if (!_ValidateIndex(placementtype))
return;
6203 _prefsdata.placements[(int)placementtype].endVert = offsetvalue;
6234 bool _ValidateIndex(
6235 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
6253 EDTTieContourPrefs _prefsdata;
6255 virtual EXTAG Tag() {
return pf_TieContourPrefs; }
6257 virtual int DataSizeLoad() {
return sizeof(EDTTieContourPrefs); }
6258 virtual void* Allocate() {
return (
void*) &_prefsdata; }
6266 memcpy(&_prefsdata, ((
FCTieContourPrefs*)pSource)->_GetPrefsData(),
sizeof(_prefsdata));
6274 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
6276 void* _GetPrefsData() {
return &_prefsdata; }
6279 virtual const char*
ClassName() {
return "FCTieContourPrefs"; }
6299 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
6307 if (!_ValidateIndex(index))
return 0;
6308 return _prefsdata.contours[(int)index].span;
6318 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
6326 if (!_ValidateIndex(index))
return 0;
6327 float value = _prefsdata.contours[(int)index].insetRelativeLeft;
6339 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
6347 if (!_ValidateIndex(index))
return 0;
6348 return _prefsdata.contours[(int)index].heightLeft;
6358 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
6365 if (!_ValidateIndex(index))
return 0;
6366 return _prefsdata.contours[(int)index].insetFixedLeft;
6376 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
6383 if (!_ValidateIndex(index))
return 0;
6384 float value = _prefsdata.contours[(int)index].insetRelativeRight;
6396 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
6403 if (!_ValidateIndex(index))
return 0;
6404 return _prefsdata.contours[(int)index].heightRight;
6414 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
6421 if (!_ValidateIndex(index))
return 0;
6422 return _prefsdata.contours[(int)index].insetFixedRight;
6438 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
6443 index, Evpu16 value)
6445 if (!_ValidateIndex(index))
return;
6446 _prefsdata.contours[(int)index].span = value;
6458 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
6463 index,
float percentvalue)
6465 if (!_ValidateIndex(index))
return;
6466 percentvalue *= 2048;
6467 _prefsdata.contours[(int)index].insetRelativeLeft = (twobyte) percentvalue;
6479 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
6484 index, Evpu16 value)
6486 if (!_ValidateIndex(index))
return;
6487 _prefsdata.contours[(int)index].heightLeft = value;
6499 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
6504 index, Evpu16 value)
6506 if (!_ValidateIndex(index))
return;
6507 _prefsdata.contours[(int)index].insetFixedLeft = value;
6519 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
6524 index,
float percentvalue)
6526 if (!_ValidateIndex(index))
return;
6527 percentvalue *= 2048;
6528 _prefsdata.contours[(int)index].insetRelativeRight = (twobyte) percentvalue;
6540 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
6545 index, Evpu16 value)
6547 if (!_ValidateIndex(index))
return;
6548 _prefsdata.contours[(int)index].heightRight = value;
6560 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
6565 index, Evpu16 value)
6567 if (!_ValidateIndex(index))
return;
6568 _prefsdata.contours[(int)index].insetFixedRight = value;
6583 _FCEDTTiePrefs _prefsdata;
6584 virtual EXTAG Tag() {
return _fcpf_TiePrefs; }
6586 virtual int DataSizeLoad() {
return sizeof(_FCEDTTiePrefs); }
6587 virtual void* Allocate() {
return (
void*) &_prefsdata; }
6595 memcpy(&_prefsdata, ((
FCTiePrefs*)pSource)->_GetPrefsData(),
sizeof(_prefsdata));
6603 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
6605 void* _GetPrefsData() {
return &_prefsdata; }
6913 _prefsdata.secondsPlacement = value;
6931 _prefsdata.chordTieDirType = value;
6955 _prefsdata.mixedStemDirection = value;
7039 EDTLayerPrefs _prefsdata;
7040 virtual EXTAG Tag() {
return pf_LayerPrefs; }
7042 virtual int DataSizeLoad() {
return sizeof(EDTLayerPrefs); }
7043 virtual void* Allocate() {
return (
void*) &_prefsdata; }
7051 memcpy(&_prefsdata, ((
FCLayerPrefs*)pSource)->_GetPrefsData(),
sizeof(_prefsdata));
7058 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
7060 void* _GetPrefsData() {
return &_prefsdata; }
7081 return _dataid.prefs.prefNumber;
7093 return _dataid.prefs.prefNumber + 1;
7261 EDTChordPrefs _prefsdata;
7262 virtual EXTAG Tag() {
return pf_ChordPrefs; }
7264 virtual int DataSizeLoad() {
return sizeof(EDTChordPrefs); }
7265 virtual void* Allocate() {
return (
void*) &_prefsdata; }
7273 memcpy(&_prefsdata, ((
FCChordPrefs*)pSource)->_GetPrefsData(),
sizeof(_prefsdata));
7280 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
7282 void* _GetPrefsData() {
return &_prefsdata; }
7340 _prefsdata.UseSimpleChordSpelling = state;
7351 return (_prefsdata.DefChordAlignment == 0);
7362 _prefsdata.DefChordAlignment = state ? 0 : 2;
7371 return _prefsdata.CSHARPLIFT;
7381 return _prefsdata.CFLATLIFT;
7390 return _prefsdata.CNATURALLIFT;
7401 _prefsdata.CSHARPLIFT = value;
7410 _prefsdata.CFLATLIFT = value;
7419 _prefsdata.CNATURALLIFT = value;
7428 #ifdef PDK_FRAMEWORK_LUAFRIENDLY
7445 #ifdef PDK_FRAMEWORK_LUAFRIENDLY
7453 _prefsdata.ChordStyle = style;
7470 EDTNamePos _prefsdata;
7471 virtual EXTAG Tag() {
return _fcpf_StaffNamePositionPrefs; }
7473 virtual int DataSizeLoad() {
return sizeof(EDTNamePos); }
7474 virtual void* Allocate() {
return (
void*) &_prefsdata; }
7489 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
7491 void* _GetPrefsData() {
return &_prefsdata; }
7494 virtual const char*
ClassName() {
return "FCStaffNamePositionPrefs"; }
7503 memset(&_prefsdata, 0,
sizeof(_prefsdata));
7546 FLAG_16
GetAlignment()
const {
return (_prefsdata.flag & NAMEPOS_HALIGNBITS) >> 4; }
7576 justification &= NAMEPOS_JUSTIBITS;
7577 _prefsdata.flag &= ~NAMEPOS_JUSTIBITS;
7578 _prefsdata.flag |= justification;
7589 alignment = alignment << 4;
7590 alignment &= NAMEPOS_HALIGNBITS;
7591 _prefsdata.flag &= ~NAMEPOS_HALIGNBITS;
7592 _prefsdata.flag |= alignment;
7601 Set16BitFlag(&_prefsdata.flag, NAMEPOS_EXPAND_SINGLE_WORD, state);
7616 _FCEDTGroupNamePosPrefs _prefsdata;
7617 virtual EXTAG Tag() {
return _fcpf_GroupNamePosPrefs; }
7619 virtual int DataSizeLoad() {
return sizeof(_FCEDTGroupNamePosPrefs); }
7620 virtual void* Allocate() {
return (
void*) &_prefsdata; }
7635 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
7637 void* _GetPrefsData() {
return &_prefsdata; }
7640 virtual const char*
ClassName() {
return "FCGroupNamePositionPrefs"; }
7649 memset(&_prefsdata, 0,
sizeof(_prefsdata));
7722 justification &= 0x0007;
7723 _prefsdata.flag &= ~0x0007;
7724 _prefsdata.flag |= justification;
7735 alignment = alignment << 3;
7736 alignment &= 0x0018;
7737 _prefsdata.flag &= ~0x0018;
7738 _prefsdata.flag |= alignment;
7751 #if FXT_VERSION >= FINALEVERSION_2012
7753 #define FCMUSICCHARPREFS_TWOBYTEPTR(structmember) \
7754 ((twobyte*)(_Use2012Version() \
7755 ? _GetElementPtr(offsetof(EDTMusicCharsPrefs2012, structmember)) \
7756 : _GetElementPtr(offsetof(EDTMusicCharsPrefs, structmember))))
7758 #define FCMUSICCHARPREFS_VOIDPTR(structmember) \
7759 ((void*)(_Use2012Version() \
7760 ? _GetElementPtr(offsetof(EDTMusicCharsPrefs2012, structmember)) \
7761 : _GetElementPtr(offsetof(EDTMusicCharsPrefs, structmember))))
7763 #define FCMUSICCHARPREFS_RETURNSYMBOLCHAR(structmember) \
7764 if (_Use2012Version()) \
7765 return *((eUniChar32*) _GetElementPtr(offsetof(EDTMusicCharsPrefs2012, structmember))); \
7767 return *((twobyte*) _GetElementPtr(offsetof(EDTMusicCharsPrefs, structmember)));
7769 #define FCMUSICCHARPREFS_SETSYMBOLCHAR(structmember, charslot) \
7770 if (_Use2012Version()) \
7771 *((eUniChar32*) _GetElementPtr(offsetof(EDTMusicCharsPrefs2012, structmember))) = charslot; \
7773 *((twobyte*) _GetElementPtr(offsetof(EDTMusicCharsPrefs, structmember))) = (charslot & 0xff);
7779 #define FCMUSICCHARPREFS_TWOBYTEPTR(structmember) \
7780 ((twobyte*)(_GetElementPtr(offsetof(EDTMusicCharsPrefs, structmember))))
7782 #define FCMUSICCHARPREFS_VOIDPTR(structmember) \
7783 ((void*)(_GetElementPtr(offsetof(EDTMusicCharsPrefs, structmember))))
7785 #define FCMUSICCHARPREFS_RETURNSYMBOLCHAR(structmember) \
7786 return *((twobyte*) _GetElementPtr(offsetof(EDTMusicCharsPrefs, structmember)));
7788 #define FCMUSICCHARPREFS_SETSYMBOLCHAR(structmember, charslot) \
7789 *((twobyte*) _GetElementPtr(offsetof(EDTMusicCharsPrefs, structmember))) = (charslot & 0xff);
7800 _FCEDTMusicCharsPrefsDistances _musiccharsdistancedata;
7801 _FCEDTPre2012MusicCharsPrefs _pre2012data;
7802 EDTMusicCharsPrefs _prefsdata;
7803 #if FXT_VERSION >= FINALEVERSION_2012
7804 EDTMusicCharsPrefs2012 _prefsdata2012;
7807 bool _Use2012Version()
const;
7809 virtual EVERSION EnigmaVersion()
7811 return _Use2012Version() ? FINALEVERSION_2012 : FINALEVERSION_2010;
7814 virtual EXTAG Tag() {
return pf_MusicCharsPrefs; }
7816 virtual int DataSizeLoad()
7818 #if FXT_VERSION >= FINALEVERSION_2012
7819 if (_Use2012Version())
return sizeof(EDTMusicCharsPrefs2012);
7821 return sizeof(EDTMusicCharsPrefs);
7823 virtual void* Allocate() {
return (
void*) _GetPrefsData(); }
7839 void* _GetElementPtr(
int offset)
const
7841 char* pByteArray = (
char*) _GetPrefsData();
7842 return (
void*) &pByteArray[offset];
7846 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
7848 void* _GetPrefsData()
const
7850 #if FXT_VERSION >= FINALEVERSION_2012
7851 if (_Use2012Version())
return (
void*) &_prefsdata2012;
7853 return (
void*) &_prefsdata;
7857 virtual const char*
ClassName() {
return "FCMusicCharacterPrefs"; }
7868 virtual bool Load(twobyte prefsnumber = 1);
7871 virtual bool Save();
8079 eUniChar32
GetSymbolFlat()
const { FCMUSICCHARPREFS_RETURNSYMBOLCHAR(symFLAT); }
8661 void SetSymbol64thRest(eUniChar32 character) { FCMUSICCHARPREFS_SETSYMBOLCHAR(symSXREST, character); }
8669 void SetSymbol32ndRest(eUniChar32 character) { FCMUSICCHARPREFS_SETSYMBOLCHAR(symTREST, character); }
8677 void SetSymbol16thRest(eUniChar32 character) { FCMUSICCHARPREFS_SETSYMBOLCHAR(symSREST, character); }
8685 void SetSymbol8thRest(eUniChar32 character) { FCMUSICCHARPREFS_SETSYMBOLCHAR(symEREST, character); }
8701 void SetSymbolHalfRest(eUniChar32 character) { FCMUSICCHARPREFS_SETSYMBOLCHAR(symHREST, character); }
8799 void SetSymbolNatural(eUniChar32 character) { FCMUSICCHARPREFS_SETSYMBOLCHAR(symNATURAL, character); }
8807 void SetSymbolFlat(eUniChar32 character) { FCMUSICCHARPREFS_SETSYMBOLCHAR(symFLAT, character); }
8815 void SetSymbolSharp(eUniChar32 character) { FCMUSICCHARPREFS_SETSYMBOLCHAR(symSHARP, character); }
8847 void SetSymbolParFlat(eUniChar32 character) { FCMUSICCHARPREFS_SETSYMBOLCHAR(sympFLAT, character); }
8855 void SetSymbolParSharp(eUniChar32 character) { FCMUSICCHARPREFS_SETSYMBOLCHAR(sympSHARP, character); }
8888 void SetSymbolChordFlat(eUniChar32 character) { FCMUSICCHARPREFS_SETSYMBOLCHAR(symCHORDFLAT, character); }
8920 void SetSymbolKeyNatural(eUniChar32 character) { FCMUSICCHARPREFS_SETSYMBOLCHAR(symKEYSIGNATURAL, character); }
8928 void SetSymbolKeyFlat(eUniChar32 character) { FCMUSICCHARPREFS_SETSYMBOLCHAR(symKEYSIGFLAT, character); }
8936 void SetSymbolKeySharp(eUniChar32 character) { FCMUSICCHARPREFS_SETSYMBOLCHAR(symKEYSIGSHARP, character); }
9152 void SetDefaultStemLift(fourbyte value) { *((fourbyte*) FCMUSICCHARPREFS_VOIDPTR(DefStemLift)) = value; }
9349 _FCEDTPartScopePrefs _prefsdata;
9350 virtual EXTAG Tag() {
return _fcpf_PartScopePrefs; }
9352 virtual int DataSizeLoad() {
return sizeof(_prefsdata); }
9353 virtual void* Allocate() {
return (
void*) &_prefsdata; }
9361 memcpy(&_prefsdata, ((
FCPartScopePrefs*)pSource)->_GetPrefsData(),
sizeof(_prefsdata));
9369 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
9371 void* _GetPrefsData() {
return &_prefsdata; }
9374 virtual const char*
ClassName() {
return "FCPartScopePrefs"; }
9379 memset(&_prefsdata, 0,
sizeof(_prefsdata));
9402 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
9403 _FCEDTLyricsPrefs _lyricsprefs;
9405 virtual EXTAG
Tag() {
return _fcpf_LyricsPrefs; }
9407 virtual int DataSizeLoad() {
return sizeof(_lyricsprefs); }
9408 virtual void*
Allocate() {
return (
void*) &_lyricsprefs; }
9416 memcpy(&_lyricsprefs, ((
FCLyricsPrefs*)pSource)->_GetPrefsData(),
sizeof(_lyricsprefs));
9424 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
9426 void* _GetPrefsData() {
return &_lyricsprefs; }
9428 virtual const char*
ClassName() {
return "FCLyricsPrefs"; }
9488 memset(&_lyricsprefs, 0,
sizeof(_lyricsprefs));
9747 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
9748 #include "pragma_align_begin.h"
9749 struct __EDTHumanPlaybackPrefs
9751 twobyte firstinciblock[6];
9752 twobyte playbackstyle;
9753 twobyte inciblockpadding[5];
9754 twobyte thirdinciblock[6];
9756 #include "pragma_align_end.h"
9758 const EXTAG __ot_HumanPlayback = MAKEEXTAG(edOther3Inci,
'h',
'p');
9765 __EDTHumanPlaybackPrefs _prefsdata;
9766 virtual EXTAG Tag() {
return __ot_HumanPlayback; }
9768 virtual int DataSizeLoad() {
return sizeof(__EDTHumanPlaybackPrefs); }
9769 virtual void* Allocate() {
return (
void*) &_prefsdata; }
9784 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
9786 void* _GetPrefsData() {
return &_prefsdata; }
9791 memset(&_prefsdata, 0,
sizeof(_prefsdata));
9794 virtual const char*
ClassName() {
return "FCHumanPlaybackPrefs"; }
9808 return (_prefsdata.playbackstyle != 1);
9814 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
9819 #include "pragma_align_begin.h"
9820 struct __EDTStemConnectionPrefs_pre2012
9825 twobyte downstemVert;
9826 twobyte upstemHoriz;
9827 twobyte downstemHoriz;
9829 #include "pragma_align_end.h"
9831 #include "pragma_align_begin.h"
9832 struct __EDTStemConnectionPrefs_2012
9837 twobyte downstemVert;
9838 twobyte upstemHoriz;
9839 twobyte downstemHoriz;
9841 #include "pragma_align_end.h"
9867 bool _ValidateConnectionID(
int connectionID)
const;
9869 virtual EXTAG Tag() {
return MAKEEXTAG(edOther,
'4',
'0'); }
9871 virtual int DataSizeLoad() {
return 0; }
9872 virtual void* Allocate() {
return NULL; }
9880 #ifdef PDK_FRAMEWORK_DIAGNOSE
9881 DebugOut(
"Error - Calls to FCStemConnectionTable::CloneMemoryFrom aren't supported!");
9889 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
9891 __EDTStemConnectionPrefs_pre2012* _GetPrefsData_Pre2012()
const {
return (__EDTStemConnectionPrefs_pre2012*)
_datablock; }
9892 __EDTStemConnectionPrefs_2012* _GetPrefsData_2012()
const {
return (__EDTStemConnectionPrefs_2012*)
_datablock; }
9910 virtual const char*
ClassName() {
return "FCStemConnectionTable"; }
9917 virtual bool Load(twobyte prefsnumber);
9920 virtual bool Save();
10025 void SetFontID(
int connectionID, twobyte fontid);
10104 if (!pFontName)
return -1;
10111 if (namefontID ==
GetFontID(i))
return i;
10129 #ifdef PDK_FRAMEWORK_DEBUG
10152 _FCEDTRepeatPrefs _prefsdata;
10154 virtual EXTAG Tag() {
return _fcpf_RepeatPrefs; }
10156 virtual int DataSizeLoad() {
return sizeof(_FCEDTRepeatPrefs); }
10157 virtual void* Allocate() {
return (
void*) &_prefsdata; }
10165 memcpy(&_prefsdata, ((
FCRepeatPrefs*)pSource)->_GetPrefsData(),
sizeof(_prefsdata));
10172 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
10174 void* _GetPrefsData() {
return &_prefsdata; }
10223 memset(&_prefsdata, 0,
sizeof(_prefsdata));
10254 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
10294 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
10420 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
10428 _prefsdata.backToBackStyle = style;
10462 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
10467 style) { _prefsdata.wingStyle = style; }
10569 FCGuides *_pHorizontalGuides, *_pVerticalGuides;
10570 EDTGridsGuidesPrefs _prefsdata;
10572 virtual EXTAG Tag() {
return pf_GridsGuidesPrefs; }
10574 virtual int DataSizeLoad() {
return sizeof(EDTGridsGuidesPrefs); }
10575 virtual void* Allocate() {
return (
void*) &_prefsdata; }
10583 memcpy(&_prefsdata, ((
FCGridsGuidesPrefs*)pSource)->_GetPrefsData(),
sizeof(_prefsdata));
10590 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
10592 void* _GetPrefsData() {
return &_prefsdata; }
10595 virtual const char*
ClassName() {
return "FCGridsGuidesPrefs"; }
10678 _pHorizontalGuides = _pVerticalGuides = NULL;
10684 delete _pHorizontalGuides;
10685 delete _pVerticalGuides;
10693 virtual bool Save();
10777 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
10838 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
10858 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
10876 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
10945 if (value > 255)
return;
10946 _prefsdata.gridRed = value * 256;
10958 if (value > 255)
return;
10959 _prefsdata.gridGreen = value * 256;
10971 if (value > 255)
return;
10972 _prefsdata.gridBlue = value * 256;
10982 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
10995 _prefsdata.guideDisplay = value;
11027 if (value > 255)
return;
11028 _prefsdata.guideRed = value * 256;
11040 if (value > 255)
return;
11041 _prefsdata.guideGreen = value * 256;
11053 if (value > 255)
return;
11054 _prefsdata.guideBlue = value * 256;
11064 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
11076 _prefsdata.guideDisplay = value;
11107 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
11127 #ifndef PDK_FRAMEWORK_LUAFRIENDLY
11149 if (red > 255)
return;
11150 if (green > 255)
return;
11151 if (blue > 255)
return;
11170 if (red > 255)
return;
11171 if (green > 255)
return;
11172 if (blue > 255)
return;
11187 _FCEDTPianoBracePrefs _prefsdata;
11189 virtual EXTAG Tag() {
return _fcpf_PianoBracePrefs; }
11191 virtual int DataSizeLoad() {
return sizeof(_FCEDTPianoBracePrefs); }
11192 virtual void* Allocate() {
return (
void*)&_prefsdata; }
11201 memcpy(&_prefsdata, pOtherObject->_GetPrefsData(),
sizeof(_prefsdata));
11211 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
11213 void* _GetPrefsData() {
return &_prefsdata; }
11233 return _prefsdata.innerTipHoriz;
11242 return _prefsdata.innerTipVert;
11251 return _prefsdata.innerBodyHoriz;
11260 return _prefsdata.innerBodyVert;
11269 return _prefsdata.outerTipHoriz;
11278 return _prefsdata.outerTipVert;
11287 return _prefsdata.outerBodyHoriz;
11296 return _prefsdata.outerBodyVert;
11305 return _prefsdata.width;
11314 return _prefsdata.centerThickness;
11323 return _prefsdata.tipThickness;
11336 _prefsdata.innerTipHoriz = position;
11345 _prefsdata.innerTipVert = position;
11354 _prefsdata.innerBodyHoriz = position;
11363 _prefsdata.innerBodyVert = position;
11372 _prefsdata.outerTipHoriz = position;
11381 _prefsdata.outerTipVert = position;
11390 _prefsdata.outerBodyHoriz = position;
11399 _prefsdata.outerBodyVert = position;
11408 _prefsdata.width = width;
11417 _prefsdata.centerThickness = thickness;
11426 _prefsdata.tipThickness = thickness;
11438 _FCEDTPartExtractPrefs _prefsdata;
11440 virtual EXTAG Tag() {
return _fcpf_PartExtractPrefs; }
11442 virtual int DataSizeLoad() {
return sizeof(_FCEDTPartExtractPrefs); }
11443 virtual void* Allocate() {
return (
void*)&_prefsdata; }
11452 memcpy(&_prefsdata, pOtherObject->_GetPrefsData(),
sizeof(_prefsdata));
11481 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
11483 void* _GetPrefsData() {
return &_prefsdata; }
11486 virtual const char*
ClassName() {
return "FCPartExtractPrefs"; }
11493 memset(&_prefsdata, 0,
sizeof(_prefsdata));
11626 if (!pFontInfo)
return false;
11628 if (_prefsdata.partNameHeaderUseFontID != 0)
11631 pFontInfo->
SetNameByID(_prefsdata.partNameHeaderFontID);
11644 if (_prefsdata.partNameHeaderFontSize == 0)
11654 pFontInfo->
SetSize(_prefsdata.partNameHeaderFontSize);
11694 _prefsdata.spacingMethod = method;
11815 _prefsdata.partNameHeaderUseFontID =
false;
11816 _prefsdata.partNameHeaderFontSize = 0;
11833 _prefsdata.partNameHeaderFontSize = 0;
11842 _prefsdata.partNameHeaderFontSize = 0;
11851 if (!pFontInfo)
return;
11853 _prefsdata.partNameHeaderUseFontID =
true;
11854 _prefsdata.partNameHeaderFontID = pFontInfo->
GetNameByID();
11857 _prefsdata.partNameHeaderFontSize = pFontInfo->
GetSize();
bool GetOnlyFirstSystemClef() const
Returns if the clefs should be displayed only on the first system, or not.
Definition: ff_prefs.h:2028
void SetGuideColorRed(utwobyte value)
Returns the red color status of the guide, which is part of the RGB value.
Definition: ff_prefs.h:11025
void SetWordExtSyllableJustification(twobyte value)
Sets the justification option for syllables with word extensions.
Definition: ff_prefs.h:9669
void SetSymbolKeyNatural(eUniChar32 character)
Sets the symbol for naturals in key signatures.
Definition: ff_prefs.h:8920
void SetGuitarBendDefID(CMPER idvalue)
Sets the default custom startshape definition ID for guitar bend lines.
Definition: ff_prefs.h:5489
void SetMaxMeasureWidth(twobyte value)
Sets the maximum measure width.
Definition: ff_prefs.h:4381
FCTuplet::SHAPESTYLE GetShapeStyle() const
Returns the shape style.
Definition: finaleframework.cpp:28884
twobyte GetMetronomeSpeed() const
Returns the metronome speed number.
Definition: ff_prefs.h:787
bool LoadFull()
Loads the full name positioning data.
Definition: ff_prefs.h:7512
void SetLedgerLeftHalf(Evpu16 value)
Sets the document setting for ledger line left half length in EFIXes.
Definition: ff_prefs.h:1659
void SetHeavyLineThickness(Efix16 value)
Sets the thick line thickness for repeat barlines, in EFIXes.
Definition: ff_prefs.h:10399
eUniChar32 GetSymbolKeyDoubleSharp() const
Returns the symbol for double-sharps in key signatures.
Definition: ff_prefs.h:8223
Evpu16 GetEndingFrontHookLength() const
Returns the default length (height) of repeat front hooks, in EVPUs.
Definition: ff_prefs.h:10329
void SetKeepOctaveTransposition(bool state)
Definition: finaleframework.cpp:29520
void SetLeftHookLength(twobyte value)
Sets the left-side hook length.
Definition: ff_prefs.h:3175
bool GetAvoidClefs() const
Returns true if Avoid Clefs is used.
Definition: ff_prefs.h:4176
twobyte GetGraceNotePlaybackDuration() const
Returns the duration of a grace note (in EDUs).
Definition: ff_prefs.h:2052
bool GetAvoidSeconds() const
Returns true if Avoid Seconds is used.
Definition: ff_prefs.h:4206
eUniChar32 GetSymbolQuarterNotehead() const
Returns the default symbol character for filled "quarter note" noteheads.
Definition: ff_prefs.h:7882
bool GetIgnoreHiddenNotes() const
Returns the "Ignore Layers Containing Only Hidden Notes" state.
Definition: ff_prefs.h:7157
virtual void DebugDump()
Outputs the class data/information for debugging purposes.
Definition: ff_base.h:918
Efix16 GetBracketThickness() const
Return the bracket thickness, in EFIXes.
Definition: ff_prefs.h:3000
twobyte GetWordExtSyllableJustification() const
Returns the justification option for syllables with word extensions.
Definition: ff_prefs.h:9542
static void DebugOutString(const char *pszPrefixText, const char *thestring)
Static method that outputs a line for debugging purposes (C string version). The text appears with th...
Definition: finaleframework.cpp:375
virtual const PDKFRAMEWORK_CLASSID GetClassID()
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_prefs.h:3369
virtual const PDKFRAMEWORK_CLASSID GetClassID()
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_prefs.h:11217
FCRepeatPrefs()
The constructor.
Definition: ff_prefs.h:10221
Definition: ff_prefs.h:5973
virtual const char * ClassName()
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_base.h:772
Class for document-independent font information.
Definition: ff_base.h:1024
bool GetUseFreezeStemsTies() const
Returns if the freeze stems and ties should be frozen.
Definition: ff_prefs.h:7119
void SetSlurThicknessHorizontalLeft(Evpu16 value)
Sets slur thickness to the horizontal left, in EVPUs.
Definition: ff_prefs.h:5726
Evpu16 GetEndingVerticalText() const
Returns default vertical positioning for ending text.
Definition: ff_prefs.h:10365
void SetNumberStyle(FCTuplet::NUMBERSTYLE value)
Sets the number style.
Definition: finaleframework.cpp:28944
virtual const char * ClassName()
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_prefs.h:7285
Evpu16 GetTimeSigAbbreviatedVertical() const
Returns the vertical adjustment of abbreviated time signature, in EVPUs, for the score.
Definition: ff_prefs.h:1059
void SetHalfStemsForBeamedRests(bool state)
Sets the state of the "Display Half-stems for Beamed Rests" beam option.
Definition: ff_prefs.h:2288
virtual const char * ClassName()
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_prefs.h:4628
bool GetBreakSlurBracket() const
Returns the "Break slur or bracket" state.
Definition: ff_prefs.h:2878
void SetGridShow(bool state)
Sets if the grid should display.
Definition: ff_prefs.h:10922
Evpu16 GetSlurThicknessVerticalLeft() const
Returns slur thickness to the vertical left, in EVPUs.
Definition: ff_prefs.h:5392
void SetSymbolKeyFlat(eUniChar32 character)
Sets the symbol for flats in key signatures.
Definition: ff_prefs.h:8928
void SetDisplayInConcertPitch(bool state)
Sets if the part should use the "Display in Concert Pitch" setting.
Definition: ff_prefs.h:9392
bool GetCourtesyKeySigAtSystemEnd() const
Returns if courtesy key signatures should be displayed at the end of systems.
Definition: ff_prefs.h:2126
fourbyte GetVerticalOuterTip() const
Returns the vertical position for the outer tip, in 1/10000 of an EVPU.
Definition: ff_prefs.h:11276
Evpu16 GetTimeSigTopVertical() const
Returns the vertical adjustment of top time sig symbol from top staff line, for the score...
Definition: ff_prefs.h:975
Evpu16 GetThicknessLeft() const
Returns the left-side tie thickness.
Definition: ff_prefs.h:6681
void SetUseBottomNote(bool value)
Sets the "Use Bottom Note" state.
Definition: ff_prefs.h:3059
eUniChar32 GetSymbolParSharp() const
Returns the default symbol for the sharp accidental within parentheses.
Definition: ff_prefs.h:8127
void SetAllowHorizontalDrag(bool value)
Sets the "Allow Horizontal Drag" state.
Definition: ff_prefs.h:3053
void SetAvoidSeconds(bool state)
Sets if Avoid Seconds is used or not.
Definition: ff_prefs.h:4435
Definition: ff_prefs.h:4712
Evpu16 GetClefSpaceAfter() const
Returns the space after clef, in EVPUs.
Definition: ff_prefs.h:1047
twobyte GetWordExtSyllableAlignment() const
Returns the alignment option for syllables with word extensions.
Definition: ff_prefs.h:9532
int GetVerticalGuideCount() const
Returns the number of vertical guides (=the guides where the line goes vertically). This value must be identical to the number of actual guides in the document.
Definition: ff_prefs.h:10902
void SetVertical16thFlagUp(twobyte value)
Sets the vertical adjustment for the 16th upstem flag, in EFIXes.
Definition: ff_prefs.h:9224
void SetEngraverSlurSpaceAround(Evpu16 spacevalue)
Sets the space around objects for Engraver Slurs.
Definition: ff_prefs.h:5588
void SetSymbolNatural(eUniChar32 character)
Sets the default symbol for the natural accidental.
Definition: ff_prefs.h:8799
FCStemConnectionTable()
The constructor.
Definition: ff_prefs.h:9899
void SetPickupDuration(TimeEdu16 duration)
Sets the duration of the pickup measure (in EDUs). 0 if no pickup measure.
Definition: ff_prefs.h:2627
twobyte GetVerticalOffset() const
Returns the vertical tuplet offset.
Definition: ff_prefs.h:2916
Definition: ff_prefs.h:5970
Evpu16 GetLineDashLength() const
Returns the default dash length, if EVPUs.
Definition: ff_prefs.h:5202
Evpu16 GetReverseStemAdjust() const
Returns the document setting for the reverse stem adjustment, in EVPUs.
Definition: ff_prefs.h:1594
void SetAdjustDotForMultiVoices(bool state)
Sets if the augmentation dots should adjust for multiple voices.
Definition: ff_prefs.h:2484
void SetBeamThreeEights(bool state)
Sets the "Beam three eight notes before/after an eight rest" beaming option.
Definition: ff_prefs.h:2300
void SetVerticalWholeSlashBaseline(twobyte value)
Sets the whole note diamond baseline adjustment value (for rhythmical notation), in EVPUs...
Definition: ff_prefs.h:9326
Definition: ff_prefs.h:1800
bool GetAlwaysSlashGraceNote() const
Returns the state of the "Always Slash Grace Notes" check box.
Definition: ff_prefs.h:1972
void SetLeftPageTopMargin(twobyte value)
Sets the top page margin for all/left-side pages.
Definition: ff_prefs.h:3648
Definition: ff_prefs.h:1813
void SetSlurBreakStaffLineAvoid(Evpu16 value)
Sets the minimum distance to avoid staff lines by, for slur system breaks. In EVPUs.
Definition: ff_prefs.h:5666
twobyte GetVerticalHalfSlashBaseline() const
Returns the half note diamond baseline adjustment value (for rhythmical notation), in EVPUs.
Definition: ff_prefs.h:8585
Definition: ff_prefs.h:10665
void SetPlacementMode(FCTuplet::PLACEMENTMODE value)
Sets the placement mode.
Definition: finaleframework.cpp:28913
eUniChar32 GetSymbolKeySharp() const
Returns the symbol for sharps in key signatures.
Definition: ff_prefs.h:8207
virtual bool Load(twobyte prefsno=1)
The default Load method for preference data. All preference data loading must go through here at some...
Definition: finaleframework.cpp:28353
virtual const PDKFRAMEWORK_CLASSID GetClassID()
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_prefs.h:7858
Definition: ff_prefs.h:9461
eUniChar32 GetSymbolQuarterRest() const
Returns the default symbol character for quarter note rests.
Definition: ff_prefs.h:7955
void SetKeySigLeftHorizontalOffset(Evpu16 value)
Returns the "Break for key signatures - left gap" setting.
Definition: ff_prefs.h:6873
eUniChar32 GetSymbolWholeSlashDiamond() const
Returns the symbol for whole note diamond in Alternate Notation.
Definition: ff_prefs.h:8255
Evpu16 GetLeftFixedInset(CONTOUR_INDEXES index)
Returns the left-side inset, as an absolute value.
Definition: ff_prefs.h:6357
void SetHorizontal16thFlagUp(twobyte value)
Sets the horizontal adjustment for the 16th upstem flag, in EFIXes.
Definition: ff_prefs.h:9176
void SetSlurTipAvoidStaffUse(bool state)
Sets if slur tips should avoid staff lines.
Definition: ff_prefs.h:5704
virtual bool Load(twobyte prefsnumber=1)
Overridden version of Load()
Definition: finaleframework.cpp:28432
Base class for all preference data classes.
Definition: ff_prefs.h:633
twobyte GetLayerNumber() const
Returns the 1-based layer number for the loaded layer preferences. -1 if no data has been loaded...
Definition: ff_prefs.h:7090
bool GetDisplayAllBarlines() const
Returns true if "Display All Barlines" is used.
Definition: ff_prefs.h:1925
bool GetBeamThreeEights() const
Returns the "Beam three eight notes before/after an eight rest" beaming option.
Definition: ff_prefs.h:1871
bool GetFixedInsetStyle() const
Returns if the inset style is fixed or in percent (in the tie contour options).
Definition: ff_prefs.h:6803
void SetGridColorGreen(utwobyte value)
Returns the green color status of the grid, which is part of the RGB value.
Definition: ff_prefs.h:10956
void SetJustification(FLAG_16 justification)
Sets the default justification for the staff text.
Definition: ff_prefs.h:7574
void SetSymbolFirstFlagUp(eUniChar32 character)
Sets the symbol for First Upstem Flag.
Definition: ff_prefs.h:8734
bool GetKeySigModeChange() const
Returns if the key should redisplay if only mode is changing.
Definition: ff_prefs.h:2070
Evpu16 GetVerticalBottomDotAdjustment() const
Returns the bottom repeat dot adjustment, in EVPUs.
Definition: ff_prefs.h:10286
void SetUpstemHorizontalAdjust(int connectionID, Efix16 distance)
Sets the upstem horizontal adjustment for the notehead that has the stem connection data...
Definition: finaleframework.cpp:29666
FCTuplet::NUMBERSTYLE GetNumberStyle() const
Returns the number style.
Definition: finaleframework.cpp:28861
bool GetKeySigOnlyFirstSystem() const
Returns if the clef should be displayed only on first staff system.
Definition: ff_prefs.h:2058
Definition: ff_prefs.h:4709
void SetAvoidNoteAndAccidentals(bool state)
Sets if Avoid Note and Accidentals is used or not.
Definition: ff_prefs.h:4429
Evpu16 GetSharpBaselineAdjustment() const
Returns the "Chord Alteration Baseline Adjustment" for sharps (in EVPUs).
Definition: ff_prefs.h:7369
eUniChar32 GetSymbolChordNatural() const
Returns the symbol for natural accidentals in chord symbols.
Definition: ff_prefs.h:8151
void SetWordExtSyllableAlignment(twobyte value)
Sets the alignment option for syllables with word extensions.
Definition: ff_prefs.h:9659
void SetFlatBaselineAdjustment(Evpu16 value)
Sets the "Chord Alteration Baseline Adjustment" for flats (in EVPUs).
Definition: ff_prefs.h:7408
void SetKeySpaceAfterCancel(Evpu16 value)
Sets the space after a canceled key signature, in EVPUs.
Definition: ff_prefs.h:1284
void SetRightPageBottomMargin(twobyte value)
Sets the bottom page margin for right-side pages.
Definition: ff_prefs.h:3701
FCTiePrefs()
The constructor.
Definition: ff_prefs.h:6668
void SetKeySpaceAfter(Evpu16 value)
Sets the space after key signature, in EVPUs.
Definition: ff_prefs.h:1278
FCTiePlacementPrefs()
The constructor.
Definition: ff_prefs.h:6032
void SetEngraverSlurMaxStretchPercent(twobyte value)
Sets the Engraver Slur max stretch value for stretches (in 1/100 percent).
Definition: ff_prefs.h:5639
void SetMetronomeSpeed(twobyte value)
Sets the metronome speed number.
Definition: ff_prefs.h:843
virtual const PDKFRAMEWORK_CLASSID GetClassID()
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_prefs.h:7286
bool GetGridShow() const
Returns if the grid should display.
Definition: ff_prefs.h:10730
int FindIndex(FCString *pFontName, eUniChar32 character)
Search for a matching stem connection index for the font+character.
Definition: ff_prefs.h:10102
virtual const char * ClassName()
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_prefs.h:7494
void SetLeftPageBottomMargin(twobyte value)
Sets the bottom page margin for all/left-side pages.
Definition: ff_prefs.h:3654
bool GetDotAfterNumber() const
Returns if the repeat number automatically should display with a period dot at the end...
Definition: ff_prefs.h:10372
void SetStopMeasure(eMeas measure)
Sets the playback stop measure.
Definition: ff_prefs.h:863
twobyte GetVertical16thFlagDown() const
Returns the vertical adjustment for the 16th downstem flag, in EFIXes.
Definition: ff_prefs.h:8518
Definition: ff_prefs.h:4724
void SetLedgerRightHalf(Evpu16 value)
Sets the document setting for ledger line right half length in EFIXes.
Definition: ff_prefs.h:1671
bool GetPlayback() const
Returns the playback state for the layer.
Definition: ff_prefs.h:7143
Class for attaching an tuplet to an entry.
Definition: ff_entrydetails.h:1647
void SetSymbolWholeNotehead(eUniChar32 character)
Sets the default symbol character for whole-note noteheads.
Definition: ff_prefs.h:8636
void SetGuideColorGreen(utwobyte value)
Returns the green color status of the guide, which is part of the RGB value.
Definition: ff_prefs.h:11038
Evpu16 GetVerticalEnd(TIEPLACEMENT_INDEXES placementtype)
Returns the end (right-side) vertical placement position for a specific tie placement type...
Definition: ff_prefs.h:6109
static void DebugOut(const char *pszLine)
Static method to output a line of text for debugging purposes.
Definition: finaleframework.cpp:465
bool GetUseOuterPlacement() const
Returns the "Use outer placement" value.
Definition: ff_prefs.h:6735
bool GetGuitarBendAutoGenerateText() const
Returns the value for Guitar Bend Options - Automatically Generate Text.
Definition: ff_prefs.h:5437
void SetSymbolCutTimeSigParts(eUniChar32 value)
Returns the symbol character used for the abbreviated cut time signature for parts.
Definition: finaleframework.cpp:28646
void SetScaleManualNotePositioning(bool state)
Sets if manual positioning of notes should be scaled.
Definition: ff_prefs.h:2609
void * _datablock
Pointer to the object's data block, the meaning is implementation-specific for each derived subclass...
Definition: ff_base.h:640
void SetFontID(int connectionID, twobyte fontid)
Sets the Enigma font ID for the notehead that has the stem connection data.
Definition: finaleframework.cpp:29661
void SetSymbolAugmentationDot(eUniChar32 character)
Sets the symbol for augmentation dots.
Definition: ff_prefs.h:9017
twobyte GetAccidentalsGutter() const
Returns the adjustment before accidental directly after barline (which affects music spacing)...
Definition: ff_prefs.h:4275
eUniChar32 GetSymbolNatural() const
Returns the default symbol for the natural accidental.
Definition: ff_prefs.h:8071
void SetFretboardsResizeFraction(fourbyte value)
Sets the fretboard resize value, in 10000th of a percent.
Definition: ff_prefs.h:2658
FLAG_16 GetJustification() const
Returns the default justification for the staff text.
Definition: ff_prefs.h:7538
eUniChar32 GetSymbolWiggle() const
Returns the default wiggle (~) character for trills.
Definition: finaleframework.cpp:28546
twobyte GetSystemStaffHeight() const
Returns the staff height in a system (in EVPUs * 16).
Definition: ff_prefs.h:3566
void SetSecondsPlacement(FLAG_16 value)
Sets the seconds placement style.
Definition: ff_prefs.h:6905
void SetSecondaryBeamSpace(twobyte value)
Sets the space between each secondary beam.
Definition: ff_prefs.h:1224
void SetEndingHorizontalText(Evpu16 value)
Sets the default horizontal positioning for ending text.
Definition: ff_prefs.h:10527
void SetScalingFactor(double ratio)
Sets the scaling ratio, using the same type of preentation as in the Finale user interface.
Definition: ff_prefs.h:4357
Class for repeat-related document preferences.
Definition: ff_prefs.h:10150
void SetTimeSigTopVertical(Evpu16 value)
Sets the vertical adjustment of top time sig symbol from top staff line, for the score.
Definition: ff_prefs.h:1230
Definition: ff_prefs.h:4757
twobyte GetVerticalSecondFlagUp() const
Returns the vertical adjustment for the second upstem flag, in EFIXes.
Definition: ff_prefs.h:8488
void SetEngraverSlurMaxAngle(twobyte value)
Sets the maximum slur angle (in 1/100 of a degree) for Engraver Slurs.
Definition: ff_prefs.h:5570
void SetHairpinDefaultShortOpening(Evpu16 value)
Sets the default hairpin short opening value (added in Finale 25.3) in the Smart Shape preferences...
Definition: finaleframework.cpp:29086
Evpu16 GetTimeSigPartsSpaceBefore() const
Returns the space before the time signature, in EVPUs, for the parts.
Definition: ff_prefs.h:1077
twobyte GetFirstSystemLeft() const
Returns the left system margin for the first system.
Definition: ff_prefs.h:3423
virtual void DebugDump()
Outputs the class data/information for debugging purposes.
Definition: ff_prefs.h:5797
bool GetSlurTipAvoidStaffUse() const
Returns if slur tips should avoid staff lines.
Definition: ff_prefs.h:5361
void SetSpaceBefore(twobyte value)
Sets the document setting for extra space before the music in a measure.
Definition: ff_prefs.h:1182
bool GetAvoidNoteAndAccidentals() const
Returns true if Avoid Note and Accidentals is used.
Definition: ff_prefs.h:4200
FCSmartShapePrefs()
The constructor.
Definition: ff_prefs.h:5103
float GetLeftRelativeInset(CONTOUR_INDEXES index)
Returns the left-side inset, as percent.
Definition: ff_prefs.h:6317
Preferences that controls the visual appearance of the piano braces in the document.
Definition: ff_prefs.h:11184
eUniChar32 GetSymbolWholeNotehead() const
Returns the default symbol character for whole-note noteheads.
Definition: ff_prefs.h:7898
void SetVerticalHalfSlashBaseline(twobyte value)
Sets the half note diamond baseline adjustment value (for rhythmical notation), in EVPUs...
Definition: ff_prefs.h:9314
virtual bool Load(twobyte prefsnumber)
Special loading mechanism for loading the complete stem connection table.
Definition: finaleframework.cpp:29577
Definition: ff_prefs.h:5964
twobyte GetClefResize() const
Returns the default % reduction for clef changes.
Definition: ff_prefs.h:1985
void SetSymbolBrevisSlashDiamond(eUniChar32 character)
Sets the symbol for brevis (double-whole note) diamond in Alternate Notation.
Definition: ff_prefs.h:8993
void SetGravityZoneSize(Efix32 value)
Sets the Gravity zone size, in EFIXes.
Definition: finaleframework.cpp:29343
Class for a multi-measure rest instance.
Definition: ff_other.h:18234
void SetAccidentalsGutter(twobyte value)
Sets the adjustment before accidental directly after barline (which is changed after music spacing)...
Definition: ff_prefs.h:4535
Definition: ff_prefs.h:9475
fourbyte GetTipWidth() const
Returns the tie tip width, in 1/10000 of an EVPU.
Definition: ff_prefs.h:6831
void SetLedgerLeftRestHalf(Evpu16 value)
Sets the document setting for ledger line left half rest length in EFIXes.
Definition: ff_prefs.h:1665
Evpu16 GetAccidentalMultiSpace() const
Returns the space between accidentals on note, in EVPUs.
Definition: ff_prefs.h:1113
Definition: ff_prefs.h:6225
Definition: ff_prefs.h:4760
twobyte GetEngraverSlurSymmetryPercent() const
Returns slur symmetry percentage (in 1/100 of a percent) for Engraver Slurs.
Definition: ff_prefs.h:5235
bool GetExtendSecondaryBeamsOverRests() const
Returns the state of the "Extend Secondary Beams Over Rests" beam option.
Definition: ff_prefs.h:1843
BRACKETMODE
The settings for when the bracket shape should show.
Definition: ff_entrydetails.h:1718
bool GetDoubleBarlineAtKeyChange() const
Returns true if the "Double barline preceding key changes" option is used. This option is only availa...
Definition: finaleframework.cpp:29478
void SetConsolidateRestsAcrossLayers(bool value)
Sets the "Consolidate Rests Across Layers", available in Finale 2014 and above.
Definition: finaleframework.cpp:29496
Definition: ff_prefs.h:1810
Evpu16 GetVerticalStart(TIEPLACEMENT_INDEXES placementtype)
Returns the start (left-side) vertical placement position for a specific tie placement type...
Definition: ff_prefs.h:6067
void SetSymbolSpace(twobyte value)
Sets the space between mm rest symbols (in EVPUs).
Definition: ff_prefs.h:4982
void SetSlurBreakSystemStart(Evpu16 value)
Sets the horizontal system start adjustment for slur system breaks. In EVPUs.
Definition: ff_prefs.h:5675
FLAG_16 GetAlignment() const
Returns the default alignment for the group text.
Definition: ff_prefs.h:7692
void SetBreakForTimeSigs(bool state)
Sets if the tie should break for time signatures.
Definition: ff_prefs.h:6849
eUniChar32 GetSymbolTrill() const
Returns the default trill (tr) character.
Definition: finaleframework.cpp:28534
void SetHorizontalOffset(twobyte value)
Sets the horizontal tuplet offset.
Definition: ff_prefs.h:3131
void SetUseAllotmentMode(bool allotmenttable)
Sets the spacing to allotment table mode.
Definition: ff_prefs.h:4564
virtual const char * ClassName()
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_prefs.h:10214
void SetSymbolTwoBarRepeat(eUniChar32 character)
Sets the symbol for two-bars repeats in Alternate Notation.
Definition: ff_prefs.h:9009
bool GetCloseBarlineAtEnd() const
Returns true if "Close Barline at End of Piece" is used.
Definition: ff_prefs.h:1937
virtual bool Load(twobyte prefsno)
Overwritten Load method to always load other.cmper 1.
Definition: ff_prefs.h:9798
Evpu16 GetAfterClefSpace() const
Returns the "Forward repeat spacing - after clef" document setting, in EVPUs.
Definition: ff_prefs.h:10305
Efix16 GetHeavyLineThickness() const
Returns the thick line thickness for repeat barlines, in EFIXes.
Definition: ff_prefs.h:10234
bool GetHairpinMakeHorizontal() const
Returns the "make horizontal" value in the Smart Shape preferences.
Definition: ff_prefs.h:5153
bool GetGuideSnap() const
Returns if items should snap to guides.
Definition: ff_prefs.h:10803
void SetSymbol64thRest(eUniChar32 character)
Sets the default symbol character for 64th rests.
Definition: ff_prefs.h:8661
Definition: ff_prefs.h:7307
bool GetAdjustDotForMultiVoices() const
Returns if the augmentation dots should adjust for multiple voices.
Definition: ff_prefs.h:2046
void SetKeySigModeChange(bool state)
Sets if the key should redisplay if only mode is changing.
Definition: ff_prefs.h:2508
Definition: ff_prefs.h:4664
Definition: ff_prefs.h:10628
Definition: ff_prefs.h:6624
void SetDisplayReverseStemming(bool state)
Sets the state of the "Display Reverse Stemming" stem option.
Definition: ff_prefs.h:2306
void SetCourtesyTimeSigAtSystemEnd(bool state)
Sets if courtesy time signatures should be displayed at the end of systems.
Definition: ff_prefs.h:2560
void SetHorizontalOuterBody(fourbyte position)
Sets the horizontal position for the outer body, in 1/10000 of an EVPU.
Definition: ff_prefs.h:11388
bool GetKeySigCancelSwitchingSharpsFlats() const
Returns the Finale 25.4 option if outgoing keys should be canceled when switching between sharps and ...
Definition: finaleframework.cpp:29502
void SetSymbolBrevisRest(eUniChar32 character)
Sets the default symbol character for brevis (double-whole note) rests.
Definition: ff_prefs.h:8717
void SetSystemTop(twobyte value)
Sets the top system margin setting.
Definition: ff_prefs.h:3612
CMPER GetGuitarBendDefID() const
Returns the default custom startshape definition ID for guitar bend lines.
Definition: ff_prefs.h:5144
twobyte GetVerticalFirstFlagDown() const
Returns the vertical adjustment for the first downstem flag, in EFIXes.
Definition: ff_prefs.h:8506
bool GetAvoidChords() const
Returns true if Avoid Chords is used.
Definition: ff_prefs.h:4170
Evpu32 GetBarlineDashSpace() const
Returns the barline dash space, in EVPUs.
Definition: ff_prefs.h:1011
virtual const char * ClassName()
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_prefs.h:1830
Efix16 GetLineWidth() const
Returns the default line width for normal lines, if EFIXes.
Definition: ff_prefs.h:5196
eUniChar32 GetSymbolAugmentationDot() const
Returns the symbol for augmentation dots.
Definition: ff_prefs.h:8287
fourbyte GetSlurTipWidth() const
Returns the slur tip width (in 1/10,000 of an EVPU)
Definition: ff_prefs.h:5350
void SetUseNoteShapes(bool state)
Sets if note shape should be used.
Definition: ff_prefs.h:2621
PAGEMARGINSCOPES
The beaming styles for use with GetPageMarginScope() and GetPageMarginScope().
Definition: ff_prefs.h:1807
Evpu16 GetTimeSigPartsAbbreviatedVertical() const
Returns the vertical adjustment of abbreviated time signature, in EVPUs, for the parts.
Definition: ff_prefs.h:1065
twobyte GetVerticalQuarterSlashStemLift() const
Returns the quarter note (small) slash stem connection lift value (for rhythmical notation)...
Definition: ff_prefs.h:8579
twobyte GetChordDirectionType() const
Returns the chord direction type.
Definition: ff_prefs.h:6751
Evpu16 GetShortenedStemLength() const
Returns the document setting for shortened stem lengths, in EVPUs.
Definition: ff_prefs.h:1582
virtual const PDKFRAMEWORK_CLASSID GetClassID()
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_prefs.h:5833
Definition: ff_prefs.h:6654
void SetSymbolFlat(eUniChar32 character)
Sets the default symbol for the flat accidental.
Definition: ff_prefs.h:8807
twobyte GetVerticalBrevisSlashBaseline() const
Returns the brevis (double-whole) note diamond baseline adjustment value (for rhythmical notation)...
Definition: ff_prefs.h:8603
void SetAlignment(FLAG_16 alignment)
Sets the default alignment for the group text.
Definition: ff_prefs.h:7733
const char * GetName() const
Gets the font name (const C-string version).
Definition: finaleframework.cpp:3289
virtual bool Save()
Overrides Save to be able to handle data that aren't part of the original EDT data structure...
Definition: finaleframework.cpp:29174
virtual bool Load(twobyte prefsnumber=1)
Overloaded version of the Load() method.
Definition: finaleframework.cpp:28748
eUniChar32 GetSymbolSmallSlash() const
Returns the symbol for small slashes in Alternate Notation.
Definition: ff_prefs.h:8239
void SetAvoidHiddenNotes(bool state)
Sets if Avoid Hidden Notes is used or not.
Definition: ff_prefs.h:4411
twobyte GetAlternateBrevisDiamondVertical() const
Returns the value for Alternate Notation: Rhythmic Notation Vertical Positioning - Double Whole Note ...
Definition: ff_prefs.h:1134
void SetSymbol16thFlagUp(eUniChar32 character)
Sets the symbol for 16th Note Upstem Flag.
Definition: ff_prefs.h:8766
void SetSymbolParDoubleFlat(eUniChar32 character)
Sets the default symbol for the double-flat accidental within parentheses.
Definition: ff_prefs.h:8863
void SetVerticalGuideCount(int value)
Sets the number of vertical guides (=the guides where the line goes vertically). This value must be i...
Definition: ff_prefs.h:11094
bool GetGuideSnapToItem(ITEMTOSNAP itemconstant)
Returns the guide "snap state" of a specific item.
Definition: finaleframework.cpp:29302
twobyte GetVerticalFlagSpacing() const
Returns the "Flag Spacing" value, in EVPUs.
Definition: ff_prefs.h:8561
void SetClefKeyExtraSpace(Evpu16 value)
Sets the extra space between clef and key signature.
Definition: ff_prefs.h:1420
eUniChar32 GetSymbolParDoubleFlat() const
Returns the default symbol for the double-flat accidental within parentheses.
Definition: ff_prefs.h:8135
void SetVerticalBottomDotAdjustment(Evpu16 value)
Sets the bottom repeat dot adjustment, in EVPUs.
Definition: ff_prefs.h:10453
void SetSpaceBetweenLines(Efix16 value)
Sets the distance between lines in a repeat, in EFIXes.
Definition: ff_prefs.h:10411
void SetLeftPageRightMargin(twobyte value)
Sets the right page margin for all/left-side pages.
Definition: ff_prefs.h:3666
void SetSymbolCommonTimeSigParts(eUniChar32 value)
Sets the symbol character used for the abbreviated common time signature for parts.
Definition: finaleframework.cpp:28638
bool ChangeRest(FCMultiMeasureRest *pRest)
Copies the the preference settings to a multimeasure rest object.
Definition: finaleframework.cpp:29109
void SetAutoUpdate(bool value)
Sets the state of the "Update Automatically" option for MM rests.
Definition: ff_prefs.h:4976
eUniChar32 GetSymbolFlat() const
Returns the default symbol for the flat accidental.
Definition: ff_prefs.h:8079
Definition: ff_prefs.h:7298
Evpu16 GetSlurBreakStaffLineAvoid() const
Returns the minimum distance to avoid staff lines by, for slur system breaks. In EVPUs.
Definition: ff_prefs.h:5323
void SetTipWidth(fourbyte value)
Sets the tie tip width, in 1/10000 of an EVPU.
Definition: ff_prefs.h:7025
void SetFirstSyllableJustification(twobyte value)
Sets the justification option for first syllables.
Definition: ff_prefs.h:9696
Layer preferences for one specific layer.
Definition: ff_prefs.h:7037
void SetCloseBarlineAtSystem(bool state)
Sets if "Close Barline at End of Each System" is used.
Definition: ff_prefs.h:2401
eUniChar32 GetSymbolParDoubleSharp() const
Returns the default symbol for the double-sharp accidental within parentheses.
Definition: ff_prefs.h:8143
void SetHorizontalInnerBody(fourbyte position)
Sets the horizontal position for the inner body, in 1/10000 of an EVPU.
Definition: ff_prefs.h:11352
void SetFirstSyllableAlignment(twobyte value)
Sets the alignment option for first syllables.
Definition: ff_prefs.h:9686
void SetShapeID(twobyte shapeID)
Seturns the shape ID for the MM rest. (For use in the FCShapeDef class.)
Definition: ff_prefs.h:4969
Definition: ff_prefs.h:4640
bool GetChordDirectionOpposingSeconds() const
Returns the "Tie direction - opposing seconds" state.
Definition: ff_prefs.h:6757
void SetEnclosureThickness(Efix16 value)
Sets the document setting for the default enclosure line thickness, in EFIXes.
Definition: ff_prefs.h:1695
Evpu16 GetSlurBreakSystemEnd() const
Returns the horizontal system end adjustment for slur system breaks. In EVPUs.
Definition: ff_prefs.h:5341
eUniChar32 GetSymbolChordFlat() const
Returns the symbol for flat accidentals in chord symbols.
Definition: ff_prefs.h:8159
bool GetChordPlayback() const
Returns if chord playback is enabled.
Definition: ff_prefs.h:2213
Evpu16 GetClefSpaceBefore() const
Returns the space before clef, in EVPUs.
Definition: ff_prefs.h:1041
bool GetRebarWhenTimeSigChanged() const
Return true if measures should rebar when the Time Signature Tool changes the time signature...
Definition: ff_prefs.h:3916
void SetSpaceAfter(twobyte value)
Sets the document setting for extra space after the music in a measure.
Definition: ff_prefs.h:1188
twobyte GetAugmentationDotVerticalAdjust() const
Returns the default vertical offset for an augmentation dot.
Definition: ff_prefs.h:951
Definition: ff_prefs.h:4655
bool GetLeftBarlineDisplaySingle() const
Returns true if "Left Barlines - Display on Single Staves" is used.
Definition: ff_prefs.h:1950
FCPageFormatPrefs()
The constructor.
Definition: ff_prefs.h:3375
void SetEndingFrontHookLength(Evpu16 value)
Sets the default length (height) of repeat front hooks, in EVPUs.
Definition: ff_prefs.h:10497
bool GetRecalcSystems() const
Return true if systems should be recalculated when the layout is updated. The setting is called "Refl...
Definition: ff_prefs.h:3907
void SetKeySigCancelSwitchingSharpsFlats(bool state)
Sets the Finale 25.4 option if outgoing keys should be canceled when switching between sharps and fla...
Definition: finaleframework.cpp:29508
fourbyte GetHorizontalInnerTip() const
Returns the horizontal position for the inner tip, in 1/10000 of an EVPU.
Definition: ff_prefs.h:11231
void SetVerticalFirstFlagDown(twobyte value)
Sets the vertical adjustment for the first downstem flag, in EFIXes.
Definition: ff_prefs.h:9236
void SetSlurThicknessVerticalLeft(Evpu16 value)
Sets slur thickness to the vertical left, in EVPUs.
Definition: ff_prefs.h:5735
void SetVerticalShapeOffset(twobyte value)
Sets the vertical shape offset.
Definition: ff_prefs.h:3163
bool GetShowDefaultGroupNames() const
Returns if default group names should be displayed as placeholders. The setting is called "Staff/Show...
Definition: ff_prefs.h:3865
Class for the Slur Contour preferences.
Definition: ff_prefs.h:5805
void SetKeySigRightHorizontalOffset(Evpu16 value)
Returns the "Break for key signatures - right gap" setting.
Definition: ff_prefs.h:6879
void SetAvoidStaff(bool value)
Sets the "Avoid Staff" state.
Definition: finaleframework.cpp:29034
fourbyte GetVerticalInnerTip() const
Returns the vertical position for the inner tip, in 1/10000 of an EVPU.
Definition: ff_prefs.h:11240
void SetAlternateBrevisDiamondVertical(twobyte value)
Sets the value for Alternate Notation: Rhythmic Notation Vertical Positioning - Double Whole Note Dia...
Definition: ff_prefs.h:1389
void Set16BitFlag(FLAG_16 *flag, FLAG_16 flagbits, bool state)
Sets a 16 bit flag in the data block.
Definition: finaleframework.cpp:573
eUniChar32 GetSymbolKeyFlat() const
Returns the symbol for flats in key signatures.
Definition: ff_prefs.h:8199
void SetSystemBottom(twobyte value)
Sets the Bottom system margin setting.
Definition: ff_prefs.h:3618
Definition: ff_prefs.h:4661
void SetSymbolTimeSigPlusScore(eUniChar32 character)
Sets the symbol for plus signs in time signatures (in the score).
Definition: ff_prefs.h:9033
Definition: ff_prefs.h:7316
void SetAlwaysSlashGraceNote(bool state)
Sets the state of the "Always Slash Grace Notes" check box.
Definition: ff_prefs.h:2267
twobyte GetScalingReferenceDuration() const
Returns the reference duration for scaling.
Definition: ff_prefs.h:4315
TIE_SECONDS_CONSTANTS
The constants for seconds placement.
Definition: ff_prefs.h:6612
twobyte GetStartSystemSyllableJustification() const
Returns the justification option for syllables at start of systems.
Definition: ff_prefs.h:9596
twobyte GetVerticalShapeOffset() const
Returns the vertical shape offset.
Definition: ff_prefs.h:2940
bool GetEngraverSlurStretchByPercent() const
Returns if Engraver Slur stretches should be made in percent or absolute.
Definition: ff_prefs.h:5287
Class for the Smart Shape preferences.
Definition: ff_prefs.h:5065
Evpu16 GetKeySpaceBefore() const
Returns the space before key signature, in EVPUs.
Definition: ff_prefs.h:1017
twobyte GetSecondaryBeamSpace() const
Returns the space between each secondary beam, in EVPUs.
Definition: ff_prefs.h:969
eUniChar32 GetSymbolParNatural() const
Returns the default symbol for the natural accidental within parentheses.
Definition: ff_prefs.h:8111
void SetClefTimeExtraSpace(Evpu16 value)
Sets the extra space between clef and time signature.
Definition: ff_prefs.h:1426
Definition: ff_prefs.h:1791
void SetSymbolKeyDoubleFlat(eUniChar32 character)
Sets the symbol for double-flats in key signatures.
Definition: ff_prefs.h:8944
void SetKeySigNaturalsInC(bool state)
Sets if naturals should be displayed in C at start of staff systems.
Definition: ff_prefs.h:2502
bool GetIgnoreHiddenLayers() const
Returns the "Ignore hidden layers" state.
Definition: ff_prefs.h:7171
void SetGuitarBendReplaceWithFull(bool state)
Sets the value for Guitar Bend Options - Replace "1" with "Full".
Definition: ff_prefs.h:5791
void SetExpandSingleWord(bool state)
Sets the default "expand single word" state.
Definition: ff_prefs.h:7745
void SetSymbolWiggle(eUniChar32 value)
Sets the default wiggle (~) character for trills.
Definition: finaleframework.cpp:28682
Evpu16 GetSystemRightHorizontalOffset() const
Returns the value for "Tie system break, horizontal end adjustment".
Definition: ff_prefs.h:6729
Class that contains document preferences that doesn't fit in any other class.
Definition: ff_prefs.h:1739
void SetRecalcSystems(bool state)
Sets if systems should be recalculated when the layout is updated. The setting is called "Reflow syst...
Definition: ff_prefs.h:4007
FCMultiMeasureRestPrefs()
The constructor.
Definition: ff_prefs.h:4886
bool GetDisplayReverseStemming() const
Returns the state of the "Display Reverse Stemming" stem option.
Definition: ff_prefs.h:1904
void SetGraceNotePlaybackDuration(twobyte value)
Sets the duration of a grace note (in EDUs).
Definition: ff_prefs.h:2490
bool GetAllowHorizontalDrag() const
Returns the "Allow Horizontal Drag" state.
Definition: ff_prefs.h:2840
FCPlaybackPrefs()
The constructor.
Definition: ff_prefs.h:767
bool GetShowFretboards() const
Returns the "Show Fretboards" (in the Chord menu).
Definition: ff_prefs.h:2013
void SetIgnoreHiddenLayers(bool state)
Sets the "ignore hidden layers" state.
Definition: ff_prefs.h:7249
void SetRespaceMeasureLayout(bool state)
Sets if measures should reflow within a system at a layout update.
Definition: ff_prefs.h:3976
void SetVerticalOffset(twobyte value)
Sets the vertical tuplet offset.
Definition: ff_prefs.h:3137
void SetItalicizeCapoChords(bool state)
Sets the the "Italicize Capo Chords" (in the Chord menu).
Definition: ff_prefs.h:2441
void SetEngraverTuplet(bool value)
Sets the engraver tuplet state.
Definition: ff_prefs.h:3039
bool GetDisplayInConcertPitch() const
Returns true if the part is set to use the "Display in Concert Pitch" setting.
Definition: ff_prefs.h:9386
void SetSymbolKeySharp(eUniChar32 character)
Sets the symbol for sharps in key signatures.
Definition: ff_prefs.h:8936
void SetSecondsInTimeStamp(bool state)
Sets if the time stamp (for text inserts) should include seconds.
Definition: ff_prefs.h:2573
Definition: ff_prefs.h:4691
Definition: ff_prefs.h:10207
twobyte GetHorizontalFirstFlagUp() const
Returns the horizontal adjustment for the first upstem flag, in EFIXes.
Definition: ff_prefs.h:8434
void SetTimeSigAbbreviatedVertical(Evpu16 value)
Sets the vertical adjustment of abbreviated time signature, in EVPUs, for the score.
Definition: ff_prefs.h:1314
virtual const char * ClassName()
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_prefs.h:3805
PDKFRAMEWORK_CLASSID
Constants for the GetClassID method.
Definition: ff_base.h:60
void SetDownstemVerticalAdjust(int connectionID, Efix16 distance)
Sets the downstem vertical adjustment for the notehead that has the stem connection data...
Definition: finaleframework.cpp:29681
virtual const PDKFRAMEWORK_CLASSID GetClassID()
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_prefs.h:1831
Class for document preferences related to guides and grids.
Definition: ff_prefs.h:10567
void SetHorizontalInnerTip(fourbyte position)
Sets the horizontal position for the inner tip, in 1/10000 of an EVPU.
Definition: ff_prefs.h:11334
Definition: ff_prefs.h:4736
void SetHorizontalGuideCount(int value)
Sets the number of horizontal guides (=the guides where the line goes horizontally). This value must be identical to the number of actual guides.
Definition: ff_prefs.h:11088
virtual const char * ClassName()
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_prefs.h:3368
eUniChar32 GetSymbolBrevisSlashDiamond() const
Returns the symbol for brevis (double-whole note) diamond in Alternate Notation.
Definition: ff_prefs.h:8263
CONTOUR_INDEXES
The index constants for all methods in FCTieContourPrefs.
Definition: ff_prefs.h:6219
UNISONS_MODE
The constants used by GetUnisonsMode.
Definition: ff_prefs.h:4077
void SetTimeSigRightHorizontalOffset(Evpu16 value)
Returns the "Break for time signatures - right gap" setting.
Definition: ff_prefs.h:6867
twobyte GetLongSpan()
Returns the defined distance for the long span slur.
Definition: ff_prefs.h:5925
Evpu16 GetLeftHeight(CONTOUR_INDEXES index)
Returns the left-side height.
Definition: ff_prefs.h:6338
Efix16 GetDownstemVerticalAdjust(int connectionID)
Returns the downstem vertical adjustment for the notehead that has the stem connection data...
Definition: finaleframework.cpp:29642
void SetDownstemHorizontalAdjust(int connectionID, Efix16 distance)
Sets the downstem horizontal adjustment for the notehead that has the stem connection data...
Definition: finaleframework.cpp:29676
void SetCenterUsingDuration(bool value)
Sets the "Center number using duration" state.
Definition: finaleframework.cpp:29052
void SetBreakForKeySigs(bool state)
Sets if the tie should break for key signatures.
Definition: ff_prefs.h:6855
twobyte GetVertical32ndRest() const
Returns the vertical adjustment for 32nd note rests, in EVPUs.
Definition: ff_prefs.h:8542
eUniChar32 GetSymbolDefaultMeasureRest() const
Returns the default measure rest symbol.
Definition: ff_prefs.h:7998
virtual bool Reload()
Overridden version of Reload(), that handles prefs from multiple sources.
Definition: finaleframework.cpp:28394
twobyte GetStartNumberingAt() const
Returns the threshold number where mm rests should start to be created.
Definition: ff_prefs.h:4948
Evpu16 GetGraceNoteSpacing() const
Returns the horizontal grace note spacing, in EVPUs.
Definition: ff_prefs.h:1146
int GetScalingValue() const
Returns the scaling factor, multiplied with 10000.
Definition: ff_prefs.h:4113
bool GetScaleManualNotePositioning() const
Sets if manual positioning of notes should be scaled.
Definition: ff_prefs.h:2158
void SetCourtesyClefAtSystemEnd(bool state)
Sets if courtesy clefs should be displayed at the end of systems.
Definition: ff_prefs.h:2554
GRACENOTE_SPACINGMODE GetGraceNoteSpacingMode() const
Returns the grace note spacing mode.
Definition: ff_prefs.h:4226
bool GetGridSnap() const
Returns if items should snap to the grid.
Definition: ff_prefs.h:10736
bool GetExpandSingleWord() const
Returns the default "expand single word" state.
Definition: ff_prefs.h:7698
twobyte GetSystemBottom() const
Returns the bottom system margin setting.
Definition: ff_prefs.h:3455
void SetAbbreviateCommonTimeSig(bool state)
Sets if common time signatures should be abbreviated.
Definition: ff_prefs.h:2542
Efix16 GetEnclosureThickness() const
Returns the document setting for the default enclosure line thickness, in EFIXes. ...
Definition: ff_prefs.h:1564
void SetHalfStemLength(Evpu16 value)
Sets the document setting for half-stem lengths, in EVPUs.
Definition: ff_prefs.h:1719
REPEATWINGSTYLES
The repeat wing styles.
Definition: ff_prefs.h:10198
Default positioning for full and abbreviated group names.
Definition: ff_prefs.h:7614
void SetSystemDistanceBetween(twobyte value)
Sets the distance between systems. This is the negative value compared to what's found in the Finale ...
Definition: ff_prefs.h:3742
eUniChar32 GetSymbolTwoBarRepeat() const
Returns the symbol for two-bars repeats in Alternate Notation.
Definition: ff_prefs.h:8279
bool GetNormalDefaultBarline() const
Returns true if the default barline style is the normal barline.
Definition: ff_prefs.h:1966
Efix16 GetHeavyBarlineThickness() const
Returns the document setting for heavy barline thickness, in EFIXes.
Definition: ff_prefs.h:1497
Definition: ff_prefs.h:10201
virtual void CloneMemoryFrom(__FCBaseData *pSource)
Definition: finaleframework.cpp:753
void SetScalingReferenceDuration(fourbyte duration)
Sets the reference duration for scaling.
Definition: ff_prefs.h:4573
void SetGraceNoteSize(twobyte value)
Sets the grace note resize, in percent.
Definition: ff_prefs.h:1617
Evpu16 GetVerticalTopDotAdjustment() const
Returns the top repeat dot adjustment, in EVPUs.
Definition: ff_prefs.h:10279
twobyte GetHorizontalStraightFlagDown() const
Returns the horizontal adjustment for the straight downstem flag, in EFIXes.
Definition: ff_prefs.h:8476
void SetNumberHorizontalAdjust(twobyte value)
Sets the horizontal adjustment for multimeasure rests numbers.
Definition: ff_prefs.h:5007
Efix16 GetBeamThickness() const
Returns the document setting for beam thickness in EFIXes.
Definition: ff_prefs.h:1479
void SetEndingBackHookLength(Evpu16 value)
Sets the default length (height) of back hooks, in EVPUs.
Definition: ff_prefs.h:10503
Definition: ff_prefs.h:751
Evpu16 GetKeySigLeftHorizontalOffset() const
Returns the "Break for key signatures - left gap" setting.
Definition: ff_prefs.h:6711
void SetStartNumberingAt(twobyte value)
Sets the threshold number where mm rests should start to be created.
Definition: ff_prefs.h:5001
fourbyte GetPageWidth() const
Returns the page width.
Definition: ff_prefs.h:3473
bool GetUseWordExtSyllable() const
Returns if the positioning options (alignment/justification ) for syllables with word extensions shou...
Definition: ff_prefs.h:9522
void SetVerticalEnd(TIEPLACEMENT_INDEXES placementtype, Evpu16 offsetvalue)
Sets the end (right-side) vertical placement position for the specific tie placement type...
Definition: ff_prefs.h:6194
int GetMaxPasses() const
Returns the maximum number of playback passes a repeat should be allowed.
Definition: ff_prefs.h:10379
Evpu16 GetThicknessRight() const
Returns the right-side tie thickness.
Definition: ff_prefs.h:6675
fourbyte GetUnderlineDepth() const
Returns the Underline Depth option (currently Mac only).
Definition: ff_prefs.h:2195
static void DebugOutDigit(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:274
void SetVerticalStart(TIEPLACEMENT_INDEXES placementtype, Evpu16 offsetvalue)
Sets the start (left-side) vertical placement position for the specific tie placement type...
Definition: ff_prefs.h:6154
Evpu16 GetEngraverSlurSpaceAround() const
Returns space around objects for Engraver Slurs.
Definition: ff_prefs.h:5244
twobyte GetEngraverSlurMaxStretchPercent() const
Returns the Engraver Slur max stretch value for stretches (in 1/100 percent).
Definition: ff_prefs.h:5296
twobyte GetLeftHookLength() const
Returns the left-side hook length.
Definition: ff_prefs.h:2952
void SetGridColorRed(utwobyte value)
Returns the red color status of the grid, which is part of the RGB value.
Definition: ff_prefs.h:10943
Definition: ff_prefs.h:6618
void SetShortenedStemLength(Evpu16 value)
Sets the document setting for shortened stem lengths, in EVPUs.
Definition: ff_prefs.h:1713
void SetScalingReferenceWidth(fourbyte width)
Sets the reference width for scaling.
Definition: ff_prefs.h:4583
twobyte GetScalingReferenceWidth() const
Returns the reference width for scaling.
Definition: ff_prefs.h:4324
void SetKeySpaceBefore(Evpu16 value)
Sets the space before key signature, in EVPUs.
Definition: ff_prefs.h:1272
Efix16 GetDownstemHorizontalAdjust(int connectionID)
Returns the downstem horizontal adjustment for the notehead that has the stem connection data...
Definition: finaleframework.cpp:29637
void SetIncludeRestsInFour(bool state)
Sets the state of the "Include rests when beaming in groups of four" beaming option.
Definition: ff_prefs.h:2312
Evpu16 GetAccidentalMultiCharSpace() const
Returns the space within multi-character accidentals, in EVPUs.
Definition: ff_prefs.h:1101
bool GetGuitarBendHideNumber() const
Returns the value for Guitar Bend Options - Hide "Bend-To" Number.
Definition: ff_prefs.h:5428
twobyte GetCurveResolution() const
Returns the curve resolution (1-128), for non-PostScript and screen output.
Definition: ff_prefs.h:2040
Efix16 GetLedgerLineThickness() const
Returns the document setting for ledger line thickness in EFIXes.
Definition: ff_prefs.h:1521
void SetMeasurementUnit(twobyte value)
Sets the currently selected measurement unit. The setting is called "Measurement Units" in the Finale...
Definition: ff_prefs.h:3953
bool GetLeftBarlineDisplayMultipe() const
Returns true if "Left Barlines - Display on Multiple Staves" is used.
Definition: ff_prefs.h:1957
void SetRightHookLength(twobyte value)
Sets the right-side hook length.
Definition: ff_prefs.h:3187
twobyte GetSystemTop() const
Returns the top system margin setting.
Definition: ff_prefs.h:3449
void SetHorizontalFirstFlagDown(twobyte value)
Sets the horizontal adjustment for the first downstem flag, in EFIXes.
Definition: ff_prefs.h:9188
virtual bool Load(twobyte prefsno=1)
Overrides Load to be able to handle data that aren't part of the original EDT data structure...
Definition: finaleframework.cpp:29145
void SetUsePrinterMetrics(bool state)
Sets if printer font metrics should be used instead of screen. Windows only.
Definition: ff_prefs.h:4551
FCPianoBracePrefs()
The constructor.
Definition: ff_prefs.h:11220
void SetCloseBarlineAtEnd(bool state)
Sets if "Close Barline at End of Piece" is used.
Definition: ff_prefs.h:2407
twobyte GetTimeSigCompositeDecimals() const
Returns how many decimals composite time signatures should have in the fraction part.
Definition: ff_prefs.h:2096
twobyte GetRightPageLeftMargin() const
Returns the left page margin for right-side pages.
Definition: ff_prefs.h:3552
CMPER GetTabSlideDefID() const
Returns the default custom startshape definition ID for tab slide lines.
Definition: ff_prefs.h:5135
Definition: ff_prefs.h:10631
void SetBracketFullDuration(bool value)
Sets the "Bracket Full Duration" state.
Definition: finaleframework.cpp:29046
void SetNaturalBaselineAdjustment(Evpu16 value)
Sets the "Chord Alteration Baseline Adjustment" for naturals (in EVPUs).
Definition: ff_prefs.h:7417
void SetNormalDefaultBarline(bool state)
Returns if the default barline style is the normal barline.
Definition: ff_prefs.h:2435
FLAG_16 GetJustification() const
Returns the default justification for the group text.
Definition: ff_prefs.h:7684
Evpu16 GetEndingBracketHeight() const
Returns the default height of repeat brackets, in EVPUs.
Definition: ff_prefs.h:10323
void SetSystemLeft(twobyte value)
Sets the general left system margin setting.
Definition: ff_prefs.h:3600
void SetGuideSnap(bool state)
Sets if items should snap to guides.
Definition: ff_prefs.h:11016
FCSizePrefs()
The constructor.
Definition: ff_prefs.h:1469
Evpu16 GetHairpinDefaultShortOpening() const
On Finale 25.3 and later, returns the default "short span" hairpin opening width in the Smart Shape p...
Definition: finaleframework.cpp:29080
void SetExpandSingleWord(bool state)
Sets the default "expand single word" state.
Definition: ff_prefs.h:7599
FCGridsGuidesPrefs()
The constructor.
Definition: ff_prefs.h:10676
void SetFreezeStemsUp(bool state)
Sets if frozen stems should be up or down.
Definition: ff_prefs.h:7207
double GetScalingFactor() const
Returns the scaling ratio, in the same way the Finale UI displays it.
Definition: ff_prefs.h:4128
void SetShowDefaultGroupNames(bool state)
Sets if default group names should be displayed as placeholders. The setting is called "Staff/Show De...
Definition: ff_prefs.h:3967
bool GetHideWhenInactive() const
Returns the "Hide layer when inactive" state.
Definition: ff_prefs.h:7163
twobyte GetVertical128thRest() const
Returns the vertical adjustment for 128th note rests, in EVPUs.
Definition: ff_prefs.h:8555
twobyte GetMaxSlope() const
Returns the maximum slope, in 10ths of a percent.
Definition: ff_prefs.h:3011
FCFontPrefs()
The constructor.
Definition: ff_prefs.h:4777
int GetItemNo() const
Returns the prefs number for the loaded data.
Definition: ff_prefs.h:712
void SetCenterThickness(fourbyte thickness)
Sets the center thickness, in 1/10000 of an EVPU.
Definition: ff_prefs.h:11415
void SetPageMarginScope(PAGEMARGINSCOPES mode)
Returns the margin adjusment scope for "Page Margins" in the Layout menu.
Definition: ff_prefs.h:2678
Evpu16 GetTimeSigSpaceAfter() const
Returns the space after the time signature, in EVPUs, for the score.
Definition: ff_prefs.h:1083
eUniChar32 GetSymbolTimeSigPlusScore() const
Returns the symbol for plus signs in time signatures (in the score).
Definition: ff_prefs.h:8307
void SetShapeStyle(FCTuplet::SHAPESTYLE value)
Sets the shape style.
Definition: finaleframework.cpp:28976
Definition: ff_prefs.h:4700
bool GetShowDefaultStaffNames() const
Returns if default staff names should be displayed as placeholders. The setting is called "Staff/Show...
Definition: ff_prefs.h:3858
void SetBarlineFinalSpace(Efix16 value)
Sets the space between final barlines, in EFIXes.
Definition: ff_prefs.h:1260
Definition: ff_prefs.h:4718
void SetCrossStaffNotesInOriginal(bool state)
Sets if cross staff notes should be displayed in the original staff.
Definition: ff_prefs.h:2615
void SetGuideSnapToItem(ITEMTOSNAP itemconstant, bool state)
Sets the guide "snap state" of a specific item.
Definition: finaleframework.cpp:29420
Definition: ff_prefs.h:7304
void SetMaxSpaceBetweenHyphens(Evpu16 value)
Sets the maximum space between hyphens, in EVPUs.
Definition: ff_prefs.h:9636
Class for Human Playback preferences.
Definition: ff_prefs.h:9763
virtual const char * ClassName()
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_prefs.h:5095
void SetAccidentalMultiSpace(Evpu16 value)
Sets the space between accidentals on note, in EVPUs.
Definition: ff_prefs.h:1368
eUniChar32 GetSymbolParFlat() const
Returns the default symbol for the flat accidental within parentheses.
Definition: ff_prefs.h:8119
utwobyte GetGuideColorBlue() const
Returns the blue color status of the guide, which is part of the RGB value.
Definition: ff_prefs.h:10830
NUMBERSTYLE
The settings for the number style that should be used by the tuplet.
Definition: ff_entrydetails.h:1694
void SetHookLength(Evpu16 value)
Sets the hook length, if EVPUs.
Definition: ff_prefs.h:5558
TIE_CHORD_DIRECTIONS
The constants for the tie chord direction type.
Definition: ff_prefs.h:6631
eUniChar32 GetSymbol16thFlagDown() const
Returns the symbol for 16th Note Downstem Flag.
Definition: ff_prefs.h:8046
void SetSystemRight(twobyte value)
Sets the right system margin setting.
Definition: ff_prefs.h:3606
void SetGraceSlashThickness(Efix16 value)
Sets the document setting for grace note slash thickness in EFIXes.
Definition: ff_prefs.h:1623
void SetAvoidLedgerLines(bool state)
Sets if Avoid Ledger Lines is used or not.
Definition: ff_prefs.h:4417
bool GetUseSmartHyphens() const
Returns if smart hyphens should be used.
Definition: ff_prefs.h:9495
void SetUseRestOffset(bool state)
Sets if the vertical rest offset should be used.
Definition: ff_prefs.h:7184
Definition: ff_prefs.h:4643
void SetAvoidStaffLines(bool state)
Sets if the tie should avoid staff lines.
Definition: ff_prefs.h:6982
void SetInterpolateAllotments(bool state)
Sets if allotment should be interpolated if the duration wasn't found in the table (the "Use default ...
Definition: ff_prefs.h:4442
void SetRightPageRightMargin(twobyte value)
Sets the right page margin for right-side pages.
Definition: ff_prefs.h:3717
eUniChar32 GetSymbolCutTimeSigParts() const
Returns the symbol character used for the abbreviated cut time signature for parts.
Definition: finaleframework.cpp:28510
twobyte GetVerticalStraightFlagDown() const
Returns the vertical adjustment for the straight downstem flag, in EFIXes.
Definition: ff_prefs.h:8524
Efix16 GetThinLineThickness() const
Returns the thin line thickness for repeat barlines, in EFIXes.
Definition: ff_prefs.h:10240
void SetOctavesAsText(bool state)
Set the flag for if octavas should display as text instead of a symbol.
Definition: ff_prefs.h:5564
void SetBarlineDoubleSpace(Efix16 value)
Sets the space between double barlines, in EFIXes.
Definition: ff_prefs.h:1254
Definition: ff_prefs.h:4637
Definition: ff_prefs.h:6634
FCMusicCharacterPrefs()
The constructor.
Definition: ff_prefs.h:7864
twobyte GetHorizontal16thFlagDown() const
Returns the horizontal adjustment for the 16th downstem flag, in EFIXes.
Definition: ff_prefs.h:8470
void SetHorizontal16thFlagDown(twobyte value)
Sets the horizontal adjustment for the 16th downstem flag, in EFIXes.
Definition: ff_prefs.h:9200
bool GetUseStemConnections() const
Returns true if the stem connection table is used for the document.
Definition: ff_prefs.h:1979
eUniChar32 GetSymbolWholeRest() const
Returns the default symbol character for whole rests.
Definition: ff_prefs.h:7971
Efix16 GetStaffLineThickness() const
Returns the document setting for staff line thickness in EFIXes.
Definition: ff_prefs.h:1515
twobyte GetBaseKeyVelocity() const
Returns the base key velocity value.
Definition: ff_prefs.h:774
void SetSpacing(bool state)
Sets the music spacing state for the layer.
Definition: ff_prefs.h:7227
Definition: ff_prefs.h:7301
void SetUseSimpleSpelling(bool state)
Sets if simplified chord spelling should be used or not.
Definition: ff_prefs.h:7338
void SetHairpinMaxShortSpanLength(twobyte value)
Sets the "Maximum short span length" (added in Finale 25.3) in the Smart Shape preferences.
Definition: finaleframework.cpp:29099
Definition: ff_prefs.h:4694
void SetUseSymbols(bool value)
Sets if symbols should be activated for MM rests.
Definition: ff_prefs.h:4988
void SetRightPageTopMargin(twobyte value)
Sets the top page margin for right-side pages.
Definition: ff_prefs.h:3693
void SetSymbol16thRest(eUniChar32 character)
Sets the default symbol character for 16th rests.
Definition: ff_prefs.h:8677
bool IsUsed()
Return true if Human Playback is used for the document.
Definition: ff_prefs.h:9806
void SetBeforeSingleAccidental(bool state)
Sets if the tie should end before a single accidental.
Definition: ff_prefs.h:6976
void SetFirstPageTopMargin(twobyte value)
Sets the top page margin for the first page.
Definition: ff_prefs.h:3679
void SetSize(twobyte fontsize)
Sets the font size as an integer value.
Definition: ff_base.h:1306
eUniChar32 GetSymbolOctave() const
Returns the default octava (8va) character.
Definition: finaleframework.cpp:28558
float GetRightRelativeInset(CONTOUR_INDEXES index)
Returns the right-side inset, as percent.
Definition: ff_prefs.h:6375
Definition: ff_prefs.h:4658
void SetClefResize(twobyte value)
Sets the default % reduction for clef changes.
Definition: ff_prefs.h:2374
twobyte GetLayerIndex() const
Returns the 0-based layer index for the loaded layer preferences. -1 if no data has been loaded...
Definition: ff_prefs.h:7078
bool GetUseAllotmentMode() const
Returns if the spacing is set to allotment mode.
Definition: ff_prefs.h:4306
eUniChar32 GetSymbol8thRest() const
Returns the default symbol character for 8th rests.
Definition: ff_prefs.h:7947
Definition: ff_prefs.h:10185
eClef GetDefaultClefIndex() const
Returns the default clef index.
Definition: ff_prefs.h:2034
void SetMixedStemDirectionType(twobyte value)
Returns the "Tie direction at mixed stems" type.
Definition: ff_prefs.h:6948
bool GetIncludeRestsInFour() const
Returns the state of the "Include rests when beaming in groups of four" beaming option.
Definition: ff_prefs.h:1910
void SetSymbolLargeSlash(eUniChar32 character)
Sets the symbol for large slashes in Alternate Notation.
Definition: ff_prefs.h:8961
twobyte GetVertical16thFlagUp() const
Returns the vertical adjustment for the 16th upstem flag, in EFIXes.
Definition: ff_prefs.h:8494
eUniChar32 GetSymbol32ndRest() const
Returns the default symbol character for 32nd rests.
Definition: ff_prefs.h:7931
bool GetAvoidStaffLinesOnly() const
Returns the "In Staff Only" state (in the tie contour options). If set, avoid staff lines in staves o...
Definition: ff_prefs.h:6825
GRACENOTE_SPACINGMODE
The grace note spacing constants used by GetGraceNoteSpacingMode.
Definition: ff_prefs.h:4053
Definition: ff_prefs.h:10640
void SetKeySigCancelOutgoing(bool state)
Sets if outgoing keys should be canceled.
Definition: ff_prefs.h:2514
void SetBeamThickness(Efix16 value)
Sets the document setting for beam thickness in EFIXes.
Definition: ff_prefs.h:1611
void SetDoubleBarlineAtKeyChange(bool state)
Sets if the "Double barline preceding key changes" option should be used. This option is only availab...
Definition: finaleframework.cpp:29484
twobyte GetSpaceBefore() const
Returns the document setting for extra space before the music in a measure.
Definition: ff_prefs.h:927
void SetGraceNoteSpacingMode(GRACENOTE_SPACINGMODE value)
Sets the grace note spacing mode.
Definition: ff_prefs.h:4450
eUniChar32 GetSymbol16thFlagUp() const
Returns the symbol for 16th Note Upstem Flag.
Definition: ff_prefs.h:8038
Definition: ff_prefs.h:4652
Class for Multimeasure rests document preferences (in the Document Options dialog box)...
Definition: ff_prefs.h:4851
void SetFirstSystemLeft(twobyte value)
Sets the left system margin for the first system.
Definition: ff_prefs.h:3586
twobyte GetEndingInsetEnd() const
Returns the inset for the ends of bracket.
Definition: ff_prefs.h:10353
Definition: ff_prefs.h:4688
bool GetConsolidateRestsAcrossLayers() const
Returns the "Consolidate Rests Across Layers", available in Finale 2014 and above.
Definition: finaleframework.cpp:29490
void SetShowDefaultStaffNames(bool state)
Sets if default staff names should be displayed as placeholders. The setting is called "Staff/Show De...
Definition: ff_prefs.h:3960
void SetPlayback(bool state)
Sets the playback state for the layer.
Definition: ff_prefs.h:7221
eUniChar32 GetSymbolSharp() const
Returns the default symbol for the sharp accidental.
Definition: ff_prefs.h:8087
Definition: ff_prefs.h:5958
void SetFixedInsetStyle(bool state)
Sets if the inset style is fixed or in percent (in the tie contour options).
Definition: ff_prefs.h:6996
GGLINESTYLES GetGridLineStyle() const
Returns the line style that should be used for grids.
Definition: ff_prefs.h:10782
Efix16 GetEndingLineThickness() const
Returns the line thickness, in EFIXes.
Definition: ff_prefs.h:10341
Definition: ff_prefs.h:6657
void SetHorizontalPos(Evpu16 value)
Sets the default horizontal position for the group text.
Definition: ff_prefs.h:7706
Options that affects Music (Note) Spacing in the document.
Definition: ff_prefs.h:4023
eUniChar32 GetSymbolTwoOctavesBass() const
Returns the default 2-octava bass (15ma) character.
Definition: finaleframework.cpp:28594
void SetIgnoreHiddenNotes(bool state)
Sets the "Ignore Layers Containing Only Hidden Notes" state.
Definition: ff_prefs.h:7235
bool GetLeftAlignment() const
Returns if the chords should be left aligned.
Definition: ff_prefs.h:7349
fourbyte GetShapeSlurTipWidth() const
Returns the document setting for the shape designer slur tip width, in 1/10000 EVPUs.
Definition: ff_prefs.h:1570
twobyte GetMinMeasureWidth() const
Returns the minimum measure width.
Definition: ff_prefs.h:4158
eMeas GetStartMeasure() const
Returns the playback start measure, which is used if the start mode allows it.
Definition: ff_prefs.h:802
void SetVerticalInnerTip(fourbyte position)
Sets the vertical position for the inner tip, in 1/10000 of an EVPU.
Definition: ff_prefs.h:11343
int GetHorizontalGuideCount() const
Returns the number of horizontal guides (=the guides where the line goes horizontally). This value must be identical to the number of actual guides in the document.
Definition: ff_prefs.h:10892
virtual const char * ClassName()
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_prefs.h:6660
The preferences for ties (includes options both from tie options and tie contour options).
Definition: ff_prefs.h:6581
void SetSymbolChordNatural(eUniChar32 character)
Sets the symbol for natural accidentals in chord symbols.
Definition: ff_prefs.h:8880
The preferences for the default tuplet definition.
Definition: ff_prefs.h:2731
bool LoadAbbreviated()
Loads the abbreviated name positioning data.
Definition: ff_prefs.h:7518
void SetOnlyFirstSystemClef(bool state)
Sets if the clefs should be displayed only on the first system, or not.
Definition: ff_prefs.h:2459
twobyte GetUseSymbolsLessThan() const
Returns the threshold measure where symbols should be used instead of shapes.
Definition: ff_prefs.h:4942
Efix16 GetWordExtLineThickness() const
Returns the word extension line thickness, in EFIXes.
Definition: ff_prefs.h:9515
void SetKeySpaceBetweenAccidentals(Evpu16 value)
Sets the space between key signature accidentals, in EVPUs.
Definition: ff_prefs.h:1290
void SetSlopeAdjust(twobyte value)
Sets the "Manual Slope Adjustment" value.
Definition: ff_prefs.h:3199
Definition: ff_prefs.h:9458
Evpu16 GetLedgerRightRestHalf() const
Returns the document setting for ledger line right half rest length in EFIXes.
Definition: ff_prefs.h:1546
void SetGlissandoDefID(CMPER idvalue)
Sets the default custom startshape definition ID for glissando lines.
Definition: ff_prefs.h:5471
Evpu16 GetClefTimeExtraSpace() const
Returns the extra space between clef and time signature.
Definition: ff_prefs.h:1171
void SetVertical16thFlagDown(twobyte value)
Sets the vertical adjustment for the 16th downstem flag, in EFIXes.
Definition: ff_prefs.h:9248
void SetNoteheadCharacter(int connectionID, eUniChar32 character)
Sets the font character for the notehead that has the stem connection data.
Definition: finaleframework.cpp:29656
Definition: ff_prefs.h:1775
void SetVerticalSecondaryGroupAdjust(twobyte value)
Sets the "Second Group Adjust" value for flags, in EVPUs.
Definition: ff_prefs.h:9296
void SetUseInterpolation(bool state)
Sets if heights should be interpolated or not (in the tie contour options).
Definition: ff_prefs.h:7005
void SetChordDirectionOpposingSeconds(bool state)
Sets the "Tie direction - opposing seconds" state.
Definition: ff_prefs.h:6940
virtual const char * ClassName()
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_prefs.h:10595
twobyte GetSystemDistanceBetween() const
Returns the distance between systems. This is the negative value compared to what's found in the Fina...
Definition: ff_prefs.h:3461
void SetPrimaryBeamWithinSpace(bool state)
Sets the state of the "Allow Primary Beam Within a Space" beam option.
Definition: ff_prefs.h:2281
virtual const PDKFRAMEWORK_CLASSID GetClassID()
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_prefs.h:7641
void SetGridStep(twobyte value)
Sets the "Display one in ??? Grid Lines" option.
Definition: ff_prefs.h:10934
twobyte GetFirstSystemDistance() const
Returns the first system distance to top.
Definition: ff_prefs.h:3578
void SetVertical64thRest(twobyte value)
Sets the vertical adjustment for 64th note rests,in EVPUs.
Definition: ff_prefs.h:9278
FCStaffNamePositionPrefs()
The constructor.
Definition: ff_prefs.h:7501
void SetHorizontalPos(Evpu16 value)
Sets the default horizontal position for the staff text.
Definition: ff_prefs.h:7560
void SetHorizontalStraightFlagDown(twobyte value)
Sets the horizontal adjustment for the straight downstem flag, in EFIXes.
Definition: ff_prefs.h:9206
void SetLineDashLength(Evpu16 value)
Returns the default dash length, if EVPUs.
Definition: ff_prefs.h:5546
twobyte GetFirstPageTopMargin() const
Returns the top page margin for the first page.
Definition: ff_prefs.h:3522
TimeEdu16 GetPickupDuration() const
Returns the duration of the pickup measure (in EDUs). 0 if no pickup measure.
Definition: ff_prefs.h:2176
void SetSymbolTrill(eUniChar32 value)
Sets the default trill (tr) character.
Definition: finaleframework.cpp:28670
void SetGuideLineStyle(GGLINESTYLES value)
Sets the line style that should be used for guides.
Definition: ff_prefs.h:11063
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:449
twobyte GetFirstSystemTop() const
Returns the top system margin for the first system.
Definition: ff_prefs.h:3431
Contains the lyrics preferences data.
Definition: ff_prefs.h:9400
twobyte GetNameByID()
Gets the internal Enigma font ID. This value is document-specific.
Definition: finaleframework.cpp:3297
The "Program Options" (program-wide options that is not stored in the document).
Definition: ff_prefs.h:3776
twobyte GetMixedStemDirectionType() const
Returns the "Tie direction at mixed stems" type.
Definition: ff_prefs.h:6765
twobyte GetHorizontalShapeOffset() const
Returns the horizontal shape offset.
Definition: ff_prefs.h:2934
void SetThicknessRight(Evpu16 value)
Returns the right-side tie thickness.
Definition: ff_prefs.h:6837
bool GetEngraverSlurAvoidAccidentals() const
Returns if the engraver slur should avoid accidentals.
Definition: ff_prefs.h:5254
bool GetUseRestOffsetInMultiple() const
Returns true if the vertical rest offset should be used only if multiple layers have music...
Definition: ff_prefs.h:7113
CHORDSTYLES GetStyle() const
Returns the chord style to use for the document.
Definition: ff_prefs.h:7433
Class for the "Page Format for Score/Parts" preference data.
Definition: ff_prefs.h:3333
void SetAugmentationDotSpace(twobyte value)
Sets the default space between each augmentation dot.
Definition: ff_prefs.h:1194
twobyte GetNumberHorizontalAdjust() const
Returns the horizontal adjustment for multimeasure rests numbers.
Definition: ff_prefs.h:4954
Contains data that are specific to one part scope. Each part have their own records, and the part scope needs to be switched prior to a load/save.
Definition: ff_prefs.h:9347
void SetSymbolSecondFlagDown(eUniChar32 value)
Sets the symbol for Second Downstem Flag.
Definition: ff_prefs.h:8758
void SetLedgerRightRestHalf(Evpu16 value)
Sets the document setting for ledger line right half rest length in EFIXes.
Definition: ff_prefs.h:1677
Definition: ff_prefs.h:4649
Efix16 GetHairpinLineWidth() const
Returns the hairpin line width, in EFIXes.
Definition: ff_prefs.h:5184
virtual const char * ClassName()
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_prefs.h:2761
virtual void * Allocate()=0
void SetSlurTipWidth(fourbyte value)
Sets the slur tip width (in 1/10,000 of an EVPU)
Definition: ff_prefs.h:5693
Efix16 GetStemLineThickness() const
Returns the document setting for the stem line thickness, in EFIXes.
Definition: ff_prefs.h:1600
bool GetUseSymbols() const
Returns if sumbols should be activated for MM rests.
Definition: ff_prefs.h:4935
void SetWingStyle(REPEATWINGSTYLES style)
Returns the wing styles for repeats barlines.
Definition: ff_prefs.h:10461
FCGroupNamePositionPrefs()
The constructor.
Definition: ff_prefs.h:7647
void SetAugmentationDotUpstemAdjust(twobyte value)
Sets the default horizontal adjustment for augmentation dots attached to upstem flags.
Definition: ff_prefs.h:1212
Definition: ff_prefs.h:10191
void SetGridColorBlue(utwobyte value)
Returns the blue color status of the grid, which is part of the RGB value.
Definition: ff_prefs.h:10969
void SetAvoidStaffLinesDistance(Evpu16 value)
Sets the EVPU distance for how much to avoid staff lines vertically (in the tie contour options)...
Definition: ff_prefs.h:6988
twobyte GetAccidentalVertical() const
Returns the vertical spacing between accidentals, in spaces.
Definition: ff_prefs.h:1095
fourbyte GetVerticalInnerBody() const
Returns the vertical position for the inner body, in 1/10000 of an EVPU.
Definition: ff_prefs.h:11258
eUniChar32 GetSymbolLongaRest() const
Returns the default symbol character for longa rests.
Definition: finaleframework.cpp:28526
eUniChar32 GetSymbolBackwardRepeatDot() const
Returns the symbol for backward repeat dots.
Definition: finaleframework.cpp:28518
void SetShapeEndAdjust(twobyte value)
Sets the right-side adjustment for shapes.
Definition: ff_prefs.h:5029
virtual bool Save()
Saves the currently loaded to its current location.
Definition: finaleframework.cpp:28377
void SetSystemLeftHorizontalOffset(Evpu16 value)
Sets the value for "Tie system break, horizontal start adjustment".
Definition: ff_prefs.h:6885
void SetJustification(FLAG_16 justification)
Sets the default justification for the group text.
Definition: ff_prefs.h:7720
void SetTimeSigBottomVertical(Evpu16 value)
Sets the vertical adjustment of bottom time sig symbol from bottom staff line, for the score...
Definition: ff_prefs.h:1242
void SetBackToBackStyle(REPEATBACKTOBACKSTYLES style)
Returns the back-to-back line style.
Definition: ff_prefs.h:10419
void SetBeamSlopeStyle(BEAMSLOPESTYLES mode)
Sets the beam slope style.
Definition: ff_prefs.h:2322
virtual void DebugDump()
Outputs the class data/information for debugging purposes.
Definition: ff_prefs.h:5050
void SetRebarWhenTimeSigChanged(bool state)
Sets if measures should rebar when the Time Signature Tool changes the time signature.
Definition: ff_prefs.h:4015
void SetClefChangeOffset(twobyte value)
Sets the space after a clef change and the barline, as a positive value.
Definition: ff_prefs.h:1218
fourbyte GetUnderlineThickness() const
Returns the Underline Thickness option (currently Mac only).
Definition: ff_prefs.h:2201
Evpu16 GetTimeSigPartsTopVertical() const
Returns the vertical adjustment of top time sig symbol from top staff line, for the parts...
Definition: ff_prefs.h:981
twobyte GetVerticalWholeSlashBaseline() const
Returns the whole note diamond baseline adjustment value (for rhythmical notation), in EVPUs.
Definition: ff_prefs.h:8597
Evpu16 GetKeySpaceAfter() const
Returns the space after key signature, in EVPUs.
Definition: ff_prefs.h:1023
Definition: ff_prefs.h:4727
twobyte GetTiesGutter() const
Returns the adjustment before ties directly after a system break (which affects the beat chart)...
Definition: ff_prefs.h:4282
void SetTimeSigLeftHorizontalOffset(Evpu16 value)
Returns the "Break for time signatures - left gap" setting.
Definition: ff_prefs.h:6861
twobyte GetGraceNoteSize() const
Returns the grace note resize, in percent.
Definition: ff_prefs.h:1485
void SetKeyTimeExtraSpace(Evpu16 value)
Sets the extra space between key and time signature.
Definition: ff_prefs.h:1414
virtual const PDKFRAMEWORK_CLASSID GetClassID()
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_prefs.h:3806
eUniChar32 GetSymbolLargeSlash() const
Returns the symbol for large slashes in Alternate Notation.
Definition: ff_prefs.h:8231
void SetSymbol16thFlagDown(eUniChar32 character)
Sets the symbol for 16th Note Downstem Flag.
Definition: ff_prefs.h:8774
void SetGuitarBendParentheses(bool state)
Sets the value for Guitar Bend Options - Place Release Bend Number in Parentheses.
Definition: ff_prefs.h:5762
void SetAfterTimeSpace(Evpu16 value)
Returns the "Forward repeat spacing - after time signature" document setting, in EVPUs.
Definition: ff_prefs.h:10485
bool GetEngraverSlurStretchFirst() const
Returns if Engraver Slurs should stretch before lift.
Definition: ff_prefs.h:5276
bool GetBreakForTimeSigs() const
Returns true if the tie should break for time signatures.
Definition: ff_prefs.h:6687
void SetSymbolParSharp(eUniChar32 character)
Sets the default symbol for the sharp accidental within parentheses.
Definition: ff_prefs.h:8855
void SetNumberVerticalAdjust(twobyte value)
Sets the vertical adjustment for multimeasure rests numbers.
Definition: ff_prefs.h:5015
fourbyte GetHorizontalOuterTip() const
Returns the horizontal position for the outer tip, in 1/10000 of an EVPU.
Definition: ff_prefs.h:11267
twobyte GetVerticalStraightFlagUp() const
Returns the vertical adjustment for the straight upstem flag, in EFIXes.
Definition: ff_prefs.h:8500
Definition: ff_prefs.h:10622
void SetTimeSigPartsSpaceBefore(Evpu16 value)
Sets the space before the time signature, in EVPUs, for the parts.
Definition: ff_prefs.h:1332
void SetHairpinDefaultOpening(Evpu16 value)
Sets the default hairpin opening value in the Smart Shape preferences.
Definition: ff_prefs.h:5506
Evpu16 GetSlurThicknessHorizontalLeft() const
Returns slur thickness to the horizontal left, in EVPUs.
Definition: ff_prefs.h:5383
void SetStyle(CHORDSTYLES style)
Sets the chord style to use for the document.
Definition: ff_prefs.h:7444
void SetIgnoreNumberOffset(bool value)
Sets the "Ignore Horizontal Number Offset".
Definition: ff_prefs.h:3151
Definition: ff_prefs.h:4766
int GetCount() const
Returns the number of active stem connections in the array.
Definition: ff_prefs.h:10083
Definition: ff_prefs.h:6231
twobyte GetRightPageRightMargin() const
Returns the right page margin for right-side pages.
Definition: ff_prefs.h:3560
bool GetRespaceMeasureLayout() const
Returns true if measures should reflow within a system at a layout update.
Definition: ff_prefs.h:3874
Evpu16 GetKeyTimeExtraSpace() const
Returns the extra space between key and time signature.
Definition: ff_prefs.h:1159
void SetSymbolSecondFlagUp(eUniChar32 character)
Sets the symbol for Second Upstem Flag.
Definition: ff_prefs.h:8750
bool GetShowActiveLayerOnly() const
Returns the "Show Active Layer Only" option.
Definition: ff_prefs.h:1991
void SetLeftBarlineDisplaySingle(bool state)
Sets if "Left Barlines - Display on Single Staves" is used.
Definition: ff_prefs.h:2420
virtual const PDKFRAMEWORK_CLASSID GetClassID()
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_prefs.h:6280
void SetBracketThickness(Efix16 value)
Return the bracket thickness, in EFIXes.
Definition: ff_prefs.h:3223
eUniChar32 GetSymbolHalfNotehead() const
Returns the default symbol character for half-note noteheads.
Definition: ff_prefs.h:7890
void SetEngraverSlurSymmetryPercent(twobyte value)
Sets the slur symmetry percentage (in 1/100 of a percent) for Engraver Slurs.
Definition: ff_prefs.h:5579
fourbyte GetWidth() const
Returns the width of the brace, in 1/10000 of an EVPU.
Definition: ff_prefs.h:11303
eUniChar32 GetSymbol16thRest() const
Returns the default symbol character for 16th rests.
Definition: ff_prefs.h:7939
void SetVertical128thRest(twobyte value)
Sets the vertical adjustment for 128th note rests,in EVPUs.
Definition: ff_prefs.h:9284
bool GetKeySigNaturalsInC() const
Returns if naturals should be displayed in C at start of staff systems.
Definition: ff_prefs.h:2064
Evpu16 GetHairpinDefaultOpening() const
Returns the default hairpin opening width in the Smart Shape preferences.
Definition: ff_prefs.h:5161
void SetVerticalHalfSlashStemLift(twobyte value)
Sets the half note diamond stem connection lift value (for rhythmical notation), in EVPUs...
Definition: ff_prefs.h:9320
void SetUseStartSystemSyllable(bool state)
Sets if the positioning options (alignment/justification ) for syllables at start of systems should b...
Definition: ff_prefs.h:9703
void SetMaxBeamSlope(Evpu16 slope)
Sets the maximum beam slope, in EVPUs.
Definition: ff_prefs.h:2453
virtual const PDKFRAMEWORK_CLASSID GetClassID()
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_prefs.h:9911
twobyte GetVerticalSecondaryGroupAdjust() const
Returns the "Second Group Adjust" value for flags, in EVPUs.
Definition: ff_prefs.h:8567
Definition: ff_prefs.h:6637
void SetSymbolChordFlat(eUniChar32 character)
Sets the symbol for flat accidentals in chord symbols.
Definition: ff_prefs.h:8888
twobyte GetMaxMeasureWidth() const
Returns the maximum measure width.
Definition: ff_prefs.h:4152
GGLINESTYLES GetGuideLineStyle() const
Returns the line style that should be used for guides.
Definition: ff_prefs.h:10843
void SetSymbolSharp(eUniChar32 character)
Sets the default symbol for the sharp accidental.
Definition: ff_prefs.h:8815
twobyte GetShapeEndAdjust() const
Returns the right-side adjustment for multimeasure shapes.
Definition: ff_prefs.h:4910
void SetEngraverSlurMaxLift(Efix32 maxlift)
Sets the max lift value for Engraver Slurs, in EFIXes.
Definition: ff_prefs.h:5657
Definition: ff_prefs.h:4739
void SetOtherSyllableJustification(twobyte value)
Sets the justification option for other kind of syllables (that aren't covered by other options)...
Definition: ff_prefs.h:9741
void SetHorizontalStraightFlagUp(twobyte value)
Sets the horizontal adjustment for the straight upstem flag, in EFIXes.
Definition: ff_prefs.h:9182
eUniChar32 GetSymbolChordDoubleSharp() const
Returns the symbol for double-sharp accidentals in chord symbols.
Definition: ff_prefs.h:8183
void SetPitchRepresentationValue(twobyte value)
Sets the octave representation number value. The setting is called "Pitch Representation->Middle C" i...
Definition: ff_prefs.h:3944
twobyte GetVertical64thRest() const
Returns the vertical adjustment for 64th note rests, in EVPUs.
Definition: ff_prefs.h:8548
void SetRightRelativeInset(CONTOUR_INDEXES index, float percentvalue)
Sets the right-side inset, as percent.
Definition: ff_prefs.h:6518
twobyte CalcInset(int slurlength)
Calculates and returns the default inset value based on the slur lengths.
Definition: ff_prefs.h:5847
void SetThinBarlineThickness(Efix16 value)
Sets the document setting for thin barline thickness in EFIXes.
Definition: ff_prefs.h:1635
bool GetCourtesyClefAtSystemEnd() const
Returns if courtesy clefs should be displayed at the end of systems.
Definition: ff_prefs.h:2114
Definition: ff_prefs.h:4751
void SetAvoidSystemMarginCollisions(bool state)
Sets the "Avoid Margin Collision" setting in the Layout menu.
Definition: ff_prefs.h:2670
void SetShapeSlurTipWidth(fourbyte value)
Sets the document setting for the shape designer slur tip width, in 1/10000 EVPUs.
Definition: ff_prefs.h:1701
bool GetUseStraightFlags() const
Returns the if straight flags should be used.
Definition: ff_prefs.h:8428
void SetSymbolWholeSlashDiamond(eUniChar32 character)
Sets the symbol for whole note diamond in Alternate Notation.
Definition: ff_prefs.h:8985
Definition: ff_prefs.h:6621
void SetLeftPageLeftMargin(twobyte value)
Sets the left page margin for all/left-side pages.
Definition: ff_prefs.h:3660
Evpu16 GetTimeSigLeftHorizontalOffset() const
Returns the "Break for time signatures - left gap" setting.
Definition: ff_prefs.h:6699
bool GetGuitarBendReplaceWithFull() const
Returns the value for Guitar Bend Options - Replace "1" with "Full".
Definition: ff_prefs.h:5448
bool GetCloseBarlineAtSystem() const
Returns true if "Close Barline at End of Each System" is used.
Definition: ff_prefs.h:1931
eUniChar32 GetNoteheadCharacter(int connectionID) const
Returns the font character for the notehead that has the stem connection data.
Definition: finaleframework.cpp:29617
void SetTimeSigCompositeDecimals(twobyte count)
Sets how many decimals composite time signatures should have in the fraction part.
Definition: ff_prefs.h:2536
bool CopyFromRest(FCMultiMeasureRest *pRest)
Copies a multimeasure rest object to the preference definition.
Definition: finaleframework.cpp:29125
Evpu16 GetSlurThicknessHorizontalRight() const
Returns slur thickness to the horizontal right, in EVPUs.
Definition: ff_prefs.h:5401
void SetRightFixedInset(CONTOUR_INDEXES index, Evpu16 value)
Sets the right-side inset, as an absolute value.
Definition: ff_prefs.h:6559
twobyte GetSymbolSpace() const
Returns the space between mm rest symbols (in EVPUs).
Definition: ff_prefs.h:4929
eUniChar32 GetSymbolCommonTimeSigParts() const
Returns the symbol character used for the abbreviated common time signature for parts.
Definition: finaleframework.cpp:28502
virtual const PDKFRAMEWORK_CLASSID GetClassID()
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_prefs.h:9795
void SetSymbolHalfSlashDiamond(eUniChar32 character)
Sets the symbol for half note diamond in Alternate Notation.
Definition: ff_prefs.h:8977
fourbyte GetDefaultStemLift() const
Returns the default vertical stem lift value, in EFIXes.
Definition: ff_prefs.h:8422
bool GetUseFacingPages() const
Returns true if the separate settings for right-page margins should be used.
Definition: ff_prefs.h:3528
void SetHorizontalSecondFlagDown(twobyte value)
Sets the horizontal adjustment for the second downstem flag, in EFIXes.
Definition: ff_prefs.h:9194
bool GetUseBottomNote() const
Returns the "Use Bottom Note" state.
Definition: ff_prefs.h:2846
bool GetUseRestOffset() const
Returns true if the vertical rest offset should be used.
Definition: ff_prefs.h:7106
Definition: ff_prefs.h:10188
void SetGuideShow(bool state)
Sets if guides should display.
Definition: ff_prefs.h:11010
void SetBrokenBeamLength(Evpu16 value)
Sets the document setting for broken beam length, in EVPUs.
Definition: ff_prefs.h:1683
void SetVerticalFlagSpacing(twobyte value)
Sets the "Flag Spacing" value, in EVPUs.
Definition: ff_prefs.h:9290
void SetUnderlineDepth(fourbyte value)
Sets the Underline Depth option (currently Mac only).
Definition: ff_prefs.h:2646
virtual const PDKFRAMEWORK_CLASSID GetClassID()
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_prefs.h:10215
void SetFirstSystemDistance(twobyte value)
Sets the first system distance to top.
Definition: ff_prefs.h:3735
LYRICS_ALIGNMENTS
The alignment values for syllable positioning.
Definition: ff_prefs.h:9438
Efix16 GetGraceSlashThickness() const
Returns the document setting for grace note slash thickness in EFIXes.
Definition: ff_prefs.h:1491
void SetAlternateWholeDiamondVertical(twobyte value)
Sets the value for Alternate Notation: Rhythmic Notation Vertical Positioning - Whole Note Diamond Ba...
Definition: ff_prefs.h:1382
Evpu16 GetAfterTimeSpace() const
Returns the "Forward repeat spacing - after time signature" document setting, in EVPUs.
Definition: ff_prefs.h:10317
void SetUseSmartHyphens(bool state)
Sets if smart hyphens should be used.
Definition: ff_prefs.h:9622
CMPER GetCustomLineDefID() const
Returns the default custom startshape definition ID for custom smartshape lines.
Definition: ff_prefs.h:5117
twobyte GetSlopeAdjust() const
Returns the "Manual Slope Adjustment" value.
Definition: ff_prefs.h:2976
virtual const PDKFRAMEWORK_CLASSID GetClassID()
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_prefs.h:4090
void SetUseWordExtSyllable(bool state)
Sets if the positioning options (alignment/justification ) for syllables with word extensions should ...
Definition: ff_prefs.h:9649
Evpu16 GetKeySigRightHorizontalOffset() const
Returns the "Break for key signatures - right gap" setting.
Definition: ff_prefs.h:6717
bool GetAvoidHiddenNotes() const
Returns true if Avoid Hidden Notes is used.
Definition: ff_prefs.h:4182
virtual const PDKFRAMEWORK_CLASSID GetClassID()
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_prefs.h:7064
void SetSystemScaling(twobyte value)
Returns the system scaling in percent.
Definition: ff_prefs.h:3729
void SetSymbolQuarterNotehead(eUniChar32 character)
Sets the default symbol character for filled "quarter note" noteheads.
Definition: ff_prefs.h:8620
Definition: ff_prefs.h:4646
void SetVerticalOuterTip(fourbyte position)
Sets the vertical position for the outer tip, in 1/10000 of an EVPU.
Definition: ff_prefs.h:11379
void SetSwing(twobyte value)
Returns the playback swing value.
Definition: ff_prefs.h:851
void SetAfterMultipleDots(bool state)
Sets if the tie should start after multiple dots.
Definition: ff_prefs.h:6970
void SetKeySigOnlyFirstSystem(bool state)
Sets if the clef should be displayed only on first staff system.
Definition: ff_prefs.h:2496
bool ChangeTuplet(FCTuplet *pTuplet, bool changeposition=true)
Copies the default tuplet definition to a tuplet.
Definition: finaleframework.cpp:28770
bool GetPrimaryBeamWithinSpace() const
Returns the state of the "Allow Primary Beam Within a Space" beam option.
Definition: ff_prefs.h:1850
void SetVerticalStraightFlagUp(twobyte value)
Sets the vertical adjustment for the straight upstem flag, in EFIXes.
Definition: ff_prefs.h:9230
bool GetUseFirstSystemMargins() const
Returns true if the first system should have special margins.
Definition: ff_prefs.h:3467
void SetVertical8thRest(twobyte value)
Sets the vertical adjustment for 8th note rests,in EVPUs.
Definition: ff_prefs.h:9260
Evpu16 GetNaturalBaselineAdjustment() const
Returns the "Chord Alteration Baseline Adjustment" for naturals (in EVPUs).
Definition: ff_prefs.h:7388
void SetPitchRepresentationType(twobyte value)
Sets the preferred Pitch representation type for MIDI notes in Finale. The setting is called "Pitch R...
Definition: ff_prefs.h:3931
eUniChar32 GetSymbolCommonTimeSigScore() const
Returns the symbol character used for the abbreviated common time signature for the score...
Definition: finaleframework.cpp:28470
Definition: ff_prefs.h:4697
fourbyte GetHorizontalOuterBody() const
Returns the horizontal position for the outer body, in 1/10000 of an EVPU.
Definition: ff_prefs.h:11285
twobyte GetShapeStartAdjust() const
Returns the left-side adjustment for multimeasure shapes.
Definition: ff_prefs.h:4916
Efix32 GetGridDistance() const
Returns the distance between each grid element, in EFIXes.
Definition: finaleframework.cpp:29251
virtual const char * ClassName()
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_prefs.h:4879
twobyte GetSystemScaling() const
Returns the system scaling in percent.
Definition: ff_prefs.h:3572
fourbyte GetFretboardsResizeFraction() const
Returns the fretboard resize value, in 10000th of a percent.
Definition: ff_prefs.h:2207
MANUAL_POSITIONING GetManualPositioning() const
Returns the options for how to treat manual positioned notes.
Definition: ff_prefs.h:4245
void SetVerticalTopDotAdjustment(Evpu16 value)
Sets the top repeat dot adjustment, in EVPUs.
Definition: ff_prefs.h:10447
Contains the document options for size and widths.
Definition: ff_prefs.h:1435
bool GetUseStartSystemSyllable() const
Returns if the positioning options (alignment/justification ) for syllables at start of systems shoul...
Definition: ff_prefs.h:9576
void SetLeftFixedInset(CONTOUR_INDEXES index, Evpu16 value)
Sets the left-side inset, as an absolute value.
Definition: ff_prefs.h:6498
Evpu16 GetLineDashSpace() const
Returns the default dash space, if EVPUs.
Definition: ff_prefs.h:5208
void SetSymbolOctave(eUniChar32 value)
Sets the default octava (8va) character.
Definition: finaleframework.cpp:28694
Evpu16 GetLedgerRightHalf() const
Returns the document setting for ledger line right half length in EFIXes.
Definition: ff_prefs.h:1540
Definition: ff_prefs.h:10613
Definition: ff_prefs.h:9443
twobyte GetAugmentationDotNoteSpace() const
Returns the default horizontal space between augmentation dot and note.
Definition: ff_prefs.h:945
void SetAfterKeySpace(Evpu16 value)
Returns the "Forward repeat spacing - after key signature" document setting, in EVPUs.
Definition: ff_prefs.h:10479
twobyte GetFirstSyllableJustification() const
Returns the justification option for first syllables.
Definition: ff_prefs.h:9569
fourbyte GetTipThickness() const
Returns the tip thickness, in 1/10000 of an EVPU.
Definition: ff_prefs.h:11321
void SetRecalcMeasures(bool state)
Sets if measure layout should be recalculated when the layout is updated.
Definition: ff_prefs.h:4000
Evpu16 GetSlurTipAvoidStaffAmount() const
Returns if slur tips should avoid staff lines.
Definition: ff_prefs.h:5372
twobyte GetAugmentationDotUpstemAdjust() const
Returns the default horizontal adjustment for augmentation dots attached to upstem flags...
Definition: ff_prefs.h:957
void SetVerticalInnerBody(fourbyte position)
Sets the vertical position for the inner body, in 1/10000 of an EVPU.
Definition: ff_prefs.h:11361
eUniChar32 GetSymbolStraightFlagDown() const
Returns the symbol for Straight Downstem Flag.
Definition: ff_prefs.h:8062
eUniChar32 GetSymbolOctaveBass() const
Returns the default octava bass (8vb) character.
Definition: finaleframework.cpp:28570
void SetEndingInsetEnd(twobyte value)
Sets the inset for the ends of bracket.
Definition: ff_prefs.h:10521
void SetVerticalBrevisSlashBaseline(twobyte value)
Sets the brevis (double-whole) note diamond baseline adjustment value (for rhythmical notation)...
Definition: ff_prefs.h:9332
Efix32 GetEngraverSlurMaxStretchFixed() const
Returns the Engraver Slur max stretch value for fixed stretches, in EFIXes.
Definition: ff_prefs.h:5305
Definition: ff_prefs.h:10643
bool GetItalicizeCapoChords() const
Returns the "Italicize Capo Chords" setting (in the Chord menu).
Definition: ff_prefs.h:2007
bool GetHalfStemsForBeamedRests() const
Returns the state of the "Display Half-stems for Beamed Rests" beam option.
Definition: ff_prefs.h:1857
Evpu16 GetRightFixedInset(CONTOUR_INDEXES index)
Returns the right-side inset, as an absolute value.
Definition: ff_prefs.h:6413
void SetSharpBaselineAdjustment(Evpu16 value)
Sets the "Chord Alteration Baseline Adjustment" for sharps (in EVPUs).
Definition: ff_prefs.h:7399
void SetNormalStemLength(Evpu16 value)
Sets the document setting for normal stem lengths, in EVPUs.
Definition: ff_prefs.h:1707
void SetSymbol8thRest(eUniChar32 character)
Sets the default symbol character for 8th rests.
Definition: ff_prefs.h:8685
virtual const PDKFRAMEWORK_CLASSID GetClassID()
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_prefs.h:912
twobyte GetFirstSyllableAlignment() const
Returns the alignment option for first syllables.
Definition: ff_prefs.h:9559
virtual const char * ClassName()
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_prefs.h:6025
void SetTiesGutter(twobyte value)
Sets the adjustment before ties directly after a system break (which affects the beat chart)...
Definition: ff_prefs.h:4542
Class that contains the guides for a document. This class is handled through the FCGridsGuidesPrefs c...
Definition: ff_othercollection.h:2065
eUniChar32 GetSymbolOneBarRepeat() const
Returns the symbol for one-bar repeats in Alternate Notation.
Definition: ff_prefs.h:8271
void SetAvoidArticulations(bool state)
Sets if Avoid Articulations is used or not.
Definition: ff_prefs.h:4393
void SetBeamedCommonTimeEights(bool state)
Sets the state of the "Beam 4 eights in 4/4" document option.
Definition: ff_prefs.h:2380
eUniChar32 GetSymbolDoubleFlat() const
Returns the default symbol for the double-flat accidental.
Definition: ff_prefs.h:8095
eUniChar32 GetSymbolSecondFlagUp() const
Returns the symbol for Second Upstem Flag.
Definition: ff_prefs.h:8022
void SetVerticalSecondFlagUp(twobyte value)
Sets the vertical adjustment for the second upstem flag, in EFIXes.
Definition: ff_prefs.h:9218
void SetAfterClefSpace(Evpu16 value)
Returns the "Forward repeat spacing - after clef signature" document setting, in EVPUs.
Definition: ff_prefs.h:10473
Definition: ff_prefs.h:9455
FCMiscDocPrefs()
The constructor.
Definition: ff_prefs.h:1826
Definition: ff_prefs.h:4754
Class for preferences values that controls distances (between objects, etc)
Definition: ff_prefs.h:883
Definition: ff_prefs.h:10634
void SetUseFirstSystemMargins(bool value)
Sets if the first system should have special margins or not.
Definition: ff_prefs.h:3624
Evpu16 GetMaxSpaceBetweenHyphens() const
Returns the maximum space between hyphens, in EVPUs.
Definition: ff_prefs.h:9509
Evpu16 GetSpan(CONTOUR_INDEXES index)
Returns the horizontal span value for the contour definition.
Definition: ff_prefs.h:6298
twobyte GetMinimumDistanceWithTies() const
Returns the minimum distance between notes with ties.
Definition: ff_prefs.h:4146
fourbyte GetHorizontalInnerBody() const
Returns the horizontal position for the inner body, in 1/10000 of an EVPU.
Definition: ff_prefs.h:11249
void SetVerticalOuterBody(fourbyte position)
Sets the vertical position for the outer body, in 1/10000 of an EVPU.
Definition: ff_prefs.h:11397
bool LoadFull()
Loads the full name positioning data.
Definition: ff_prefs.h:7658
void SetBreakSlurBracket(bool value)
Sets the "Break slur or bracket" state.
Definition: ff_prefs.h:3093
Definition: ff_prefs.h:4748
twobyte GetMetronomeBeat() const
Returns the metronome beat (in EDUs).
Definition: ff_prefs.h:780
void SetGraceNoteSpacing(Evpu16 value)
Sets the horizontal grace note spacing, in EVPUs.
Definition: ff_prefs.h:1401
twobyte GetNumberVerticalAdjust() const
Returns the horizontal adjustment for multimeasure rests numbers.
Definition: ff_prefs.h:4962
void SetSymbolParNatural(eUniChar32 character)
Sets the default symbol for the natural accidental within parentheses.
Definition: ff_prefs.h:8839
void SetEngraverSlurStretchByPercent(bool state)
Sets if Engraver Slur stretches should be made in percent or absolute.
Definition: ff_prefs.h:5630
int _loadedsize
Loaded size of the data block for a loaded object, in bytes. Since the datablock is implementation-sp...
Definition: ff_base.h:653
void SetSymbolBackwardRepeatDot(eUniChar32 value)
Sets the symbol for backward repeat dots.
Definition: finaleframework.cpp:28654
void SetHairpinLineWidth(Efix16 value)
Sets the hairpin line width, in EFIXes.
Definition: ff_prefs.h:5528
void SetLeftRelativeInset(CONTOUR_INDEXES index, float percentvalue)
Sets the left-side inset, as percent.
Definition: ff_prefs.h:6457
virtual const PDKFRAMEWORK_CLASSID GetClassID()
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_prefs.h:4880
virtual const PDKFRAMEWORK_CLASSID GetClassID()
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_prefs.h:6026
twobyte GetVertical16thRest() const
Returns the vertical adjustment for 16th note rests, in EVPUs.
Definition: ff_prefs.h:8536
void SetExtendSecondaryBeamsOverRests(bool state)
Sets the state of the "Extend Secondary Beams Over Rests" beam option.
Definition: ff_prefs.h:2274
Definition: ff_prefs.h:4670
void SetHorizontalSecondFlagUp(twobyte value)
Sets the horizontal adjustment for the second upstem flag, in EFIXes.
Definition: ff_prefs.h:9170
void SetTipThickness(fourbyte thickness)
Sets the tip thickness, in 1/10000 of an EVPU.
Definition: ff_prefs.h:11424
twobyte GetHorizontalFirstFlagDown() const
Returns the horizontal adjustment for the first downstem flag, in EFIXes.
Definition: ff_prefs.h:8458
eUniChar32 GetSymbolChordDoubleFlat() const
Returns the symbol for double-flat accidentals in chord symbols.
Definition: ff_prefs.h:8175
void SetSymbolChordDoubleFlat(eUniChar32 character)
Sets the symbol for double-flat accidentals in chord symbols.
Definition: ff_prefs.h:8904
bool GetUseNoteShapes() const
Sets if note shape should be used.
Definition: ff_prefs.h:2170
bool GetAvoidArticulations() const
Returns true if Avoid Articulations is used.
Definition: ff_prefs.h:4164
void SetFinalBarlineAtEnd(bool state)
Sets if "final barline at end" is used.
Definition: ff_prefs.h:2414
Evpu16 GetAvoidStaffLinesDistance() const
Returns the EVPU distance for how much to avoid staff lines vertically (in the tie contour options)...
Definition: ff_prefs.h:6795
virtual const PDKFRAMEWORK_CLASSID GetClassID()
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_prefs.h:1463
Class for the 6 document sets of options that control default tie placement.
Definition: ff_prefs.h:5949
void SetClefSpaceAfter(Evpu16 value)
Sets the space after clef, in EVPUs.
Definition: ff_prefs.h:1302
bool GetAvoidLyrics() const
Returns true if Avoid Lyrics is used.
Definition: ff_prefs.h:4194
eUniChar32 GetSymbolFirstFlagUp() const
Returns the symbol for First Upstem Flag.
Definition: ff_prefs.h:8006
GGLINESTYLES
The line styles for grids and guides.
Definition: ff_prefs.h:10656
Evpu16 GetForwardSpace() const
Returns the space between repeat dot and repeat lines in forward repeats, in EVPUs.
Definition: ff_prefs.h:10266
Evpu16 GetSlurBreakSystemStart() const
Returns the horizontal system start adjustment for slur system breaks. In EVPUs.
Definition: ff_prefs.h:5332
Definition: ff_prefs.h:4745
twobyte GetAlternateWholeDiamondVertical() const
Returns the value for Alternate Notation: Rhythmic Notation Vertical Positioning - Whole Note Diamond...
Definition: ff_prefs.h:1127
Base class for all data-related classes (that handles Finale data).
Definition: ff_base.h:628
twobyte GetLeftPageBottomMargin() const
Returns the bottom page margin for all/left-side pages.
Definition: ff_prefs.h:3497
twobyte GetHorizontalOffset() const
Returns the horizontal tuplet offset.
Definition: ff_prefs.h:2910
Evpu16 GetVerticalPos() const
Returns the default vertical position for the group text.
Definition: ff_prefs.h:7676
Evpu16 GetHalfStemLength() const
Returns the document setting for half-stem lengths, in EVPUs.
Definition: ff_prefs.h:1588
Contains the document options for music character preferences.
Definition: ff_prefs.h:7798
void SetNumberOffsetDownstem(twobyte value)
Sets the Horizontal Number Offset/Downstem side of notes.
Definition: ff_prefs.h:3214
void SetSymbolParDoubleSharp(eUniChar32 character)
Sets the default symbol for the double-sharp accidental within parentheses.
Definition: ff_prefs.h:8871
MEASUREMENTUNITS
Constants for Finale's standard measurement units.
Definition: ff_base.h:212
twobyte GetEndingInsetStart() const
Returns the inset for the starts of bracket.
Definition: ff_prefs.h:10347
void SetUseFacingPages(bool state)
Sets if the separate settings for right-page margins should be used, or not.
Definition: ff_prefs.h:3685
void SetUseRestOffsetInMultiple(bool state)
Sets if the vertical rest offset should be used only if multiple layers have music.
Definition: ff_prefs.h:7191
twobyte GetSize() const
Returns the font size as an integer number.
Definition: ff_base.h:1115
Efix32 GetEngraverSlurMaxLift() const
Returns the max lift value for Engraver Slurs, in EFIXes.
Definition: ff_prefs.h:5314
FCLyricsPrefs()
The constructor.
Definition: ff_prefs.h:9486
eUniChar32 GetSymbolSecondFlagDown() const
Returns the symbol for Second Downstem Flag.
Definition: ff_prefs.h:8030
twobyte GetRightExtension() const
Returns the "Right extension" value.
Definition: ff_prefs.h:2970
FCChordPrefs()
The constructor.
Definition: ff_prefs.h:7324
void SetAvoidChords(bool state)
Sets if Avoid Chords is used or not.
Definition: ff_prefs.h:4399
twobyte GetMediumSpan()
Returns the defined distance for the medium span slur.
Definition: ff_prefs.h:5919
twobyte GetVerticalTwoMeasureRepeatOffset() const
Returns the vertical value offset for two-bar repeats, in EVPUs.
Definition: ff_prefs.h:8609
void SetMatchHookLengths(bool value)
Sets the "Match lengths of hooks" state.
Definition: ff_prefs.h:3169
bool GetMatchHookLengths() const
Returns the "match length of hooks" state.
Definition: ff_prefs.h:2946
void SetMinMeasureWidth(twobyte value)
Sets the minimum measure width.
Definition: ff_prefs.h:4387
void SetBarlineDashSpace(Evpu32 value)
Sets the barline dash space, in EVPUs.
Definition: ff_prefs.h:1266
void SetBeamMaxDistance(twobyte value)
Sets the Max Distance from Middle Staff Line, in spaces.
Definition: ff_prefs.h:1395
Evpu16 GetVerticalPos() const
Returns the default vertical position for the staff text.
Definition: ff_prefs.h:7530
twobyte GetLeftPageLeftMargin() const
Returns the left page margin for all/left-side pages.
Definition: ff_prefs.h:3503
void SetHorizontalStart(TIEPLACEMENT_INDEXES placementtype, Evpu16 offsetvalue)
Sets the start (left-side) horizontal placement position for the specific tie placement type...
Definition: ff_prefs.h:6134
void SetDefaultClefIndex(eClef clef)
Sets the default clef index.
Definition: ff_prefs.h:2465
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:390
virtual const char * ClassName()
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_prefs.h:11216
void SetGridDistance(Efix32 value)
Sets the distance between each grid element, in EFIXes.
Definition: finaleframework.cpp:29354
virtual bool LoadFirst()
Loads the very first element in the database, if any.
Definition: ff_prefs.h:706
bool GetAutomaticUpdateLayout() const
Returns true if "Automatic Update Layout" is set in the Program Options.
Definition: ff_prefs.h:3880
virtual const char * ClassName()
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_prefs.h:7857
eUniChar32 GetSymbol128thRest() const
Returns the default symbol character for 128th rests.
Definition: ff_prefs.h:7915
void SetClefSpaceBefore(Evpu16 value)
Sets the space before clef, in EVPUs.
Definition: ff_prefs.h:1296
bool GetDisplayPartExpressions() const
Returns the "Display Expressions for Parts" option state.
Definition: ff_prefs.h:2189
virtual void DebugDump()
Outputs the class data/information for debugging purposes.
Definition: ff_prefs.h:10130
twobyte GetLeftExtension() const
Returns the "left extension" value.
Definition: ff_prefs.h:2958
void SetSymbolSmallSlash(eUniChar32 character)
Sets the symbol for small slashes in Alternate Notation.
Definition: ff_prefs.h:8969
void SetEngraverSlurAvoidAccidentals(bool state)
Sets if the engraver slurs should avoid accidentals.
Definition: ff_prefs.h:5597
void SetWordExtLineThickness(Efix16 value)
Sets the word extension line thickness, in EFIXes.
Definition: ff_prefs.h:9642
void SetHorizontalFirstFlagUp(twobyte value)
Sets the horizontal adjustment for the first upstem flag, in EFIXes.
Definition: ff_prefs.h:9164
twobyte GetExtraLongSpan()
Returns the defined distance for the extra long span slur.
Definition: ff_prefs.h:5931
Definition: ff_prefs.h:1794
TIE_MIXED_STEM_TYPES
Constants for tie direction at mixed stems.
Definition: ff_prefs.h:6648
void SetNameByID(twobyte id)
Sets the font name by using the document's internal Enigma font ID.
Definition: finaleframework.cpp:3330
virtual const char * ClassName()
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_prefs.h:4089
void SetStemLineThickness(Efix16 value)
Sets the document setting for the stem line thickness, in EFIXes.
Definition: ff_prefs.h:1731
REPEATBACKTOBACKSTYLES GetBackToBackStyle() const
Returns the back-to-back line style.
Definition: ff_prefs.h:10259
FCDistancePrefs()
The constructor.
Definition: ff_prefs.h:918
twobyte GetVerticalFirstFlagUp() const
Returns the vertical adjustment for the first upstem flag, in EFIXes.
Definition: ff_prefs.h:8482
void SetUseStraightFlags(bool state)
Sets the if straight flags should be used.
Definition: ff_prefs.h:9158
bool GetFreezeTiesSameDirection() const
Returns the "Freeze ties in the Same Direction as Stems" state.
Definition: ff_prefs.h:7137
FCGuides * GetHorizontalGuides()
Returns a pointer to the collection object that contains the horizontal guides.
Definition: finaleframework.cpp:29223
Evpu16 GetNormalStemLength() const
Returns the document setting for normal stem lengths, in EVPUs.
Definition: ff_prefs.h:1576
bool GetEngraverTuplet() const
Returns the "Engraver Tuplet" state.
Definition: ff_prefs.h:2827
Evpu16 GetFlatBaselineAdjustment() const
Returns the "Chord Alteration Baseline Adjustment" for flats (in EVPUs).
Definition: ff_prefs.h:7379
virtual bool Save()
Special saving mechanism for loading the complete stem connection table.
Definition: finaleframework.cpp:29598
void SetEngraverSlurStretchFirst(bool state)
Sets if Engraver Slurs should stretch before lift.
Definition: ff_prefs.h:5619
Definition: ff_prefs.h:757
bool GetIgnoreNumberOffset() const
Returns the "Ignore Horizontal Number Offset" state.
Definition: ff_prefs.h:2928
bool GetUseFirstPageTopMargin() const
Returns true if a different top margin should be used on the first page.
Definition: ff_prefs.h:3515
Definition: ff_prefs.h:4673
void SetUseStemConnections(bool state)
Sets if the stem connection table is used for the document or not.
Definition: ff_prefs.h:2353
void SetBackwardSpace(Evpu16 value)
Sets the space between repeat dot and repeat lines in backward repeats, in EVPUs. ...
Definition: ff_prefs.h:10441
void SetDisplayAllBarlines(bool state)
Sets if "Display All Barlines" is used.
Definition: ff_prefs.h:2395
Definition: ff_prefs.h:9440
void SetThinLineThickness(Efix16 value)
Sets the thin line thickness for repeat barlines, in EFIXes.
Definition: ff_prefs.h:10405
void SetEndingVerticalText(Evpu16 value)
Sets default vertical positioning for ending text.
Definition: ff_prefs.h:10533
bool GetAutoUpdate() const
Returns the state of the "Update Automatically" option for MM rests.
Definition: ff_prefs.h:4923
PLAYBACKSTARTMODE GetStartMode() const
Returns the start playback mode.
Definition: ff_prefs.h:819
Definition: ff_prefs.h:9478
bool GetBeforeSingleAccidental() const
Returns if the tie should end before a single accidental.
Definition: ff_prefs.h:6783
twobyte GetAlternateHalfDiamondVertical() const
Returns the value for Alternate Notation: Rhythmic Notation Vertical Positioning - Half Note Diamond ...
Definition: ff_prefs.h:1120
FCTieContourPrefs()
The constructor.
Definition: ff_prefs.h:6286
bool GetOctavesAsText() const
Returns the flag for if octavas should display as text instead of a symbol.
Definition: ff_prefs.h:5220
virtual __FCBaseData * CreateObject()=0
Creates a new instance of the object.
utwobyte GetGuideColorRed() const
Returns the red color status of the guide, which is part of the RGB value.
Definition: ff_prefs.h:10812
Evpu16 GetGroupBracketDefaultDistance() const
Returns the default horizontal distance for group brackets from the edge of the staff.
Definition: ff_prefs.h:1153
Definition: ff_prefs.h:6228
twobyte GetHorizontalSecondFlagUp() const
Returns the horizontal adjustment for the second upstem flag, in EFIXes.
Definition: ff_prefs.h:8440
void SetGridSnap(bool state)
Sets if items should snap to the grid.
Definition: ff_prefs.h:10928
bool GetRetainFrozenMeasures() const
Return true if frozen systems should be retained when the layout is updated.
Definition: ff_prefs.h:3889
void SetSpan(CONTOUR_INDEXES index, Evpu16 value)
Sets the horizontal span value for the contour definition.
Definition: ff_prefs.h:6437
void SetAlternateHalfDiamondVertical(twobyte value)
Sets the value for Alternate Notation: Rhythmic Notation Vertical Positioning - Half Note Diamond Bas...
Definition: ff_prefs.h:1375
twobyte GetVerticalQuarterSlashBaseline() const
Returns the quarter note (small) slash baseline adjustment value (for rhythmical notation), in EVPUs.
Definition: ff_prefs.h:8573
void SetAvoidStaffLinesOnly(bool state)
Sets the "In Staff Only" state (in the tie contour options). If set, avoid staff lines in staves only...
Definition: ff_prefs.h:7019
fourbyte GetPageHeight() const
Returns the page height.
Definition: ff_prefs.h:3479
bool GetUsePrinterMetrics() const
Returns if printer font metrics should be used instead of screen. Windows only.
Definition: ff_prefs.h:4291
void SetRightPageLeftMargin(twobyte value)
Sets the left page margin for right-side pages.
Definition: ff_prefs.h:3709
Definition: ff_prefs.h:9471
Definition: ff_prefs.h:4763
Definition: ff_prefs.h:4667
twobyte GetVerticalSecondFlagDown() const
Returns the vertical adjustment for the second downstem flag, in EFIXes.
Definition: ff_prefs.h:8512
void SetReverseStemAdjust(Evpu16 value)
Set the document setting for the reverse stem adjustment, in EVPUs.
Definition: ff_prefs.h:1725
bool GetAvoidStaffLines() const
Returns if the tie should avoid staff lines.
Definition: ff_prefs.h:6789
Efix16 GetUpstemVerticalAdjust(int connectionID)
Returns the upstem vertical adjustment for the notehead that has the stem connection data...
Definition: finaleframework.cpp:29632
virtual const char * ClassName()
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_prefs.h:9374
void SetSymbolHalfNotehead(eUniChar32 character)
Sets the default symbol character for half-note noteheads.
Definition: ff_prefs.h:8628
virtual const PDKFRAMEWORK_CLASSID GetClassID()
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_prefs.h:761
twobyte GetLeftPageTopMargin() const
Returns the top page margin for all/left-side pages.
Definition: ff_prefs.h:3491
Class for the document's playback preferences values.
Definition: ff_prefs.h:720
Efix16 GetSpaceBetweenLines() const
Returns the distance between lines in a repeat, in EFIXes.
Definition: ff_prefs.h:10246
void SetSymbolFirstFlagDown(eUniChar32 character)
Sets the symbol for First Downstem Flag.
Definition: ff_prefs.h:8742
Definition: ff_prefs.h:4742
void SetTimeSigSpaceBefore(Evpu16 value)
Sets the space before the time signature, in EVPUs, for the score.
Definition: ff_prefs.h:1326
void SetCustomLineDefID(CMPER idvalue)
Sets the default custom startshape definition ID for custom smartshape lines.
Definition: ff_prefs.h:5462
virtual const PDKFRAMEWORK_CLASSID GetClassID()=0
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
twobyte GetWidth() const
Returns the default width of a MM rest.
Definition: ff_prefs.h:4897
Definition: ff_prefs.h:1816
Evpu16 GetMinimumItemDistance() const
Returns the minimum distance between items, in EVPUs.
Definition: ff_prefs.h:4140
void SetAccidentalVertical(twobyte value)
Sets the vertical spacing between accidentals, in spaces.
Definition: ff_prefs.h:1350
void SetAbbreviateCutTimeSig(bool state)
Sets if cut time signatures should be abbreviated.
Definition: ff_prefs.h:2548
EDataID _dataid
The EdataID for the last loaded/saved object.
Definition: ff_base.h:657
FCLayerPrefs()
The constructor.
Definition: ff_prefs.h:7070
void SetHorizontalEnd(TIEPLACEMENT_INDEXES placementtype, Evpu16 offsetvalue)
Sets the end (right-side) horizontal placement position for the specific tie placement type...
Definition: ff_prefs.h:6174
REPEATBACKTOBACKSTYLES
The visual style when a back and forward repeat appears on the same barline.
Definition: ff_prefs.h:10182
PAGEMARGINSCOPES GetPageMarginScope() const
Returns the margin adjusment scope for "Page Margins" in the Layout menu.
Definition: ff_prefs.h:2233
Class that provides storage for text. This is to achieve platform-transparent text handling...
Definition: ff_base.h:1473
void SetAugmentationDotNoteSpace(twobyte value)
Sets the default horizontal space between augmentation dot and note.
Definition: ff_prefs.h:1200
BEAMSLOPESTYLES GetBeamSlopeStyle() const
Returns the beam slope style.
Definition: ff_prefs.h:1886
Evpu16 GetSystemLeftHorizontalOffset() const
Returns the value for "Tie system break, horizontal start adjustment".
Definition: ff_prefs.h:6723
void SetUseFirstPageTopMargin(bool state)
Sets if a different top margin should be used on the first page.
Definition: ff_prefs.h:3672
Definition: ff_prefs.h:10637
Evpu16 GetEndingBackHookLength() const
Return the default length (height) of back hooks, in EVPUs.
Definition: ff_prefs.h:10335
bool GetCourtesyTimeSigAtSystemEnd() const
Returns if courtesy time signatures should be displayed at the end of systems.
Definition: ff_prefs.h:2120
DATEFORMATS
Date formats to be used with GetDateFormat() and SetDateFormat().
Definition: ff_prefs.h:1772
Evpu16 GetBackwardSpace() const
Returns the space between repeat dot and repeat lines in backward repeats, in EVPUs.
Definition: ff_prefs.h:10273
bool LoadDataBlock()
Loads the data. If the object is of dynamic size, the old memory block is freed and a new is allocate...
Definition: finaleframework.cpp:818
Definition: ff_prefs.h:7310
Evpu16 GetAccidentalNoteSpace() const
Returns the space between accidental and note, in EVPUs.
Definition: ff_prefs.h:1107
void SetSymbol32ndRest(eUniChar32 character)
Sets the default symbol character for 32nd rests.
Definition: ff_prefs.h:8669
virtual const char * ClassName()
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_prefs.h:9910
void SetFirstSystemTop(twobyte value)
Sets the top system margin for the first system.
Definition: ff_prefs.h:3594
Evpu16 GetHookLength() const
Returns the hook length, if EVPUs.
Definition: ff_prefs.h:5214
PLAYBACKSTARTMODE
The playback start modes.
Definition: ff_prefs.h:748
Definition: ff_prefs.h:4706
eUniChar32 GetSymbolDoubleSharp() const
Returns the default symbol for the double-sharp accidental.
Definition: ff_prefs.h:8103
void SetUseSymbolsLessThan(twobyte value)
Sets the threshold measure where symbols should be used instead of shapes.
Definition: ff_prefs.h:4995
bool GetAvoidSystemMarginCollisions() const
Returns the "Avoid Margin Collision" setting in the Layout menu.
Definition: ff_prefs.h:2219
bool GetKeySigCancelOutgoing() const
Returns if outgoing keys should be canceled.
Definition: ff_prefs.h:2076
bool GetBreakForKeySigs() const
Returns true if the tie should break for key signatures.
Definition: ff_prefs.h:6693
void SetAlwaysFlat(bool value)
Sets the "Always Flat" state.
Definition: finaleframework.cpp:29040
Definition: ff_prefs.h:10610
void SetSymbolDoubleSharp(eUniChar32 character)
Sets the default symbol for the double-sharp accidental.
Definition: ff_prefs.h:8831
eUniChar32 GetSymbolHalfSlashDiamond() const
Returns the symbol for half note diamond in Alternate Notation.
Definition: ff_prefs.h:8247
void SetVertical32ndRest(twobyte value)
Sets the vertical adjustment for 32nd note rests,in EVPUs.
Definition: ff_prefs.h:9272
void SetUseTieEndStyle(bool state)
Sets the "Use Tie End Style" state (in the tie contour options).
Definition: ff_prefs.h:7012
utwobyte GetGridColorGreen() const
Returns the green color status of the grid, which is part of the RGB value.
Definition: ff_prefs.h:10760
virtual const char * ClassName()
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_prefs.h:6279
The 4 (short, medium, long, tie ends) tie contour definitions.
Definition: ff_prefs.h:6212
void SetEndingInsetStart(twobyte value)
Sets the inset for the starts of bracket.
Definition: ff_prefs.h:10515
void SetSlurThicknessHorizontalRight(Evpu16 value)
Sets slur thickness to the horizontal right, in EVPUs.
Definition: ff_prefs.h:5744
virtual const char * ClassName()
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_prefs.h:760
Definition: ff_prefs.h:10646
void SetSlurThicknessVerticalRight(Evpu16 value)
Sets slur thickness to the vertical right, in EVPUs.
Definition: ff_prefs.h:5753
Definition: ff_prefs.h:1797
twobyte GetRestOffset() const
Returns the vertical rest offset for the layer.
Definition: ff_prefs.h:7100
bool GetBracketFullDuration() const
Definition: ff_prefs.h:2904
twobyte GetShapeID() const
Returns the shape ID for the MM rest. (For use in the FCShapeDef class.)
Definition: ff_prefs.h:4904
Definition: ff_prefs.h:4721
ePercent GetTablatureGraceNoteSize() const
Returns the document setting for tablature grace note size, in percent.
Definition: ff_prefs.h:1558
Efix16 GetBarlineFinalSpace() const
Returns the space between final barlines, in EFIXes.
Definition: ff_prefs.h:1005
void SetThinInnerBracketReference(bool state)
Sets if the thin inner repeat barline should be used as bracket line reference.
Definition: finaleframework.cpp:29070
void SetFreezeTiesSameDirection(bool state)
Sets the "Freeze ties in the Same Direction as Stems" state.
Definition: ff_prefs.h:7215
void SetVerticalQuarterSlashStemLift(twobyte value)
Sets the quarter note (small) slash stem connection lift value (for rhythmical notation), in EVPUs.
Definition: ff_prefs.h:9308
void SetTimeSigPartsAbbreviatedVertical(Evpu16 value)
Sets the vertical adjustment of abbreviated time signature, in EVPUs, for the parts.
Definition: ff_prefs.h:1320
bool GetBeamedCommonTimeEights() const
Returns the state of the "Beam 4 eights in 4/4" document option.
Definition: ff_prefs.h:1898
utwobyte GetGuideColorGreen() const
Returns the green color status of the guide, which is part of the RGB value.
Definition: ff_prefs.h:10821
void SetSymbolDefaultMeasureRest(eUniChar32 character)
Sets the default measure rest symbol.
Definition: ff_prefs.h:8726
Definition: ff_prefs.h:4733
void SetSymbolCommonTimeSigScore(eUniChar32 character)
Sets the symbol character used for the abbreviated common time signature for the score.
Definition: finaleframework.cpp:28606
void SetAvoidClefs(bool state)
Sets if Avoid Clefs is used or not.
Definition: ff_prefs.h:4405
virtual const PDKFRAMEWORK_CLASSID GetClassID()
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_prefs.h:10596
FCTuplet::PLACEMENTMODE GetPlacementMode() const
Returns the placement mode.
Definition: finaleframework.cpp:28839
void SetTextTabCharacters(int tabcount)
Sets the number of space characters that forms a tab stop in text.
Definition: ff_prefs.h:2603
eMeas GetStopMeasure() const
Returns the playback stop measure.
Definition: ff_prefs.h:808
FCTuplet::BRACKETMODE GetBracketMode() const
Returns the bracket mode.
Definition: finaleframework.cpp:28903
void SetAccidentalMultiCharSpace(Evpu16 value)
Sets the space within multi-character accidentals, in EVPUs.
Definition: ff_prefs.h:1356
virtual const PDKFRAMEWORK_CLASSID GetClassID()
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_prefs.h:7495
void SetUseFirstSyllable(bool state)
Sets if the positioning options (alignment/justification ) for first syllables should be used...
Definition: ff_prefs.h:9676
bool GetAbbreviateCommonTimeSig() const
Returns if common time signatures should be abbreviated.
Definition: ff_prefs.h:2102
twobyte GetRightPageTopMargin() const
Returns the top page margin for right-side pages.
Definition: ff_prefs.h:3536
void SetHorizontalOuterTip(fourbyte position)
Sets the horizontal position for the outer tip, in 1/10000 of an EVPU.
Definition: ff_prefs.h:11370
void SetGridSnapToItem(ITEMTOSNAP itemconstant, bool state)
Sets the grid "snap state" of a specific item.
Definition: finaleframework.cpp:29366
virtual const PDKFRAMEWORK_CLASSID GetClassID()
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_prefs.h:2762
void SetVertical16thRest(twobyte value)
Sets the vertical adjustment for 16th note rests,in EVPUs.
Definition: ff_prefs.h:9266
fourbyte GetPageScaling() const
Returns the page scaling, in percent.
Definition: ff_prefs.h:3485
twobyte GetHorizontalStraightFlagUp() const
Returns the horizontal adjustment for the straight upstem flag, in EFIXes.
Definition: ff_prefs.h:8452
Evpu16 GetHorizontalEnd(TIEPLACEMENT_INDEXES placementtype)
Returns the end (right-side) horizontal placement position for a specific tie placement type...
Definition: ff_prefs.h:6088
BEAMSLOPESTYLES
The beaming styles for use with GetBeamSlopeStyle() and SetBeamSlopeStyle()
Definition: ff_prefs.h:1788
virtual EXTAG Tag()=0
The Enigma tag for the derived class.
twobyte GetGraceNoteMinDistance() const
Returns the minimum distance between grace notes.
Definition: ff_prefs.h:4232
Definition: ff_prefs.h:4769
bool GetAvoidLedgerLines() const
Returns true if Avoid Ledger Lines is used.
Definition: ff_prefs.h:4188
Evpu32 GetBarlineDashLength() const
Returns the document setting for barline dash length, in EVPUs.
Definition: ff_prefs.h:1509
virtual bool Save()
Overridden version of Save()
Definition: finaleframework.cpp:28451
ITEMTOSNAP
Constants for setting/getting the items that the grids/guides should snap to.
Definition: ff_prefs.h:10607
FCGuides * GetVerticalGuides()
Returns a pointer to the collection object that contains the vertical guides.
Definition: finaleframework.cpp:29232
eUniChar32 GetSymbolTimeSigPlusParts() const
Returns the symbol for plus signs in time signatures in parts.
Definition: finaleframework.cpp:28494
Definition: ff_prefs.h:4715
Efix16 GetBarlineDoubleSpace() const
Returns the space between double barlines, in EFIXes.
Definition: ff_prefs.h:999
bool LoadScore()
Loads the "Page Format for Score" data to the object.
Definition: ff_prefs.h:3401
bool GetUseFirstSyllable() const
Returns if the positioning options (alignment/justification ) for first syllables should be used...
Definition: ff_prefs.h:9549
Definition: ff_prefs.h:754
bool GetGuitarBendParentheses() const
Returns the value for Guitar Bend Options - Place Release Bend Number in Parentheses.
Definition: ff_prefs.h:5419
void SetStaffLineThickness(Efix16 value)
Sets the document setting for staff line thickness in EFIXes.
Definition: ff_prefs.h:1647
eUniChar32 GetSymbolBrevisNotehead() const
Returns the default symbol character for brevis (double-whole) noteheads.
Definition: ff_prefs.h:7906
bool GetFreezeStemsUp() const
Returns if frozen stems should be up or down.
Definition: ff_prefs.h:7129
virtual const char * ClassName()
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_prefs.h:911
void SetBracketMode(FCTuplet::BRACKETMODE value)
Sets the bracket mode.
Definition: finaleframework.cpp:29002
void SetHorizontalShapeOffset(twobyte value)
Sets the horizontal shape offset.
Definition: ff_prefs.h:3157
Evpu16 GetTimeSigSpaceBefore() const
Returns the space before the time signature, in EVPUs, for the score.
Definition: ff_prefs.h:1071
void SetGuideColors(utwobyte red, utwobyte green, utwobyte blue)
Sets the full RGB color of the guides.
Definition: ff_prefs.h:11167
bool GetUseSimpleSpelling() const
Returns if simplified chord spelling should be used or not.
Definition: ff_prefs.h:7331
void SetManualPositioning(MANUAL_POSITIONING value)
Sets the options for how to treat manual positioned notes.
Definition: ff_prefs.h:4471
Definition: ff_prefs.h:1778
bool GetSpacing() const
Returns the music spacing state for the layer.
Definition: ff_prefs.h:7149
bool GetInterpolateAllotments() const
Returns if allotment should be interpolated if the duration wasn't found in the table (the "Use defau...
Definition: ff_prefs.h:4213
void SetHyphenSystemStart(twobyte value)
Sets the mode for how hyphens should be treated at start of systems.
Definition: ff_prefs.h:9630
void SetSymbolCutTimeSigScore(eUniChar32 character)
Sets the symbol character used for the abbreviated cut time signature for the score.
Definition: finaleframework.cpp:28618
void SetPageScaling(twobyte scaling)
Sets the page scaling, in percent.
Definition: ff_prefs.h:3642
twobyte GetSystemLeft() const
Returns the general left system margin setting.
Definition: ff_prefs.h:3437
bool GetRecalcMeasures() const
Return true if measure layout should be recalculated when the layout is updated.
Definition: ff_prefs.h:3899
void SetStartSystemSyllableJustification(twobyte value)
Sets the justification option for syllables at start of systems.
Definition: ff_prefs.h:9723
eUniChar32 GetSymbolCutTimeSigScore() const
Returns the symbol character used for the abbreviated cut time signature for the score.
Definition: finaleframework.cpp:28482
void SetMaxSlope(twobyte value)
Returns the maximum slope, in 10ths of a percent.
Definition: ff_prefs.h:3232
twobyte GetPitchRepresentationValue() const
Returns the octave representation number value. The setting is called "Pitch Representation->Middle C...
Definition: ff_prefs.h:3833
virtual const char * ClassName()
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_prefs.h:7063
virtual void DebugDump()
Outputs the class data/information for debugging purposes.
Definition: ff_prefs.h:5937
Definition: ff_prefs.h:1781
void SetGraceNoteMinDistance(twobyte value)
Sets the minimum distance between grace notes.
Definition: ff_prefs.h:4463
void SetThicknessLeft(Evpu16 value)
Returns the left-side tie thickness.
Definition: ff_prefs.h:6843
void SetDateFormat(DATEFORMATS dateformat)
Sets the date format to be used in the document (for text inserts).
Definition: ff_prefs.h:2581
virtual const PDKFRAMEWORK_CLASSID GetClassID()
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_prefs.h:6661
twobyte GetShortSpan()
Returns the defined distance for the short span slur.
Definition: ff_prefs.h:5913
void SetLeftBarlineDisplayMultipe(bool state)
Sets if "Left Barlines - Display on Multiple Staves" is used.
Definition: ff_prefs.h:2426
void SetStartSystemSyllableAlignment(twobyte value)
Sets the alignment option for syllables at start of systems.
Definition: ff_prefs.h:9713
twobyte GetRightPageBottomMargin() const
Returns the bottom page margin for right-side pages.
Definition: ff_prefs.h:3544
void SetRestOffset(twobyte value)
Sets the vertical rest offset for the layer.
Definition: ff_prefs.h:7178
void SetVerticalQuarterSlashBaseline(twobyte value)
Sets the quarter note (small) slash baseline adjustment value (for rhythmical notation), in EVPUs.
Definition: ff_prefs.h:9302
void SetVerticalStraightFlagDown(twobyte value)
Sets the vertical adjustment for the straight downstem flag, in EFIXes.
Definition: ff_prefs.h:9254
void SetGridLineStyle(GGLINESTYLES value)
Sets the line style that should be used for grids.
Definition: ff_prefs.h:10981
twobyte CalcHeight(int slurlength)
Calculates and returns the default height value based on the slur lengths.
Definition: ff_prefs.h:5882
virtual const PDKFRAMEWORK_CLASSID GetClassID()
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_prefs.h:5096
void SetHairpinMakeHorizontal(bool state)
Sets the "make horizontal" value in the Smart Shape preferences.
Definition: ff_prefs.h:5498
utwobyte GetGridColorRed() const
Returns the red color status of the grid, which is part of the RGB value.
Definition: ff_prefs.h:10751
twobyte GetNumberOffsetDownstem() const
Returns the Horizontal Number Offset/Downstem side of notes.
Definition: ff_prefs.h:2991
Default positioning for full and abbreviated staff names.
Definition: ff_prefs.h:7468
void SetMaxPasses(int value)
Sets the maximum number of playback passes a repeat should be allowed.
Definition: ff_prefs.h:10547
bool GetGridSnapToItem(ITEMTOSNAP itemconstant)
Returns the grid "snap state" of a specific item.
Definition: finaleframework.cpp:29261
Definition: ff_prefs.h:5967
virtual const char * ClassName()
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_prefs.h:9794
void SetSlurTipAvoidStaffAmount(Evpu16 value)
Sets if slur tips should avoid staff lines.
Definition: ff_prefs.h:5715
bool CopyFromTuplet(FCTuplet *pTuplet, bool changeposition=true)
Copies a tuplet to default tuplet definition.
Definition: finaleframework.cpp:28802
Definition: ff_prefs.h:10668
twobyte GetEngraverSlurMaxAngle() const
Returns maximum slur angle (in 1/100 of a degree) for Engraver Slurs.
Definition: ff_prefs.h:5226
bool LoadParts()
Loads the "Page Format for Parts" data to the object.
Definition: ff_prefs.h:3412
void SetTimeSigPartsSpaceAfter(Evpu16 value)
Sets the space after the time signature, in EVPUs, for the parts.
Definition: ff_prefs.h:1344
void SetTimeSigPartsTopVertical(Evpu16 value)
Sets the vertical adjustment of top time sig symbol from top staff line, for the parts.
Definition: ff_prefs.h:1236
void SetLineDashSpace(Evpu16 value)
Sets the default dash space, if EVPUs.
Definition: ff_prefs.h:5552
Efix32 GetGravityZoneSize() const
Returns the Gravity zone size, in EFIXes.
Definition: finaleframework.cpp:29241
void SetSymbolBrevisNotehead(eUniChar32 character)
Sets the default symbol character for brevis (double-whole) noteheads.
Definition: ff_prefs.h:8644
FCGeneralPrefs()
The constructor.
Definition: ff_prefs.h:3810
SMARTHYPHEN_SYSTEMSTART
Smart hyphen values to be used with GetHyphenSystemStart and SetHyphenSystemStart.
Definition: ff_prefs.h:9468
Definition: ff_prefs.h:6640
A very special-purpose preferences class that contains the full stem connection table from Finale's d...
Definition: ff_prefs.h:9860
Definition: ff_prefs.h:4679
void SetSymbolForwardRepeatDot(eUniChar32 character)
Sets the symbol for forward repeat dots.
Definition: ff_prefs.h:9025
eUniChar32 GetSymbolKeyDoubleFlat() const
Returns the symbol for double-flats in key signatures.
Definition: ff_prefs.h:8215
virtual const PDKFRAMEWORK_CLASSID GetClassID()
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_prefs.h:4629
twobyte GetSwing() const
Returns the playback swing value.
Definition: ff_prefs.h:795
PLACEMENTMODE
The settings for where the tuplet should be placed compared to the note entry.
Definition: ff_entrydetails.h:1681
Definition: ff_prefs.h:10662
twobyte GetNumberOffsetUpstem() const
Returns the Horizontal Number Offset/Upstem side of notes.
Definition: ff_prefs.h:2982
void SetWidth(fourbyte width)
Sets the width of the brace, in 1/10000 of an EVPU.
Definition: ff_prefs.h:11406
utwobyte GetGridColorBlue() const
Returns the blue color status of the grid, which is part of the RGB value.
Definition: ff_prefs.h:10769
void SetLedgerLineThickness(Efix16 value)
Sets the document setting for ledger line thickness in EFIXes.
Definition: ff_prefs.h:1653
void SetAutomaticUpdateLayout(bool state)
Sets if "Automatic Update Layout" is set in the Program Options.
Definition: ff_prefs.h:3982
CMPER GetGlissandoDefID() const
Returns the default custom startshape definition ID for glissando lines.
Definition: ff_prefs.h:5126
void SetHideWhenInactive(bool state)
Sets the "Hide layer when inactive" state.
Definition: ff_prefs.h:7241
void SetBarlineDashLength(Evpu32 value)
Sets the document setting for barline dash length, in EVPUs.
Definition: ff_prefs.h:1641
FCMusicSpacingPrefs()
The constructor.
Definition: ff_prefs.h:4096
void SetGridColors(utwobyte red, utwobyte green, utwobyte blue)
Sets the full RGB color of the grid.
Definition: ff_prefs.h:11146
bool GetUseEngraverSlurs() const
Returns true if engraver slurs should be used.
Definition: ff_prefs.h:5190
void SetHeavyBarlineThickness(Efix16 value)
Sets the document setting for heavy barline thickness, in EFIXes.
Definition: ff_prefs.h:1629
void SetMetronomeBeat(twobyte value)
Sets the metronome beat (in EDUs, quarter note = 1024 EDUs).
Definition: ff_prefs.h:834
virtual ~FCGridsGuidesPrefs()
The destructor.
Definition: ff_prefs.h:10682
bool GetAvoidStaff() const
Returns the "Avoid Staff" state.
Definition: ff_prefs.h:2834
FCFontInfo * CreateFontInfo()
Creates a FCFontInfo object and initializes with the font preference data. If no data has been loaded...
Definition: ff_prefs.h:4808
void SetOtherSyllableAlignment(twobyte value)
Sets the alignment option for other kind of syllables (that aren't covered by other options)...
Definition: ff_prefs.h:9732
bool GetExtendBeamsOverRests() const
Returns the state of the "Extend beams over rests" document option.
Definition: ff_prefs.h:1892
bool GetCenterUsingDuration() const
Returns the "center number using duration" state.
Definition: ff_prefs.h:2922
FLAG_16 GetEnigmaStyles() const
Gets the font style as standard Enigma bit storage.
Definition: ff_base.h:1164
Definition: ff_prefs.h:4730
void SetSymbolOneBarRepeat(eUniChar32 character)
Sets the symbol for one-bar repeats in Alternate Notation.
Definition: ff_prefs.h:9001
void SetSymbolWholeRest(eUniChar32 character)
Sets the default symbol character for whole rests.
Definition: ff_prefs.h:8709
FLAG_16 GetSecondsPlacement() const
Returns the seconds placement style.
Definition: ff_prefs.h:6743
eUniChar32 GetSymbolHalfRest() const
Returns the default symbol character for half rests.
Definition: ff_prefs.h:7963
bool GetAllowFloatingRests() const
Returns the state of the "Allow rests to float" beam option.
Definition: ff_prefs.h:1865
eUniChar32 GetSymbol64thRest() const
Returns the default symbol character for 64th rests.
Definition: ff_prefs.h:7923
twobyte GetHorizontalSecondFlagDown() const
Returns the horizontal adjustment for the second downstem flag, in EFIXes.
Definition: ff_prefs.h:8464
bool GetSecondsInTimeStamp() const
Returns if the time stamp (for text inserts) should include seconds.
Definition: ff_prefs.h:2133
void SetSymbolChordDoubleSharp(eUniChar32 character)
Sets the symbol for double-sharp accidentals in chord symbols.
Definition: ff_prefs.h:8912
Definition: ff_prefs.h:9446
void SetScalingValue(int value)
Sets the scaling factor, multiplied with 10000.
Definition: ff_prefs.h:4340
void SetSymbolStraightFlagDown(eUniChar32 character)
Sets the symbol for Straight Downstem Flag.
Definition: ff_prefs.h:8790
bool GetFontInfo(FCFontInfo *pFontInfo)
Gets the loaded font information.
Definition: ff_prefs.h:4790
Evpu16 GetLedgerLeftRestHalf() const
Returns the document setting for ledger line left half rest length in EFIXes.
Definition: ff_prefs.h:1533
void SetSymbolParFlat(eUniChar32 character)
Sets the default symbol for the flat accidental within parentheses.
Definition: ff_prefs.h:8847
bool SetFontInfo(FCFontInfo *pFontInfo)
Sets the loaded font information.
Definition: ff_prefs.h:4832
twobyte GetAugmentationDotSpace() const
Returns the space between each augmentation dot.
Definition: ff_prefs.h:939
void SetChordDirectionType(twobyte value)
Returns the chord direction type.
Definition: ff_prefs.h:6924
void SetAvoidLyrics(bool state)
Sets if Avoid Lyrics is used or not.
Definition: ff_prefs.h:4423
int GetMaxElementCount() const
Returns the maximum number of elements that can be referenced in the array.
void SetUpstemVerticalAdjust(int connectionID, Efix16 distance)
Sets the upstem vertical adjustment for the notehead that has the stem connection data...
Definition: finaleframework.cpp:29671
FONTPREF_CONSTANTS
Constants for loading font preferences.
Definition: ff_prefs.h:4634
void SetStartMode(PLAYBACKSTARTMODE mode)
Returns the start playback mode.
Definition: ff_prefs.h:869
void SetTimeSigSpaceAfter(Evpu16 value)
Sets the space after the time signature, in EVPUs, for the score.
Definition: ff_prefs.h:1338
void SetDisplayPartExpressions(bool state)
Sets the "Display Expressions for Parts" option state.
Definition: ff_prefs.h:2640
Evpu16 GetTimeSigPartsSpaceAfter() const
Returns the space after the time signature, in EVPUs, for the parts.
Definition: ff_prefs.h:1089
Evpu16 GetEngraverSlurAccidentalSpace() const
Returns the space around accidentals for Engraver Slurs, in EVPUs.
Definition: ff_prefs.h:5265
Font preferences data in the Document Options.
Definition: ff_prefs.h:4601
TIEPLACEMENT_INDEXES
The index constants for all methods in FCTiePlacementPrefs.
Definition: ff_prefs.h:5956
void SetStartMeasure(eMeas measure)
Sets the playback start measure, which is used if the start mode allows it.
Definition: ff_prefs.h:857
void SetCurveResolution(twobyte value)
Sets the curve resolution (1-128), for non-PostScript and screen output.
Definition: ff_prefs.h:2473
eUniChar32 GetSymbolKeyNatural() const
Returns the symbol for naturals in key signatures.
Definition: ff_prefs.h:8191
twobyte GetHorizontal16thFlagUp() const
Returns the horizontal adjustment for the 16th upstem flag, in EFIXes.
Definition: ff_prefs.h:8446
void SetAfterSingleDot(bool state)
Sets if the tie should start after a single dot.
Definition: ff_prefs.h:6964
bool GetUseInterpolation() const
Returns if heights should be interpolated or not (in the tie contour options).
Definition: ff_prefs.h:6812
__FCBaseData()
The constructor.
Definition: finaleframework.cpp:705
bool LoadAbbreviated()
Loads the abbreviated name positioning data.
Definition: ff_prefs.h:7664
void SetSymbolDoubleFlat(eUniChar32 character)
Sets the default symbol for the double-flat accidental.
Definition: ff_prefs.h:8823
void SetPageWidth(fourbyte width)
Sets the page width.
Definition: ff_prefs.h:3630
void SetKeySigPreserveOctave(bool state)
Sets if the octaves should be preserved when simplifying keys.
Definition: ff_prefs.h:2530
twobyte GetClefChangeOffset() const
Returns the space after a clef change and the barline, as a positive value.
Definition: ff_prefs.h:963
void SetPageHeight(fourbyte height)
Sets the page height.
Definition: ff_prefs.h:3636
eUniChar32 GetSymbolFirstFlagDown() const
Returns the symbol for First Downstem Flag.
Definition: ff_prefs.h:8014
Class for document-specific chord settings. Some additional chord-related settings are available in F...
Definition: ff_prefs.h:7259
virtual const char * ClassName()
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_prefs.h:5832
void SetStemVerticalNoteheadOffset(Efix32 value)
Sets the vertical stem offset for noteheads, in EFIXes.
Definition: ff_prefs.h:1308
void SetVerticalPos(Evpu16 value)
Sets the default vertical position for the group text.
Definition: ff_prefs.h:7712
bool GetGuideShow() const
Returns if guides should display.
Definition: ff_prefs.h:10797
Evpu16 GetHorizontalStart(TIEPLACEMENT_INDEXES placementtype)
Returns the start (left-side) horizontal placement position for a specific tie placement type...
Definition: ff_prefs.h:6046
bool GetThinInnerBracketReference() const
Returns if the thin inner repeat barline should be used as bracket line reference.
Definition: finaleframework.cpp:29064
Evpu16 GetKeySpaceAfterCancel() const
Returns the space after a canceled key signature, in EVPUs.
Definition: ff_prefs.h:1029
CHORDSTYLES
Chord styles for use with the FCChordPrefs::GetStyle() and FCChordPrefs::SetStyle() methods...
Definition: ff_prefs.h:7292
Definition: ff_prefs.h:6615
void SetUseEngraverSlurs(bool state)
Sets true if engraver slurs should be used.
Definition: ff_prefs.h:5534
void SetUnisonsMode(UNISONS_MODE value)
Sets the mode for how to treat unisons.
Definition: ff_prefs.h:4503
Definition: ff_prefs.h:7295
Definition: ff_prefs.h:7313
MEASUREMENTUNITS GetMeasurementUnit() const
Returns the currently selected measurement unit. The setting is called "Measurement Units" in the Fin...
Definition: ff_prefs.h:3848
void SetShowActiveLayerOnly(bool state)
Sets the "Show Active Layer Only" option.
Definition: ff_prefs.h:2359
Definition: ff_prefs.h:6222
void SetSymbolTwoOctaves(eUniChar32 value)
Sets the default 2-octava (15ma) character.
Definition: finaleframework.cpp:28718
bool GetAfterMultipleDots() const
Returns if the tie should start after multiple dots.
Definition: ff_prefs.h:6777
void SetSystemRightHorizontalOffset(Evpu16 value)
Sets the value for "Tie system break, horizontal end adjustment".
Definition: ff_prefs.h:6891
void SetSystemStaffHeight(twobyte value)
Sets the staff height in a system (in EVPUs * 16).
Definition: ff_prefs.h:3723
eUniChar32 GetSymbolTwoOctaves() const
Returns the default 2-octava (15ma) character.
Definition: finaleframework.cpp:28582
void SetVerticalFirstFlagUp(twobyte value)
Sets the vertical adjustment for the first upstem flag, in EFIXes.
Definition: ff_prefs.h:9212
void SetSpecialExtractionID(CMPER cmper)
Sets the Cmper to the special extracted part IU list. 0 if no special extracted part is active...
Definition: ff_prefs.h:2634
twobyte GetBeamMaxDistance() const
Returns the Max Distance from Middle Staff Line, in spaces.
Definition: ff_prefs.h:1140
void SetEndingLineThickness(Efix16 value)
Sets the line thickness, in EFIXes.
Definition: ff_prefs.h:10509
void SetDotAfterNumber(bool state)
Sets if the repeat number automatically should display with a period dot at the end, or not.
Definition: ff_prefs.h:10540
void SetEngraverSlurAccidentalSpace(Evpu16 spacevalue)
Sets the space around accidentals for Engraver Slurs, in EVPUs.
Definition: ff_prefs.h:5608
MANUAL_POSITIONING
The constants used by GetManualPositioning.
Definition: ff_prefs.h:4064
Definition: ff_prefs.h:10659
void SetMinimumDistanceWithTies(twobyte value)
Sets the minimum distance between notes with ties.
Definition: ff_prefs.h:4375
twobyte GetFontID(int connectionID)
Returns the Enigma font ID for the notehead that has the stem connection data.
Definition: finaleframework.cpp:29622
FLAG_16 GetAlignment() const
Returns the default alignment for the staff text.
Definition: ff_prefs.h:7546
void SetRetainFrozenMeasures(bool state)
Sets if frozen systems should be retained when the layout is updated.
Definition: ff_prefs.h:3991
void SetDefaultStemLift(fourbyte value)
Sets the default vertical stem lift value, in EFIXes.
Definition: ff_prefs.h:9152
twobyte GetHyphenSystemStart() const
Gets the mode for how hyphens should be treated at start of systems.
Definition: ff_prefs.h:9503
void SetRightExtension(twobyte value)
Sets the "Right Extension" value.
Definition: ff_prefs.h:3193
bool GetAbbreviateCutTimeSig() const
Returns if cut time signatures should be abbreviated.
Definition: ff_prefs.h:2108
SHAPESTYLE
The setting for which bracket shape the tuplet should use.
Definition: ff_entrydetails.h:1707
bool GetFinalBarlineAtEnd() const
Returns true if "final barline at end" is used.
Definition: ff_prefs.h:1943
twobyte GetSystemRight() const
Returns the right system margin setting.
Definition: ff_prefs.h:3443
Definition: ff_prefs.h:6651
Evpu16 GetKeySpaceBetweenAccidentals() const
Returns the space between key signature accidentals, in EVPUs.
Definition: ff_prefs.h:1035
Definition: ff_prefs.h:10625
twobyte GetRightHookLength() const
returns the right-side hook length.
Definition: ff_prefs.h:2964
int GetTextTabCharacters() const
Returns the number of space characters that forms a tab stop in text.
Definition: ff_prefs.h:2152
Definition: ff_prefs.h:4685
twobyte GetOtherSyllableJustification() const
Returns the justification option for other kind of syllables (that aren't covered by other options)...
Definition: ff_prefs.h:9614
UNISONS_MODE GetUnisonsMode() const
Returns the mode for how to treat unisons.
Definition: ff_prefs.h:4263
CMPER GetSpecialExtractionID() const
Returns the Cmper to the special extracted part IU list. 0 if no special extracted part is active...
Definition: ff_prefs.h:2183
void SetSymbolStraightFlagUp(eUniChar32 character)
Sets the symbol for Straight Upstem Flag.
Definition: ff_prefs.h:8782
void SetNumberOffsetUpstem(twobyte value)
Sets the Horizontal Number Offset/Upstem side of notes.
Definition: ff_prefs.h:3205
void SetSymbolQuarterRest(eUniChar32 character)
Sets the default symbol character for quarter note rests.
Definition: ff_prefs.h:8693
void SetLineWidth(Efix16 value)
Sets the default line width for normal lines, if EFIXes.
Definition: ff_prefs.h:5540
twobyte GetSpaceAfter() const
Returns the document setting for extra space after the music in a measure.
Definition: ff_prefs.h:933
void SetSlurBreakSystemEnd(Evpu16 value)
Sets the horizontal system end adjustment for slur system breaks. In EVPUs.
Definition: ff_prefs.h:5684
void SetUseFreezeStemsTies(bool state)
Sets if the freeze stems and ties should be frozen.
Definition: ff_prefs.h:7197
virtual const char * ClassName()
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_prefs.h:7640
Evpu16 GetHorizontalPos() const
Returns the default horizontal position for the group text.
Definition: ff_prefs.h:7670
virtual int DataSizeLoad()=0
Returns the data size for the data structure that should be loaded.
bool GetUseTieEndStyle() const
Returns the "Use Tie End Style" state (in the tie contour options).
Definition: ff_prefs.h:6818
virtual ~FCStemConnectionTable()
The destructor.
Definition: finaleframework.cpp:29572
void SetTabSlideDefID(CMPER idvalue)
Sets the default custom startshape definition ID for tab slide lines.
Definition: ff_prefs.h:5480
Efix16 GetUpstemHorizontalAdjust(int connectionID)
Returns the upstem horizontal adjustment for the notehead that has the stem connection data...
Definition: finaleframework.cpp:29627
REPEATWINGSTYLES GetWingStyle() const
Returns the wing styles for repeats barlines.
Definition: ff_prefs.h:10299
void SetLeftExtension(twobyte value)
Sets the "Left Extension" value.
Definition: ff_prefs.h:3181
fourbyte GetCenterThickness() const
Returns the center thickness, in 1/10000 of an EVPU.
Definition: ff_prefs.h:11312
eUniChar32 GetSymbolStraightFlagUp() const
Returns the symbol for Straight Upstem Flag.
Definition: ff_prefs.h:8054
bool DataIsLoaded() const
Returns true is any data has been loaded into the object.
Definition: ff_base.h:715
Evpu16 GetClefKeyExtraSpace() const
Returns the extra space between clef and key signature.
Definition: ff_prefs.h:1165
bool GetKeepOctaveTransposition() const
Returns the "Keep octave transposition in Concert Pitch" setting for the document, introduced in Finale 25.2.
Definition: finaleframework.cpp:29514
virtual const char * ClassName()
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_prefs.h:1462
void SetShowFretboards(bool state)
Sets the the "Show Fretboards" (in the Chord menu).
Definition: ff_prefs.h:2447
twobyte GetOtherSyllableAlignment() const
Returns the alignment option for other kind of syllables (that aren't covered by other options)...
Definition: ff_prefs.h:9605
Evpu16 GetRightHeight(CONTOUR_INDEXES index)
Returns the right-side height.
Definition: ff_prefs.h:6395
void SetEngraverSlurMaxStretchFixed(Efix32 maxvalue)
Sets the Engraver Slur max stretch value for fixed stretches, in EFIXes.
Definition: ff_prefs.h:5648
void SetGroupBracketDefaultDistance(Evpu16 value)
Sets the default horizontal distance for group brackets from the edge of the staff.
Definition: ff_prefs.h:1408
Evpu16 GetTimeSigRightHorizontalOffset() const
Returns the "Break for time signatures - right gap" setting.
Definition: ff_prefs.h:6705
twobyte GetVertical8thRest() const
Returns the vertical adjustment for 8th note rests, in EVPUs.
Definition: ff_prefs.h:8530
LYRICS_JUSTIFICATIONS
The justification values for syllable positioning.
Definition: ff_prefs.h:9453
void SetSymbolTimeSigPlusParts(eUniChar32 value)
Sets the symbol for plus signs in time signatures in parts.
Definition: finaleframework.cpp:28630
Evpu16 GetAfterKeySpace() const
Returns the "Forward repeat spacing - after key signature" document setting, in EVPUs.
Definition: ff_prefs.h:10311
bool GetAfterSingleDot() const
Returns if the tie should start after a single dot.
Definition: ff_prefs.h:6771
twobyte GetPitchRepresentationType() const
Returns the preferred Pitch representation type for MIDI notes in Finale. The setting is called "Pitc...
Definition: ff_prefs.h:3820
Definition: ff_prefs.h:4676
void SetLeftHeight(CONTOUR_INDEXES index, Evpu16 value)
Sets the left-side height.
Definition: ff_prefs.h:6478
void SetAccidentalNoteSpace(Evpu16 value)
Sets the space between accidental and note, in EVPUs.
Definition: ff_prefs.h:1362
twobyte GetLeftPageRightMargin() const
Returns the right page margin for all/left-side pages.
Definition: ff_prefs.h:3509
twobyte GetHairpinMaxShortSpanLength() const
Returns the "Maximum short span length" (added in Finale 25.3) in the Smart Shape preferences...
Definition: finaleframework.cpp:29093
eUniChar32 GetSymbolBrevisRest() const
Returns the default symbol character for brevis (double-whole note) rests.
Definition: ff_prefs.h:7979
Definition: ff_prefs.h:10204
Evpu16 GetLedgerLeftHalf() const
Returns the document setting for ledger line left half length in EFIXes.
Definition: ff_prefs.h:1527
Definition: ff_prefs.h:10619
void SetVerticalSecondFlagDown(twobyte value)
Sets the vertical adjustment for the second downstem flag, in EFIXes.
Definition: ff_prefs.h:9242
void SetTablatureGraceNoteSize(ePercent value)
Sets the document setting for tablature grace note size, in percent.
Definition: ff_prefs.h:1689
Definition: ff_prefs.h:1819
virtual const PDKFRAMEWORK_CLASSID GetClassID()
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_prefs.h:9375
void SetSymbolHalfRest(eUniChar32 character)
Sets the default symbol character for half rests.
Definition: ff_prefs.h:8701
void SetSymbolOctaveBass(eUniChar32 value)
Sets the default octava bass (8vb) character.
Definition: finaleframework.cpp:28706
Evpu16 GetHorizontalPos() const
Returns the default horizontal position for the staff text.
Definition: ff_prefs.h:7524
void SetBaseKeyVelocity(twobyte value)
Sets the base key velocity value.
Definition: ff_prefs.h:826
void SetGuideColorBlue(twobyte value)
Returns the blue color status of the guide, which is part of the RGB value.
Definition: ff_prefs.h:11051
void SetAllowFloatingRests(bool state)
Sets the state of the "Allow rests to float" beam option.
Definition: ff_prefs.h:2294
void SetMinimumItemDistance(Evpu16 value)
Sets the minimum distance between items, in EVPUs.
Definition: ff_prefs.h:4369
twobyte GetVerticalHalfSlashStemLift() const
Returns the half note diamond stem connection lift value (for rhythmical notation), in EVPUs.
Definition: ff_prefs.h:8591
void SetChordPlayback(bool state)
Sets if chord playback should be enabled.
Definition: ff_prefs.h:2664
Evpu16 GetTimeSigBottomVertical() const
Returns the vertical adjustment of bottom time sig symbol from bottom staff line, for the score...
Definition: ff_prefs.h:987
void SetNameString(FCString *pString)
Sets the font name (FCString version).
Definition: finaleframework.cpp:3319
bool GetKeySigPreserveOctave() const
Returns if the octaves should be preserved when simplifying keys.
Definition: ff_prefs.h:2090
fourbyte GetVerticalOuterBody() const
Returns the vertical position for the outer body, in 1/10000 of an EVPU.
Definition: ff_prefs.h:11294
void SetSymbolLongaRest(eUniChar32 value)
Sets the default symbol character for longa rests.
Definition: finaleframework.cpp:28662
void SetUseOuterPlacement(bool state)
Sets the "Use outer placement" state.
Definition: ff_prefs.h:6897
Evpu16 GetEndingHorizontalText() const
Returns the default horizontal positioning for ending text.
Definition: ff_prefs.h:10359
void SetSymbolChordSharp(eUniChar32 character)
Sets the symbol for sharp accidentals in chord symbols.
Definition: ff_prefs.h:8896
void SetTimeSigPartsBottomVertical(Evpu16 value)
Sets the vertical adjustment of bottom time sig symbol from bottom staff line, for the parts...
Definition: ff_prefs.h:1248
void SetRightHeight(CONTOUR_INDEXES index, Evpu16 value)
Sets the right-side height.
Definition: ff_prefs.h:6539
twobyte GetGridStep() const
Returns the "Display one in ??? Grid Lines" option.
Definition: ff_prefs.h:10742
void SetShapeStartAdjust(twobyte value)
Sets the left-side adjustment for multimeasure shapes.
Definition: ff_prefs.h:5035
void SetCourtesyKeySigAtSystemEnd(bool state)
Sets if courtesy key signatures should be displayed at the end of systems.
Definition: ff_prefs.h:2566
Efix32 GetStemVerticalNoteheadOffset() const
Returns the vertical stem offset for noteheads, in EFIXes.
Definition: ff_prefs.h:1053
void SetGuitarBendAutoGenerateText(bool state)
Sets the value for Guitar Bend Options - Automatically Generate Text.
Definition: ff_prefs.h:5780
twobyte GetStartSystemSyllableAlignment() const
Returns the alignment option for syllables at start of systems.
Definition: ff_prefs.h:9586
bool GetExpandSingleWord() const
Returns the default "expand single word" state.
Definition: ff_prefs.h:7552
Definition: ff_prefs.h:10210
bool GetAlwaysFlat() const
Returns the "Always Flat" state.
Definition: ff_prefs.h:2897
virtual bool Save()
Overloaded version of Save().
Definition: finaleframework.cpp:29208
Definition: ff_prefs.h:10616
Efix16 GetThinBarlineThickness() const
Returns the document setting for thin barline thickness in EFIXes.
Definition: ff_prefs.h:1503
eUniChar32 GetSymbolChordSharp() const
Returns the symbol for sharp accidentals in chord symbols.
Definition: ff_prefs.h:8167
virtual bool Save()
Overloaded version of the Save() method.
Definition: finaleframework.cpp:28759
int ElementsExpand(int noofnewelements)
Expand the array with more elements. This method is only active on Finale 2014 and above...
Definition: finaleframework.cpp:29546
void SetVerticalPos(Evpu16 value)
Sets the default vertical position for the staff text.
Definition: ff_prefs.h:7566
void SetGuitarBendHideNumber(bool state)
Sets the value for Guitar Bend Options - Hide "Bend-To" Number.
Definition: ff_prefs.h:5771
void SetUnderlineThickness(fourbyte value)
Sets the Underline Thickness option (currently Mac only).
Definition: ff_prefs.h:2652
Definition: ff_prefs.h:4703
Definition: ff_prefs.h:5961
void SetSymbolTwoOctavesBass(eUniChar32 value)
Returns the default 2-octava bass (15ma) character.
Definition: finaleframework.cpp:28730
void SetEndingBracketHeight(Evpu16 value)
Sets the default height of repeat brackets, in EVPUs.
Definition: ff_prefs.h:10491
void SetForwardSpace(Evpu16 value)
Sets the space between repeat dot and repeat lines in forward repeats, in EVPUs.
Definition: ff_prefs.h:10435
Evpu16 GetTimeSigPartsBottomVertical() const
Returns the vertical adjustment of bottom time sig symbol from bottom staff line, for the parts...
Definition: ff_prefs.h:993
Evpu16 GetMaxBeamSlope() const
Returns the maximum beam slope, in EVPUs.
Definition: ff_prefs.h:2022
void SetAugmentationDotVerticalAdjust(twobyte value)
Sets the default vertical offset for an augmentation dot.
Definition: ff_prefs.h:1206
void SetAlignment(FLAG_16 alignment)
Sets the default alignment for the staff text.
Definition: ff_prefs.h:7587
void SetLeftAlignment(bool state)
Sets if the chords should be left or center aligned.
Definition: ff_prefs.h:7360
virtual void DebugDump()
Outputs the class data/information for debugging purposes.
Definition: ff_prefs.h:3238
DATEFORMATS GetDateFormat() const
Returns the date format to be used in the document (for text inserts).
Definition: ff_prefs.h:2146
void SetVerticalTwoMeasureRepeatOffset(twobyte value)
Sets the vertical value offset for two-bar repeats, in EVPUs.
Definition: ff_prefs.h:9338
void SetSymbolKeyDoubleSharp(eUniChar32 character)
Sets the symbol for double-sharps in key signatures.
Definition: ff_prefs.h:8952
eUniChar32 GetSymbolForwardRepeatDot() const
Returns the symbol for forward repeat dots.
Definition: ff_prefs.h:8299
Definition: ff_prefs.h:4682
Evpu16 GetSlurThicknessVerticalRight() const
Returns slur thickness to the vertical right, in EVPUs.
Definition: ff_prefs.h:5410
Evpu16 GetBrokenBeamLength() const
Returns the document setting for broken beam length, in EVPUs.
Definition: ff_prefs.h:1552
void SetEnigmaStyles(FLAG_16 fontstyles)
Sets the font style as standard Enigma bit storage.
Definition: ff_base.h:1261
void SetExtendBeamsOverRests(bool state)
Sets the state of the "Extend beams over rests" document option.
Definition: ff_prefs.h:2346
void SetSymbol128thRest(eUniChar32 character)
Sets the default symbol character for 128th rests.
Definition: ff_prefs.h:8653
void SetWidth(twobyte value)
Sets the default width of a MM rest.
Definition: ff_prefs.h:5022
bool GetCrossStaffNotesInOriginal() const
Sets if cross staff notes should be displayed in the original staff.
Definition: ff_prefs.h:2164