194 enum CLASS_APPROACHES
196 CLASSAPPROACH_NONE = 0,
197 CLASSAPPROACH_ENTRYDETAILS,
198 CLASSAPPROACH_NOTEDETAILS,
199 CLASSAPPROACH_MEASUREDETAILS,
200 CLASSAPPROACH_CELLDETAILS
209 class _FCLuaIterEntryFilter :
public __FCBase
228 for (
int i = 0; i <
GetCount(); i++)
230 _FCLuaIterEntryFilter* pItem = GetItemAt(i);
231 if (pItem->GetFilter() == filter)
return pItem;
238 if (Find(filter))
return false;
239 Add(
new _FCLuaIterEntryFilter(filter));
245 _FCLuaIterEntryFilter* pItem = Find(filter);
246 if (!pItem)
return false;
248 if (index == -1)
return false;
258 class _FCLuaIterNoteFilter :
public __FCBase
277 for (
int i = 0; i <
GetCount(); i++)
279 _FCLuaIterNoteFilter* pItem = GetItemAt(i);
280 if (pItem->GetFilter() == filter)
return pItem;
287 if (Find(filter))
return false;
288 Add(
new _FCLuaIterNoteFilter(filter));
294 _FCLuaIterNoteFilter* pItem = Find(filter);
295 if (!pItem)
return false;
297 if (index == -1)
return false;
307 class _FCLuaIterAltNotationFilter :
public __FCBase
321 _FCLuaIterAltNotationFilter* GetItemAt(
int index) {
return (_FCLuaIterAltNotationFilter*)
__FCCollection::GetItemAt(index); }
325 for (
int i = 0; i <
GetCount(); i++)
327 _FCLuaIterAltNotationFilter* pItem = GetItemAt(i);
328 if (pItem->GetFilter() == filter)
return pItem;
335 if (Find(filter))
return false;
336 Add(
new _FCLuaIterAltNotationFilter(filter));
342 _FCLuaIterAltNotationFilter* pItem = Find(filter);
343 if (!pItem)
return false;
345 if (index == -1)
return false;
354 class _FCLuaIterNotationStyleFilter :
public __FCBase
368 _FCLuaIterNotationStyleFilter* GetItemAt(
int index) {
return (_FCLuaIterNotationStyleFilter*)
__FCCollection::GetItemAt(index); }
372 for (
int i = 0; i <
GetCount(); i++)
374 _FCLuaIterNotationStyleFilter* pItem = GetItemAt(i);
375 if (pItem->GetFilter() == filter)
return pItem;
382 if (Find(filter))
return false;
383 Add(
new _FCLuaIterNotationStyleFilter(filter));
389 _FCLuaIterNotationStyleFilter* pItem = Find(filter);
390 if (!pItem)
return false;
392 if (index == -1)
return false;
398 _FCLuaIterEntryFilters _entryfilters_AND;
399 _FCLuaIterEntryFilters _entryfilters_OR;
400 _FCLuaIterEntryFilters _entryfilters_NOT;
402 _FCLuaIterNoteFilters _notefilters_AND;
403 _FCLuaIterNoteFilters _notefilters_OR;
404 _FCLuaIterNoteFilters _notefilters_NOT;
406 _FCLuaIterAltNotationFilters _altnotationfilters_AND;
407 _FCLuaIterAltNotationFilters _altnotationfilters_OR;
408 _FCLuaIterAltNotationFilters _altnotationfilters_NOT;
410 _FCLuaIterNotationStyleFilters _notationstylefilters_AND;
411 _FCLuaIterNotationStyleFilters _notationstylefilters_OR;
412 _FCLuaIterNotationStyleFilters _notationstylefilters_NOT;
414 bool _nullregionequalsall;
416 bool _forwardprocessing;
417 bool _downwardprocessing;
418 bool _partialmeasureselections;
420 double _timingstart, _timingend;
421 bool _useprogressbar;
422 bool _abortableprogressbar;
423 bool _progressbar_useraborted;
424 int _progressfrequency;
426 bool _processscorepart;
427 bool _processcurrentpart;
428 bool _processcurrentdoc;
483 #ifdef PDK_FRAMEWORK_DIAGNOSE
484 DebugOutDigit(
"Error: Unknown '_entryfiltermode' in FCLuaIterator:EntryMatchesFilter(): ", (
int)filter);
493 if (_entryfilters_AND.GetCount() == 0)
return true;
494 for (
int i = 0; i < _entryfilters_AND.GetCount(); i++)
497 if (!EntryFilterCheck(pEntry, filter))
return false;
504 if (_entryfilters_OR.GetCount() == 0)
return true;
505 for (
int i = 0; i < _entryfilters_OR.GetCount(); i++)
508 if (EntryFilterCheck(pEntry, filter))
return true;
515 if (_entryfilters_NOT.GetCount() == 0)
return true;
516 for (
int i = 0; i < _entryfilters_NOT.GetCount(); i++)
519 if (EntryFilterCheck(pEntry, filter))
return false;
526 if (!EntryMatchesANDFilters(pEntry))
return false;
527 if (!EntryMatchesORFilters(pEntry))
return false;
528 if (!EntryMatchesNOTFilters(pEntry))
return false;
543 if (_notationstylefilters_AND.GetCount() == 0)
return true;
544 for (
int i = 0; i < _notationstylefilters_AND.GetCount(); i++)
547 if (!NotationStyleFilterCheck(pStaffSpec, filter))
return false;
554 if (_notationstylefilters_OR.GetCount() == 0)
return true;
555 for (
int i = 0; i < _notationstylefilters_OR.GetCount(); i++)
558 if (NotationStyleFilterCheck(pStaffSpec, filter))
return true;
565 if (_notationstylefilters_NOT.GetCount() == 0)
return true;
566 for (
int i = 0; i < _notationstylefilters_NOT.GetCount(); i++)
569 if (NotationStyleFilterCheck(pStaffSpec, filter))
return false;
575 bool NotationStyleMatchesFilters(
FCNoteEntry* pEntry)
577 if ((_notationstylefilters_AND.GetCount() == 0) &&
578 (_notationstylefilters_OR.GetCount() == 0) &&
579 (_notationstylefilters_NOT.GetCount() == 0))
583 if (!NotationStyleMatchesANDFilters(&staffspec))
return false;
584 if (!NotationStyleMatchesORFilters(&staffspec))
return false;
585 if (!NotationStyleMatchesNOTFilters(&staffspec))
return false;
590 bool NotationStyleMatchesFilters(eMeas measure, eStaff staff, TimeEdu32 measurepos)
592 if ((_notationstylefilters_AND.GetCount() == 0) &&
593 (_notationstylefilters_OR.GetCount() == 0) &&
594 (_notationstylefilters_NOT.GetCount() == 0))
597 FCCell cell(measure, staff);
598 if (!staffspec.
LoadForCell(&cell, measurepos))
return false;
599 if (!NotationStyleMatchesANDFilters(&staffspec))
return false;
600 if (!NotationStyleMatchesORFilters(&staffspec))
return false;
601 if (!NotationStyleMatchesNOTFilters(&staffspec))
return false;
616 if (_altnotationfilters_AND.GetCount() == 0)
return true;
617 for (
int i = 0; i < _altnotationfilters_AND.GetCount(); i++)
620 if (!AltNotationFilterCheck(pStaffSpec, filter))
return false;
627 if (_altnotationfilters_OR.GetCount() == 0)
return true;
628 for (
int i = 0; i < _altnotationfilters_OR.GetCount(); i++)
631 if (AltNotationFilterCheck(pStaffSpec, filter))
return true;
638 if (_altnotationfilters_NOT.GetCount() == 0)
return true;
639 for (
int i = 0; i < _altnotationfilters_NOT.GetCount(); i++)
642 if (AltNotationFilterCheck(pStaffSpec, filter))
return false;
648 bool AlternateNotationMatchesFilters(
FCNoteEntry* pEntry)
650 if ((_altnotationfilters_AND.GetCount() == 0) &&
651 (_altnotationfilters_OR.GetCount() == 0) &&
652 (_altnotationfilters_NOT.GetCount() == 0))
656 if (!AltNotationMatchesANDFilters(&staffspec))
return false;
657 if (!AltNotationMatchesORFilters(&staffspec))
return false;
658 if (!AltNotationMatchesNOTFilters(&staffspec))
return false;
663 bool AlternateNotationMatchesFilters(eMeas measure, eStaff staff, TimeEdu32 measurepos)
665 if ((_altnotationfilters_AND.GetCount() == 0) &&
666 (_altnotationfilters_OR.GetCount() == 0) &&
667 (_altnotationfilters_NOT.GetCount() == 0))
670 FCCell cell(measure, staff);
671 if (!staffspec.
LoadForCell(&cell, measurepos))
return false;
672 if (!AltNotationMatchesANDFilters(&staffspec))
return false;
673 if (!AltNotationMatchesORFilters(&staffspec))
return false;
674 if (!AltNotationMatchesNOTFilters(&staffspec))
return false;
696 #ifdef PDK_FRAMEWORK_DIAGNOSE
697 DebugOutDigit(
"Error: Unknown '_notfiltermode' in FCLuaIterator:NoteMatchesFilter(): ", (
int)filter);
703 bool NoteMatchesANDFilters(
FCNote* pNote)
705 if (_notefilters_AND.GetCount() == 0)
return true;
706 for (
int i = 0; i < _notefilters_AND.GetCount(); i++)
709 if (!NoteFilterCheck(pNote, filter))
return false;
714 bool NoteMatchesORFilters(
FCNote* pNote)
716 if (_notefilters_OR.GetCount() == 0)
return true;
717 for (
int i = 0; i < _notefilters_OR.GetCount(); i++)
720 if (NoteFilterCheck(pNote, filter))
return true;
725 bool NoteMatchesNOTFilters(
FCNote* pNote)
727 if (_notefilters_NOT.GetCount() == 0)
return true;
728 for (
int i = 0; i < _notefilters_NOT.GetCount(); i++)
731 if (NoteFilterCheck(pNote, filter))
return false;
736 bool NoteMatchesFilters(
FCNote* pNote)
738 if (!NoteMatchesANDFilters(pNote))
return false;
739 if (!NoteMatchesORFilters(pNote))
return false;
740 if (!NoteMatchesNOTFilters(pNote))
return false;
748 void OutputExceptionError(luabridge::LuaException e)
752 LuaRun_AppendLineToOutput(&errstring);
756 bool ExecuteCallback(luabridge::LuaRef &lua_callback_function, luabridge::LuaRef ¶meter, EProgressDataP *ppProgressBarData)
758 bool continueflag =
true;
761 luabridge::LuaRef returnvalue = lua_callback_function(parameter);
762 if (returnvalue.type() == LUA_TBOOLEAN) continueflag = returnvalue.cast <
bool>();
763 if (continueflag ==
false)
766 EndProgressBar(ppProgressBarData,
false);
771 catch (luabridge::LuaException e)
773 OutputExceptionError(e);
774 EndProgressBar(ppProgressBarData,
true);
781 bool ExecuteCellCallback(luabridge::LuaRef &lua_callback_function,
int measure,
int staff, EProgressDataP *ppProgressBarData)
783 bool continueflag =
true;
786 luabridge::LuaRef returnvalue = lua_callback_function(measure, staff);
787 if (returnvalue.type() == LUA_TBOOLEAN) continueflag = returnvalue.cast <
bool>();
788 if (continueflag ==
false)
791 EndProgressBar(ppProgressBarData,
false);
796 catch (luabridge::LuaException e)
798 OutputExceptionError(e);
799 EndProgressBar(ppProgressBarData,
true);
806 bool ExecuteFileCallback(luabridge::LuaRef &lua_callback_function,
FCDocument* pDocument,
FCString* pFileName, EProgressDataP *ppProgressBarData)
808 bool continueflag =
true;
811 luabridge::LuaRef returnvalue = lua_callback_function(pDocument, pFileName);
812 if (returnvalue.type() == LUA_TBOOLEAN) continueflag = returnvalue.cast <
bool>();
813 if (continueflag ==
false)
816 EndProgressBar(ppProgressBarData,
false);
821 catch (luabridge::LuaException e)
823 OutputExceptionError(e);
824 EndProgressBar(ppProgressBarData,
true);
830 int ProcessRegionEntries(
FCMusicRegion* pRegion, luabridge::LuaRef &lua_callback_function,
bool shouldsave)
833 if (!pRegion || pRegion->
IsEmpty())
835 if (!_nullregionequalsall)
return 0;
837 pRegion = &fullregion;
839 if (!lua_callback_function.isFunction())
return 0;
840 if (pRegion->
IsEmpty())
return 0;
842 int progressupdatecount;
843 EProgressDataP pProgressBarData;
848 if (_forwardprocessing)
859 if (_downwardprocessing)
868 if (!UpdateProgressBar(&pProgressBarData, &progressupdatecount))
877 bool entriesprocessed =
false;
880 if (_forwardprocessing)
883 entryidx = entrycell.GetCount() - 1;
884 while (entryidx >= 0 && entryidx < entrycell.GetCount())
890 if (!EntryMatchesFilters(pEntry))
break;
891 if (!NotationStyleMatchesFilters(pEntry))
break;
892 if (!AlternateNotationMatchesFilters(pEntry))
break;
894 entriesprocessed =
true;
895 luabridge::LuaRef parameter(_pGlobal_LuaState, pEntry);
897 if (!ExecuteCallback(lua_callback_function, parameter, &pProgressBarData))
903 if (_forwardprocessing) entryidx++;
else entryidx--;
906 if (shouldsave && entriesprocessed) entrycell.Save();
909 if (_downwardprocessing) slot++;
else slot--;
913 if (_forwardprocessing) meas++;
else meas--;
915 EndProgressBar(&pProgressBarData,
false);
924 case FCID_ARTICULATIONDEF:
927 case FCID_CATEGORYDEF:
936 case FCID_CUSTOMSMARTLINEDEF:
939 case FCID_EXECUTABLESHAPEDEF:
942 case FCID_FRETBOARDSTYLEDEF:
945 case FCID_FRETBOARDGROUPDEF:
948 case FCID_FRETINSTRUMENTDEF:
954 case FCID_INSTRUMENTDEF:
960 case FCID_MEASURENUMBERREGION:
963 case FCID_MULTIMEASUREREST:
966 case FCID_MULTISTAFFINSTRUMENT:
970 pCollectionData =
new FCPages();
972 case FCID_PAGEGRAPHIC:
981 case FCID_SHAPEEXPRESSIONDEF:
984 case FCID_SMARTSHAPE:
990 case FCID_STAFFSTYLEDEF:
993 case FCID_STAFFSYSTEM:
996 case FCID_TEXTEXPRESSIONDEF:
999 case FCID_TEXTREPEATDEF:
1005 if (!pCollectionData)
return NULL;
1007 return pCollectionData;
1010 int ProcessRegionNotes(
FCMusicRegion* pRegion, luabridge::LuaRef &lua_callback_function,
bool shouldsave)
1013 if (!pRegion || pRegion->
IsEmpty())
1015 if (!_nullregionequalsall)
return 0;
1017 pRegion = &fullregion;
1019 if (!lua_callback_function.isFunction())
return 0;
1020 if (pRegion->
IsEmpty())
return 0;
1022 int progressupdatecount;
1023 EProgressDataP pProgressBarData;
1028 if (_forwardprocessing)
1037 if ((!_partialmeasureselections) && pRegion->
IsMeasurePartial(meas))
break;
1039 if (_downwardprocessing)
1049 if (!UpdateProgressBar(&pProgressBarData, &progressupdatecount))
1058 bool entriesprocessed =
false;
1061 if (_forwardprocessing)
1064 entryidx = entrycell.GetCount() - 1;
1066 while (entryidx >= 0 && entryidx < entrycell.GetCount())
1071 if (pEntry->
IsRest())
break;
1073 if (!EntryMatchesFilters(pEntry))
break;
1074 if (!NotationStyleMatchesFilters(pEntry))
break;
1075 if (!AlternateNotationMatchesFilters(pEntry))
break;
1078 if (_forwardprocessing)
1083 while (noteidx >= 0 && noteidx < pEntry->GetCount())
1088 if (!NoteMatchesFilters(pNote))
break;
1090 entriesprocessed =
true;
1091 luabridge::LuaRef parameter(_pGlobal_LuaState, pNote);
1093 if (!ExecuteCallback(lua_callback_function, parameter, &pProgressBarData))
1099 if (_forwardprocessing) noteidx++;
else noteidx--;
1103 if (_forwardprocessing) entryidx ++;
else entryidx --;
1106 if (shouldsave && entriesprocessed) entrycell.Save();
1109 if (_downwardprocessing) slot++;
else slot--;
1113 if (_forwardprocessing) meas++;
else meas--;
1115 EndProgressBar(&pProgressBarData,
false);
1120 int ProcessForEachCell(
FCMusicRegion* pRegion, luabridge::LuaRef& lua_callback_function)
1123 if (!pRegion || pRegion->
IsEmpty())
1125 if (!_nullregionequalsall)
return 0;
1127 pRegion = &fullregion;
1129 if (!lua_callback_function.isFunction())
return 0;
1130 if (pRegion->
IsEmpty())
return 0;
1132 int progressupdatecount;
1133 EProgressDataP pProgressBarData;
1138 if (_forwardprocessing)
1147 if ((!_partialmeasureselections) && pRegion->
IsMeasurePartial(meas))
break;
1149 if (_downwardprocessing)
1158 if (!UpdateProgressBar(&pProgressBarData, &progressupdatecount))
1163 if (!NotationStyleMatchesFilters(meas, staff, 0))
break;
1164 if (!AlternateNotationMatchesFilters(meas, staff, 0))
break;
1167 if (!ExecuteCellCallback(lua_callback_function, meas, staff, &pProgressBarData))
1173 if (_downwardprocessing) slot++;
else slot--;
1177 if (_forwardprocessing) meas++;
else meas--;
1179 EndProgressBar(&pProgressBarData,
false);
1184 int ProcessForEachPart(luabridge::LuaRef& lua_callback_function)
1186 if (!lua_callback_function.isFunction())
return 0;
1188 int progressupdatecount;
1189 EProgressDataP pProgressBarData;
1193 StartProgressBar(&pProgressBarData, allparts.
GetCount(), &progressupdatecount);
1196 if (_forwardprocessing)
1200 while (partidx >= 0 && partidx < allparts.
GetCount())
1205 if (!UpdateProgressBar(&pProgressBarData, &progressupdatecount))
return count;
1209 if (!_processscorepart && pPart->
IsScore())
break;
1210 if (!_processcurrentpart && pPart->
IsCurrent())
break;
1214 luabridge::LuaRef parameter(_pGlobal_LuaState, pPart);
1216 bool callbackreturn = ExecuteCallback(lua_callback_function, parameter, &pProgressBarData);
1219 if (!callbackreturn)
return count;
1222 if (_forwardprocessing)
1228 EndProgressBar(&pProgressBarData,
false);
1234 int ProcessForEach(
__FCCollectionData* pCollection, luabridge::LuaRef& lua_callback_function,
bool shouldsave)
1236 if (!pCollection)
return 0;
1237 if (pCollection->
GetCount() == 0)
return 0;
1238 if (!lua_callback_function.isFunction())
return 0;
1240 int progressupdatecount;
1241 EProgressDataP pProgressBarData;
1243 StartProgressBar(&pProgressBarData, pCollection->
GetCount(), &progressupdatecount);
1245 luabridge::LuaRef parameter(_pGlobal_LuaState);
1251 if (_forwardprocessing)
1256 while (i >= 0 && i < pCollection->GetCount())
1261 if (!UpdateProgressBar(&pProgressBarData, &progressupdatecount))
1268 if (!pObject)
break;
1269 if (!SetupCorrectCppClass(pObject, parameter))
1271 EndProgressBar(&pProgressBarData,
false);
1277 if (!ExecuteCallback(lua_callback_function, parameter, &pProgressBarData))
1281 if (shouldsave) pObject->
Save();
1284 if (_forwardprocessing) i++;
else i--;
1286 EndProgressBar(&pProgressBarData,
false);
1289 if (_forwardprocessing) i++;
else i--;
1292 struct EACH_REGION_OBJECT_DATA
1297 EProgressDataP pProgressBarData;
1298 CLASS_APPROACHES classapproach;
1300 int progressupdatecount;
1308 bool ProcessEntryDetailsCell(eMeas meas, eStaff staff, luabridge::LuaRef& lua_callback_function, luabridge::LuaRef ¶meter, EACH_REGION_OBJECT_DATA* pERData)
1315 if (_forwardprocessing)
1318 entryidx = entrycell.GetCount() - 1;
1319 while (entryidx >= 0 && entryidx < entrycell.GetCount())
1324 if (!pERData->pRegion->IsEntryPosWithin(pEntry))
break;
1325 if (!EntryMatchesFilters(pEntry))
break;
1326 if (!NotationStyleMatchesFilters(pEntry))
break;
1327 if (!AlternateNotationMatchesFilters(pEntry))
break;
1329 if (_forwardprocessing)
1331 twobyte currentinci = 0;
1336 if (!ExecuteCallback(lua_callback_function, parameter, &pERData->pProgressBarData))
1340 if (pERData->shouldsave) pEntryObject->
Save();
1348 if (lastinci == kNewInci)
break;
1349 while (lastinci >= 0)
1355 if (!ExecuteCallback(lua_callback_function, parameter, &pERData->pProgressBarData))
1359 if (pERData->shouldsave) pEntryObject->
Save();
1366 if (_forwardprocessing) entryidx++;
else entryidx--;
1378 bool ProcessMeasureDetailsCell(eMeas meas, eStaff staff, luabridge::LuaRef& lua_callback_function, luabridge::LuaRef ¶meter, EACH_REGION_OBJECT_DATA* pERData)
1384 if (!_forwardprocessing) inci = pMeasureObject->
CalcLastInci();
1385 if (inci == kNewInci)
return true;
1386 while (pMeasureObject->
Load(meas, inci))
1392 if (meas != pMeasureObject->
GetMeasure())
break;
1393 FCCell cell(meas, staff);
1394 if (!pERData->pRegion->IsCellPosWithin(&cell, pMeasureObject->
GetMeasurePos()))
break;
1396 if (!NotationStyleMatchesFilters(meas, staff, pMeasureObject->
GetMeasurePos()))
break;
1397 if (!AlternateNotationMatchesFilters(meas, staff, pMeasureObject->
GetMeasurePos()))
break;
1401 if (!ExecuteCallback(lua_callback_function, parameter, &pERData->pProgressBarData))
1405 if (pERData->shouldsave) pMeasureObject->
Save();
1410 if (inci < 0)
return true;
1421 bool ProcessCellDetailsCell(eMeas meas, eStaff staff, luabridge::LuaRef& lua_callback_function, luabridge::LuaRef ¶meter, EACH_REGION_OBJECT_DATA* pERData)
1425 FCCell cell(meas, staff);
1428 bool success = _forwardprocessing ? pCellObject->
LoadFirst() : pCellObject->
LoadLast();
1434 if (!pERData->pRegion->IsCellPosWithin(&cell, pCellObject->
GetMeasurePos()))
break;
1436 if (!NotationStyleMatchesFilters(meas, staff, pCellObject->
GetMeasurePos()))
break;
1437 if (!AlternateNotationMatchesFilters(meas, staff, pCellObject->
GetMeasurePos()))
break;
1441 if (!ExecuteCallback(lua_callback_function, parameter, &pERData->pProgressBarData))
1445 if (pERData->shouldsave) pCellObject->
Save();
1457 int ProcessForEachRegionObject(
FCMusicRegion* pRegion,
int classID, luabridge::LuaRef lua_callback_function,
bool shouldsave)
1460 if (!pRegion || pRegion->
IsEmpty())
1462 if (!_nullregionequalsall)
return 0;
1464 pRegion = &fullregion;
1466 if (!lua_callback_function.isFunction())
return 0;
1467 if (pRegion->
IsEmpty())
return 0;
1470 EACH_REGION_OBJECT_DATA erdata;
1471 erdata.pRegion = pRegion;
1472 erdata.progressupdatecount = 0;
1473 erdata.shouldsave = shouldsave;
1474 erdata.pObject = MapRegionClassApproach((
PDKFRAMEWORK_CLASSID) classID, &erdata.classapproach);
1475 if (erdata.classapproach == CLASSAPPROACH_NONE)
return 0;
1483 luabridge::LuaRef parameter(_pGlobal_LuaState);
1484 if (!SetupCorrectCppClass(erdata.pObject, parameter))
1486 EndProgressBar(&erdata.pProgressBarData,
false);
1492 if (_forwardprocessing)
1500 if ((!_partialmeasureselections) && pRegion->
IsMeasurePartial(meas))
break;
1502 if (_downwardprocessing)
1511 if (!UpdateProgressBar(&erdata.pProgressBarData, &erdata.progressupdatecount))
1513 delete erdata.pObject;
1514 return erdata.count;
1524 bool continueflag =
false;
1525 switch (erdata.classapproach)
1527 case CLASSAPPROACH_ENTRYDETAILS:
1528 case CLASSAPPROACH_NOTEDETAILS:
1532 continueflag = ProcessEntryDetailsCell(meas, staff, lua_callback_function, parameter, &erdata);
1534 case CLASSAPPROACH_MEASUREDETAILS:
1538 continueflag = ProcessMeasureDetailsCell(meas, staff, lua_callback_function, parameter, &erdata);
1540 case CLASSAPPROACH_CELLDETAILS:
1544 continueflag = ProcessCellDetailsCell(meas, staff, lua_callback_function, parameter, &erdata);
1551 delete erdata.pObject;
1552 return erdata.count;
1556 if (_downwardprocessing) slot++;
else slot--;
1560 if (_forwardprocessing) meas++;
else meas--;
1562 delete erdata.pObject;
1563 EndProgressBar(&erdata.pProgressBarData,
false);
1564 return erdata.count;
1571 int ProcessForEachDocument(luabridge::LuaRef lua_callback_function,
bool shouldsave)
1573 if (!lua_callback_function.isFunction())
return 0;
1575 int progressupdatecount;
1576 EProgressDataP pProgressBarData;
1580 StartProgressBar(&pProgressBarData, alldocs.
GetCount(), &progressupdatecount);
1583 if (_forwardprocessing)
1588 while (docidx >= 0 && docidx < alldocs.
GetCount())
1593 if (!UpdateProgressBar(&pProgressBarData, &progressupdatecount))
1600 if (!_processcurrentdoc && pDoc->
IsCurrent())
break;
1605 luabridge::LuaRef parameter(_pGlobal_LuaState, pDoc);
1609 if (!ExecuteCallback(lua_callback_function, parameter, &pProgressBarData))
1618 if (_forwardprocessing)
1624 EndProgressBar(&pProgressBarData,
false);
1629 int ProcessForEachFile(
FCStrings* pFileStrings, luabridge::LuaRef lua_callback_function,
bool shouldsave)
1631 if (!pFileStrings)
return 0;
1632 if (pFileStrings->
GetCount() == 0)
return 0;
1635 int progressupdatecount;
1636 EProgressDataP pProgressBarData;
1637 StartProgressBar(&pProgressBarData, pFileStrings->
GetCount(), &progressupdatecount);
1645 int filenameidx = 0;
1646 if (_forwardprocessing)
1649 filenameidx = pFileStrings->
GetCount() - 1;
1650 while (filenameidx >= 0 && filenameidx < pFileStrings->GetCount())
1655 if (!pString)
break;
1656 if (pString->
IsEmpty())
break;
1659 bool executereturn =
false;
1662 if (document.
Open(pString, shouldsave, &lastundostring))
1665 executereturn = ExecuteFileCallback(lua_callback_function, &document, pString, &pProgressBarData);
1666 if (executereturn && shouldsave) document.
Save();
1674 if (currentdocument.SwitchTo(&lastundostring,
true))
1676 currentdocument._DiscardSwitchBack();
1682 luabridge::LuaRef parameter(_pGlobal_LuaState, NULL);
1683 executereturn = ExecuteFileCallback(lua_callback_function, &document, NULL, &pProgressBarData);
1685 if (!executereturn)
return count;
1688 if (_forwardprocessing) filenameidx++;
else filenameidx--;
1690 EndProgressBar(&pProgressBarData,
false);
1695 int ProcessForEachInteger(
int integer1,
int integer2, luabridge::LuaRef lua_callback_function)
1700 if (integer1 > integer2) incdec = -1;
1704 int progressupdatecount;
1705 EProgressDataP pProgressBarData;
1708 StartProgressBar(&pProgressBarData, (integer2 - integer1) * incdec + 1, &progressupdatecount);
1716 for (
int i = integer1; i != integer2; i += incdec)
1719 if (!UpdateProgressBar(&pProgressBarData, &progressupdatecount))
return count;
1721 luabridge::LuaRef parameter(_pGlobal_LuaState, i + incdec);
1723 bool executereturn = ExecuteCallback(lua_callback_function, parameter, &pProgressBarData);
1724 if (!executereturn)
return count;
1726 EndProgressBar(&pProgressBarData,
false);
1737 case FCID_ACCIDENTALMOD:
1738 *pClassApproach = CLASSAPPROACH_NOTEDETAILS;
1740 case FCID_ARTICULATION:
1741 *pClassApproach = CLASSAPPROACH_ENTRYDETAILS;
1743 case FCID_BEATCHARTELEMENT:
1744 *pClassApproach = CLASSAPPROACH_MEASUREDETAILS;
1746 case FCID_BROKENBEAMMOD:
1747 *pClassApproach = CLASSAPPROACH_ENTRYDETAILS;
1754 *pClassApproach = CLASSAPPROACH_CELLDETAILS;
1757 *pClassApproach = CLASSAPPROACH_CELLDETAILS;
1759 case FCID_CROSSSTAFFMOD:
1760 *pClassApproach = CLASSAPPROACH_NOTEDETAILS;
1762 case FCID_CUSTOMSTEMMOD:
1763 *pClassApproach = CLASSAPPROACH_ENTRYDETAILS;
1766 *pClassApproach = CLASSAPPROACH_NOTEDETAILS;
1768 case FCID_ENTRYALTERMOD:
1769 *pClassApproach = CLASSAPPROACH_ENTRYDETAILS;
1771 case FCID_EXPRESSION:
1772 *pClassApproach = CLASSAPPROACH_MEASUREDETAILS;
1774 case FCID_MIDIEXPRESSION:
1775 *pClassApproach = CLASSAPPROACH_CELLDETAILS;
1777 case FCID_NOTEHEADMOD:
1778 *pClassApproach = CLASSAPPROACH_NOTEDETAILS;
1780 case FCID_PERCUSSIONNOTEMOD:
1781 *pClassApproach = CLASSAPPROACH_NOTEDETAILS;
1783 case FCID_PERFORMANCEMOD:
1784 *pClassApproach = CLASSAPPROACH_NOTEDETAILS;
1786 case FCID_SECONDARYBEAMBREAKMOD:
1787 *pClassApproach = CLASSAPPROACH_ENTRYDETAILS;
1789 case FCID_SEPARATEMEASURENUMBER:
1790 *pClassApproach = CLASSAPPROACH_CELLDETAILS;
1792 case FCID_SEPARATEPLACEMENT:
1793 *pClassApproach = CLASSAPPROACH_MEASUREDETAILS;
1795 case FCID_SMARTSHAPEENTRYMARK:
1796 *pClassApproach = CLASSAPPROACH_ENTRYDETAILS;
1799 *pClassApproach = CLASSAPPROACH_ENTRYDETAILS;
1801 case FCID_SYLLABLEENTRYMOD:
1802 *pClassApproach = CLASSAPPROACH_ENTRYDETAILS;
1804 case FCID_TABLATURENOTEMOD:
1805 *pClassApproach = CLASSAPPROACH_NOTEDETAILS;
1808 *pClassApproach = CLASSAPPROACH_ENTRYDETAILS;
1811 *pClassApproach = CLASSAPPROACH_NONE;
1834 void StartProgressBar(EProgressDataP *ppProgressBarData,
int count,
int* pProgressUpdateCount)
1836 _progressbar_useraborted =
false;
1837 *pProgressUpdateCount = 0;
1838 if (!_useprogressbar)
return;
1839 *ppProgressBarData = FX_StartMassEdit(NULL, count);
1850 bool UpdateProgressBar(EProgressDataP *ppProgressBarData,
int* pProgressUpdateCount)
1852 if (!_useprogressbar)
return true;
1853 if (!*ppProgressBarData)
return true;
1854 (*pProgressUpdateCount)++;
1855 if (*pProgressUpdateCount < _progressfrequency)
return true;
1857 bool continueflag = (FX_MassEditProgress(*ppProgressBarData, _progressfrequency, 0, 0, 0) != 0);
1858 if ((!continueflag) && _abortableprogressbar)
1860 _progressbar_useraborted =
true;
1861 FX_EndMassEdit(*ppProgressBarData,
true);
1872 void EndProgressBar(EProgressDataP *ppProgressBarData,
bool abortprogress)
1874 if (!_useprogressbar)
return;
1875 if (!*ppProgressBarData)
return;
1876 FX_EndMassEdit(*ppProgressBarData, abortprogress);
1877 *ppProgressBarData = NULL;
1881 bool SetupCorrectCppClass(
__FCBaseData* pProcessObject, luabridge::LuaRef ¶meter)
1885 case FCID_ACCIDENTALMOD:
1886 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCAccidentalMod*)pProcessObject);
1888 case FCID_ALLOTMENT:
1889 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCAllotment*)pProcessObject);
1891 case FCID_ARTICULATION:
1892 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCArticulation*)pProcessObject);
1894 case FCID_ARTICULATIONDEF:
1895 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCArticulationDef*)pProcessObject);
1897 case FCID_BACKWARDREPEAT:
1898 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCBackwardRepeat*)pProcessObject);
1901 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCBaseline*)pProcessObject);
1904 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCBeamMod*)pProcessObject);
1906 case FCID_BEATCHARTELEMENT:
1907 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCBeatChartElement*)pProcessObject);
1909 case FCID_BROKENBEAMMOD:
1910 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCBrokenBeamMod*)pProcessObject);
1912 case FCID_CATEGORYDEF:
1913 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCCategoryDef*)pProcessObject);
1915 case FCID_CELLCLEFCHANGE:
1916 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCCellClefChange*)pProcessObject);
1918 case FCID_CELLFRAMEHOLD:
1919 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCCellFrameHold*)pProcessObject);
1921 case FCID_CELLGRAPHIC:
1922 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCCellGraphic*)pProcessObject);
1925 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCCellText*)pProcessObject);
1927 case FCID_CENTERSMARTSHAPE:
1928 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCCenterSmartShape*)pProcessObject);
1931 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCChord*)pProcessObject);
1933 case FCID_CHORDSUFFIXELEMENT:
1936 case FCID_CHORUSSYLLABLE:
1937 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCChorusSyllable*)pProcessObject);
1940 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCClefDef*)pProcessObject);
1942 case FCID_CROSSSTAFFMOD:
1943 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCCrossStaffMod*)pProcessObject);
1945 case FCID_CUSTOMSMARTLINEDEF:
1948 case FCID_CUSTOMSTEMMOD:
1949 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCCustomStemMod*)pProcessObject);
1952 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCDotMod*)pProcessObject);
1954 case FCID_ENCLOSURE:
1955 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCEnclosure*)pProcessObject);
1957 case FCID_ENDINGREPEAT:
1958 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCEndingRepeat*)pProcessObject);
1960 case FCID_ENTRYALTERMOD:
1961 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCEntryAlterMod*)pProcessObject);
1963 case FCID_EXECUTABLESHAPEDEF:
1966 case FCID_EXPRESSION:
1967 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCExpression*)pProcessObject);
1969 case FCID_FREEZESYSTEM:
1970 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCFreezeSystem*)pProcessObject);
1972 case FCID_FRETBOARDSTYLEDEF:
1975 case FCID_FRETBOARDGROUPDEF:
1978 case FCID_FRETINSTRUMENTDEF:
1982 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCGroup*)pProcessObject);
1984 case FCID_INDEPENDENTCELLDETAIL:
1987 case FCID_INSTRUMENTDEF:
1988 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCInstrumentDef*)pProcessObject);
1990 case FCID_INSTRUMENTPLAYBACKDATA:
1994 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCMeasure*)pProcessObject);
1996 case FCID_MEASURENUMBERREGION:
1999 case FCID_METATOOLASSIGNMENT:
2002 case FCID_MIDIEXPRESSION:
2003 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCMidiExpression*)pProcessObject);
2005 case FCID_MULTIMEASUREREST:
2006 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCMultiMeasureRest*)pProcessObject);
2008 case FCID_MULTISTAFFINSTRUMENT:
2011 case FCID_NOTEHEADMOD:
2012 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCNoteheadMod*)pProcessObject);
2014 case FCID_PERCUSSIONLAYOUTNOTE:
2017 case FCID_PERCUSSIONSTAFF:
2018 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCPercussionStaff*)pProcessObject);
2020 case FCID_PERFORMANCEMOD:
2021 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCPerformanceMod*)pProcessObject);
2024 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCPage*)pProcessObject);
2026 case FCID_PAGEGRAPHIC:
2027 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCPageGraphic*)pProcessObject);
2030 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCPageText*)pProcessObject);
2032 case FCID_PERCUSSIONNOTEMOD:
2036 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCRawText*)pProcessObject);
2038 case FCID_SECONDARYBEAMBREAKMOD:
2041 case FCID_SECTIONSYLLABLE:
2042 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCSectionSyllable*)pProcessObject);
2044 case FCID_SEPARATEMEASURENUMBER:
2047 case FCID_SEPARATEPLACEMENT:
2051 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCShapeDef*)pProcessObject);
2053 case FCID_SHAPEEXPRESSIONDEF:
2056 case FCID_SMARTSHAPE:
2057 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCSmartShape*)pProcessObject);
2059 case FCID_SMARTSHAPEENTRYMARK:
2062 case FCID_SMARTSHAPEMEASUREMARK:
2066 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCStaff*)pProcessObject);
2068 case FCID_STAFFLIST:
2069 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCStaffList*)pProcessObject);
2071 case FCID_STAFFNAMEPOSITION:
2074 case FCID_STAFFSTYLEASSIGN:
2075 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCStaffStyleAssign*)pProcessObject);
2077 case FCID_STAFFSTYLEDEF:
2078 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCStaffStyleDef*)pProcessObject);
2080 case FCID_STAFFSYSTEM:
2081 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCStaffSystem*)pProcessObject);
2084 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCStemMod*)pProcessObject);
2086 case FCID_SYLLABLEENTRYMOD:
2087 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCSyllableEntryMod*)pProcessObject);
2089 case FCID_SYSTEMSTAFF:
2090 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCSystemStaff*)pProcessObject);
2092 case FCID_TABLATURENOTEMOD:
2093 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCTablatureNoteMod*)pProcessObject);
2095 case FCID_TEMPOELEMENT:
2096 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCTempoElement*)pProcessObject);
2098 case FCID_TEXTBLOCK:
2099 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCTextBlock*)pProcessObject);
2101 case FCID_TEXTEXPRESSIONDEF:
2104 case FCID_TEXTREPEAT:
2105 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCTextRepeat*)pProcessObject);
2107 case FCID_TEXTREPEATDEF:
2108 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCTextRepeatDef*)pProcessObject);
2111 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCTieMod*)pProcessObject);
2114 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCTuplet*)pProcessObject);
2116 case FCID_VERSESYLLABLE:
2117 parameter = luabridge::LuaRef(_pGlobal_LuaState, (
FCVerseSyllable*)pProcessObject);
2121 #ifdef PDK_FRAMEWORK_DIAGNOSE
2134 _progressfrequency = 20;
2135 _timingstart = _timingend = 0;
2136 _forwardprocessing =
true;
2137 _downwardprocessing =
true;
2138 _partialmeasureselections =
true;
2139 _nullregionequalsall =
false;
2140 _useprogressbar =
false;
2141 _abortableprogressbar =
false;
2142 _progressbar_useraborted =
false;
2144 _processscorepart =
true;
2145 _processcurrentpart =
true;
2146 _processcurrentdoc =
true;
2182 int count = ProcessForEach(pCollection, lua_callback_function,
false);
2218 int count = ProcessForEach(pCollection, lua_callback_function,
true);
2247 int count = ProcessRegionEntries(pRegion, lua_callback_function,
false);
2290 int count = ProcessRegionEntries(pRegion, lua_callback_function,
true);
2339 int count = ProcessRegionNotes(pRegion, lua_callback_function,
false);
2379 int count = ProcessRegionNotes(pRegion, lua_callback_function,
true);
2411 int count = ProcessForEachCell(pRegion, lua_callback_function);
2438 int count = ProcessForEachPart(lua_callback_function);
2505 if (!lua_callback_function.isFunction())
return 0;
2513 int count = ProcessForEach(pCollection, lua_callback_function,
false);
2547 if (!lua_callback_function.isFunction())
return 0;
2555 int count = ProcessForEach(pCollection, lua_callback_function,
true);
2608 int count = ProcessForEachRegionObject(pRegion, classID, lua_callback_function,
false);
2639 int count = ProcessForEachRegionObject(pRegion, classID, lua_callback_function,
true);
2680 int count = ProcessForEachDocument(lua_callback_function,
false);
2724 int count = ProcessForEachDocument(lua_callback_function,
true);
2772 int count = ProcessForEachFile(pFileStrings, lua_callback_function,
false);
2824 int count = ProcessForEachFile(pFileStrings, lua_callback_function,
true);
2859 int ForEachInteger(
int integer1,
int integer2, luabridge::LuaRef lua_callback_function)
2862 int count = ProcessForEachInteger(integer1, integer2, lua_callback_function);
2879 return _progressfrequency;
2888 return _abortableprogressbar;
2907 return _loadlayermode;
2988 if (freq < 1)
return;
2989 _progressfrequency = freq;
3123 _entryfilters_AND.ClearAll();
3124 _entryfilters_OR.ClearAll();
3125 _entryfilters_NOT.ClearAll();
3208 _notefilters_AND.ClearAll();
3209 _notefilters_OR.ClearAll();
3210 _notefilters_NOT.ClearAll();
3294 _altnotationfilters_AND.ClearAll();
3295 _altnotationfilters_OR.ClearAll();
3296 _altnotationfilters_NOT.ClearAll();
3381 _notationstylefilters_AND.ClearAll();
3382 _notationstylefilters_OR.ClearAll();
3383 _notationstylefilters_NOT.ClearAll();
3422 if (_timingend == 0)
return 0;
3423 return (_timingend - _timingstart);
Collection class for FCCustomSmartLineDef class objects.
Definition: ff_smartshapes.h:3137
bool GetNullRegionEqualsAll() const
Returns if NULL regions should automatically be interpreted as a full document region, or not. This setting affects all region-based iterators.
Definition: fflua_luaiterator.h:2935
__FCBase * GetItemAt(int index)
Returns the object at the index position. Index is 0-based.
Definition: finaleframework.cpp:12797
The class for a note definition in a percussion layout.
Definition: ff_other.h:23136
Class that specifies the cross-staff connection for a note.
Definition: ff_entrydetails.h:1007
The class for a section syllable.
Definition: ff_entrydetails.h:2718
void SetProcessCurrentPart(bool state)
Sets if the part currently in editing focus should be processed in ForEachPart calls.
Definition: fflua_luaiterator.h:3017
bool SwitchBack(bool saveedits)
Ends the started edit block and switch back to the previous document.
Definition: finaleframework.cpp:27152
The class for a measure number region.
Definition: ff_other.h:5254
Class for a shape expression definition.
Definition: ff_other.h:14483
void SetForwardProcessing(bool forward)
Sets the direction of the iteration.
Definition: fflua_luaiterator.h:3046
bool IsNotationStyleFilterAdded(int filter, int logicmode)
Returns true if a specific filter for a notation style has been added/activated for the iterator...
Definition: fflua_luaiterator.h:3396
Class for a collection of documents. Usually used to get all the currently loaded documents in Finale...
Definition: ff_documents.h:277
virtual TimeEdu32 GetMeasurePos() const
Virtual method for cell-attached data that has a position in the measure.
Definition: ff_celldetails.h:86
Base class for all collections based on decendants from __FCBaseData.
Definition: ff_basecollection.h:465
Class for chord assignments to a measure/staff.
Definition: ff_celldetails.h:1144
The class for a verse syllable.
Definition: ff_entrydetails.h:2679
int LoadAll()
Loads all parts (including the "score part") for the document.
Definition: finaleframework.cpp:27034
bool Close()
Closes the document.
Definition: finaleframework.cpp:27290
Definition: fflua_luaiterator.h:128
virtual bool LoadNext()
Overloaded method of LoadNext that will only load incis within the same cmper1/cmper2.
Definition: finaleframework.cpp:20265
Class to encapsulate enclosures (available for example in expressions and measure numbers...
Definition: ff_other.h:2743
int ForEachNote(FCMusicRegion *pRegion, luabridge::LuaRef lua_callback_function)
Browses through all notes (as in noteheads) in a region. If a note entry consists of a chord with mul...
Definition: fflua_luaiterator.h:2336
Collection class for FCMultiMeasureRest class objects.
Definition: ff_othercollection.h:1051
twobyte GetEndMeasure() const
Returns the end measure for the region.
Definition: ff_region.h:408
Definition: fflua_luaiterator.h:104
void SetDirty(bool state)
Sets the "dirty" flag for the document (that indicates that the document needs to be saved)...
Definition: ff_documents.h:240
Encapsulates baselines offset values for lyrics, expressions, fretboards and chords.
Definition: ff_details.h:1069
bool GetGraceNote() const
Gets the grace note state of the note entry.
Definition: ff_noteframe.h:1467
Class that stores one record of a fretboard chord definition.
Definition: ff_other.h:21082
ALTERNATE_STAFF
Alternate staff notation styles for FCStaff::GetAltNotationStyle() and FCStaff::SetAltNotationStyle()...
Definition: ff_other.h:8995
bool RemoveAltNotationFilter(int filter, int logicmode)
Removes a alternate notation filter.
Definition: fflua_luaiterator.h:3274
ENTNUM GetEntryNumber() const
Returns the internal entry number (ID) for the note entry.
Definition: ff_noteframe.h:1059
Class for page-assigned graphics. Currently, this class can only be used to edit existing page graphi...
Definition: ff_other.h:18859
Class for attaching an tuplet to an entry.
Definition: ff_entrydetails.h:1647
Definition: fflua_luaiterator.h:162
Class for freezing a system at a specific measure.
Definition: ff_other.h:13506
virtual eStaff GetStaff() const
Virtual method for returning the staff number.
Definition: ff_other.h:138
Class for custom stem shapes (in Finale's Special Tools). The data is connected to either an upstem o...
Definition: ff_entrydetails.h:3658
Collection class for FCShapeDef class objects, which defines the shape definitions in the document...
Definition: ff_othercollection.h:1303
Class for measure/cell-attached graphic objects.
Definition: ff_celldetails.h:1809
Class for acciental modifications (as in Finale's Special Tools).
Definition: ff_entrydetails.h:3039
Collection class for FCFretboardGroupDef class objects.
Definition: ff_othercollection.h:1379
int ForEachDocumentSaved(luabridge::LuaRef lua_callback_function)
Browses through all the currently opened documents, passes the document to the Lua callback function...
Definition: fflua_luaiterator.h:2721
Collection class for FCShapeExpressionDef class objects.
Definition: ff_othercollection.h:759
Class for a multi-measure rest instance.
Definition: ff_other.h:18234
Class for a category definition.
Definition: ff_other.h:12571
void SetCString(const char *pszBuffer, int maxchars=-1)
Sets the string, using a C-string version of the string.
Definition: finaleframework.cpp:1030
static double GetHiResTimer()
Returns a high-resolution timer value, mainly for use with internal profilers.
Definition: finaleframework.cpp:22004
bool SwitchTo(FCString *pUndoString, bool saveedits)
Switch document focus to this document and start a new (nested) undo/redo record, without closing the...
Definition: finaleframework.cpp:27129
void SetNullRegionEqualsAll(bool state)
Sets if NULL regions should automatically be interpreted as a full document region, or not. This setting affects all region-based iterators.
Definition: fflua_luaiterator.h:3031
Class for staff (or staff style) name positioning data.
Definition: ff_other.h:6956
Class for measure-attached (cell-attached) text blocks. The ConnectCell method must be called prior t...
Definition: ff_celldetails.h:1876
int CalcMeasureSpan()
Calculates the number of measures in the region.
Definition: ff_region.h:495
Class for a page-connected text block.
Definition: ff_other.h:15674
Class that contains data that appears in the middle of a long smart shape. This class is normally lin...
Definition: ff_smartshapes.h:418
int GetProgressUpdateFrequency() const
Returns the update frequency for the progress bar.
Definition: fflua_luaiterator.h:2877
Definition: fflua_luaiterator.h:107
void SetUseProgressBar(bool use)
Sets if the update progress bar should be used or not.
Definition: fflua_luaiterator.h:2973
bool ClearItemAt(int index)
Deletes the object at the index position and disposes the object. Index is 0-based.
Definition: finaleframework.cpp:12821
Class for manually broken beam adjustments (in Finale's Special Tools).
Definition: ff_entrydetails.h:4492
Class for a text block.
Definition: ff_other.h:15039
Class for Lua callback iterators. This class is not part of the C++ PDK Framework.
Definition: fflua_luaiterator.h:72
virtual void SetNoteEntry(FCNoteEntry *pEntry)
Maps the data to an entry.
Definition: ff_entrydetails.h:102
Definition: fflua_luaiterator.h:143
The class for an articulation definition. On Finale 2012 and above, this class supports the Unicode c...
Definition: ff_other.h:11535
bool GetAccidentalFreeze() const
Returns the freezed accidental state.
Definition: ff_noteframe.h:103
bool IsEntryPosWithin(FCNoteEntry *pEntry)
Checks if a entry is within the region. This checks for partial measures.
Definition: finaleframework.cpp:14672
Definition: fflua_luaiterator.h:165
bool Open(FCString *pFilePath, bool createwindow, FCString *pUndoString)
Opens a file as a new Finale documnent. The new document will automatically get editing focus...
Definition: finaleframework.cpp:27216
Collection class for FCTextRepeatDef class objects.
Definition: ff_othercollection.h:1197
Class with adjustments to the ties (in Finale's Special Tools).
Definition: ff_entrydetails.h:4372
Collection class for FCPage class objects.
Definition: ff_othercollection.h:59
bool GetNoteDetailFlag() const
Returns true for existing note detail records.
Definition: ff_noteframe.h:1789
The class for an instrument definition item (in the instrument list/Score Manager).
Definition: ff_other.h:22745
LUAITERATOR_LOGICMETHOD
Logical operators that are used for filters. If no filters are added/activated, all items are automat...
Definition: fflua_luaiterator.h:181
Class for controlling justification/alignment for all syllables that are connected to an entry...
Definition: ff_entrydetails.h:2742
bool GetProcessCurrentDocument() const
Returns if the document currently in editing focus should be processed in ForEachDocument and ForEach...
Definition: fflua_luaiterator.h:2928
bool CalcAccidental() const
Returns the displayed state of an accidental. This is the method that should be used to find out if a...
Definition: finaleframework.cpp:15738
int ForEachObjectSaved(int classID, luabridge::LuaRef lua_callback_function)
Loads all the objects of a specific type and sends them to a Lua callback function. After callback has processed the object, each object is saved.
Definition: fflua_luaiterator.h:2545
bool GetSmartShapeFlag() const
Returns true if the entry is marked to contain smart shapes.
Definition: ff_noteframe.h:1850
bool IsScore()
Returns true if the part is the score.
Definition: ff_parts.h:289
Definition: fflua_luaiterator.h:125
Collection class for FCFretInstrumentDef class objects.
Definition: ff_othercollection.h:1226
Encapsulates the continous MIDI data in a cell.
Definition: ff_celldetails.h:248
PDKFRAMEWORK_CLASSID
Constants for the GetClassID method.
Definition: ff_base.h:60
Class for text repeat assignments to a measure. The assignment is connected with a FCTextRepeatDef de...
Definition: ff_other.h:19723
STAFFNOTATION_STYLE GetNotationStyle() const
Returns the notation style for the staff.
Definition: ff_other.h:9452
The class for a backward repeat definition.
Definition: ff_other.h:21623
Definition: fflua_luaiterator.h:110
Collection class for FCMeasure class objects.
Definition: ff_othercollection.h:189
bool GetProcessScorePart() const
Returns if the score part (the part with part ID 0) should be processed in ForEachPart calls...
Definition: fflua_luaiterator.h:2915
bool CloseCurrentDocumentWindow()
Closes the current document Window.
Definition: finaleframework.cpp:27283
The class for a fretboard style definition, which reflects the content the "Fretboard Style" dialog b...
Definition: ff_other.h:20547
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
Collection class for FCGroup class objects.
Definition: ff_detailscollection.h:22
bool IsUntitled()
Returns true if the document has no file connected to it.
Definition: finaleframework.cpp:27302
void ClearAllNotationStyleFilters()
Removes all filters for notation styles. This will result in all items being processed.
Definition: fflua_luaiterator.h:3379
Class for an opened Finale document. An opened Finale document has a 1-based ID and can be displayed ...
Definition: ff_documents.h:26
__FCStaffBase::ALTERNATE_STAFF GetAltNotationStyle()
Returns the alternate notation style for the staff.
Definition: ff_other.h:9507
FCNote * GetItemAt(int index)
Overload version of GetItemAt(), which returns a note object (if available) for the note entry...
Definition: ff_noteframe.h:855
Class that stores one "inci" of a staff list (for a system or for the global list of staves)...
Definition: ff_other.h:6706
Class for a text expression definition.
Definition: ff_other.h:13603
The class for raw text objects. All other text classes are based on this class, but it can also be us...
Definition: ff_text.h:16
Class that handles separate placement for repeats.
Definition: ff_other.h:16251
Collection class for FCChord class objects.
Definition: ff_celldetails.h:2140
bool GetArticulationFlag() const
Returns true if the entry is marked to contain articulations.
Definition: ff_noteframe.h:1843
int LoadAll()
Gets all open docs into the collection.
Definition: finaleframework.cpp:27378
Definition: fflua_luaiterator.h:92
void SetLoadLayerMode(int loadlayermode)
Sets the load layer mode for the note entry iterators, such as ForEachEntry(), ForEachNote(), etc.
Definition: fflua_luaiterator.h:3005
Class for tablature instruments definitions.
Definition: ff_other.h:23746
Class for manual stem adjustments (in Finale's Special Tools).
Definition: ff_entrydetails.h:1307
bool GetSpecialAltsFlag() const
Returns true for existing special alteration records.
Definition: ff_noteframe.h:1807
bool LoadForCell(FCCell *pCell, TimeEdu32 durationpos)
Loads the staff spec data based on a position in a cell.
Definition: finaleframework.cpp:8771
Definition: fflua_luaiterator.h:184
twobyte CalcStaffNumber(twobyte slot)
Calculates the staff number, based on the region's slot number.
Definition: ff_region.h:522
The class for a chorus syllable.
Definition: ff_entrydetails.h:2699
FCLuaIterator()
The constructor.
Definition: fflua_luaiterator.h:2132
Class for smartshape assignments/connections to an entry.
Definition: ff_smartshapes.h:305
int ForEachSaved(__FCCollectionData *pCollection, luabridge::LuaRef lua_callback_function)
Browses through the items in a collection. After the Lua callback function has processed the object...
Definition: fflua_luaiterator.h:2215
Definition: fflua_luaiterator.h:131
TimeEdu32 CalcNondottedDuration()
Returns the non-dotted symbolic duration of the entry.
Definition: ff_noteframe.h:1550
Definition: fflua_luaiterator.h:134
int ForEachNoteSaved(FCMusicRegion *pRegion, luabridge::LuaRef lua_callback_function)
Browses through all notes (as in noteheads) in a region and saves the entries. If a note entry consis...
Definition: fflua_luaiterator.h:2376
Class that represent one part in a document. The class also provides methods to switch between parts...
Definition: ff_parts.h:67
void SetProcessScorePart(bool state)
Sets if the score part (the part with part ID 0) should be processed in ForEachPart calls...
Definition: fflua_luaiterator.h:3011
Definition: fflua_luaiterator.h:101
The class for one single beat chart element.
Definition: ff_other.h:22059
bool GetForwardProcessing() const
Returns the direction of the iteration.
Definition: fflua_luaiterator.h:2947
Collection class for FCExecutableShapeDef class objects.
Definition: ff_othercollection.h:1285
int ForEach(__FCCollectionData *pCollection, luabridge::LuaRef lua_callback_function)
Browses through the items in a collection and sends the object to a Lua callback function, similar to the each() iterator in JW Lua.
Definition: fflua_luaiterator.h:2179
Class for a shape definition (as in Finale's Shape selection dialog).
Definition: ff_other.h:2109
int ForEachCell(FCMusicRegion *pRegion, luabridge::LuaRef lua_callback_function)
Browses through each cell in a region, similar to the eachcell() iterator in JW Lua.
Definition: fflua_luaiterator.h:2408
Definition: fflua_luaiterator.h:95
bool RemoveNotationStyleFilter(int filter, int logicmode)
Removes a notation style filter.
Definition: fflua_luaiterator.h:3361
int GetCount() const
Returns the number of elements of the collection.
Definition: ff_basecollection.h:86
Class for expression assignments to a measure/staff.
Definition: ff_other.h:16483
bool GetStemDetailFlag() const
Gets the flag state for stem detail records.
Definition: ff_noteframe.h:1828
bool AddAltNotationFilter(int filter, int logicmode)
Adds/activates an alternate notation filter.
Definition: fflua_luaiterator.h:3247
Collection class for FCPart objects.
Definition: ff_parts.h:517
int ForEachRegionObjectSaved(FCMusicRegion *pRegion, int classID, luabridge::LuaRef lua_callback_function)
Loads all the objects of a specific type that appears within a region and sends them to a Lua callbac...
Definition: fflua_luaiterator.h:2636
Class with info about one tablature note.
Definition: ff_entrydetails.h:4570
bool IsCurrent()
Returns true if the current document is the current document.
Definition: ff_documents.h:60
bool IsEmpty() const
Returns true if the region is empty.
Definition: ff_region.h:112
The class for a staff system on a page.
Definition: ff_other.h:3548
FCString * GetItemAt(int index)
Overridden GetItemAt() method.
Definition: ff_basecollection.h:958
void SetAbortableProgressBar(bool state)
Sets if the progress bar should be abortable (by the Esc key).
Definition: fflua_luaiterator.h:2996
Class that contains independent key/time signatures for a cell.
Definition: ff_celldetails.h:2172
Collection class for FCClefDef class objects.
Definition: ff_globals.h:225
Definition: fflua_luaiterator.h:187
bool GetTie() const
Gets the tie start state for the note.
Definition: ff_noteframe.h:175
int ForEachEntry(FCMusicRegion *pRegion, luabridge::LuaRef lua_callback_function)
Browses through the entries in a region, similar to the eachentry() iterator in JW Lua...
Definition: fflua_luaiterator.h:2244
Encapsulates one note in a note entry (from the FCNoteEntry class).
Definition: ff_noteframe.h:27
Definition: fflua_luaiterator.h:122
The class for a text repeat definition.
Definition: ff_other.h:19396
Class for staff style assignments to a staff.
Definition: ff_other.h:18060
Class for a manually added or edited measure number in a cell.
Definition: ff_celldetails.h:630
Class for allotment data (in the Document Options).
Definition: ff_other.h:18752
bool IsAltNotationFilterAdded(int filter, int logicmode)
Returns true if a specific filter for alternate notation has been added/activated for the iterator...
Definition: fflua_luaiterator.h:3310
LUAITERATOR_NOTEFILTERS
Constants for the note filters.
Definition: fflua_luaiterator.h:159
bool IsEntryFilterAdded(int filter, int logicmode)
Returns true if a specific note entry filter has been added/activated for the iterator.
Definition: fflua_luaiterator.h:3138
Collection class for FCFretboardStyleDef class objects.
Definition: ff_othercollection.h:1355
int GetIndexOf(__FCBase *pObject)
Returns the 0-based order index for the object within the collection.
Definition: finaleframework.cpp:12805
Class for custom beam adjustments (in Finale's Special Tools).
Definition: ff_entrydetails.h:3758
Definition: fflua_luaiterator.h:86
bool GetLyricFlag() const
Returns the flag that marks that an entry has syllable attached to it.
Definition: ff_noteframe.h:1820
Class that holds the TGF frames and the clef changes of a TGF frame.
Definition: ff_celldetails.h:900
The class that reference a cell (one measure on one staff) in the musical "grid". ...
Definition: ff_cell.h:17
Contains a clef change inside a cell. This is an item member in a FCCellClefChanges collection (creat...
Definition: ff_other.h:24169
int ForEachEntrySaved(FCMusicRegion *pRegion, luabridge::LuaRef lua_callback_function)
Browses through and saves the entries in a region, similar to the eachentrysaved() iterator in JW Lua...
Definition: fflua_luaiterator.h:2287
FCDocument * GetItemAt(int index)
Overridden version of GetItemAt().
Definition: ff_documents.h:330
bool GetProgressBarUserAborted() const
Returns true if the processing was aborted by the user (using the Esc key) during the last processing...
Definition: fflua_luaiterator.h:2896
Base class for the Finale Framework classes.
Definition: ff_base.h:47
An object that contains one staff list section (out of 4). Before data is loaded/saved, the SetMode() method must be called.
Definition: ff_other.h:23363
bool AddEntryFilter(int filter, int logicmode)
Adds/activates a note entry filter.
Definition: fflua_luaiterator.h:3077
Collection class for FCCategoryDef class objects.
Definition: ff_othercollection.h:669
Class for attaching an articulation definition to an entry.
Definition: ff_entrydetails.h:1450
bool SetFullDocument()
Sets the region to span the full document.
Definition: finaleframework.cpp:14544
The class for a measure (the full vertical measure stack) in the document. It maps the Measure Attrib...
Definition: ff_other.h:4052
bool IsNoteFilterAdded(int filter, int logicmode)
Returns true if a specific note filter has been added/activated for the iterator. ...
Definition: fflua_luaiterator.h:3223
bool IsNote()
Returns true if entry is a note.
Definition: ff_noteframe.h:1886
bool Save()
Saves the current document at the current document path.
Definition: finaleframework.cpp:27211
void ClearAllNoteFilters()
Removes all note filters.
Definition: fflua_luaiterator.h:3206
Collection class for FCTextExpressionDef class objects.
Definition: ff_othercollection.h:732
bool GetPerformanceDataFlag() const
Returns true for existing performance data records.
Definition: ff_noteframe.h:1799
Definition: fflua_luaiterator.h:116
Class that stores the information for drum mapping, either for a staff or staff style.
Definition: ff_other.h:6860
virtual bool LoadFirst()
Overloads the LoadFirst method with a one that loads the cell data into cmper1 (staff), cmper2 (measure), inci (0)
Definition: finaleframework.cpp:20228
bool IsDotted()
Returns true if it's a dotted entry.
Definition: finaleframework.cpp:17069
Class for a multi-staff instrument defined in the Score Manager.
Definition: ff_other.h:18540
Definition: fflua_luaiterator.h:169
The class for a staff in the score. It is also a base class for staff styles.
Definition: ff_other.h:10912
Collection class for FCPageGraphic class objects.
Definition: ff_othercollection.h:1167
Base class for all data-related classes (that handles Finale data).
Definition: ff_base.h:628
STAFFNOTATION_STYLE
Styles for the FCStaff::GetNotationStyle() and FCStaff::SetNotationStyle() methods. The constants are also used for the similar FCStaffStyleDef methods.
Definition: ff_other.h:8977
Definition: fflua_luaiterator.h:146
void SetLoadLayerMode(int mode)
Sets the "layer mode" for the Load method. This must be called/st before any Load() call...
Definition: ff_noteframe.h:3078
virtual bool Save()
Saves the currently loaded to its current location.
Definition: finaleframework.cpp:848
int ForEachFile(FCStrings *pFileStrings, luabridge::LuaRef lua_callback_function)
Opens all the files in a list of strings (as a FCStrings object), and passes the document to the Lua ...
Definition: fflua_luaiterator.h:2769
void SetPartialMeasureSelections(bool partialselections)
Returns partially selected measures should be processed.
Definition: fflua_luaiterator.h:3065
int ForEachDocument(luabridge::LuaRef lua_callback_function)
Browses through all the currently opened documents, and passes the document to the Lua callback funct...
Definition: fflua_luaiterator.h:2677
bool SwitchTo()
Sets the focus to this part (but does not set it in view).
Definition: ff_parts.h:240
void ConnectCell(FCCell *pCell)
Connects the object to a cell. This must be done prior to any load/save operations.
Definition: ff_celldetails.h:50
void ClearAllEntryFilters()
Removes all entry filters. This will result in all entry being processed by the ForEachEntry and ForE...
Definition: fflua_luaiterator.h:3121
int ForEachPart(luabridge::LuaRef lua_callback_function)
Browses through all the parts in the current document, and passes the part to the callback function...
Definition: fflua_luaiterator.h:2435
Class for (what it seems) the sole purpose of note entry resize.
Definition: ff_entrydetails.h:2936
virtual bool Load(CMPER itemno, twobyte inci)
Loads the indicated record within the item number.
Definition: finaleframework.cpp:4169
bool GetAbortableProgressBar() const
Returns if the progress bar should be abortable (by the Esc key).
Definition: fflua_luaiterator.h:2886
static void GetLastUndoString(FCString *pString)
Fetches the last undo string for the edit block.
Definition: ff_documents.h:254
bool IsMeasurePartial(eMeas measure)
Returns true if a specific measure is partially selected.
Definition: finaleframework.cpp:14696
bool LoadForEntry(FCNoteEntry *pNoteEntry)
Loads the staff spec data based on the position in the note entry.
Definition: finaleframework.cpp:8761
bool GetSecondaryBeamFlag() const
Returns true for secondary beam detail records.
Definition: ff_noteframe.h:1836
bool RemoveNoteFilter(int filter, int logicmode)
Removes a note filter.
Definition: fflua_luaiterator.h:3188
void SetProgressUpdateFrequency(int freq)
Sets the update frequency for the progress bar.
Definition: fflua_luaiterator.h:2986
Definition: fflua_luaiterator.h:149
Collection class for FCMeasureNumberRegion class objects.
Definition: ff_othercollection.h:327
Base class for "other" (ot_*) data with incis.
Definition: ff_other.h:59
virtual const PDKFRAMEWORK_CLASSID GetClassID()=0
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
virtual bool LoadLast()
Overloads the LoadLast method with a one that loads the cell data into cmper1 (staff), cmper2 (measure) and the last found inci.
Definition: finaleframework.cpp:20243
Class that provides storage for text. This is to achieve platform-transparent text handling...
Definition: ff_base.h:1473
virtual twobyte CalcLastInci()
For internal use only!
Definition: ff_base.h:700
Encapsulates a note entry from an owner class (for example FCNoteEntryCell, FCNoteEntryLayer) class...
Definition: ff_noteframe.h:808
Collection class for FCPageText class objects.
Definition: ff_othercollection.h:851
bool IsCurrent()
Returns true if the part is the very same as the current part in the editing focus.
Definition: ff_parts.h:308
Base class for data that attach to cells. A call to the ConnectCell method is required prior to loadi...
Definition: ff_celldetails.h:21
Base class that provides the basic functionality for entry detail data (such as Special Tools modific...
Definition: ff_entrydetails.h:25
bool AddNoteFilter(int filter, int logicmode)
Adds/activates a note filter.
Definition: fflua_luaiterator.h:3162
A record that represents a smart shape in the score. It's connected to a score through FCSmartShapeMe...
Definition: ff_smartshapes.h:925
virtual twobyte CalcLastInci()
Overridden version of CalcLastInci for __FCInciOther-based classes.
Definition: finaleframework.cpp:4187
The class for a custom smart shape lines.
Definition: ff_smartshapes.h:1911
bool GetUseProgressBar() const
Returns if the update progress bar should be used or not.
Definition: fflua_luaiterator.h:2871
Definition: fflua_luaiterator.h:98
Class that encapsulates EREGION and provides additional functionality to region handling.
Definition: ff_region.h:24
Class for a staff style definition.
Definition: ff_other.h:17040
The class for a single tempo change in the Tempo Tool. The tempo elements should be stored in measure...
Definition: ff_other.h:22334
twobyte GetStartSlot() const
Returns the start slot (staff) for the region.
Definition: ff_region.h:435
The class representing a physical page in Finale.
Definition: ff_other.h:3240
FCPart * GetItemAt(int index)
Definition: ff_parts.h:591
The class for instrument playback data. This is also the link between staves/staff styles and the FCI...
Definition: ff_other.h:22991
Collection class for FCString class objects.
Definition: ff_basecollection.h:924
bool RemoveEntryFilter(int filter, int logicmode)
Removes a note entry filter.
Definition: fflua_luaiterator.h:3103
bool IsRest()
Returns true if entry is a rest.
Definition: ff_noteframe.h:1894
void SetDownwardProcessing(bool downward)
Sets the vertical direction for processing staves in the iteration, for region-based iterators...
Definition: fflua_luaiterator.h:3056
virtual int LoadAll()
Loads all available data into the collection.
Definition: finaleframework.cpp:12977
Collection class for FCMultiStaffInstrument class objects.
Definition: ff_othercollection.h:1099
int CalcStaffSpan()
Calculates the number of staves in the region.
Definition: ff_region.h:507
int ForEachFileSaved(FCStrings *pFileStrings, luabridge::LuaRef lua_callback_function)
Opens all the files in a list of strings (as a FCStrings object), passes the document to the Lua call...
Definition: fflua_luaiterator.h:2821
LUAITERATOR_ENTRYFILTERS
Constants for the note entry filters.
Definition: fflua_luaiterator.h:83
Class for secondary beam breaks (in Finale's Special Tools).
Definition: ff_entrydetails.h:1117
virtual eMeas GetMeasure() const
Virtual method for returning the measure number.
Definition: ff_other.h:129
twobyte GetEndSlot() const
Returns the end slot (staff) for the region.
Definition: ff_region.h:448
Collection class for FCStaff class objects.
Definition: ff_othercollection.h:278
Class that encapsulate a cell of note entries.
Definition: ff_noteframe.h:2574
Class that stores one record of a chord suffix definition.
Definition: ff_other.h:20248
Class for smartshape assignments to a measure.
Definition: ff_smartshapes.h:190
Definition: fflua_luaiterator.h:140
The class for a "current staff state" (the sum of staff changes and staff style changes) at a specifi...
Definition: ff_other.h:11456
Definition: fflua_luaiterator.h:137
int ForEachRegionObject(FCMusicRegion *pRegion, int classID, luabridge::LuaRef lua_callback_function)
Loads all the objects of a specific type within a selected region and sends them to a Lua callback fu...
Definition: fflua_luaiterator.h:2605
Class for notehead modifications (as in Finale's Special Tools).
Definition: ff_entrydetails.h:314
void Add(__FCBase *pNewItem)
Adds an element to the end of the collection.
Definition: finaleframework.cpp:12756
Definition: fflua_luaiterator.h:113
virtual bool LoadPrevious()
Definition: finaleframework.cpp:20275
bool GetTupletStartFlag() const
Returns true if the entry is marked to start a tuplet.
Definition: ff_noteframe.h:1814
bool GetDownwardProcessing() const
Returns the vertical direction for processing staves in the iteration, for region-based iterators...
Definition: fflua_luaiterator.h:2955
void SetProcessCurrentDocument(bool state)
Sets if the document currently in editing focus should be processed in ForEachDocument and ForEachDoc...
Definition: fflua_luaiterator.h:3024
Collection class for FCSmartShape class objects.
Definition: ff_smartshapes.h:3167
Collection class for FCArticulationDef class objects.
Definition: ff_othercollection.h:473
int GetLoadLayerMode() const
Returns the load layer mode for the note entry iterators, such as ForEachEntry(), ForEachNote()...
Definition: fflua_luaiterator.h:2905
virtual bool HasStaffValue()
Method that should return true if GetStaff() returns actual values.
Definition: ff_other.h:141
int ForEachInteger(int integer1, int integer2, luabridge::LuaRef lua_callback_function)
Passes an integer range to the Lua callback function, one by one. This iterator automatically handles...
Definition: fflua_luaiterator.h:2859
bool AddNotationStyleFilter(int filter, int logicmode)
Adds/activates an notation style filter.
Definition: fflua_luaiterator.h:3334
int ForEachObject(int classID, luabridge::LuaRef lua_callback_function)
Loads all the objects of a specific type and sends them to a Lua callback function.
Definition: fflua_luaiterator.h:2503
Encapsulates a staff group.
Definition: ff_details.h:69
virtual TimeEdu32 GetMeasurePos() const
Virtual method for returning the position within the measure.
Definition: ff_other.h:148
Data class for the global clef definitions.
Definition: ff_globals.h:42
double CalcLastDuration()
Reports the duration of the last iterator run.
Definition: fflua_luaiterator.h:3420
bool GetPartialMeasureSelections() const
Returns partially selected measures should be processed.
Definition: fflua_luaiterator.h:2964
bool SetToCurrent()
Remaps the object to the current document.
Definition: ff_documents.h:90
Collection class for FCStaffSystem class objects. A collection typically contains all staff systems f...
Definition: ff_othercollection.h:127
bool GetProcessCurrentPart() const
Returns if the part currently in editing focus should be processed in ForEachPart calls...
Definition: fflua_luaiterator.h:2921
Definition: fflua_luaiterator.h:119
Definition: fflua_luaiterator.h:172
The class for a start of repeat bracket in the document. There can only be one ending repeat in each ...
Definition: ff_other.h:21157
Class with adjustments to the augmentation dots (in Finale's Special Tools).
Definition: ff_entrydetails.h:860
twobyte GetStartMeasure() const
Returns the start measure for the region.
Definition: ff_region.h:400
virtual bool Load(ENTNUM entnum, twobyte inci)
Loads the data at the given entry number and inci.
Definition: finaleframework.cpp:18886
Class for percussion note modification.
Definition: ff_entrydetails.h:3575
Collection class for FCStaffStyleDef class objects.
Definition: ff_othercollection.h:1013
bool GetAccidentalParentheses() const
Returns the parentheses accidental state.
Definition: ff_noteframe.h:110
Definition: fflua_luaiterator.h:89
void ClearAllAltNotationFilters()
Removes all filters for alternate notation. This will result in all items being processed.
Definition: fflua_luaiterator.h:3292
Base class for all collection classes. A collection is a storage that can store multiple objects of s...
Definition: ff_basecollection.h:24
The class for an executable shape definition.
Definition: ff_other.h:20161
bool IsEmpty()
Returns true if the string is empty.
Definition: ff_base.h:2461
Collection class for FCInstrumentDef class objects.
Definition: ff_othercollection.h:1681
Definition: fflua_luaiterator.h:190
bool SwitchBack()
Switches back yo the "original" current part, that was in focus at the call to SwitchTo.
Definition: ff_parts.h:256