Preferences that controls the part extraction options in the document. More...

#include <ff_prefs.h>

Inheritance diagram for FCPartExtractPrefs:

Public Types
enum	EXTRACT_SPACING { EXTRACT_SPACING_TIMESIG = 0 , EXTRACT_SPACING_BEAT = 1 , EXTRACT_SPACING_NOTE = 2 , EXTRACT_SPACING_PRESERVECURRENT = 3 }
	The constants to use for controlling the spacing of the music for the extracted part. 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.

	FCPartExtractPrefs ()
	The constructor.

twobyte	GetSpacingMethod () const
	Returns the spacing method to use for extracted parts.

bool	GetUseNewStaffPlacement () const
	If set, use new staff position placement.

Evpu16	GetNewTopStaff () const
	If GetUseNewStaffPlacement() is true, returns new top staff system position.

Evpu16	GetNewSystemDistanceBetween () const
	If GetUseNewStaffPlacement() is true, returns distance between staff systems.

bool	GetRemovePageOneBlocks () const
	Returns if page text/graphics on page 1 should be removed.

bool	GetRemovePageTwoPlusBlocks () const
	Returns if page text/graphics on page 2+ should be removed.

bool	GetRemoveMultiPageBlocks () const
	Returns if multi-page text/graphics blocks should be removed.

bool	GetRemoveStaffGroupNames () const
	Returns if Staff or Group Names should be removed.

bool	GetFitMeasuresPerSystem () const
	Returns if a specific number of measures should fit on one staff system.

bool	GetFitMultimeasureRestAsOne () const
	Returns if multimeasure rests should be treated as one measure or not.

twobyte	GetMeasuresPerSystem () const
	Returns the number of measures per staff system. Only used if GetFitMeasuresPerSystem() is true.

bool	GetPromptForEachName () const
	Returns if Finale should prompt for each file name. If false, autogenerate file names.

bool	GetCreateNameHeader () const
	Returns if Staff/Group Name Header text should be created.

Evpu16	GetNameHeaderHorizontal () const
	Returns the horizontal position of part name header. Used if GetCreateNameHeader() returns true.

Evpu16	GetNameHeaderVertical () const
	Returns the vertical position of part name header. Used if GetCreateNameHeader() returns true.

twobyte	GetNameHeaderResize () const
	Returns the resize (in %) of the part header name. Used if GetCreateNameHeader() returns true.

twobyte	GetNameHeaderStartPage () const
	Returns the part header name start page. Used if GetCreateNameHeader() returns true.

twobyte	GetNameHeaderEndPage () const
	Returns the part header name end page. Used if GetCreateNameHeader() returns true.

bool	GetNameHeaderUseFontName () const
	Returns true if the font name should be used. Used if GetCreateNameHeader() returns true.

bool	GetNameHeaderFontInfo (FCFontInfo *pFontInfo)
	Gets the font info for the name header. Used if GetCreateNameHeader() returns true.

bool	GetOpenExtractedParts () const
	Returns true if the extracted parts should automatically be opened.

bool	GetSpaceSystemsEvenly () const
	Returns if Apply Space Systems Evenly should be applied to the extracted parts.

void	SetSpacingMethod (int method)
	Sets the spacing method to use for extracted parts.

void	SetUseNewStaffPlacement (bool state)
	If set, use new staff position placement.

void	SetNewTopStaff (Evpu16 value)
	If GetUseNewStaffPlacement() is true, returns new top staff system position.

void	SetNewSystemDistanceBetween (Evpu16 value)
	If GetUseNewStaffPlacement() is true, returns distance between staff systems.

void	SetRemovePageOneBlocks (bool state)
	Sets if page text/graphics on page 1 should be removed.

void	SetRemovePageTwoPlusBlocks (bool state)
	Sets if page text/graphics on page 2+ should be removed.

void	SetRemoveMultiPageBlocks (bool state)
	Sets if multi-page text/graphics blocks should be removed.

void	SetRemoveStaffGroupNames (bool state)
	Sets if Staff or Group Names should be removed.

void	SetFitMeasuresPerSystem (bool state)
	Sets if a specific number of measures should fit on one staff system.

void	SetFitMultimeasureRestAsOne (bool state)
	Sets if multimeasure rests should be treated as one measure or not.

void	SetMeasuresPerSystem (twobyte value)
	Sets the number of measures per staff system. Only used if GetFitMeasuresPerSystem() is true.

void	SetPromptForEachName (bool state)
	Sets if the Finale user interface should prompt for each file name. If false, autogenerate file names.

void	SetCreateNameHeader (bool state)
	Sets if Staff/Group Name Header text should be created.

void	SetNameHeaderHorizontal (Evpu16 position)
	Sets the horizontal position of part name header. Used if GetCreateNameHeader() returns true.

void	SetNameHeaderVertical (Evpu16 position)
	Sets the vertical position of part name header. Used if GetCreateNameHeader() returns true.

void	SetNameHeaderResize (twobyte value)
	Sets the resize (in %) of the part header name. Used if GetCreateNameHeader() returns true.

void	SetNameHeaderStartPage (twobyte value)
	Sets the part header name start page. Used if GetCreateNameHeader() returns true.

void	SetNameHeaderEndPage (twobyte value)
	Sets the part header name end page. Used if GetCreateNameHeader() returns true.

void	SetNameHeaderUseFontName (bool state)
	Sets true if the font name should be used. Used if GetCreateNameHeader() returns true.

void	SetNameHeaderDefaultFont ()
	Sets the document to use its default font name, font size, and style for part extraction.

void	SetNameHeaderDefaultFontName ()
	Sets the document to use its default font name only for part extraction.

void	SetNameHeaderDefaultFontSize ()
	Sets the document to use its default font size only for part extraction.

void	SetNameHeaderFontInfo (FCFontInfo *pFontInfo)
	Sets the font info for the name header. Used if GetCreateNameHeader() returns true.

void	SetOpenExtractedParts (bool state)
	Sets if the extracted parts should automatically be opened.

void	SetSpaceSystemsEvenly (bool state)
	Sets if Apply Space Systems Evenly should be applied to the extracted parts.

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 EVERSION	EnigmaVersion () const
	The Enigma version for save/load/create/delete operations.

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

Preferences that controls the part extraction options in the document.

Despite the mention of Lua-supported properties, this class is not hooked up to Lua. It appears to be obsolete in the post Finale 2007 era of linked parts.

Member Enumeration Documentation

◆ EXTRACT_SPACING

enum FCPartExtractPrefs::EXTRACT_SPACING

The constants to use for controlling the spacing of the music for the extracted part.

Enumerator
EXTRACT_SPACING_TIMESIG	Apply Time Sig Spacing on the extracted part.
EXTRACT_SPACING_BEAT	Apply Beat Spacing on the extracted part.
EXTRACT_SPACING_NOTE	Apply Note Spacing on the extracted part.
EXTRACT_SPACING_PRESERVECURRENT	Preserve current spacing.

Member Function Documentation

◆ ClassName()

const char * FCPartExtractPrefs::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.

◆ GetClassID()

const PDKFRAMEWORK_CLASSID FCPartExtractPrefs::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.

◆ GetCreateNameHeader()

bool FCPartExtractPrefs::GetCreateNameHeader ( ) const

inline

Returns if Staff/Group Name Header text should be created.

Lua-supported (also as property).

◆ GetFitMeasuresPerSystem()

bool FCPartExtractPrefs::GetFitMeasuresPerSystem ( ) const

inline

Returns if a specific number of measures should fit on one staff system.

If true, the GetMeasuresPerSystem() method contains the number of measures per system.

Lua-supported (also as property).

◆ GetFitMultimeasureRestAsOne()

bool FCPartExtractPrefs::GetFitMultimeasureRestAsOne ( ) const

inline

Returns if multimeasure rests should be treated as one measure or not.

Lua-supported (also as property).

◆ GetMeasuresPerSystem()

twobyte FCPartExtractPrefs::GetMeasuresPerSystem ( ) const

inline

Returns the number of measures per staff system. Only used if GetFitMeasuresPerSystem() is true.

Lua-supported (also as property).

◆ GetNameHeaderEndPage()

twobyte FCPartExtractPrefs::GetNameHeaderEndPage ( ) const

inline

Returns the part header name end page. Used if GetCreateNameHeader() returns true.

Lua-supported (also as property).

◆ GetNameHeaderFontInfo()

bool FCPartExtractPrefs::GetNameHeaderFontInfo ( FCFontInfo * pFontInfo )

inline

Gets the font info for the name header. Used if GetCreateNameHeader() returns true.

Lua-supported.

◆ GetNameHeaderHorizontal()

Evpu16 FCPartExtractPrefs::GetNameHeaderHorizontal ( ) const

inline

Returns the horizontal position of part name header. Used if GetCreateNameHeader() returns true.

Lua-supported (also as property).

◆ GetNameHeaderResize()

twobyte FCPartExtractPrefs::GetNameHeaderResize ( ) const

inline

Returns the resize (in %) of the part header name. Used if GetCreateNameHeader() returns true.

Lua-supported (also as property).

◆ GetNameHeaderStartPage()

twobyte FCPartExtractPrefs::GetNameHeaderStartPage ( ) const

inline

Returns the part header name start page. Used if GetCreateNameHeader() returns true.

Lua-supported (also as property).

◆ GetNameHeaderUseFontName()

bool FCPartExtractPrefs::GetNameHeaderUseFontName ( ) const

inline

Returns true if the font name should be used. Used if GetCreateNameHeader() returns true.

Lua-supported (also as property).

◆ GetNameHeaderVertical()

Evpu16 FCPartExtractPrefs::GetNameHeaderVertical ( ) const

inline

Returns the vertical position of part name header. Used if GetCreateNameHeader() returns true.

Lua-supported (also as property).

◆ GetNewSystemDistanceBetween()

Evpu16 FCPartExtractPrefs::GetNewSystemDistanceBetween ( ) const

inline

If GetUseNewStaffPlacement() is true, returns distance between staff systems.

Lua-supported (also as property).

◆ GetNewTopStaff()

Evpu16 FCPartExtractPrefs::GetNewTopStaff ( ) const

inline

If GetUseNewStaffPlacement() is true, returns new top staff system position.

Lua-supported (also as property).

◆ GetOpenExtractedParts()

bool FCPartExtractPrefs::GetOpenExtractedParts ( ) const

inline

Returns true if the extracted parts should automatically be opened.

Lua-supported (also as property).

◆ GetPromptForEachName()

bool FCPartExtractPrefs::GetPromptForEachName ( ) const

inline

Returns if Finale should prompt for each file name. If false, autogenerate file names.

Lua-supported (also as property).

◆ GetRemoveMultiPageBlocks()

bool FCPartExtractPrefs::GetRemoveMultiPageBlocks ( ) const

inline

Returns if multi-page text/graphics blocks should be removed.

Lua-supported (also as property).

◆ GetRemovePageOneBlocks()

bool FCPartExtractPrefs::GetRemovePageOneBlocks ( ) const

inline

Returns if page text/graphics on page 1 should be removed.

Lua-supported (also as property).

◆ GetRemovePageTwoPlusBlocks()

bool FCPartExtractPrefs::GetRemovePageTwoPlusBlocks ( ) const

inline

Returns if page text/graphics on page 2+ should be removed.

Lua-supported (also as property).

◆ GetRemoveStaffGroupNames()

bool FCPartExtractPrefs::GetRemoveStaffGroupNames ( ) const

inline

Returns if Staff or Group Names should be removed.

Lua-supported (also as property).

◆ GetSpaceSystemsEvenly()

bool FCPartExtractPrefs::GetSpaceSystemsEvenly ( ) const

inline

Returns if Apply Space Systems Evenly should be applied to the extracted parts.

Lua-supported (also as property).

◆ GetSpacingMethod()

twobyte FCPartExtractPrefs::GetSpacingMethod ( ) const

inline

Returns the spacing method to use for extracted parts.

Lua-supported (also as property).

Returns: Any of the EXTRACT_SPACING_ constants.

◆ GetUseNewStaffPlacement()

bool FCPartExtractPrefs::GetUseNewStaffPlacement ( ) const

inline

If set, use new staff position placement.

This setting affects the GetNewTopStaff() and GetNewSystemDistanceBetween() values.

Lua-supported (also as property).

◆ SetCreateNameHeader()

void FCPartExtractPrefs::SetCreateNameHeader ( bool state )

inline

Sets if Staff/Group Name Header text should be created.

Lua-supported (also as property).

◆ SetFitMeasuresPerSystem()

void FCPartExtractPrefs::SetFitMeasuresPerSystem ( bool state )

inline

Sets if a specific number of measures should fit on one staff system.

If true, the GetMeasuresPerSystem() method contains the number of measures per system.

Lua-supported (also as property).

◆ SetFitMultimeasureRestAsOne()

void FCPartExtractPrefs::SetFitMultimeasureRestAsOne ( bool state )

inline

Sets if multimeasure rests should be treated as one measure or not.

Lua-supported (also as property).

◆ SetMeasuresPerSystem()

void FCPartExtractPrefs::SetMeasuresPerSystem ( twobyte value )

inline

Sets the number of measures per staff system. Only used if GetFitMeasuresPerSystem() is true.

Lua-supported (also as property).

◆ SetNameHeaderDefaultFont()

void FCPartExtractPrefs::SetNameHeaderDefaultFont ( )

inline

Sets the document to use its default font name, font size, and style for part extraction.

Lua-supported.

◆ SetNameHeaderDefaultFontName()

void FCPartExtractPrefs::SetNameHeaderDefaultFontName ( )

inline

Sets the document to use its default font name only for part extraction.

Lua-supported.

◆ SetNameHeaderDefaultFontSize()

void FCPartExtractPrefs::SetNameHeaderDefaultFontSize ( )

inline

Sets the document to use its default font size only for part extraction.

Lua-supported.

◆ SetNameHeaderEndPage()

void FCPartExtractPrefs::SetNameHeaderEndPage ( twobyte value )

inline

Sets the part header name end page. Used if GetCreateNameHeader() returns true.

Lua-supported (also as property).

◆ SetNameHeaderFontInfo()

void FCPartExtractPrefs::SetNameHeaderFontInfo ( FCFontInfo * pFontInfo )

inline

Sets the font info for the name header. Used if GetCreateNameHeader() returns true.

Lua-supported.

◆ SetNameHeaderHorizontal()

void FCPartExtractPrefs::SetNameHeaderHorizontal ( Evpu16 position )

inline

Sets the horizontal position of part name header. Used if GetCreateNameHeader() returns true.

Lua-supported (also as property).

◆ SetNameHeaderResize()

void FCPartExtractPrefs::SetNameHeaderResize ( twobyte value )

inline

Sets the resize (in %) of the part header name. Used if GetCreateNameHeader() returns true.

Lua-supported (also as property).

◆ SetNameHeaderStartPage()

void FCPartExtractPrefs::SetNameHeaderStartPage ( twobyte value )

inline

Sets the part header name start page. Used if GetCreateNameHeader() returns true.

Lua-supported (also as property).

◆ SetNameHeaderUseFontName()

void FCPartExtractPrefs::SetNameHeaderUseFontName ( bool state )

inline

Sets true if the font name should be used. Used if GetCreateNameHeader() returns true.

Lua-supported (also as property).

◆ SetNameHeaderVertical()

void FCPartExtractPrefs::SetNameHeaderVertical ( Evpu16 position )

inline

Sets the vertical position of part name header. Used if GetCreateNameHeader() returns true.

Lua-supported (also as property).

◆ SetNewSystemDistanceBetween()

void FCPartExtractPrefs::SetNewSystemDistanceBetween ( Evpu16 value )

inline

If GetUseNewStaffPlacement() is true, returns distance between staff systems.

Lua-supported (also as property).

◆ SetNewTopStaff()

void FCPartExtractPrefs::SetNewTopStaff ( Evpu16 value )

inline

If GetUseNewStaffPlacement() is true, returns new top staff system position.

Lua-supported (also as property).

◆ SetOpenExtractedParts()

void FCPartExtractPrefs::SetOpenExtractedParts ( bool state )

inline

Sets if the extracted parts should automatically be opened.

Lua-supported (also as property).

◆ SetPromptForEachName()

void FCPartExtractPrefs::SetPromptForEachName ( bool state )

inline

Sets if the Finale user interface should prompt for each file name. If false, autogenerate file names.

Lua-supported (also as property).

◆ SetRemoveMultiPageBlocks()

void FCPartExtractPrefs::SetRemoveMultiPageBlocks ( bool state )

inline

Sets if multi-page text/graphics blocks should be removed.

Lua-supported (also as property).

◆ SetRemovePageOneBlocks()

void FCPartExtractPrefs::SetRemovePageOneBlocks ( bool state )

inline

Sets if page text/graphics on page 1 should be removed.

Lua-supported (also as property).

◆ SetRemovePageTwoPlusBlocks()

void FCPartExtractPrefs::SetRemovePageTwoPlusBlocks ( bool state )

inline

Sets if page text/graphics on page 2+ should be removed.

Lua-supported (also as property).

◆ SetRemoveStaffGroupNames()

void FCPartExtractPrefs::SetRemoveStaffGroupNames ( bool state )

inline

Sets if Staff or Group Names should be removed.

Lua-supported (also as property).

◆ SetSpaceSystemsEvenly()

void FCPartExtractPrefs::SetSpaceSystemsEvenly ( bool state )

inline

Sets if Apply Space Systems Evenly should be applied to the extracted parts.

Lua-supported (also as property).

◆ SetSpacingMethod()

void FCPartExtractPrefs::SetSpacingMethod ( int method )

inline

Sets the spacing method to use for extracted parts.

Lua-supported (also as property).

Parameters

method Any of the EXTRACT_SPACING_ constants.

◆ SetUseNewStaffPlacement()

void FCPartExtractPrefs::SetUseNewStaffPlacement ( bool state )

inline

If set, use new staff position placement.

This setting affects the GetNewTopStaff() and GetNewSystemDistanceBetween() values.

Lua-supported (also as property).

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ EXTRACT_SPACING

Member Function Documentation

◆ ClassName()

◆ GetClassID()

◆ GetCreateNameHeader()

◆ GetFitMeasuresPerSystem()

◆ GetFitMultimeasureRestAsOne()

◆ GetMeasuresPerSystem()

◆ GetNameHeaderEndPage()

◆ GetNameHeaderFontInfo()

◆ GetNameHeaderHorizontal()

◆ GetNameHeaderResize()

◆ GetNameHeaderStartPage()

◆ GetNameHeaderUseFontName()

◆ GetNameHeaderVertical()

◆ GetNewSystemDistanceBetween()

◆ GetNewTopStaff()

◆ GetOpenExtractedParts()

◆ GetPromptForEachName()

◆ GetRemoveMultiPageBlocks()

◆ GetRemovePageOneBlocks()

◆ GetRemovePageTwoPlusBlocks()

◆ GetRemoveStaffGroupNames()

◆ GetSpaceSystemsEvenly()

◆ GetSpacingMethod()

◆ GetUseNewStaffPlacement()

◆ SetCreateNameHeader()

◆ SetFitMeasuresPerSystem()

◆ SetFitMultimeasureRestAsOne()

◆ SetMeasuresPerSystem()

◆ SetNameHeaderDefaultFont()

◆ SetNameHeaderDefaultFontName()

◆ SetNameHeaderDefaultFontSize()

◆ SetNameHeaderEndPage()

◆ SetNameHeaderFontInfo()

◆ SetNameHeaderHorizontal()

◆ SetNameHeaderResize()

◆ SetNameHeaderStartPage()

◆ SetNameHeaderUseFontName()

◆ SetNameHeaderVertical()

◆ SetNewSystemDistanceBetween()

◆ SetNewTopStaff()

◆ SetOpenExtractedParts()

◆ SetPromptForEachName()

◆ SetRemoveMultiPageBlocks()

◆ SetRemovePageOneBlocks()

◆ SetRemovePageTwoPlusBlocks()

◆ SetRemoveStaffGroupNames()

◆ SetSpaceSystemsEvenly()

◆ SetSpacingMethod()

◆ SetUseNewStaffPlacement()