FCGeneralPrefs Class Reference

The "Program Options" (program-wide options that is not stored in the document). More...

#include <ff_prefs.h>

Inheritance diagram for FCGeneralPrefs:

Public Types
enum	GRACENOTE_QUANTIZATIONMODE { GRACEQUANTMODE_ALLOW = 0 , GRACEQUANTMODE_REMOVE = 1 , GRACEQUANTMODE_CONVERT = 2 }
	The grace note spacing constants used by GetQuantizationGraceNoteMode. More...
enum	QUANTIZATIONMODE { QUANTIZATIONMODE_NOTUPLETS = FQ_NOTUPLETS , QUANTIZATIONMODE_MIXRHYTHMS = FQ_MIXRHYTHMS , QUANTIZATIONMODE_SPACEEVENLY = FQ_SPACEEVENLY }
	The quantization mode constants used by GetQuantizationMode. More...
enum	UNDOSTATE { UNDOSTATE_OFF = ::UNDO_OFF , UNDOSTATE_DISABLED = ::UNDO_DISABLED , UNDOSTATE_ENABLED = ::UNDO_ENABLED , UNDOSTATE_SUSPENDED = ::UNDO_SUSPENDED }
	The undo state constants used by GetUndoState. More...
Public Types inherited from __FCBase
enum	PDKFRAMEWORK_CLASSID {   FCID_UNKNOWN = 0 , FCID_ACCIDENTALMOD , FCID_ACTIVELYRIC , FCID_ALLOTMENT ,   FCID_ARTICULATION , FCID_ARTICULATIONDEF , FCID_BACKWARDREPEAT , FCID_BASELINE ,   FCID_BEAMMOD , FCID_BEATCHARTELEMENT , FCID_BOOKMARK , FCID_BROKENBEAMMOD ,   FCID_CATEGORYDEF , FCID_CELLCLEFCHANGE , FCID_CELLFRAMEHOLD , FCID_CELLGRAPHIC ,   FCID_CELLTEXT , FCID_CENTERSMARTSHAPE , FCID_CHORD , FCID_CHORDPREFS ,   FCID_CHORDSUFFIXELEMENT , FCID_CHORUSSYLLABLE , FCID_CLEFDEF , FCID_COMPOSITETIMESIGBOTTOMELEMENT ,   FCID_COMPOSITETIMESIGTOPELEMENT , FCID_CROSSSTAFFMOD , FCID_CUSTOMSMARTLINEDEF , FCID_CUSTOMSTEMMOD ,   FCID_DISTANCEPREFS , FCID_DOTMOD , FCID_ENCLOSURE , FCID_ENDINGREPEAT ,   FCID_ENIGMATEXTSTYLE , FCID_ENTRYALTERMOD , FCID_EXECUTABLESHAPEDEF , FCID_EXPRESSION ,   FCID_FONTINFO , FCID_FONTPREFS , FCID_FREEZESYSTEM , FCID_FRETBOARDSTYLEDEF ,   FCID_FRETBOARDSTYLEDEFS , FCID_FRETBOARDGROUPDEF , FCID_FRETBOARDGROUPDEFS , FCID_FRETINSTRUMENTDEF ,   FCID_GENERALPREFS , FCID_GRIDSGUIDESPREFS , FCID_GROUP , FCID_GROUPNAMEPOSITIONPREFS ,   FCID_HUMANPLAYBACKPREFS , FCID_INDEPENDENTCELLDETAIL , FCID_INSTRUMENTDEF , FCID_INSTRUMENTPLAYBACKDATA ,   FCID_KEYMODEDEF , FCID_KEYSIGNATURE , FCID_LAYERPREFS , FCID_LYRICSBASELINE ,   FCID_LYRICSPREFS , FCID_MEASURE , FCID_MEASURENUMBERREGION , FCID_METATOOLASSIGNMENT ,   FCID_MIDIEXPRESSION , FCID_MISCDOCPREFS , FCID_MULTIMEASUREREST , FCID_MULTIMEASURERESTPREFS ,   FCID_MULTISTAFFINSTRUMENT , FCID_MULTISTAFFINSTRUMENTS , FCID_MUSICCHARACTERPREFS , FCID_MUSICSPACINGPREFS ,   FCID_NUMBER , FCID_NOTEHEADMOD , FCID_OTHERINCI , FCID_PERCUSSIONLAYOUTNOTE ,   FCID_PERCUSSIONSTAFF , FCID_PERFORMANCEMOD , FCID_PAGE , FCID_PAGEFORMATPREFS ,   FCID_PAGEGRAPHIC , FCID_PAGETEXT , FCID_PART , FCID_PARTEXTRACTPREFS ,   FCID_PARTSCOPEPREFS , FCID_PARTSTAFFVOICING , FCID_PERCUSSIONNOTEMOD , FCID_PIANOBRACEPREFS ,   FCID_PLAYBACKPREFS , FCID_RAWTEXT , FCID_REPEATPREFS , FCID_SECONDARYBEAMBREAKMOD ,   FCID_BEAMEXTENSIONMOD , FCID_SECTIONSYLLABLE , FCID_SEPARATEMEASURENUMBER , FCID_SEPARATEPLACEMENT ,   FCID_SHAPEDEF , FCID_SHAPEEXPRESSIONDEF , FCID_SLURCONTOURPREFS , FCID_SIZEPREFS ,   FCID_SMARTSHAPE , FCID_SMARTSHAPEENTRYMARK , FCID_SMARTSHAPEMEASUREMARK , FCID_SMARTSHAPEPREFS ,   FCID_STAFF , FCID_STAFFLIST , FCID_STAFFNAMEPOSITION , FCID_STAFFNAMEPOSITIONPREFS ,   FCID_STAFFSTYLEASSIGN , FCID_STAFFSTYLEDEF , FCID_STAFFSYSTEM , FCID_STEMCONNECTIONTABLE ,   FCID_STEMMOD , FCID_STRING , FCID_SYLLABLEENTRYMOD , FCID_SYSTEMSTAFF ,   FCID_TABLATURENOTEMOD , FCID_TEMPOELEMENT , FCID_TEXTBLOCK , FCID_TEXTEXPRESSIONDEF ,   FCID_TEXTREPEAT , FCID_TEXTREPEATDEF , FCID_TIEMOD , FCID_TIEPREFS ,   FCID_TIECONTOURPREFS , FCID_TIEPLACEMENTPREFS , FCID_TIMESIGNATURE , FCID_TUPLET ,   FCID_TUPLETPREFS , FCID_VERSESYLLABLE }
	Constants for the GetClassID method. More...
enum	MEASUREMENTUNITS {   MEASUREMENTUNIT_DEFAULT = UNIT_DEFAULT , MEASUREMENTUNIT_EVPUS = UNIT_EVPUS , MEASUREMENTUNIT_INCHES = UNIT_INCHES , MEASUREMENTUNIT_CENTIMETERS = UNIT_CENTS ,   MEASUREMENTUNIT_POINTS = UNIT_POINTS , MEASUREMENTUNIT_PICAS = UNIT_PICAS , MEASUREMENTUNIT_SPACES = UNIT_SPACES , MEASUREMENTUNIT_MILLIMETERS = 100 }
	Constants for Finale's standard measurement units. More...

Public Member Functions
const char *	ClassName () const override
	Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child class.
const PDKFRAMEWORK_CLASSID	GetClassID () const override
	Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has problems to resolve the true classes of inherited objects.
	FCGeneralPrefs ()
	The constructor.
twobyte	GetPitchRepresentationType () const
	Returns the preferred Pitch representation type for MIDI notes in Finale. The setting is called "Pitch Representation" in the Finale Preferences.
twobyte	GetPitchRepresentationValue () const
	Returns the octave representation number value. The setting is called "Pitch Representation->Middle C" in the Finale Preferences.
MEASUREMENTUNITS	GetMeasurementUnit () const
	Returns the currently selected measurement unit. The setting is called "Measurement Units" in the Finale Preferences.
bool	GetShowDefaultStaffNames () const
	Returns if default staff names should be displayed as placeholders. The setting is called "Staff/Show Default Staff Names" and is found in the Staff Tool.
bool	GetShowDefaultGroupNames () const
	Returns if default group names should be displayed as placeholders. The setting is called "Staff/Show Default Group Names" and is found in the Staff Tool.
bool	GetRespaceMeasureLayout () const
	Returns true if measures should reflow within a system at a layout update.
bool	GetAutomaticUpdateLayout () const
	Returns true if "Automatic Update Layout" is set in the Program Options.
bool	GetAutomaticMusicSpacing () const
	Returns true if "Automatic Music Spacing" is set in the Program Options.
bool	GetRetainFrozenMeasures () const
	Return true if frozen systems should be retained when the layout is updated.
bool	GetRecalcMeasures () const
	Return true if measure layout should be recalculated when the layout is updated.
bool	GetRecalcSystems () const
	Return true if systems should be recalculated when the layout is updated. The setting is called "Reflow systems across pages" in the Finale Preferences.
bool	GetRebarWhenTimeSigChanged () const
	Return true if measures should rebar when the Time Signature Tool changes the time signature.
TimeEdu16	GetQuantizationSmallestNoteValue () const
	Return the smallest note value for quantization.
QUANTIZATIONMODE	GetQuantizationMode () const
	Return the mode for quantization.
TimeEdu16	GetQuantizationSmallestNoteValueToRemove () const
	Return the smallest note value to remove.
GRACENOTE_QUANTIZATIONMODE	GetQuantizationGraceNoteMode () const
	Return the quantization mode for grace notes.
bool	GetQuantizationMinimizeRests () const
	Return whether to minimize rests in quantization.
bool	GetDottedRestsAreLegalInSimpleMeter () const
	Return true if simple meters can contain dotted rests.
bool	GetDottedRestsAreLegalInCompoundMeter () const
	Return true if compound meters can contain dotted rests.
bool	GetQuantizationRetainKeyVelocities () const
	Return true if key velocities should be retained in quantization.
bool	GetQuantizationRetainNoteDurations () const
	Return true if note durations should be retained in quantization.
bool	GetQuantizationIncludeVoiceTwo () const
	Return true if Voice Two should be used in quantization.
bool	GetQuantizationSoftenSyncopations () const
	Return true if quantization should soften syncopations (use fewer ties).
bool	GetQuantizationUseSensitivityLevel () const
	Return whether to use the sensitivity level value in quantization.
TimeEdu16	GetQuantizationSensitivityLevel () const
	Return the sensitivity level value for quantization.
bool	GetIncludeMIDITempoChanges () const
	Return true if tempo changes should be included in MIDI import.
bool	GetIncludeMIDIContinuousData () const
	Return true if continuous data should be included in MIDI import.
bool	GetRebarStopOnlyAtEndOfPiece () const
	Return true if rebar music should stop only at the end of the document.
bool	GetRebarStopAtEndOfRegion () const
	Return true if rebar music should stop at the end of the selected region.
bool	GetRebarStopAtKeyChange () const
	Return true if rebar music should stop at the next key change.
bool	GetRebarStopAtTimeChange () const
	Return true if rebar music should stop at the next meter change.
bool	GetRebarStopAtSpecialBarline () const
	Return true if rebar music should stop at special barlines.
bool	GetRebarStopAtEmptyFrame () const
	Return true if rebar music should stop at empty frames.
bool	GetRebeamOnRebar () const
	Return true if rebar music should also rebeam music.
twobyte	GetKeyboardSplitPoint () const
	Return the MIDI note (0-127) that defines the Hyperscribe fixed keyboard split point.
bool	GetTransposeMIDIOnInput () const
	Return whether to transpose MIDI on input.
twobyte	GetHiddenObjectShading () const
	Returns the "Hidden Object Shading" value in Program Options.
ePercent	GetCustomZoom1 () const
	Returns the "Custom Zoom 1" value in Program Options.
ePercent	GetCustomZoom2 () const
	Returns the "Custom Zoom 2" value in Program Options.
ePercent	GetCustomZoom3 () const
	Returns the "Custom Zoom 3" value in Program Options.
UNDOSTATE	GetUndoState () const
	Return current Undo state.
void	SetPitchRepresentationType (twobyte value)
	Sets the preferred Pitch representation type for MIDI notes in Finale. The setting is called "Pitch Representation" in the Finale Preferences.
void	SetPitchRepresentationValue (twobyte value)
	Sets the octave representation number value. The setting is called "Pitch Representation->Middle C" in the Finale Preferences.
void	SetMeasurementUnit (twobyte value)
	Sets the currently selected measurement unit. The setting is called "Measurement Units" in the Finale Preferences.
void	SetShowDefaultStaffNames (bool state)
	Sets if default staff names should be displayed as placeholders. The setting is called "Staff/Show Default Staff Names" and is found in the Staff Tool.
void	SetShowDefaultGroupNames (bool state)
	Sets if default group names should be displayed as placeholders. The setting is called "Staff/Show Default Group Names" and is found in the Staff Tool.
void	SetRespaceMeasureLayout (bool state)
	Sets if measures should reflow within a system at a layout update.
void	SetAutomaticUpdateLayout (bool state)
	Sets if "Automatic Update Layout" is set in the Program Options.
void	SetAutomaticMusicSpacing (bool state)
	Sets if "Automatic Music Spacing" is set in the Program Options.
void	SetRetainFrozenMeasures (bool state)
	Sets if frozen systems should be retained when the layout is updated.
void	SetRecalcMeasures (bool state)
	Sets if measure layout should be recalculated when the layout is updated.
void	SetRecalcSystems (bool state)
	Sets if systems should be recalculated when the layout is updated. The setting is called "Reflow systems across pages" in the Finale Preferences.
void	SetRebarWhenTimeSigChanged (bool state)
	Sets if measures should rebar when the Time Signature Tool changes the time signature.
void	SetQuantizationSmallestNoteValue (TimeEdu16 value)
	Sets the smallest note value for quantization.
void	SetQuantizationMode (twobyte value)
	Sets the mode for quantization.
void	SetQuantizationSmallestNoteValueToRemove (TimeEdu16 value)
	Sets the smallest note value to remove.
void	SetQuantizationGraceNoteMode (twobyte value)
	Sets the quantization mode for grace notes.
void	SetQuantizationMinimizeRests (bool state)
	Sets whether to minimize rests in quantization.
void	SetDottedRestsAreLegalInSimpleMeter (bool state)
	Sets if simple meters can contain dotted rests.
void	SetDottedRestsAreLegalInCompoundMeter (bool state)
	Sets if compound meters can contain dotted rests.
void	SetQuantizationRetainKeyVelocities (bool state)
	Return true if key velocities should be retained in quantization.
void	SetQuantizationRetainNoteDurations (bool state)
	Sets if note durations should be retained in quantization.
void	SetQuantizationIncludeVoiceTwo (bool state)
	Sets if Voice Two should be used in quantization.
void	SetQuantizationSoftenSyncopations (bool state)
	Sets if quantization should soften syncopations (use fewer ties).
void	SetQuantizationUseSensitivityLevel (bool state)
	Sets whether to use the sensitivity level value in quantization.
void	SetQuantizationSensitivityLevel (TimeEdu16 value)
	Sets the sensitivity level value for quantization.
void	SetIncludeMIDITempoChanges (bool state)
	Sets if tempo changes should be included in MIDI import.
void	SetIncludeMIDIContinuousData (bool state)
	Sets if continuous data should be included in MIDI import.
void	SetRebarStopAtEndOfRegion (bool state)
	Sets if rebar music should stop at the end of the selected region.
void	SetRebarStopAtKeyChange (bool state)
	Sets if rebar music should stop at the next key change.
void	SetRebarStopAtTimeChange (bool state)
	Sets if rebar music should stop at the next meter change.
void	SetRebarStopAtSpecialBarline (bool state)
	Sets if rebar music should stop at special barlines.
void	SetRebarStopAtEmptyFrame (bool state)
	Sets if rebar music should stop at empty frames.
void	SetRebeamOnRebar (bool state)
	Sets if rebar music should also rebeam music.
void	SetKeyboardSplitPoint (twobyte value)
	Sets the MIDI note (0-127) that defines the Hyperscribe fixed keyboard split point.
void	SetTransposeMIDIOnInput (bool state)
	Sets whether to transpose MIDI on input.
void	SetHiddenObjectShading (twobyte percent)
	Sets the "Hidden Object Shading" value in Program Options.
void	SetCustomZoom1 (ePercent percent)
	Sets the "Custom Zoom 1" value in Program Options.
void	SetCustomZoom2 (ePercent percent)
	Sets the "Custom Zoom 2" value in Program Options.
void	SetCustomZoom3 (ePercent percent)
	Sets the "Custom Zoom 3" value in Program Options.
void	ClearRebarStopAtOptions ()
	Clears all Stop At options in the Rebar Options dialog box.
Public Member Functions inherited from __FCPrefsBase
bool	Reload () override
	Overridden version of Reload(), that handles prefs from multiple sources.
virtual bool	Load (twobyte prefsno=1)
	The default Load method for preference data. All preference data loading must go through here at some point.
bool	Save () override
	Saves the currently loaded to its current location.
bool	LoadFirst () override
	Loads the very first element in the database, if any.
int	GetItemNo () const
	Returns the prefs number for the loaded data.
Public Member Functions inherited from __FCBaseData
EDOCID	GetConnectedDocID () const
	Returns the document ID that was connected to the last load/save of the data.
bool	VerifyConnectedDocID ()
	Checks that the stored document ID for the data object matches the current document's ID.
virtual int	DataSizeSave () const
	Returns the data size for the data structure that should be saved or created.
void	_CloneFrom (__FCBaseData *pSource)
	For internal use only. Copies object data (except data block) from another object.
const EDataID *	_GetDataID ()
	Intended ONLY for the _CloneFrom implementation.
int	_GetLoadedSize () const
	Intended ONLY for the _CloneFrom implementation.
const void *	GetDataBlock ()
	Intended ONLY for the _CloneFrom implementation.
EXTAG	GetCustomTag () const
	Returns the custom Enigma tag, if any.
void	SetCustomTag (EXTAG tag)
	Sets the custom Enigma tag, for classes that support multiple Enigma tags.
	__FCBaseData ()
	The constructor.
virtual	~__FCBaseData ()
	Virtual destructor.
virtual bool	DeleteData ()
	Deletes the associated data from Finale's database. Be careful when deleting multiple objects.
virtual bool	DeepDeleteData ()
	Deletes data and all data that's connected to the object.
virtual bool	LoadLast ()
	Loads the very last element in the database, if any.
virtual bool	LoadNext ()
	Loads the next element from the database, if any.
virtual bool	LoadPrevious ()
	Loads the previous element in the database, if any.
bool	RelinkToCurrentView ()
	Relinks the contents in the current view so that the score and part(s) match.
bool	RelinkToScore ()
	Relinks all parts to the contents of the score.
__FCBaseData *	CreateClone ()
	Creates an identical copy of an object.
void	DebugDump () override
	Outputs the class data/information for debugging purposes.
void	DebugDataDump () override
	Outputs a memory dump of the data block in the object for debugging purposes.
void	DebugDataByteArrayDump () override
	Outputs a memory dump of the data block in the object for debugging purposes, as a C++ byte array.
void	DebugDataOffsetDump (int offset, int size)
	For debug mode only. Dumps a data memory block at a specific offset and with a specific size.
FCNumbers *	CreateRawDataDump ()
	Creates a byte collection with the raw loaded data block for the object (if the object type supports single data blocks). This method is only intended for debug purposes.
Public Member Functions inherited from __FCBase
virtual	~__FCBase ()
	Virtual destructor, so all inherited classes get the virtual destructor.
void	DebugMsgInt (const char *pszPrefixText, int i)
	Creates a simple Message Box for debug purposes. The text appears with the extra digit (in decimal presentation) appearing afterwards.
void	DebugMsgHex (const char *pszPrefixText, int i)
	Creates a simple Message Box for debug purposes. The text appears with the extra digit (as a hexadecimal number) appearing afterwards.
void	DebugMsgString (const char *pszPrefixText, const char *thestring)
	Creates a simple Message Box for debug purposes. The text appears with the extra string appearing afterwards.
void	DebugMsg (const char *pszMsg)
	Creates a simple Message Box for debug purposes with just one text string.
void	DebugOutMenuInfo (FCUI *pUI, int menuixd_horiz, int menuixd_vert) const
	Outputs the menu command info for debugging purposes.
int	DebugOutFormat (const char *fmt,...)
	Outputs debug text using C style "printf" syntax.
void	Set16BitFlag (FLAG_16 *flag, FLAG_16 flagbits, bool state)
	Sets a 16 bit flag.
void	Set32BitFlag (FLAG_32 *flag, FLAG_32 flagbits, bool state)
	Sets/resets a 32 bit flag, by using a bit mask.
bool	GetBitFlag (FLAG_32 flag, FLAG_32 flagbits) const
	Gets a state from flag bits. Returns true if any bit in the mask is set.
int	GetBitCount (FLAG_32 flag)
	Returns the total number of set bits in a 32-bit unsigned int.
void	SetSpecific32Bit (FLAG_32 *flag, int bitnumber, bool state)
	Sets/resets a single bit in a 32 bit flag, by specifying one specific bit.
void	SetUserData (void *pData)
	Sets the user data attached to the instance of an object.
void	SetUserData2 (void *pData)
	Sets the additional user data attached to the instance of an object.
void *	GetUserData () const
	Gets the user data attached to the instance of an object.
void *	GetUserData2 () const
	Gets the additional user data attached to the instance of an object.
virtual bool	IsIdentical (const __FCBase *pCompareObject) const
	Returns true if the data in the passed object is considered to be identical to the current object, otherwise false.
void	StoreXML_String (tinyxml2::XMLElement *pParentNode, const char *pszElementName, FCString *pStringValue)
	Helper function to store FCString objects in the XML file.
void	StoreXML_Integer (tinyxml2::XMLElement *pParentNode, const char *pszElementName, int value)
	Helper function to store integer objects in the XML file.
void	StoreXML_Bool (tinyxml2::XMLElement *pParentNode, const char *pszElementName, bool value)
	Helper function to store boolean objects in the XML file.
void	StoreXML_StringAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, FCString *pStringValue)
	Helper function to store FCString objects in the XML file, as an attribute to a node.
void	StoreXML_IntegerAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, int value)
	Helper function to store integer objects in the XML file, as an attribute to a node.
void	StoreXML_BoolAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, bool value)
	Helper function to store boolean objects in the XML file, as an attribute to a node.
void	StoreXML_FloatAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, float value)
	Helper function to store floating point objects in the XML file, as an attribute to a node.
virtual void	StoreToXML (tinyxml2::XMLElement *pParentNode)
	Virtual method that is used to store an object's data.
bool	ReadXML_String (tinyxml2::XMLElement *pParentNode, const char *pszElementName, FCString *pStringValue)
	Helper method to read FCString objects from the XML file.
bool	ReadXML_Integer (tinyxml2::XMLElement *pParentNode, const char *pszElementName, int *pValue)
	Helper method to read integer objects from the XML file.
bool	ReadXML_Bool (tinyxml2::XMLElement *pParentNode, const char *pszElementName, bool *pValue)
	Helper method to read boolean objects from the XML file.
bool	ReadXML_StringAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, FCString *pStringValue)
	Helper method to read FCString objects from the XML file, as an attribute to a node.
bool	ReadXML_IntegerAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, int *pValue)
	Helper method to read integer objects from the XML file, as an attribute to a node.
bool	ReadXML_BoolAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, bool *pValue)
	Helper method to read boolean objects from the XML file, as an attribute to a node.
bool	ReadXML_FloatAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, float *pValue)
	Helper method to read floating point objects from the XML file, as an attribute to a node.
virtual bool	ReadFromXML (tinyxml2::XMLElement *pParentNode)
	Virtual method that is used to read object data.

Additional Inherited Members
Static Public Member Functions inherited from __FCBase
static void	DebugOutPtr (const char *pszPrefixText, void *ptr)
	Static method that outputs a line for debugging purposes. The prefix text appears with the extra ptr (in hexadeximal representation) appearing afterwards.
static void	DebugOutInt (const char *pszPrefixText, int i)
	Static method that outputs a line for debugging purposes. The text appears with the extra digit (in decimal presentation) appearing afterwards.
static void	DebugOutFloat (const char *pszPrefixText, double f)
	Static method that outputs a line for debugging purposes. The text appears with the extra float value appearing afterwards.
static void	DebugOutTag (const char *pszPrefixText, EXTAG extag)
	Static method that outputs a line for debugging purposes. The text appears with the EXTAG (in text) appearing afterwards.
static void	DebugOutHex (const char *pszPrefixText, int i)
	Static method that outputs a line for debugging purposes. The text appears with the extra digit (in hexadecimal presentation) appearing afterwards.
static void	DebugOutBin (const char *pszPrefixText, int i)
	Static method that outputs a line for debugging purposes. The text appears with the extra digit (in binary presentation) appearing afterwards.
static void	DebugOutString (const char *pszPrefixText, const char *thestring)
	Static method that outputs a line for debugging purposes (C string version). The text appears with the extra string appearing afterwards.
static void	DebugOutString (const char *pszPrefixText, FCString *pString)
	Static method that outputs a line for debugging purposes (FCString version). The text appears with the extra string appearing afterwards.
static void	DebugOutBool (const char *pszPrefixText, bool state)
	Static method that outputs a line for debugging purposes. The boolean state appears afterwards as either "TRUE" or "FALSE".
static void	DebugOutBlock (const void *pBuffer, int startoffset, int size)
	Static method that outputs a memory block for debugging purposes. Eight bytes per line will appear (as hex digits) until the whole memory block is dumped.
static void	DebugOutByteArrayBlock (const void *pBuffer, int startoffset, int size)
	Static method that outputs a memory block for debugging purposes. Eight bytes per line will appear (as hex digits) as a C++ onebyte array, until the whole memory block is dumped.
static void	DebugOut (const char *pszLine)
	Static method to output a line of text for debugging purposes.
Protected Member Functions inherited from __FCPrefsBase
	__FCPrefsBase ()
	standard constructor
Protected Member Functions inherited from __FCBaseData
virtual void	Deallocate ()
virtual bool	IsDynamicSize ()
bool	LoadDataBlock ()
	Loads the data. If the object is of dynamic size, the old memory block is freed and a new is allocated.
void	ClearData ()
virtual twobyte	CalcLastInci ()
	For internal use only!
bool	DataIsLoaded () const
	Returns true is any data has been loaded into the object.
void	_TagDocumentID ()
	For internal use only.
Protected Member Functions inherited from __FCBase
	__FCBase ()
	The constructor.
Protected Attributes inherited from __FCBaseData
EDOCID	_connecteddocID
	The "connected" document ID., which is the document the where the document was loaded (or last saved). This is for a mechanism to prevent resaving of certain data in other documents.
void *	_datablock
	Pointer to the object's data block, the meaning is implementation-specific for each derived subclass.
bool	_heapdatablock
	Variable that tells if _datablock is dynamically created on the heap (and should be deleted at object destruction).
int	_loadedsize
	Loaded size of the data block for a loaded object, in bytes. Since the datablock is implementation-specific, the _loadedsize should be updated by child classes that create new data.
EDataID	_dataid
	The EdataID for the last loaded/saved object.

Detailed Description

The "Program Options" (program-wide options that is not stored in the document).

Please note that these options are global. Make sure to notify the user if an option is changed.

The Reflow Measures settings in the Finale Preferences needs a special combination of values, as outlined below:

Do Not Reflow:

• GetRecalcMeasures() = false
• GetRespaceMeasureLayout() = false
• GetRetainFrozenMeasures() = true

Only Within Systems:

• GetRecalcMeasures() = false
• GetRespaceMeasureLayout() = true
• GetRetainFrozenMeasures() = true

Across Systems (Maintain System Locks):

• GetRecalcMeasures() = true
• GetRespaceMeasureLayout() = false
• GetRetainFrozenMeasures() = true

Across Systems (Remove System Locks):

• GetRecalcMeasures() = true
• GetRespaceMeasureLayout() = false
• GetRetainFrozenMeasures() = false

Member Enumeration Documentation

GRACENOTE_QUANTIZATIONMODE

enum FCGeneralPrefs::GRACENOTE_QUANTIZATIONMODE

The grace note spacing constants used by GetQuantizationGraceNoteMode.

Lua-supported.

Enumerator
GRACEQUANTMODE_ALLOW	Allow grace notes.
GRACEQUANTMODE_REMOVE	Remove grace notes.
GRACEQUANTMODE_CONVERT	Convert grace notes to real notes.

QUANTIZATIONMODE

enum FCGeneralPrefs::QUANTIZATIONMODE

The quantization mode constants used by GetQuantizationMode.

Lua-supported.

Enumerator
QUANTIZATIONMODE_NOTUPLETS	No Tuplets
QUANTIZATIONMODE_MIXRHYTHMS	Mix Rhythms
QUANTIZATIONMODE_SPACEEVENLY	Space Notes Evenly in Beat

UNDOSTATE

enum FCGeneralPrefs::UNDOSTATE

The undo state constants used by GetUndoState.

Lua-supported.

Enumerator
UNDOSTATE_OFF	This state occurs internally within Finale, but plugins possibly never see it.
UNDOSTATE_DISABLED	User unchecked "Allow Undo" in Finale Preferences Edit pane.
UNDOSTATE_ENABLED	User checked "Allow Undo" in Finale Preferences Edit pane.
UNDOSTATE_SUSPENDED	Undo is temporarily disabled until next Finale launch.

Member Function Documentation

ClassName()

const char * FCGeneralPrefs::ClassName ( ) const

inlineoverridevirtual

Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child class.

Lua-supported.

Reimplemented from __FCPrefsBase.

ClearRebarStopAtOptions()

void FCGeneralPrefs::ClearRebarStopAtOptions ( )

inline

Clears all Stop At options in the Rebar Options dialog box.

Lua-supported (0.64).

GetAutomaticMusicSpacing()

bool FCGeneralPrefs::GetAutomaticMusicSpacing ( ) const

inline

Returns true if "Automatic Music Spacing" is set in the Program Options.

This function requires a minimum running Finale version of Finale 27.3. If you call it in an earlier Finale version, it results in a run-time error.

Lua-supported (also as property) (0.65)

GetAutomaticUpdateLayout()

bool FCGeneralPrefs::GetAutomaticUpdateLayout ( ) const

inline

Returns true if "Automatic Update Layout" is set in the Program Options.

Lua-supported (also as property).

GetClassID()

const PDKFRAMEWORK_CLASSID FCGeneralPrefs::GetClassID ( ) const

inlineoverridevirtual

Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has problems to resolve the true classes of inherited objects.

This method must be overwritten by all child classes.

Lua-supported (also read-only property) (0.55).

Implements __FCBaseData.

GetCustomZoom1()

ePercent FCGeneralPrefs::GetCustomZoom1 ( ) const

inline

Returns the "Custom Zoom 1" value in Program Options.

This function requires a minimum running Finale version of Finale 27.3. If you call it in an earlier Finale version, it results in a run-time error.

Lua-supported (also as property) (0.65)

Returns

a value greater than or equal to 0 representing a percent (100 = 100%)

GetCustomZoom2()

ePercent FCGeneralPrefs::GetCustomZoom2 ( ) const

inline

Returns the "Custom Zoom 2" value in Program Options.

This function requires a minimum running Finale version of Finale 27.3. If you call it in an earlier Finale version, it results in a run-time error.

Lua-supported (also as property) (0.65)

Returns

a value greater than or equal to 0 representing a percent (100 = 100%)

GetCustomZoom3()

ePercent FCGeneralPrefs::GetCustomZoom3 ( ) const

inline

Returns the "Custom Zoom 3" value in Program Options.

This function requires a minimum running Finale version of Finale 27.3. If you call it in an earlier Finale version, it results in a run-time error.

Lua-supported (also as property) (0.65)

Returns

a value greater than or equal to 0 representing a percent (100 = 100%)

GetDottedRestsAreLegalInCompoundMeter()

bool FCGeneralPrefs::GetDottedRestsAreLegalInCompoundMeter ( ) const

inline

Return true if compound meters can contain dotted rests.

The setting is called "Allow Dotted Rests in Compound Meters" in the More Quantization Settings dialog box.

Lua-supported (also as property) (0.64).

GetDottedRestsAreLegalInSimpleMeter()

bool FCGeneralPrefs::GetDottedRestsAreLegalInSimpleMeter ( ) const

inline

Return true if simple meters can contain dotted rests.

The setting is called "Allow Dotted Rests in Simple Meters" in the More Quantization Settings dialog box.

Lua-supported (also as property) (0.64).

GetHiddenObjectShading()

twobyte FCGeneralPrefs::GetHiddenObjectShading ( ) const

inline

Returns the "Hidden Object Shading" value in Program Options.

This function requires a minimum running Finale version of Finale 27.3. If you call it in an earlier Finale version, it results in a run-time error.

Lua-supported (also as property) (0.65)

Returns

a value from 0 to 100 representing a percent

GetIncludeMIDIContinuousData()

bool FCGeneralPrefs::GetIncludeMIDIContinuousData ( ) const

inline

Return true if continuous data should be included in MIDI import.

The setting is called "Include Continuous Data" in the Import MIDI FIle Options dialog box.

Lua-supported (also as property) (0.64).

GetIncludeMIDITempoChanges()

bool FCGeneralPrefs::GetIncludeMIDITempoChanges ( ) const

inline

Return true if tempo changes should be included in MIDI import.

The setting is called "Include Tempo Changes" in the Import MIDI FIle Options dialog box.

Lua-supported (also as property) (0.64).

GetKeyboardSplitPoint()

twobyte FCGeneralPrefs::GetKeyboardSplitPoint ( ) const

inline

Return the MIDI note (0-127) that defines the Hyperscribe fixed keyboard split point.

The setting is called "Split at MIDI Note" in the Fixed Split Point dialog box (Hyperscribe Tool).

Lua-supported (also as property) (0.64).

GetMeasurementUnit()

MEASUREMENTUNITS FCGeneralPrefs::GetMeasurementUnit ( ) const

inline

Returns the currently selected measurement unit. The setting is called "Measurement Units" in the Finale Preferences.

Lua-supported (also as property).

Returns

Any of the MEASUREMENTUNIT_ constants.

GetPitchRepresentationType()

twobyte FCGeneralPrefs::GetPitchRepresentationType ( ) const

inline

Returns the preferred Pitch representation type for MIDI notes in Finale. The setting is called "Pitch Representation" in the Finale Preferences.

Lua-supported (also as property).

Returns

0 - MIDI number, 1 - pitch string

GetPitchRepresentationValue()

twobyte FCGeneralPrefs::GetPitchRepresentationValue ( ) const

inline

Returns the octave representation number value. The setting is called "Pitch Representation->Middle C" in the Finale Preferences.

Lua-supported (also as property).

Returns

0: Midi 60 = "C4"; 12: Midi 60 = "C5"; -12: Midi 60 = "C3" etc.

GetQuantizationGraceNoteMode()

GRACENOTE_QUANTIZATIONMODE FCGeneralPrefs::GetQuantizationGraceNoteMode ( ) const

inline

Return the quantization mode for grace notes.

The setting is part of the More Quantization Settings dialog box.

Lua-supported (also as property) (0.64).

Returns

Any of the GRACENOTE_QUANTIZATIONMODE constants.

GetQuantizationIncludeVoiceTwo()

bool FCGeneralPrefs::GetQuantizationIncludeVoiceTwo ( ) const

inline

Return true if Voice Two should be used in quantization.

The setting is called "Include Voice Two" in the More Quantization Settings dialog box.

Lua-supported (also as property) (0.64).

GetQuantizationMinimizeRests()

bool FCGeneralPrefs::GetQuantizationMinimizeRests ( ) const

inline

Return whether to minimize rests in quantization.

This setting is called "Minimize Number of Rests" in the More Quantization Settings dialog box.

This function requires a minimum running Finale version of Finale 27.3. If you call it in an earlier Finale version, it results in a run-time error.

Lua-supported (also as property) (0.65)

GetQuantizationMode()

QUANTIZATIONMODE FCGeneralPrefs::GetQuantizationMode ( ) const

inline

Return the mode for quantization.

The setting is called "Play This...And Get This" in the Quantization Settings dialog box.

Lua-supported (also as property) (0.64).

Returns

Any of the QUANTIZATIONMODE constants.

GetQuantizationRetainKeyVelocities()

bool FCGeneralPrefs::GetQuantizationRetainKeyVelocities ( ) const

inline

Return true if key velocities should be retained in quantization.

The setting is called "Retain Key Velocities" in the More Quantization Settings dialog box.

Lua-supported (also as property) (0.64).

GetQuantizationRetainNoteDurations()

bool FCGeneralPrefs::GetQuantizationRetainNoteDurations ( ) const

inline

Return true if note durations should be retained in quantization.

The setting is called "Retain Note Durations" in the More Quantization Settings dialog box.

Lua-supported (also as property) (0.64).

GetQuantizationSensitivityLevel()

TimeEdu16 FCGeneralPrefs::GetQuantizationSensitivityLevel ( ) const

inline

Return the sensitivity level value for quantization.

This is the value for "Sensitivity Level" in the More Quantization Settings dialog box.

Lua-supported (also as property) (0.64).

GetQuantizationSmallestNoteValue()

TimeEdu16 FCGeneralPrefs::GetQuantizationSmallestNoteValue ( ) const

inline

Return the smallest note value for quantization.

The setting is part of the Quantization Settings dialog box.

Lua-supported (also as property) (0.64).

GetQuantizationSmallestNoteValueToRemove()

TimeEdu16 FCGeneralPrefs::GetQuantizationSmallestNoteValueToRemove ( ) const

inline

Return the smallest note value to remove.

This setting is called "Remove Notes Smaller Than: [ ] EDUs" in the More Quantization Settings dialog box.

This function requires a minimum running Finale version of Finale 27.3. If you call it in an earlier Finale version, it results in a run-time error.

Lua-supported (also as property) (0.65)

GetQuantizationSoftenSyncopations()

bool FCGeneralPrefs::GetQuantizationSoftenSyncopations ( ) const

inline

Return true if quantization should soften syncopations (use fewer ties).

The setting is called "Soften Syncopations" in the More Quantization Settings dialog box.

Lua-supported (also as property) (0.64).

GetQuantizationUseSensitivityLevel()

bool FCGeneralPrefs::GetQuantizationUseSensitivityLevel ( ) const

inline

Return whether to use the sensitivity level value in quantization.

This is the checkbox for "Sensitivity Level" in the More Quantization Settings dialog box.

This function requires a minimum running Finale version of Finale 27.3. If you call it in an earlier Finale version, it results in a run-time error.

Lua-supported (also as property) (0.65)

GetRebarStopAtEmptyFrame()

bool FCGeneralPrefs::GetRebarStopAtEmptyFrame ( ) const

inline

Return true if rebar music should stop at empty frames.

The setting is called "Empty Frames" in the Rebar Options dialog box.

Lua-supported (also as property) (0.64).

GetRebarStopAtEndOfRegion()

bool FCGeneralPrefs::GetRebarStopAtEndOfRegion ( ) const

inline

Return true if rebar music should stop at the end of the selected region.

The setting is called "The End of the Region" in the Rebar Options dialog box.

Lua-supported (also as property) (0.64).

GetRebarStopAtKeyChange()

bool FCGeneralPrefs::GetRebarStopAtKeyChange ( ) const

inline

Return true if rebar music should stop at the next key change.

The setting is called "Key Signature Changes" in the Rebar Options dialog box.

Lua-supported (also as property) (0.64).

GetRebarStopAtSpecialBarline()

bool FCGeneralPrefs::GetRebarStopAtSpecialBarline ( ) const

inline

Return true if rebar music should stop at special barlines.

The setting is called "Special or Repeat Barlines, or Forward Repeats" in the Rebar Options dialog box.

Lua-supported (also as property) (0.64).

GetRebarStopAtTimeChange()

bool FCGeneralPrefs::GetRebarStopAtTimeChange ( ) const

inline

Return true if rebar music should stop at the next meter change.

The setting is called "Time Signature Changes" in the Rebar Options dialog box.

Lua-supported (also as property) (0.64).

GetRebarStopOnlyAtEndOfPiece()

bool FCGeneralPrefs::GetRebarStopOnlyAtEndOfPiece ( ) const

inline

Return true if rebar music should stop only at the end of the document.

If this setting is true, then none of the Stop At options are set in the Rebar Options dialog box.

Lua-supported (also as read-only property) (0.64).

GetRebarWhenTimeSigChanged()

bool FCGeneralPrefs::GetRebarWhenTimeSigChanged ( ) const

inline

Return true if measures should rebar when the Time Signature Tool changes the time signature.

The setting is called "Rebar" in the Time Signature dialog box.

Lua-supported (also as property).

GetRebeamOnRebar()

bool FCGeneralPrefs::GetRebeamOnRebar ( ) const

inline

Return true if rebar music should also rebeam music.

The setting is called "Rebeam" in the Rebar Options dialog box.

Lua-supported (also as property) (0.64).

GetRecalcMeasures()

bool FCGeneralPrefs::GetRecalcMeasures ( ) const

inline

Return true if measure layout should be recalculated when the layout is updated.

Please refer to the main class documentation for explanation on how this setting affects the "Reflow Measures" in the Finale Preferences.

Lua-supported (also as property).

GetRecalcSystems()

bool FCGeneralPrefs::GetRecalcSystems ( ) const

inline

Return true if systems should be recalculated when the layout is updated. The setting is called "Reflow systems across pages" in the Finale Preferences.

Lua-supported (also as property).

GetRespaceMeasureLayout()

bool FCGeneralPrefs::GetRespaceMeasureLayout ( ) const

inline

Returns true if measures should reflow within a system at a layout update.

Please refer to the main class documentation for explanation on how this setting affects the "Reflow Measures" in the Finale Preferences.

Lua-supported (also as property).

GetRetainFrozenMeasures()

bool FCGeneralPrefs::GetRetainFrozenMeasures ( ) const

inline

Return true if frozen systems should be retained when the layout is updated.

Please refer to the main class documentation for explanation on how this setting affects the "Reflow Measures" in the Finale Preferences.

Lua-supported (also as property).

GetShowDefaultGroupNames()

bool FCGeneralPrefs::GetShowDefaultGroupNames ( ) const

inline

Returns if default group names should be displayed as placeholders. The setting is called "Staff/Show Default Group Names" and is found in the Staff Tool.

Lua-supported (also as property).

GetShowDefaultStaffNames()

bool FCGeneralPrefs::GetShowDefaultStaffNames ( ) const

inline

Returns if default staff names should be displayed as placeholders. The setting is called "Staff/Show Default Staff Names" and is found in the Staff Tool.

Lua-supported (also as property).

GetTransposeMIDIOnInput()

bool FCGeneralPrefs::GetTransposeMIDIOnInput ( ) const

inline

Return whether to transpose MIDI on input.

This setting is a menu item in the "MIDI/Audio->Device Setup" menu.

This function requires a minimum running Finale version of Finale 27.3. If you call it in an earlier Finale version, it results in a run-time error.

Lua-supported (also as property) (0.65)

GetUndoState()

UNDOSTATE FCGeneralPrefs::GetUndoState ( ) const

inline

Return current Undo state.

Lua-supported (also as read-only property) (0.64).

Returns

Any of the UNDOSTATE constants.

SetAutomaticMusicSpacing()

void FCGeneralPrefs::SetAutomaticMusicSpacing ( bool state )

inline

Sets if "Automatic Music Spacing" is set in the Program Options.

This function requires a minimum running Finale version of Finale 27.3. If you call it in an earlier Finale version, it results in a run-time error.

Lua-supported (also as property) (0.65)

SetAutomaticUpdateLayout()

void FCGeneralPrefs::SetAutomaticUpdateLayout ( bool state )

inline

Sets if "Automatic Update Layout" is set in the Program Options.

Lua-supported (also as property).

SetCustomZoom1()

void FCGeneralPrefs::SetCustomZoom1 ( ePercent percent )

inline

Sets the "Custom Zoom 1" value in Program Options.

This function requires a minimum running Finale version of Finale 27.3. If you call it in an earlier Finale version, it results in a run-time error.

Lua-supported (also as property) (0.65)

Parameters

percent

a value greater than or equal to 0 representing a percent (100 = 100%). Negative values are forced to zero.

SetCustomZoom2()

void FCGeneralPrefs::SetCustomZoom2 ( ePercent percent )

inline

Sets the "Custom Zoom 2" value in Program Options.

This function requires a minimum running Finale version of Finale 27.3. If you call it in an earlier Finale version, it results in a run-time error.

Lua-supported (also as property) (0.65)

Parameters

percent

a value greater than or equal to 0 representing a percent (100 = 100%). Negative values are forced to zero.

SetCustomZoom3()

void FCGeneralPrefs::SetCustomZoom3 ( ePercent percent )

inline

Sets the "Custom Zoom 3" value in Program Options.

This function requires a minimum running Finale version of Finale 27.3. If you call it in an earlier Finale version, it results in a run-time error.

Lua-supported (also as property) (0.65)

Parameters

percent

a value greater than or equal to 0 representing a percent (100 = 100%). Negative values are forced to zero.

SetDottedRestsAreLegalInCompoundMeter()

void FCGeneralPrefs::SetDottedRestsAreLegalInCompoundMeter ( bool state )

inline

Sets if compound meters can contain dotted rests.

The setting is called "Allow Dotted Rests in Compound Meters" in the More Quantization Settings dialog box.

Lua-supported (also as property) (0.64).

SetDottedRestsAreLegalInSimpleMeter()

void FCGeneralPrefs::SetDottedRestsAreLegalInSimpleMeter ( bool state )

inline

Sets if simple meters can contain dotted rests.

The setting is called "Allow Dotted Rests in Simple Meters" in the More Quantization Settings dialog box.

Lua-supported (also as property) (0.64).

SetHiddenObjectShading()

void FCGeneralPrefs::SetHiddenObjectShading ( twobyte percent )

inline

Sets the "Hidden Object Shading" value in Program Options.

This function requires a minimum running Finale version of Finale 27.3. If you call it in an earlier Finale version, it results in a run-time error.

Lua-supported (also as property) (0.65)

Parameters

percent

a value from 0 to 100 representing a percent. The input is forced into this range.

SetIncludeMIDIContinuousData()

void FCGeneralPrefs::SetIncludeMIDIContinuousData ( bool state )

inline

Sets if continuous data should be included in MIDI import.

The setting is called "Include Continuous Data" in the Import MIDI FIle Options dialog box.

Lua-supported (also as property) (0.64).

SetIncludeMIDITempoChanges()

void FCGeneralPrefs::SetIncludeMIDITempoChanges ( bool state )

inline

Sets if tempo changes should be included in MIDI import.

The setting is called "Include Tempo Changes" in the Import MIDI FIle Options dialog box.

Lua-supported (also as property) (0.64).

SetKeyboardSplitPoint()

void FCGeneralPrefs::SetKeyboardSplitPoint ( twobyte value )

inline

Sets the MIDI note (0-127) that defines the Hyperscribe fixed keyboard split point.

The setting is called "Split at MIDI Note" in the Fixed Split Point dialog box (Hyperscribe Tool).

Lua-supported (also as property) (0.64).

SetMeasurementUnit()

void FCGeneralPrefs::SetMeasurementUnit ( twobyte value )

inline

Sets the currently selected measurement unit. The setting is called "Measurement Units" in the Finale Preferences.

Lua-supported (also as property).

Parameters

value

Any of the MEASUREMENTUNIT_ constants.

SetPitchRepresentationType()

void FCGeneralPrefs::SetPitchRepresentationType ( twobyte value )

inline

Sets the preferred Pitch representation type for MIDI notes in Finale. The setting is called "Pitch Representation" in the Finale Preferences.

Lua-supported (also as property).

Parameters

value

0 - MIDI number, 1 - pitch string

SetPitchRepresentationValue()

void FCGeneralPrefs::SetPitchRepresentationValue ( twobyte value )

inline

Sets the octave representation number value. The setting is called "Pitch Representation->Middle C" in the Finale Preferences.

Lua-supported (also as property).

Parameters

value

0: Midi 60 = "C4"; 12: Midi 60 = "C5"; -12: Midi 60 = "C3" etc.

SetQuantizationGraceNoteMode()

void FCGeneralPrefs::SetQuantizationGraceNoteMode ( twobyte value )

inline

Sets the quantization mode for grace notes.

The setting is part of the More Quantization Settings dialog box.

Lua-supported (also as property) (0.64).

Parameters

value

Any of the GRACENOTE_QUANTIZATIONMODE constants.

SetQuantizationIncludeVoiceTwo()

void FCGeneralPrefs::SetQuantizationIncludeVoiceTwo ( bool state )

inline

Sets if Voice Two should be used in quantization.

The setting is called "Include Voice Two" in the More Quantization Settings dialog box.

Lua-supported (also as property) (0.64).

SetQuantizationMinimizeRests()

void FCGeneralPrefs::SetQuantizationMinimizeRests ( bool state )

inline

Sets whether to minimize rests in quantization.

This setting is called "Minimize Number of Rests" in the More Quantization Settings dialog box.

This function requires a minimum running Finale version of Finale 27.3. If you call it in an earlier Finale version, it results in a run-time error.

Lua-supported (also as property) (0.65)

SetQuantizationMode()

void FCGeneralPrefs::SetQuantizationMode ( twobyte value )

inline

Sets the mode for quantization.

The setting is called "Play This...And Get This" in the Quantization Settings dialog box.

Lua-supported (also as property) (0.64).

Parameters

value

Any of the QUANTIZATIONMODE constants.

SetQuantizationRetainKeyVelocities()

void FCGeneralPrefs::SetQuantizationRetainKeyVelocities ( bool state )

inline

Return true if key velocities should be retained in quantization.

The setting is called "Retain Key Velocities" in the More Quantization Settings dialog box.

Lua-supported (also as property) (0.64).

SetQuantizationRetainNoteDurations()

void FCGeneralPrefs::SetQuantizationRetainNoteDurations ( bool state )

inline

Sets if note durations should be retained in quantization.

The setting is called "Retain Note Durations" in the More Quantization Settings dialog box.

Lua-supported (also as property) (0.64).

SetQuantizationSensitivityLevel()

void FCGeneralPrefs::SetQuantizationSensitivityLevel ( TimeEdu16 value )

inline

Sets the sensitivity level value for quantization.

This is the value for "Sensitivity Level" in the More Quantization Settings dialog box.

Lua-supported (also as property) (0.64).

SetQuantizationSmallestNoteValue()

void FCGeneralPrefs::SetQuantizationSmallestNoteValue ( TimeEdu16 value )

inline

Sets the smallest note value for quantization.

The setting is part of the Quantization Settings dialog box.

Lua-supported (also as property) (0.64).

SetQuantizationSmallestNoteValueToRemove()

void FCGeneralPrefs::SetQuantizationSmallestNoteValueToRemove ( TimeEdu16 value )

inline

Sets the smallest note value to remove.

This setting is called "Remove Notes Smaller Than: [ ] EDUs" in the More Quantization Settings dialog box.

This function requires a minimum running Finale version of Finale 27.3. If you call it in an earlier Finale version, it results in a run-time error.

Lua-supported (also as property) (0.65)

SetQuantizationSoftenSyncopations()

void FCGeneralPrefs::SetQuantizationSoftenSyncopations ( bool state )

inline

Sets if quantization should soften syncopations (use fewer ties).

The setting is called "Soften Syncopations" in the More Quantization Settings dialog box.

Lua-supported (also as property) (0.64).

SetQuantizationUseSensitivityLevel()

void FCGeneralPrefs::SetQuantizationUseSensitivityLevel ( bool state )

inline

Sets whether to use the sensitivity level value in quantization.

This is the checkbox for "Sensitivity Level" in the More Quantization Settings dialog box.

This function requires a minimum running Finale version of Finale 27.3. If you call it in an earlier Finale version, it results in a run-time error.

Lua-supported (also as property) (0.65)

SetRebarStopAtEmptyFrame()

void FCGeneralPrefs::SetRebarStopAtEmptyFrame ( bool state )

inline

Sets if rebar music should stop at empty frames.

The setting is called "Empty Frames" in the Rebar Options dialog box.

Lua-supported (also as property) (0.64).

SetRebarStopAtEndOfRegion()

void FCGeneralPrefs::SetRebarStopAtEndOfRegion ( bool state )

inline

Sets if rebar music should stop at the end of the selected region.

The setting is called "The End of the Region" in the Rebar Options dialog box.

Lua-supported (also as property) (0.64).

SetRebarStopAtKeyChange()

void FCGeneralPrefs::SetRebarStopAtKeyChange ( bool state )

inline

Sets if rebar music should stop at the next key change.

The setting is called "Key Signature Changes" in the Rebar Options dialog box.

Lua-supported (also as property) (0.64).

SetRebarStopAtSpecialBarline()

void FCGeneralPrefs::SetRebarStopAtSpecialBarline ( bool state )

inline

Sets if rebar music should stop at special barlines.

The setting is called "Special or Repeat Barlines, or Forward Repeats" in the Rebar Options dialog box.

Lua-supported (also as property) (0.64).

SetRebarStopAtTimeChange()

void FCGeneralPrefs::SetRebarStopAtTimeChange ( bool state )

inline

Sets if rebar music should stop at the next meter change.

The setting is called "Time Signature Changes" in the Rebar Options dialog box.

Lua-supported (also as property) (0.64).

SetRebarWhenTimeSigChanged()

void FCGeneralPrefs::SetRebarWhenTimeSigChanged ( bool state )

inline

Sets if measures should rebar when the Time Signature Tool changes the time signature.

The setting is called "Rebar" in the Time Signature dialog box.

Lua-supported (also as property).

SetRebeamOnRebar()

void FCGeneralPrefs::SetRebeamOnRebar ( bool state )

inline

Sets if rebar music should also rebeam music.

The setting is called "Rebeam" in the Rebar Options dialog box.

Lua-supported (also as property) (0.64).

SetRecalcMeasures()

void FCGeneralPrefs::SetRecalcMeasures ( bool state )

inline

Sets if measure layout should be recalculated when the layout is updated.

Please refer to the main class documentation for explanation on how this setting affects the "Reflow Measures" in the Finale Preferences.

Lua-supported (also as property).

SetRecalcSystems()

void FCGeneralPrefs::SetRecalcSystems ( bool state )

inline

Sets if systems should be recalculated when the layout is updated. The setting is called "Reflow systems across pages" in the Finale Preferences.

Lua-supported (also as property).

SetRespaceMeasureLayout()

void FCGeneralPrefs::SetRespaceMeasureLayout ( bool state )

inline

Sets if measures should reflow within a system at a layout update.

Please refer to the main class documentation for explanation on how this setting affects the "Reflow Measures" in the Finale Preferences.

Lua-supported (also as property).

SetRetainFrozenMeasures()

void FCGeneralPrefs::SetRetainFrozenMeasures ( bool state )

inline

Sets if frozen systems should be retained when the layout is updated.

Please refer to the main class documentation for explanation on how this setting affects the "Reflow Measures" in the Finale Preferences.

Lua-supported (also as property).

SetShowDefaultGroupNames()

void FCGeneralPrefs::SetShowDefaultGroupNames ( bool state )

inline

Sets if default group names should be displayed as placeholders. The setting is called "Staff/Show Default Group Names" and is found in the Staff Tool.

Lua-supported (also as property).

SetShowDefaultStaffNames()

void FCGeneralPrefs::SetShowDefaultStaffNames ( bool state )

inline

Sets if default staff names should be displayed as placeholders. The setting is called "Staff/Show Default Staff Names" and is found in the Staff Tool.

Lua-supported (also as property).

SetTransposeMIDIOnInput()

void FCGeneralPrefs::SetTransposeMIDIOnInput ( bool state )

inline

Sets whether to transpose MIDI on input.

This setting is a menu item in the "MIDI/Audio->Device Setup" menu.

This function requires a minimum running Finale version of Finale 27.3. If you call it in an earlier Finale version, it results in a run-time error.

Lua-supported (also as property) (0.65)