FCTuplet Class Reference

Class for attaching an tuplet to an entry. More...

#include <ff_entrydetails.h>

Inheritance diagram for FCTuplet:

Public Types
enum	PLACEMENTMODE {   TUPLETPLACEMENT_MANUAL = 0 , TUPLETPLACEMENT_STEMSIDE , TUPLETPLACEMENT_NOTESIDE , TUPLETPLACEMENT_ABOVE ,   TUPLETPLACEMENT_BELOW }
	The settings for where the tuplet should be placed compared to the note entry. More...
enum	NUMBERSTYLE {   TUPLETNUMBER_NONE = 0 , TUPLETNUMBER_REGULAR , TUPLETNUMBER_RATIO , TUPLETNUMBER_RATIOANDNOTE ,   TUPLETNUMBER_RATIOANDNOTE_BOTH }
	The settings for the number style that should be used by the tuplet. More...
enum	SHAPESTYLE { TUPLETSHAPE_NONE = 0 , TUPLETSHAPE_BRACKET , TUPLETSHAPE_SLUR }
	The setting for which bracket shape the tuplet should use. More...
enum	BRACKETMODE { TUPLETBRACKET_ALWAYS = 0 , TUPLETBRACKET_UNBEAMEDONLY , TUPLETBRACKET_NEVERBEAMEDONBEAMSIDE }
	The settings for when the bracket shape should show. 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
EXTAG	Tag () const override
	The Enigma tag for the derived class.
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.
	FCTuplet ()
	The constructor.
TimeEdu32	CalcFullReferenceDuration ()
	Calculates the full reference duration of a tuplet, in EDUs.
TimeEdu32	CalcFullSymbolicDuration ()
	Calculates the symbolic duration of a tuplet, in edus.
void	PrefsReset (bool resetposition)
	Resets the tuplet settings to the current preference defaults.
twobyte	GetSymbolicDuration () const
	Returns the symbolic duration value (in EDUs).
twobyte	GetSymbolicNumber () const
	Returns the symbolic number of the tuplet.
twobyte	GetReferenceDuration () const
	Returns the reference duration value (in EDUs).
twobyte	GetReferenceNumber () const
	Returns the reference number value.
PLACEMENTMODE	GetPlacementMode () const
	Gets the settings for where the tuplet should be placed compared to the note entry.
bool	GetEngraverTuplet () const
	Returns the "engraver tuplet" setting for the tuplet.
bool	GetAvoidStaff () const
	Returns the "Avoid Staff" setting for the tuplet.
bool	GetAllowHorizontalDrag () const
	Returns the "Allow Horizontal Drag" setting for the tuplet.
bool	GetUseBottomNote () const
	Returns the "Use Bottom Note" setting for the tuplet.
NUMBERSTYLE	GetNumberStyle () const
	Returns the settings for the number style that should be used by the tuplet.
SHAPESTYLE	GetShapeStyle () const
	Returns the setting for which bracket shape the tuplet should use.
bool	GetBreakSlurBracket () const
	Returns the setting for if the slur/bracket should be broken around the number.
BRACKETMODE	GetBracketMode () const
	Returns the settings for when the bracket/slur shape should show.
bool	GetAlwaysFlat () const
	Returns the "Always Flat" setting.
bool	GetBracketFullDuration () const
	Returns the "Bracket Full Duration" setting.
twobyte	GetHorizontalOffset () const
	Returns the horizontal tuplet offset in EVPUs.
twobyte	GetVerticalOffset () const
	Returns the vertical tuplet offset in EVPUs.
bool	GetCenterUsingDuration () const
	Returns the "Center Using Duration" setting.
bool	GetIgnoreNumberOffset () const
	Returns the "Ignore Number Offset" setting.
twobyte	GetHorizontalShapeOffset () const
	Returns the horizontal bracket offset in EVPUs.
twobyte	GetVerticalShapeOffset () const
	Returns the vertical bracket offset in EVPUs.
bool	GetMatchHookLengths () const
	Returns the "Match Hook Lengths" setting.
twobyte	GetLeftHookLength () const
	Returns the left-side hook length of the bracket/slur shape in EVPUs.
twobyte	GetLeftExtension () const
	Returns the left-side extension adjusment of the bracket/slur shape in EVPUs.
twobyte	GetRightHookLength () const
	Returns the right-side hook length of the bracket/slur shape in EVPUs.
twobyte	GetRightExtension () const
	Returns the right-side extension adjusment of the bracket/slur shape in EVPUs.
twobyte	GetSlopeAdjust () const
	Returns the "Manual Slope Adjustment" value.
bool	GetVisible () const
	Returns the visibility setting for the tuplet.
void	SetSymbolicNumber (twobyte value)
	Sets the symbolic number of the tuplet.
void	SetSymbolicDuration (twobyte value)
	Sets the symbolic duration value (in EDUs).
void	SetReferenceNumber (twobyte value)
	Sets the reference number value.
void	SetReferenceDuration (twobyte value)
	Sets the reference duration value (in EDUs).
void	SetPlacementMode (PLACEMENTMODE value)
	Sets where the tuplet should be placed compared to the note entry.
void	SetEngraverTuplet (bool value)
	Sets the "engraver tuplet" setting for the tuplet.
void	SetAvoidStaff (bool value)
	Sets the "Avoid Staff" setting for the tuplet.
void	SetAllowHorizontalDrag (bool value)
	Sets the "Allow Horizontal Drag" setting for the tuplet.
void	SetUseBottomNote (bool value)
	Sets the "Use Bottom Note" setting for the tuplet.
void	SetNumberStyle (NUMBERSTYLE value)
	Sets the setting for the number style that should be used by the tuplet.
void	SetShapeStyle (SHAPESTYLE value)
	Sets the setting for which bracket shape the tuplet should use.
void	SetBreakSlurBracket (bool value)
void	SetBracketMode (BRACKETMODE value)
	Sets when the slur/bracket shape should show.
void	SetAlwaysFlat (bool value)
	Sets the "Always Flat" setting.
void	SetBracketFullDuration (bool value)
	Sets the "Bracket Full Duration" setting.
void	SetHorizontalOffset (twobyte value)
	Sets the horizontal tuplet offset in EVPUs.
void	SetVerticalOffset (twobyte value)
	Sets the vertical tuplet offset in EVPUs.
void	SetCenterUsingDuration (bool value)
	Sets the "Center Using Duration" setting.
void	SetIgnoreNumberOffset (bool value)
	Sets the "Ignore Number Offset" setting.
void	SetHorizontalShapeOffset (twobyte value)
	Sets the horizontal shape offset value (in EVPUs).
void	SetVerticalShapeOffset (twobyte value)
	Sets the vertical shape offset value (in EVPUs).
void	SetMatchHookLengths (bool value)
	Sets the "Match Hook Lengths" setting.
void	SetLeftHookLength (twobyte value)
	Sets the left hook length of the bracket/slur shape in EVPUs.
void	SetLeftExtension (twobyte value)
	Sets the left extension of the bracket/slur shape in EVPUs, compared to the left default position.
void	SetRightHookLength (twobyte value)
	Sets the right hook length of the bracket/slur shape in EVPUs.
void	SetRightExtension (twobyte value)
	Sets the right extension of the bracket/slur shape in EVPUs, compared to the right-side default position.
void	SetSlopeAdjust (twobyte value)
	Sets the "Manual Slope Adjustment" value.
void	SetVisible (bool value)
	Sets the visibility state of the tuplet.
void	DebugDump () override
	Outputs the class data/information for debugging purposes.
Public Member Functions inherited from __FCEntryDetail
	__FCEntryDetail ()
	The constructor.
void	SetEntnumAndInci (ENTNUM entnum, twobyte inci)
	Sets the entry number reference and inci for the object.
virtual bool	Load (ENTNUM entnum, twobyte inci)
	Loads the data at the given entry number and inci.
bool	Reload () override
	Overridden Reload() method, that supports complex (mixed) data.
bool	SaveAs (ENTNUM entnum, twobyte inci)
	Saves the data at the given entry number and inci.
bool	LoadFirst () override
	Overloaded version of LoadFirst that will load the first inci for the entry. SetNoteEntry must be called first.
bool	LoadNext () override
	Overloaded version of LoadNext.
virtual void	SetNoteEntry (FCNoteEntry *pEntry)
	Maps the data to an entry.
FCNoteEntry *	GetNoteEntry ()
	Returns a pointer to the mapped note entry.
twobyte	GetItemInci () const
	Returns the inci number for the stored object.
ENTNUM	GetItemEntryNumber () const
	Returns the note entry number for the stored object.
virtual bool	SaveNew ()
	Saves a new inci and sets the correct flag in the associated note entry.
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	DataSizeLoad () const =0
	Returns the data size for the data structure that should be loaded.
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.
virtual void	CloneMemoryFrom (__FCBaseData *pSource)
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	Save ()
	Saves the currently loaded to its current location.
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	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	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 __FCBaseData
virtual void *	Allocate ()=0
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!
virtual __FCBaseData *	CreateObject ()=0
	Creates a new instance of the object.
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

Class for attaching an tuplet to an entry.

This class requires PDK_FRAMEWORK_ENTRIES to be defined.

Member Enumeration Documentation

BRACKETMODE

enum FCTuplet::BRACKETMODE

The settings for when the bracket shape should show.

Lua-supported.

NUMBERSTYLE

enum FCTuplet::NUMBERSTYLE

The settings for the number style that should be used by the tuplet.

Lua-supported.

PLACEMENTMODE

enum FCTuplet::PLACEMENTMODE

The settings for where the tuplet should be placed compared to the note entry.

Lua-supported.

SHAPESTYLE

enum FCTuplet::SHAPESTYLE

The setting for which bracket shape the tuplet should use.

Lua-supported.

Constructor & Destructor Documentation

FCTuplet()

FCTuplet::FCTuplet ( )

inline

The constructor.

Lua-supported.

Member Function Documentation

CalcFullReferenceDuration()

TimeEdu32 FCTuplet::CalcFullReferenceDuration ( )

inline

Calculates the full reference duration of a tuplet, in EDUs.

Example: If a tuplet should span the space of 1 quarter note, the return value becomes 1024.

Lua-supported.

CalcFullSymbolicDuration()

TimeEdu32 FCTuplet::CalcFullSymbolicDuration ( )

inline

Calculates the symbolic duration of a tuplet, in edus.

Example: If a tuplet should be displayed as 3 eighth notes, the return value is 1536.

Lua-supported.

ClassName()

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

DebugDump()

void FCTuplet::DebugDump ( )

inlineoverridevirtual

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

GetAllowHorizontalDrag()

bool FCTuplet::GetAllowHorizontalDrag ( ) const

inline

Returns the "Allow Horizontal Drag" setting for the tuplet.

Lua-supported (also as property).

GetAlwaysFlat()

bool FCTuplet::GetAlwaysFlat ( ) const

inline

Returns the "Always Flat" setting.

Lua-supported (also as property).

GetAvoidStaff()

bool FCTuplet::GetAvoidStaff ( ) const

inline

Returns the "Avoid Staff" setting for the tuplet.

Lua-supported (also as property).

GetBracketFullDuration()

bool FCTuplet::GetBracketFullDuration ( ) const

inline

Returns the "Bracket Full Duration" setting.

Lua-supported (also as property).

GetBracketMode()

FCTuplet::BRACKETMODE FCTuplet::GetBracketMode

(

)

const

Returns the settings for when the bracket/slur shape should show.

Lua-supported (also as property).

Returns

Any of these constants: TUPLETBRACKET_ALWAYS, TUPLETBRACKET_UNBEAMEDONLY, TUPLETBRACKET_NEVERBEAMEDONBEAMSIDE

GetBreakSlurBracket()

bool FCTuplet::GetBreakSlurBracket ( ) const

inline

Returns the setting for if the slur/bracket should be broken around the number.

Lua-supported (also as property).

GetCenterUsingDuration()

bool FCTuplet::GetCenterUsingDuration ( ) const

inline

Returns the "Center Using Duration" setting.

Lua-supported (also as property).

GetClassID()

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

GetEngraverTuplet()

bool FCTuplet::GetEngraverTuplet ( ) const

inline

Returns the "engraver tuplet" setting for the tuplet.

Lua-supported (also as property).

GetHorizontalOffset()

twobyte FCTuplet::GetHorizontalOffset ( ) const

inline

Returns the horizontal tuplet offset in EVPUs.

Lua-supported (also as property).

GetHorizontalShapeOffset()

twobyte FCTuplet::GetHorizontalShapeOffset ( ) const

inline

Returns the horizontal bracket offset in EVPUs.

Lua-supported (also as property).

GetIgnoreNumberOffset()

bool FCTuplet::GetIgnoreNumberOffset ( ) const

inline

Returns the "Ignore Number Offset" setting.

Lua-supported (also as property).

GetLeftExtension()

twobyte FCTuplet::GetLeftExtension ( ) const

inline

Returns the left-side extension adjusment of the bracket/slur shape in EVPUs.

Positive value means to move the left-side edge to the right.

Lua-supported (also as property).

GetLeftHookLength()

twobyte FCTuplet::GetLeftHookLength ( ) const

inline

Returns the left-side hook length of the bracket/slur shape in EVPUs.

Lua-supported (also as property).

GetMatchHookLengths()

bool FCTuplet::GetMatchHookLengths ( ) const

inline

Returns the "Match Hook Lengths" setting.

Lua-supported (also as property).

GetNumberStyle()

FCTuplet::NUMBERSTYLE FCTuplet::GetNumberStyle

(

)

const

Returns the settings for the number style that should be used by the tuplet.

Lua-supported (also as property).

Returns

Any of these constants: TUPLETNUMBER_NONE, TUPLETNUMBER_REGULAR, TUPLETNUMBER_RATIO, TUPLETNUMBER_RATIOANDNOTE, TUPLETNUMBER_RATIOANDNOTE_BOTH

GetPlacementMode()

FCTuplet::PLACEMENTMODE FCTuplet::GetPlacementMode

(

)

const

Gets the settings for where the tuplet should be placed compared to the note entry.

Can be any of these constants: TUPLETPLACEMENT_MANUAL, TUPLETPLACEMENT_STEMSIDE, TUPLETPLACEMENT_NOTESIDE, TUPLETPLACEMENT_ABOVE, TUPLETPLACEMENT_BELOW

Lua-supported (also as property).

GetReferenceDuration()

twobyte FCTuplet::GetReferenceDuration ( ) const

inline

Returns the reference duration value (in EDUs).

Lua-supported (also as property).

GetReferenceNumber()

twobyte FCTuplet::GetReferenceNumber ( ) const

inline

Returns the reference number value.

Lua-supported (also as property).

GetRightExtension()

twobyte FCTuplet::GetRightExtension ( ) const

inline

Returns the right-side extension adjusment of the bracket/slur shape in EVPUs.

Positive value means to move right-side end to the right.

Lua-supported (also as property).

GetRightHookLength()

twobyte FCTuplet::GetRightHookLength ( ) const

inline

Returns the right-side hook length of the bracket/slur shape in EVPUs.

This is only used if GetMatchHookLengths returns false.

Lua-supported (also as property).

GetShapeStyle()

FCTuplet::SHAPESTYLE FCTuplet::GetShapeStyle

(

)

const

Returns the setting for which bracket shape the tuplet should use.

Lua-supported (also as property).

Returns

Any of these constants: TUPLETSHAPE_NONE, TUPLETSHAPE_BRACKET, TUPLETSHAPE_SLUR

GetSlopeAdjust()

twobyte FCTuplet::GetSlopeAdjust ( ) const

inline

Returns the "Manual Slope Adjustment" value.

Lua-supported (also as property).

GetSymbolicDuration()

twobyte FCTuplet::GetSymbolicDuration ( ) const

inline

Returns the symbolic duration value (in EDUs).

Lua-supported (also as property).

GetSymbolicNumber()

twobyte FCTuplet::GetSymbolicNumber ( ) const

inline

Returns the symbolic number of the tuplet.

The symbolic number is the number that's "printed" in the tuplet.

Lua-supported (also as property).

GetUseBottomNote()

bool FCTuplet::GetUseBottomNote ( ) const

inline

Returns the "Use Bottom Note" setting for the tuplet.

Lua-supported (also as property).

GetVerticalOffset()

twobyte FCTuplet::GetVerticalOffset ( ) const

inline

Returns the vertical tuplet offset in EVPUs.

Lua-supported (also as property).

GetVerticalShapeOffset()

twobyte FCTuplet::GetVerticalShapeOffset ( ) const

inline

Returns the vertical bracket offset in EVPUs.

Lua-supported (also as property).

GetVisible()

bool FCTuplet::GetVisible ( ) const

inline

Returns the visibility setting for the tuplet.

Lua-supported (also as property).

PrefsReset()

void FCTuplet::PrefsReset

(

bool

resetposition

)

Resets the tuplet settings to the current preference defaults.

This method requires PDK_FRAMEWORK_PREFS to be defined.

Lua-supported.

Parameters

resetposition

True if the tuplet position should be reset to the defaults as well.

SetAllowHorizontalDrag()

void FCTuplet::SetAllowHorizontalDrag ( bool value )

inline

Sets the "Allow Horizontal Drag" setting for the tuplet.

Lua-supported (also as property).

SetAlwaysFlat()

void FCTuplet::SetAlwaysFlat ( bool value )

inline

Sets the "Always Flat" setting.

Lua-supported (also as property).

SetAvoidStaff()

void FCTuplet::SetAvoidStaff ( bool value )

inline

Sets the "Avoid Staff" setting for the tuplet.

Lua-supported (also as property).

SetBracketFullDuration()

void FCTuplet::SetBracketFullDuration ( bool value )

inline

Sets the "Bracket Full Duration" setting.

Lua-supported (also as property).

SetBracketMode()

void FCTuplet::SetBracketMode

(

FCTuplet::BRACKETMODE

value

)

Sets when the slur/bracket shape should show.

Lua-supported (also as property).

Parameters

value

Any of these constants: TUPLETBRACKET_ALWAYS, TUPLETBRACKET_UNBEAMEDONLY, TUPLETBRACKET_NEVERBEAMEDONBEAMSIDE

SetBreakSlurBracket()

void FCTuplet::SetBreakSlurBracket ( bool value )

inline

Parameters

value

Sets if the slur/bracket should be broken around the number or not.

Lua-supported (also as property).

SetCenterUsingDuration()

void FCTuplet::SetCenterUsingDuration ( bool value )

inline

Sets the "Center Using Duration" setting.

Lua-supported (also as property).

SetEngraverTuplet()

void FCTuplet::SetEngraverTuplet ( bool value )

inline

Sets the "engraver tuplet" setting for the tuplet.

Lua-supported (also as property).

SetHorizontalOffset()

void FCTuplet::SetHorizontalOffset ( twobyte value )

inline

Sets the horizontal tuplet offset in EVPUs.

Lua-supported (also as property).

SetHorizontalShapeOffset()

void FCTuplet::SetHorizontalShapeOffset ( twobyte value )

inline

Sets the horizontal shape offset value (in EVPUs).

Lua-supported (also as property).

SetIgnoreNumberOffset()

void FCTuplet::SetIgnoreNumberOffset ( bool value )

inline

Sets the "Ignore Number Offset" setting.

Lua-supported (also as property).

SetLeftExtension()

void FCTuplet::SetLeftExtension ( twobyte value )

inline

Sets the left extension of the bracket/slur shape in EVPUs, compared to the left default position.

Positive value means to move left end to the right.

Lua-supported (also as property).

SetLeftHookLength()

void FCTuplet::SetLeftHookLength ( twobyte value )

inline

Sets the left hook length of the bracket/slur shape in EVPUs.

Lua-supported (also as property).

SetMatchHookLengths()

void FCTuplet::SetMatchHookLengths ( bool value )

inline

Sets the "Match Hook Lengths" setting.

Lua-supported (also as property).

SetNumberStyle()

void FCTuplet::SetNumberStyle

(

FCTuplet::NUMBERSTYLE

value

)

Sets the setting for the number style that should be used by the tuplet.

Lua-supported (also as property).

Parameters

value

Any of these constants: TUPLETNUMBER_NONE, TUPLETNUMBER_REGULAR, TUPLETNUMBER_RATIO, TUPLETNUMBER_RATIOANDNOTE, TUPLETNUMBER_RATIOANDNOTE_BOTH

SetPlacementMode()

void FCTuplet::SetPlacementMode

(

FCTuplet::PLACEMENTMODE

value

)

Sets where the tuplet should be placed compared to the note entry.

Can be any of these constants: TUPLETPLACEMENT_MANUAL, TUPLETPLACEMENT_STEMSIDE, TUPLETPLACEMENT_NOTESIDE, TUPLETPLACEMENT_ABOVE, TUPLETPLACEMENT_BELOW

Lua-supported (also as property).

SetReferenceDuration()

void FCTuplet::SetReferenceDuration ( twobyte value )

inline

Sets the reference duration value (in EDUs).

Lua-supported (also as property).

SetReferenceNumber()

void FCTuplet::SetReferenceNumber ( twobyte value )

inline

Sets the reference number value.

Lua-supported (also as property).

SetRightExtension()

void FCTuplet::SetRightExtension ( twobyte value )

inline

Sets the right extension of the bracket/slur shape in EVPUs, compared to the right-side default position.

Positive value means to move right end to the right.

Lua-supported (also as property).

SetRightHookLength()

void FCTuplet::SetRightHookLength ( twobyte value )

inline

Sets the right hook length of the bracket/slur shape in EVPUs.

This is only used by Finale if GetMatchHookLengths returns true.

Lua-supported (also as property).

SetShapeStyle()

void FCTuplet::SetShapeStyle

(

FCTuplet::SHAPESTYLE

value

)

Sets the setting for which bracket shape the tuplet should use.

Lua-supported (also as property).

Parameters

value

Any of these constants: TUPLETSHAPE_NONE, TUPLETSHAPE_BRACKET, TUPLETSHAPE_SLUR

SetSlopeAdjust()

void FCTuplet::SetSlopeAdjust ( twobyte value )

inline

Sets the "Manual Slope Adjustment" value.

Lua-supported (also as property).

SetSymbolicDuration()

void FCTuplet::SetSymbolicDuration ( twobyte value )

inline

Sets the symbolic duration value (in EDUs).

Lua-supported (also as property).

SetSymbolicNumber()

void FCTuplet::SetSymbolicNumber ( twobyte value )

inline

Sets the symbolic number of the tuplet.

The symbolic number is the number that's "printed" in the tuplet.

Lua-supported (also as property).

SetUseBottomNote()

void FCTuplet::SetUseBottomNote ( bool value )

inline

Sets the "Use Bottom Note" setting for the tuplet.

Lua-supported (also as property).

SetVerticalOffset()

void FCTuplet::SetVerticalOffset ( twobyte value )

inline

Sets the vertical tuplet offset in EVPUs.

Lua-supported (also as property).

SetVerticalShapeOffset()

void FCTuplet::SetVerticalShapeOffset ( twobyte value )

inline

Sets the vertical shape offset value (in EVPUs).

Lua-supported (also as property).

SetVisible()

void FCTuplet::SetVisible ( bool value )

inline

Sets the visibility state of the tuplet.

Lua-supported (also as property).

Tag()

EXTAG FCTuplet::Tag ( ) const

inlineoverridevirtual

The Enigma tag for the derived class.

(Have this public so it's possible to query from the outside world.)

Implements __FCBaseData.