The preferences for the default tuplet definition. More...

#include <ff_prefs.h>

Inheritance diagram for FCTupletPrefs:

Public Member Functions
virtual const char *	ClassName ()
	Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child class. More...

virtual const PDKFRAMEWORK_CLASSID	GetClassID ()
	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. More...

virtual bool	Load (twobyte prefsnumber=1)
	Overloaded version of the Load() method. More...

virtual bool	Save ()
	Overloaded version of the Save() method. More...

bool	ChangeTuplet (FCTuplet *pTuplet, bool changeposition=true)
	Copies the default tuplet definition to a tuplet. More...

bool	CopyFromTuplet (FCTuplet *pTuplet, bool changeposition=true)
	Copies a tuplet to default tuplet definition. More...

FCTuplet::PLACEMENTMODE	GetPlacementMode () const
	Returns the placement mode. More...

bool	GetEngraverTuplet () const
	Returns the "Engraver Tuplet" state. More...

bool	GetAvoidStaff () const
	Returns the "Avoid Staff" state. More...

bool	GetAllowHorizontalDrag () const
	Returns the "Allow Horizontal Drag" state. More...

bool	GetUseBottomNote () const
	Returns the "Use Bottom Note" state. More...

FCTuplet::NUMBERSTYLE	GetNumberStyle () const
	Returns the number style. More...

FCTuplet::SHAPESTYLE	GetShapeStyle () const
	Returns the shape style. More...

bool	GetBreakSlurBracket () const
	Returns the "Break slur or bracket" state. More...

FCTuplet::BRACKETMODE	GetBracketMode () const
	Returns the bracket mode. More...

bool	GetAlwaysFlat () const
	Returns the "Always Flat" state. More...

bool	GetBracketFullDuration () const

twobyte	GetHorizontalOffset () const
	Returns the horizontal tuplet offset. More...

twobyte	GetVerticalOffset () const
	Returns the vertical tuplet offset. More...

bool	GetCenterUsingDuration () const
	Returns the "center number using duration" state. More...

bool	GetIgnoreNumberOffset () const
	Returns the "Ignore Horizontal Number Offset" state. More...

twobyte	GetHorizontalShapeOffset () const
	Returns the horizontal shape offset. More...

twobyte	GetVerticalShapeOffset () const
	Returns the vertical shape offset. More...

bool	GetMatchHookLengths () const
	Returns the "match length of hooks" state. More...

twobyte	GetLeftHookLength () const
	Returns the left-side hook length. More...

twobyte	GetLeftExtension () const
	Returns the "left extension" value. More...

twobyte	GetRightHookLength () const
	returns the right-side hook length. More...

twobyte	GetRightExtension () const
	Returns the "Right extension" value. More...

twobyte	GetSlopeAdjust () const
	Returns the "Manual Slope Adjustment" value. More...

twobyte	GetNumberOffsetUpstem () const
	Returns the Horizontal Number Offset/Upstem side of notes. More...

twobyte	GetNumberOffsetDownstem () const
	Returns the Horizontal Number Offset/Downstem side of notes. More...

Efix16	GetBracketThickness () const
	Return the bracket thickness, in EFIXes. More...

twobyte	GetMaxSlope () const
	Returns the maximum slope, in 10ths of a percent. More...

void	SetPlacementMode (FCTuplet::PLACEMENTMODE value)
	Sets the placement mode. More...

void	SetEngraverTuplet (bool value)
	Sets the engraver tuplet state. More...

void	SetAvoidStaff (bool value)
	Sets the "Avoid Staff" state. More...

void	SetAllowHorizontalDrag (bool value)
	Sets the "Allow Horizontal Drag" state. More...

void	SetUseBottomNote (bool value)
	Sets the "Use Bottom Note" state. More...

void	SetNumberStyle (FCTuplet::NUMBERSTYLE value)
	Sets the number style. More...

void	SetShapeStyle (FCTuplet::SHAPESTYLE value)
	Sets the shape style. More...

void	SetBreakSlurBracket (bool value)
	Sets the "Break slur or bracket" state. More...

void	SetBracketMode (FCTuplet::BRACKETMODE value)
	Sets the bracket mode. More...

void	SetAlwaysFlat (bool value)
	Sets the "Always Flat" state. More...

void	SetBracketFullDuration (bool value)
	Sets the "Bracket Full Duration" state. More...

void	SetHorizontalOffset (twobyte value)
	Sets the horizontal tuplet offset. More...

void	SetVerticalOffset (twobyte value)
	Sets the vertical tuplet offset. More...

void	SetCenterUsingDuration (bool value)
	Sets the "Center number using duration" state. More...

void	SetIgnoreNumberOffset (bool value)
	Sets the "Ignore Horizontal Number Offset". More...

void	SetHorizontalShapeOffset (twobyte value)
	Sets the horizontal shape offset. More...

void	SetVerticalShapeOffset (twobyte value)
	Sets the vertical shape offset. More...

void	SetMatchHookLengths (bool value)
	Sets the "Match lengths of hooks" state. More...

void	SetLeftHookLength (twobyte value)
	Sets the left-side hook length. More...

void	SetLeftExtension (twobyte value)
	Sets the "Left Extension" value. More...

void	SetRightHookLength (twobyte value)
	Sets the right-side hook length. More...

void	SetRightExtension (twobyte value)
	Sets the "Right Extension" value. More...

void	SetSlopeAdjust (twobyte value)
	Sets the "Manual Slope Adjustment" value. More...

void	SetNumberOffsetUpstem (twobyte value)
	Sets the Horizontal Number Offset/Upstem side of notes. More...

void	SetNumberOffsetDownstem (twobyte value)
	Sets the Horizontal Number Offset/Downstem side of notes. More...

void	SetBracketThickness (Efix16 value)
	Return the bracket thickness, in EFIXes. More...

void	SetMaxSlope (twobyte value)
	Returns the maximum slope, in 10ths of a percent. More...

virtual void	DebugDump ()
	Outputs the class data/information for debugging purposes. More...

Public Member Functions inherited from __FCPrefsBase
virtual bool	Reload ()
	Overridden version of Reload(), that handles prefs from multiple sources.

virtual bool	LoadFirst ()
	Loads the very first element in the database, if any. More...

int	GetItemNo () const
	Returns the prefs number for the loaded data. More...

Public Member Functions inherited from __FCBaseData
EDOCID	GetConnectedDocID () const
	Returns the document ID that was connected to the last load/save of the data. More...

bool	VerifyConnectedDocID ()
	Checks that the stored document ID for the data object matches the current document's ID. More...

virtual EVERSION	EnigmaVersion ()
	The Enigma version for save/load/create/delete operations. More...

virtual int	DataSizeSave ()
	Returns the data size for the data structure that should be saved or created. More...

void	_CloneFrom (__FCBaseData *pSource)
	For internal use only. Copies object data (except data block) from another object. More...

const EDataID *	_GetDataID ()
	Intended ONLY for the _CloneFrom implementation. More...

int	_GetLoadedSize () const
	Intended ONLY for the _CloneFrom implementation. More...

const void *	GetDataBlock ()
	Intended ONLY for the _CloneFrom implementation. More...

EXTAG	GetCustomTag ()
	Returns the custom Enigma tag, if any. More...

void	SetCustomTag (EXTAG tag)
	Sets the custom Enigma tag, for classes that support multiple Enigma tags. More...

	__FCBaseData ()
	The constructor.

virtual	~__FCBaseData ()
	Virtual destructor.

virtual bool	DeleteData ()
	Deletes the associated data from Finale's database. Be careful when deleting multiple objects. More...

virtual bool	DeepDeleteData ()
	Deletes data and all data that's connected to the object. More...

virtual bool	LoadLast ()
	Loads the very last element in the database, if any. More...

virtual bool	LoadNext ()
	Loads the next element from the database, if any. More...

virtual bool	LoadPrevious ()
	Loads the previous element in the database, if any. More...

__FCBaseData *	CreateClone ()
	Creates an identical copy of an object. More...

virtual void	DebugDataDump ()
	Outputs a memory dump of the data block in the object for debugging purposes. More...

virtual void	DebugDataByteArrayDump ()
	Outputs a memory dump of the data block in the object for debugging purposes, as a C++ byte array. More...

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. More...

Public Member Functions inherited from __FCBase
	__FCBase ()
	The constructor.

virtual	~__FCBase ()
	Virtual destructor, so all inherited classes get the virtual destructor. More...

void	DebugMsgDigit (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. More...

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. More...

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. More...

void	DebugMsg (const char *pszMsg)
	Creates a simple Message Box for debug purposes with just one text string. More...

void	DebugOutMenuInfo (FCUI *pUI, int menuixd_horiz, int menuixd_vert) const
	Outputs the menu command info for debugging purposes. More...

int	DebugOutFormat (const char *fmt,...)
	Outputs debug text using C style "printf" syntax. More...

void	Set16BitFlag (FLAG_16 *flag, FLAG_16 flagbits, bool state)
	Sets a 16 bit flag in the data block. More...

void	Set32BitFlag (FLAG_32 *flag, FLAG_32 flagbits, bool state)
	Sets a 32 bit flag in the data block. More...

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. More...

void	SetUserData (void *pData)
	Sets the user data attached to the instance of an object. More...

void	SetUserData2 (void *pData)
	Sets the additional user data attached to the instance of an object. More...

void *	GetUserData () const
	Gets the user data attached to the instance of an object. More...

void *	GetUserData2 () const
	Gets the additional user data attached to the instance of an object. More...

virtual bool	IsIdentical (__FCBase *pCompareObject)
	Returns true if the data in the passed object is considered to be identical to the current object, otherwise false. More...

void	StoreXML_String (tinyxml2::XMLElement pParentNode, const char pszElementName, FCString *pStringValue)
	Helper function to store FCString objects in the XML file. More...

void	StoreXML_Integer (tinyxml2::XMLElement pParentNode, const char pszElementName, int value)
	Helper function to store integer objects in the XML file. More...

void	StoreXML_Bool (tinyxml2::XMLElement pParentNode, const char pszElementName, bool value)
	Helper function to store boolean objects in the XML file. More...

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. More...

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. More...

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. More...

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. More...

virtual void	StoreToXML (tinyxml2::XMLElement *pParentNode)
	Virtual method that is used to store an object's data. More...

bool	ReadXML_String (tinyxml2::XMLElement pParentNode, const char pszElementName, FCString *pStringValue)
	Helper method to read FCString objects from the XML file. More...

bool	ReadXML_Integer (tinyxml2::XMLElement pParentNode, const char pszElementName, int *pValue)
	Helper method to read integer objects from the XML file. More...

bool	ReadXML_Bool (tinyxml2::XMLElement pParentNode, const char pszElementName, bool *pValue)
	Helper method to read boolean objects from the XML file. More...

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. More...

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. More...

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. More...

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. More...

virtual bool	ReadFromXML (tinyxml2::XMLElement *pParentNode)
	Virtual method that is used to read object data. More...

Additional Inherited Members
Public Types inherited from __FCBase
enum	PDKFRAMEWORK_CLASSID { FCID_UNKNOWN = 0, FCID_ACCIDENTALMOD, FCID_ALLOTMENT, FCID_ARTICULATION, FCID_ARTICULATIONDEF, FCID_BACKWARDREPEAT, FCID_BASELINE, FCID_BEAMMOD, FCID_BEATCHARTELEMENT, 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_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_KEYSIGNATURE, FCID_LAYERPREFS, 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_PERCUSSIONNOTEMOD, FCID_PIANOBRACEPREFS, FCID_PLAYBACKPREFS, FCID_RAWTEXT, FCID_REPEATPREFS, FCID_SECONDARYBEAMBREAKMOD, 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...

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. More...

static void	DebugOutDigit (const char *pszPrefixText, int i)
	Static method that outputs a line for debugging purposes. The text appears with the extra digit (in decimal presentation) appearing afterwards. More...

static void	DebugOutFloat (const char *pszPrefixText, float f)
	Static method that outputs a line for debugging purposes. The text appears with the extra float value appearing afterwards. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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". More...

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. More...

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. More...

static void	DebugOut (const char *pszLine)
	Static method to output a line of text for debugging purposes. More...

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! More...

bool	DataIsLoaded () const
	Returns true is any data has been loaded into the object. More...

void	_TagDocumentID ()
	For internal use only. More...

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. More...

EDataID	_dataid
	The EdataID for the last loaded/saved object.

Detailed Description

The preferences for the default tuplet definition.

Please note that quite a few of these preferences does not work on versions lower than Finale 2012.

This struct requires both PDK_FRAMEWORK_PREFS and PDK_FRAMEWORK_ENTRIES to be defined.

Member Function Documentation

bool FCTupletPrefs::ChangeTuplet	(	FCTuplet *	pTuplet,
		bool	changeposition = `true`
	)

Copies the default tuplet definition to a tuplet.

Lua-supported.

Parameters

[out]	pTuplet	Pointer to the destination tuplet object.
	changeposition	If set, change the tuplet position data as well.

virtual const char* FCTupletPrefs::ClassName ( )

inlinevirtual

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

Lua-supported.

Reimplemented from __FCBaseData.

bool FCTupletPrefs::CopyFromTuplet	(	FCTuplet *	pTuplet,
		bool	changeposition = `true`
	)

Copies a tuplet to default tuplet definition.

Lua-supported.

Parameters

[in]	pTuplet	Pointer to the source tuplet object.
[in]	changeposition	If set, change the tuplet position data as well.

virtual void FCTupletPrefs::DebugDump ( )

inlinevirtual

Outputs the class data/information for debugging purposes.

Accessible if PDK_FRAMEWORK_DEBUG is defined.

When child class inherit this method to output the contents of its own members, it should call the parent before providing its own output.

Reimplemented from __FCBaseData.

bool FCTupletPrefs::GetAllowHorizontalDrag ( ) const

inline

Returns the "Allow Horizontal Drag" state.

Lua-supported (also as property).

bool FCTupletPrefs::GetAlwaysFlat ( ) const

inline

Returns the "Always Flat" state.

Lua-supported (also as property).

bool FCTupletPrefs::GetAvoidStaff ( ) const

inline

Returns the "Avoid Staff" state.

Lua-supported (also as property).

bool FCTupletPrefs::GetBracketFullDuration ( ) const

inline

Returns the "Bracket Full Duration" state.

Lua-supported (also as property).

FCTuplet::BRACKETMODE FCTupletPrefs::GetBracketMode ( ) const

Returns the bracket mode.

Lua-supported (also as property).

Returns: Any of the TUPLETBRACKET_ constants.

Efix16 FCTupletPrefs::GetBracketThickness ( ) const

inline

Return the bracket thickness, in EFIXes.

Lua-supported (also as property).

bool FCTupletPrefs::GetBreakSlurBracket ( ) const

inline

Returns the "Break slur or bracket" state.

Lua-supported (also as property).

bool FCTupletPrefs::GetCenterUsingDuration ( ) const

inline

Returns the "center number using duration" state.

Lua-supported (also as property).

virtual const PDKFRAMEWORK_CLASSID FCTupletPrefs::GetClassID ( )

inlinevirtual

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.

Implements __FCBaseData.

bool FCTupletPrefs::GetEngraverTuplet ( ) const

inline

Returns the "Engraver Tuplet" state.

Lua-supported (also as property).

twobyte FCTupletPrefs::GetHorizontalOffset ( ) const

inline

Returns the horizontal tuplet offset.

Lua-supported (also as property).

twobyte FCTupletPrefs::GetHorizontalShapeOffset ( ) const

inline

Returns the horizontal shape offset.

Lua-supported (also as property).

bool FCTupletPrefs::GetIgnoreNumberOffset ( ) const

inline

Returns the "Ignore Horizontal Number Offset" state.

Lua-supported (also as property).

twobyte FCTupletPrefs::GetLeftExtension ( ) const

inline

Returns the "left extension" value.

Lua-supported.

twobyte FCTupletPrefs::GetLeftHookLength ( ) const

inline

Returns the left-side hook length.

Lua-supported (also as property).

bool FCTupletPrefs::GetMatchHookLengths ( ) const

inline

Returns the "match length of hooks" state.

Lua-supported (also as property).

twobyte FCTupletPrefs::GetMaxSlope ( ) const

inline

Returns the maximum slope, in 10ths of a percent.

Lua-supported (also as property).

Returns: The maximum slope, in 10ths of a percent.

twobyte FCTupletPrefs::GetNumberOffsetDownstem ( ) const

inline

Returns the Horizontal Number Offset/Downstem side of notes.

Lua-supported (also as property).

twobyte FCTupletPrefs::GetNumberOffsetUpstem ( ) const

inline

Returns the Horizontal Number Offset/Upstem side of notes.

Lua-supported (also as property).

FCTuplet::NUMBERSTYLE FCTupletPrefs::GetNumberStyle ( ) const

Returns the number style.

Lua-supported (also as property).

Returns: Any of the TUPLETNUMBER_ constants.

FCTuplet::PLACEMENTMODE FCTupletPrefs::GetPlacementMode ( ) const

Returns the placement mode.

Lua-supported (also as property).

Returns: Any of the TUPLETPLACEMENT_ constants.

twobyte FCTupletPrefs::GetRightExtension ( ) const

inline

Returns the "Right extension" value.

Lua-supported (also as property).

twobyte FCTupletPrefs::GetRightHookLength ( ) const

inline

returns the right-side hook length.

Lua-supported (also as property).

FCTuplet::SHAPESTYLE FCTupletPrefs::GetShapeStyle ( ) const

Returns the shape style.

Lua-supported (also as property).

Returns: Any of the TUPLETSHAPE_ constants.

twobyte FCTupletPrefs::GetSlopeAdjust ( ) const

inline

Returns the "Manual Slope Adjustment" value.

Lua-supported (also as property).

bool FCTupletPrefs::GetUseBottomNote ( ) const

inline

Returns the "Use Bottom Note" state.

Lua-supported (also as property).

twobyte FCTupletPrefs::GetVerticalOffset ( ) const

inline

Returns the vertical tuplet offset.

Lua-supported (also as property).

twobyte FCTupletPrefs::GetVerticalShapeOffset ( ) const

inline

Returns the vertical shape offset.

Lua-supported (also as property).

bool FCTupletPrefs::Load ( twobyte prefsnumber = 1 )

virtual

Overloaded version of the Load() method.

This method loads some data that aren't directly supported by the Finale PDK interface.

Lua-supported.

Parameters

prefsnumber Although this parameter isn't use, set it to 1.

Reimplemented from __FCPrefsBase.

bool FCTupletPrefs::Save ( )

virtual

Overloaded version of the Save() method.

Saves some data that aren't directly supported by the Finale PDK interface.

Lua-supported.

Reimplemented from __FCPrefsBase.

void FCTupletPrefs::SetAllowHorizontalDrag ( bool value )

inline

Sets the "Allow Horizontal Drag" state.

Lua-supported (also as property).

void FCTupletPrefs::SetAlwaysFlat ( bool value )

Sets the "Always Flat" state.

Does not work on Finale 2011 and below.

Lua-supported (also as property).

void FCTupletPrefs::SetAvoidStaff ( bool value )

Sets the "Avoid Staff" state.

Does not work on Finale 2011 and below.

Lua-supported (also as property).

void FCTupletPrefs::SetBracketFullDuration ( bool value )

Sets the "Bracket Full Duration" state.

Does not work on Finale 2011 and below.

Lua-supported (also as property).

void FCTupletPrefs::SetBracketMode ( FCTuplet::BRACKETMODE value )

Sets the bracket mode.

Does not work on Finale 2011 and below.

Lua-supported (also as property).

Parameters

value Any of the TUPLETBRACKET_ constants.

void FCTupletPrefs::SetBracketThickness ( Efix16 value )

inline

Return the bracket thickness, in EFIXes.

Lua-supported (also as property).

void FCTupletPrefs::SetBreakSlurBracket ( bool value )

inline

Sets the "Break slur or bracket" state.

Lua-supported (also as property).

void FCTupletPrefs::SetCenterUsingDuration ( bool value )

Sets the "Center number using duration" state.

Does not work on Finale 2011 and below.

Lua-supported (also as property).

void FCTupletPrefs::SetEngraverTuplet ( bool value )

inline

Sets the engraver tuplet state.

Lua-supported (also as property).

void FCTupletPrefs::SetHorizontalOffset ( twobyte value )

inline

Sets the horizontal tuplet offset.

Lua-supported (also as property).

void FCTupletPrefs::SetHorizontalShapeOffset ( twobyte value )

inline

Sets the horizontal shape offset.

Lua-supported (also as property).

void FCTupletPrefs::SetIgnoreNumberOffset ( bool value )

inline

Sets the "Ignore Horizontal Number Offset".

Lua-supported (also as property).

void FCTupletPrefs::SetLeftExtension ( twobyte value )

inline

Sets the "Left Extension" value.

Lua-supported (also as property).

void FCTupletPrefs::SetLeftHookLength ( twobyte value )

inline

Sets the left-side hook length.

Lua-supported (also as property).

void FCTupletPrefs::SetMatchHookLengths ( bool value )

inline

Sets the "Match lengths of hooks" state.

Lua-supported (also as property).

void FCTupletPrefs::SetMaxSlope ( twobyte value )

inline

Returns the maximum slope, in 10ths of a percent.

Lua-supported (also as property).

void FCTupletPrefs::SetNumberOffsetDownstem ( twobyte value )

inline

Sets the Horizontal Number Offset/Downstem side of notes.

Lua-supported (also as property).

void FCTupletPrefs::SetNumberOffsetUpstem ( twobyte value )

inline

Sets the Horizontal Number Offset/Upstem side of notes.

Lua-supported (also as property).

void FCTupletPrefs::SetNumberStyle ( FCTuplet::NUMBERSTYLE value )

Sets the number style.

Lua-supported (also as property).

Parameters

value Any of the TUPLETNUMBER_ constants.

void FCTupletPrefs::SetPlacementMode ( FCTuplet::PLACEMENTMODE value )

Sets the placement mode.

Lua-supported (also as property).

Parameters

value Any of the TUPLETPLACEMENT_ constants.

void FCTupletPrefs::SetRightExtension ( twobyte value )

inline

Sets the "Right Extension" value.

Lua-supported (also as property).

void FCTupletPrefs::SetRightHookLength ( twobyte value )

inline

Sets the right-side hook length.

Lua-supported (also as property).

void FCTupletPrefs::SetShapeStyle ( FCTuplet::SHAPESTYLE value )

Sets the shape style.

Lua-supported (also as property).

Parameters

value Any of the TUPLETSHAPE_ constants.

void FCTupletPrefs::SetSlopeAdjust ( twobyte value )

inline

Sets the "Manual Slope Adjustment" value.

Lua-supported (also as property).

void FCTupletPrefs::SetUseBottomNote ( bool value )

inline

Sets the "Use Bottom Note" state.

Lua-supported (also as property).

void FCTupletPrefs::SetVerticalOffset ( twobyte value )

inline

Sets the vertical tuplet offset.

Lua-supported (also as property).

void FCTupletPrefs::SetVerticalShapeOffset ( twobyte value )

inline

Sets the vertical shape offset.

Lua-supported (also as property).

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation