Finale PDK Framework 0.74
Classes
Lua Classes

Classes hooked up to JW Lua scripting. More...

Classes

class  __FCBaseData
 Base class for all data-related classes (that handles Finale data). More...
 
class  FCFontInfo
 Class for document-independent font information. More...
 
class  FCEnigmaTextStyle
 Class that specifies Enigma text style. This includes font, size, efx, superscript, baseline adjustments, and interspacing. MakeMusic has provided a mechansism whereby it can include color is well, but as of at least Finale 27.3 there is no support for color in Enigma strings. More...
 
class  FCString
 Class that provides storage for text. This is to achieve platform-transparent text handling, that can handle text storage regardless of how it's done on the platform (Mac/Window/C-style/Unicode/etc). More...
 
class  FCCellMetrics
 Class that encapsulate the measure metrics info data. More...
 
class  FCEntryMetrics
 Class that encapsulate the entry metrics data. More...
 
class  FCTextMetrics
 A class that fetches the metrics for text (for how Finale will render it), such as the boundary boxes and the advance width. More...
 
class  FCNumber
 Simple class to put numbers into collections. More...
 
class  FCPoint
 Simple class for the representation of x, y coordinates. More...
 
class  FCPrintSettings
 Class containing printing settings (and the ability to print documents). More...
 
class  FCFontDialog
 Class to display the font selection dialog box to the user. More...
 
class  FCRange
 Class that encapsulates a range (start, length) More...
 
class  FCCell
 The class that reference a cell (one measure on one staff) in the musical "grid". More...
 
class  FCCellPos
 This class is similar to FCCell, but also includes a position within the measure. It represents a "music position". More...
 
class  __FCCellDetail
 Base class for data that attach to cells. A call to the ConnectCell method is required prior to loading/saving data. More...
 
class  __FCNoInciCellDetail
 Base class for details data where inci always is 0. More...
 
class  __FCCollectionCellDetail
 Base class specially designed for collections of detail classes connected to cell data. More...
 
class  FCMidiExpression
 Encapsulates the continous MIDI data in a cell. More...
 
class  FCSeparateMeasureNumber
 Class for a manually added or edited measure number in a cell. More...
 
class  FCCellFrameHold
 Class that holds the TGF frames and the clef changes of a TGF frame. More...
 
class  FCChord
 Class for chord assignments to a measure/staff. More...
 
class  FCCellGraphic
 Class for measure/cell-attached graphic objects. Currently, this class can only be used to edit existing cell-attached graphics objects. More...
 
class  FCCellText
 Class for measure-attached (cell-attached) text blocks. The ConnectCell method must be called prior to load/save. More...
 
class  FCTransposer
 This is a utility class to facilitate transposition. It supports: More...
 
class  __FCNoInciDetail
 Abstract data class that contains a detail record without using the inci. More...
 
class  FCGroup
 Encapsulates a staff group. More...
 
class  FCBaseline
 Encapsulates baselines offset values for lyrics, expressions, fretboards and chords. More...
 
class  FCActiveLyric
 Class that provides access to the active lyrics block and syllable. More...
 
class  __FCFretItemBase
 Base class for classes that describe a single fret item on a fret and string. More...
 
class  FCFretItem
 Class that describes a single fret item on a fret and string. More...
 
class  FCFretBarreItem
 Class that describes a single fret item on a fret and string. More...
 
class  FCFretboardGroupItem
 Class that represents a single fretboard group item. The fretboard group item has a header and a list of fret items. More...
 
class  __FCFileDialogBase
 Base class that contains the basic functionality for the operating system's modal dialog boxes for selecting files. More...
 
class  FCFileOpenDialog
 Class to display the operating system's "Open File" modal dialog box. More...
 
class  FCFileSaveAsDialog
 Class to display the operating system's "Save File As" modal dialog box. More...
 
class  FCFolderBrowseDialog
 Class to display the operating system's modal folder browser dialog box. More...
 
class  __FCUserWindow
 Base class for all other dialog/window classes. More...
 
class  FCControl
 Base class for all UI controls in a dialog. More...
 
class  FCCtrlUpDown
 A UI class that handles an Up/Down control. The control has 2 arrows, one pointing up and one down. More...
 
class  FCCtrlLine
 UI class representing a graphical line. More...
 
class  FCCtrlHorizontalLine
 UI class representing a horizontal graphical line. More...
 
class  FCCtrlVerticalLine
 UI class representing a horizontal graphical line. More...
 
class  FCCtrlEdit
 Class that handles edit controls. More...
 
class  FCCtrlPopup
 UI class that handles a popup (on the Mac) and a combo list (on Windows). More...
 
class  FCCtrlComboBox
 UI class that handles a combo box, which is a combination of a edit field and a popup list. More...
 
class  FCCtrlTextEditor
 UI class that handles a multiline edit control for viewing or modifying text (optionally formatted with font information). It has a vertical scroll bar when needed and captures the Enter and Tab keys when it has focus. The text either wraps horizontally within the control or scrolls to the left, depending on the value specified in SetWordWrap. (The default is to wrap.) More...
 
class  FCDataListRow
 A class that represents one row of data in a FCCtrlDataList UI control. More...
 
class  FCCtrlDataList
 Class that handles a contol with multiple lines of data, arranged in columns. More...
 
class  FCCtrlListBox
 A list box control. More...
 
class  FCTreeNode
 Class representing a single node item in a FCCtrlTree control. More...
 
class  FCCtrlTree
 A tree UI control. More...
 
class  FCCtrlSwitcher
 A control to switch between multiple pages. More...
 
class  FCCtrlRadioButton
 A UI class that handles a single radio button. More...
 
class  FCCtrlRadioButtonGroup
 Class for radio button groups. More...
 
class  FCCtrlCheckbox
 Control class for a checkbox control. More...
 
class  FCCtrlButton
 Control class for push buttons. It inherits the FCCtrlCheckbox class, so the checked state can be set even for push buttons (if the push button style supports it). More...
 
class  FCCtrlSlider
 Control class for sliders. More...
 
class  FCCtrlImage
 UI class that handles a control with a static image. More...
 
class  FCResourceWindow
 Class for modeless and modal dialogs that are visually designed as a resource. This class is also a parent class to FCCustomWindow. More...
 
class  FCCustomWindow
 A class that supports programmatically created controls (that are not defined in resource files). More...
 
class  FCDocument
 Class for an opened Finale document. An opened Finale document has a 1-based ID and can be displayed in multiple document windows. More...
 
class  FCDocuments
 Class for a collection of documents. Usually used to get all the currently loaded documents in Finale. More...
 
class  __FCEntryDetail
 Base class that provides the basic functionality for entry detail data (such as Special Tools modifications). More...
 
class  __FCEntryDetailNoteID
 Base class that provide entry details that are based on noteIDs, such as notehead modifications, augmentation dot modifications etc. More...
 
class  FCNoteheadMod
 Class for notehead modifications (as in Finale's Special Tools). More...
 
class  FCDotMod
 Class with adjustments to the augmentation dots (in Finale's Special Tools). More...
 
class  FCCrossStaffMod
 Class that specifies the cross-staff connection for a note. More...
 
class  FCSecondaryBeamBreakMod
 Class for secondary beam breaks (in Finale's Special Tools). More...
 
class  FCBeamExtensionMod
 Class for beam extensions (in Finale's Special Tools). More...
 
class  FCStemMod
 Class for manual stem adjustments (in Finale's Special Tools). More...
 
class  FCArticulation
 Class for attaching an articulation definition to an entry. More...
 
class  FCTuplet
 Class for attaching an tuplet to an entry. More...
 
class  FCSyllableBase
 Base class for attaching an syllable to an entry. More...
 
class  FCVerseSyllable
 The class for a verse syllable. More...
 
class  FCChorusSyllable
 The class for a chorus syllable. More...
 
class  FCSectionSyllable
 The class for a section syllable. More...
 
class  FCSyllableEntryMod
 Class for controlling justification/alignment for all syllables that are connected to an entry. More...
 
class  FCEntryAlterMod
 Class for (what it seems) the sole purpose of note entry resize. More...
 
class  FCAccidentalMod
 Class for acciental modifications (as in Finale's Special Tools). More...
 
class  FCPercussionNoteMod
 Class for percussion note modification. More...
 
class  FCCustomStemMod
 Class for custom stem shapes (in Finale's Special Tools). The data is connected to either an upstem or downstem note. More...
 
class  FCBeamMod
 Class for custom beam adjustments (in Finale's Special Tools). More...
 
class  FCPerformanceMod
 Class for performance/playback modifications attached to note entires (as in Finale's MIDI Tool). If Human Playback is enabled, this data record is ignored. More...
 
class  FCTieMod
 Class with adjustments to the ties (in Finale's Special Tools). More...
 
class  FCBrokenBeamMod
 Class for manually broken beam adjustments (in Finale's Special Tools). More...
 
class  FCTablatureNoteMod
 Class with info about one tablature note. More...
 
class  __FCGlobals
 Base class for all data that use the global part of the EDataID. More...
 
class  FCClefDef
 Data class for the global clef definitions. More...
 
class  FCClefDefs
 Collection class for FCClefDef class objects. More...
 
class  __FCIteratorBase
 The base class for both browser and collection classes. More...
 
class  FCKeySignature
 Class for key signatures. Instances of this class are auto-created by FCMeasure:GetKeySignature and FCCell:GetKeySignature when needed. More...
 
class  FCNote
 Encapsulates one note in a note entry (from the FCNoteEntry class). More...
 
class  FCNoteEntry
 Encapsulates a note entry from an owner class (for example FCNoteEntryCell, FCNoteEntryLayer) class. More...
 
class  FCNoteEntryCell
 Class that encapsulate a cell of note entries. More...
 
class  FCNoteEntryLayer
 Class to load a layer on the same staff. This class is for example suitable when working with music lines that moves over barlines. Please note that this class uses 0-based layer numbers. More...
 
class  __FCNoInciOther
 Base class for the "Other" (ot_*) Enigma structures that don't use the inci parameter. More...
 
class  FCShapeDefInstruction
 Helper class for FCShapeDef. More...
 
class  FCShapeDefInstructions
 Helper class for FCShapeDef. More...
 
class  FCShapeDef
 Class for a shape definition (as in Finale's Shape selection dialog). More...
 
class  FCEnclosure
 Class to encapsulate enclosures (available for example in expressions and measure numbers.) More...
 
class  FCPage
 The class representing a physical page in Finale. More...
 
class  FCStaffSystem
 The class for a staff system on a page. More...
 
class  FCMeasure
 The class for a measure (the full vertical measure stack) in the document. It maps the Measure Attributes dialog settings, the internal measure optimization flag settings and more. More...
 
class  FCMeasureNumberRegion
 The class for a measure number region. More...
 
class  FCSystemStaff
 Class that stores one "inci" of a staff list (for a system or for the global list of staves). More...
 
class  FCStaffNamePosition
 Class for staff (or staff style) name positioning data. More...
 
class  FCStaff
 The class for a staff in the score. It is also a base class for staff styles. More...
 
class  FCCurrentStaffSpec
 The class for a "current staff state" (the sum of staff changes and staff style changes) at a specific position in the score, for diagnostic purposes. The class cannot save data. More...
 
class  FCArticulationDef
 The class for an articulation definition. On Finale 2012 and above, this class supports the Unicode character range. More...
 
class  FCCategoryDef
 Class for a category definition. More...
 
class  FCFreezeSystem
 Class for freezing a system at a specific measure. More...
 
class  FCTextExpressionDef
 Class for a text expression definition. More...
 
class  FCShapeExpressionDef
 Class for a shape expression definition. More...
 
class  FCTextBlock
 Class for a text block. More...
 
class  FCPageText
 Class for a page-connected text block. More...
 
class  FCSeparatePlacement
 Class that handles separate placement for repeats. More...
 
class  FCExpression
 Class for expression assignments to a measure/staff. More...
 
class  FCStaffStyleDef
 Class for a staff style definition. More...
 
class  FCStaffStyleAssign
 Class for staff style assignments to a staff. More...
 
class  FCMultiMeasureRest
 Class for a multi-measure rest instance. More...
 
class  FCMultiStaffInstrument
 Class for a multi-staff instrument defined in the Score Manager. More...
 
class  FCAllotment
 Class for allotment data (in the Document Options). More...
 
class  FCPageGraphic
 Class for page-assigned graphics. Currently, this class can only be used to edit existing page graphics objects. More...
 
class  FCTextRepeatDef
 The class for a text repeat definition. More...
 
class  FCTextRepeat
 Class for text repeat assignments to a measure. The assignment is connected with a FCTextRepeatDef definition. More...
 
class  FCChordSuffixElement
 Class that stores one record of a chord suffix definition. More...
 
class  FCFretboardStyleDef
 The class for a fretboard style definition, which reflects the content the "Fretboard Style" dialog box in Finale. More...
 
class  FCEndingRepeat
 The class for a start of repeat bracket in the document. There can only be one ending repeat in each measure. More...
 
class  FCBackwardRepeat
 The class for a backward repeat definition. More...
 
class  FCBeatChartElement
 The class for one single beat chart element. More...
 
class  FCTempoElement
 The class for a single tempo change in the Tempo Tool. The tempo elements should be stored in measure position order for each measure. More...
 
class  FCPercussionMapNote
 Class for an individual note in a percussion map, read from Finale's XML file. More...
 
class  FCPercussionMapNotes
 Collection class for FCPercussionMapNote class objects, used by the FCInstrumentDef class. More...
 
class  FCPercussionMapNotesLookup
 A lookup table for FCPercussionMapNotes notes. More...
 
class  FCPercussionLayoutNotesLookup
 A lookup table for FCPercussionLayoutNotes collections. More...
 
class  FCInstrumentDef
 The class for an instrument definition item (in the instrument list/Score Manager). More...
 
class  FCLayerPlaybackData
 Helper class for FCInstrumentPlaybackData, providing the playback data for the Chord Layer, the MIDI Expression Layer, and the note layers. More...
 
class  FCInstrumentPlaybackData
 The class for instrument playback data. This is also the link between staves/staff styles and the FCInstrumentDef definition. More...
 
class  FCPercussionLayoutNote
 The class for a note definition in a percussion layout. More...
 
class  FCStaffList
 An object that contains one staff list section (out of 4). Before data is loaded/saved, the SetMode() method must be called. More...
 
class  FCFretInstrumentDef
 Class for tablature instruments definitions. More...
 
class  FCCellClefChange
 Contains a clef change inside a cell. This is an item member in a FCCellClefChanges collection (created by the FCCellFrameHold::CreateCellClefChanges() method). More...
 
class  FCGuide
 The class for a guide in the document. More...
 
class  FCMetatoolAssignment
 Class for a metatool key assignment. More...
 
class  FCBookmark
 The class for a Finale bookmark. More...
 
class  FCCustomKeyModeSymbolList
 Class that encapsulates the list of accidental symbols for instances of FCCustomKeyModeDef. A single symbol list may be shared amongst multiple instances of FCCustomKeyModeDef, so these lists must be separately maintained. More...
 
class  FCCustomKeyModeDef
 Class that allows access to custom key modes. (Finale calls them "Nonstandard Key Signatures", but they define modes rather than key signatures.) More...
 
class  FCStaffSystemsLookup
 A lookup class designed for collecting full staff layouts for different parts in the same document in a resource-friendly way. It makes sure that each layout is only loaded once for a score/part. More...
 
class  FCPart
 Class that represents one linked part in a document. The class also provides methods to switch between linked parts. More...
 
class  FCPartStaffVoicing
 Class that represents the Voicing information for a single staff in a part. More...
 
class  FCPDFPage
 A representation of a page in a created PDF file. More...
 
class  FCPDFWriter
 Class to create a PDF and write it to disk. This is also a collection of FCPDFPage objects. More...
 
class  FCListenToMidiResult
 Class to return the results of the ListenToMidi dialog box. More...
 
class  FCHyperClick
 Class for Hyperscript click data. It corresponds to the data fields associated with the Metronome Source in the "Click and Countoff" dialog box. More...
 
class  __FCPrefsBase
 Base class for all preference data classes. More...
 
class  FCPlaybackPrefs
 Class for the document's playback preferences values. More...
 
class  FCDistancePrefs
 Class for preferences values that controls distances (between objects, etc) More...
 
class  FCSizePrefs
 Contains the document options for size and widths. More...
 
class  FCMiscDocPrefs
 Class that contains document preferences that doesn't fit in any other class. More...
 
class  FCTupletPrefs
 The preferences for the default tuplet definition. More...
 
class  FCPageFormatPrefs
 Class for the "Page Format for Score/Parts" preference data. More...
 
class  FCGeneralPrefs
 The "Program Options" (program-wide options that is not stored in the document). More...
 
class  FCMusicSpacingPrefs
 Options that affects Music (Note) Spacing in the document. More...
 
class  FCFontPrefs
 Font preferences data in the Document Options. More...
 
class  FCMultiMeasureRestPrefs
 Class for Multimeasure rests document preferences (in the Document Options dialog box). More...
 
class  FCSlurContourPrefs
 Class for the Slur Contour preferences. More...
 
class  FCSmartShapeEntryConnectStyle
 The class for a smart shape entry connection style. More...
 
class  FCSmartShapePrefs
 Class for the Smart Shape preferences. More...
 
class  FCTiePlacementPrefs
 Class for the 6 document sets of options that control default tie placement. More...
 
class  FCTieContourPrefs
 The 4 (short, medium, long, tie ends) tie contour definitions. More...
 
class  FCTiePrefs
 The preferences for ties (includes options both from tie options and tie contour options). More...
 
class  FCLayerPrefs
 Layer preferences for one specific layer. More...
 
class  FCChordPrefs
 Class for document-specific chord settings. Some additional chord-related settings are available in FCMiscDocPrefs. More...
 
class  FCStaffNamePositionPrefs
 Default positioning for full and abbreviated staff names. More...
 
class  FCGroupNamePositionPrefs
 Default positioning for full and abbreviated group names. More...
 
class  FCMusicCharacterPrefs
 Contains the document options for music character preferences. More...
 
class  FCPartScopePrefs
 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. More...
 
class  FCLyricsPrefs
 Contains the lyrics preferences data. More...
 
class  FCStemConnectionTable
 A very special-purpose preferences class that contains the full stem connection table from Finale's document options. More...
 
class  FCRepeatPrefs
 Class for repeat-related document preferences. More...
 
class  FCGridsGuidesPrefs
 Class for document preferences related to guides and grids. More...
 
class  FCPianoBracePrefs
 Preferences that controls the visual appearance of the piano braces in the document. More...
 
class  FCMusicRegion
 Class that encapsulates EREGION and provides additional functionality to region handling. More...
 
class  FCSmartShapeMeasureMark
 Class for smartshape assignments to a measure. More...
 
class  FCSmartShapeEntryMark
 Class for smartshape assignments/connections to an entry. More...
 
class  FCSmartShapeSegment
 Helper class for FCSmartShape, controlling the end points of a smart shape. This class is only constructed indirectly by the FCSmartShape.GetTerminateSegmentLeft and FCSmartShape.GetTerminateSegmentRight() methods. More...
 
class  FCSmartShapeCtrlPointAdjust
 Helper class for FCSmartShape. This class is only constructed indirectly by the FCSmartShape.GetCtrlPointAdjust method. More...
 
class  FCSmartShape
 A record that represents a smart shape in the score. It is connected to the score through FCSmartShapeMeasureMark objects in each measure where the smart shape occurs. In addition, some shapes also have FCSmartShapeEntryMark objects that connect them to entries. These entry-attached shapes can be identified with the IsEntryBased method. More...
 
class  FCCustomSmartLineDef
 The class for a custom smart shape lines. More...
 
class  FCSmartShapeMeasureMarks
 Collection class for FCSmartShapeMeasureMark class objects. More...
 
class  FCCustomSmartLineDefs
 Collection class for FCCustomSmartLineDef class objects. More...
 
class  FCRawText
 The class for raw text objects. All other text classes are based on this class, but it can also be used by its own for tx_TextBlock text. More...
 
class  FCVerseLyricsText
 The class for verse lyrics texts. More...
 
class  FCSectionLyricsText
 The class for section lyrics texts. More...
 
class  FCChorusLyricsText
 The class for chorus lyrics texts. More...
 
class  FCFileInfoText
 The class for file information text fields. More...
 
class  FCTimeSignature
 Class for time signatures. Instances of this class are auto-created when needed by FCMeasure:GetTimeSignature and FCCell:GetTimeSignature and their "ForDisplay" counterparts. More...
 
class  FCUI
 Standard class for basic user interface functionality. More...
 
class  FCCustomLuaWindow
 Special FCCustomWindow child class, that provides the additional functionality to hook up JW Lua callback functions as dialog handlers (that can be called during the run of the dialog). More...
 
class  FCLuaIterator
 Class for Lua callback iterators. This class is not part of the C++ PDK Framework. More...
 
class  FCLuaScriptItem
 Class that represents a single Lua script item. This class is not part of the C++ PDK Framework. More...
 

Detailed Description

Classes hooked up to JW Lua scripting.