FCTimeSignature Class Reference

Class for time signatures. More...

#include <ff_timesig.h>

Inheritance diagram for FCTimeSignature:

Public Member Functions
	FCTimeSignature ()
	The constructor. Sets the default time signature to 4/4.
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...
void	SetBeats (twobyte value)
	Sets the number of beats, or the composite top ID. More...
void	SetBeatDuration (twobyte value)
	Sets the beat duration (in EDUs), or the composite bottom ID. More...
void	SetCompositeTop (bool value)
	Sets the composite "mark" of the top part of the time signature.
void	SetCompositeBottom (bool value)
	Sets the composite "mark" of the bottom part of the time signature.
void	SetAbbreviate (bool state)
	Sets if the time signature should be abbreviated (to cut and common time). More...
twobyte	GetBeats () const
	Gets the number of beats. If the time signature has a composite top, this represent a composite record. More...
twobyte	CalcBeats ()
	To get the number of beats for both standard or composite time signatures. More...
twobyte	CalcLargestBeats ()
	Gets the largest number of beats in the time signature. This method works with time sigs with composite bottom as well. More...
twobyte	GetBeatDuration () const
	Gets the beat duration. If the time signature has a composite bottom, this represent a composite record ID. More...
twobyte	CalcSmallestBeatDuration ()
	Gets the smallest beat duration found in the time signature. This method works with time sigs with composite bottom as well. More...
twobyte	CalcLargestBeatDuration ()
	Gets the largest beat duration found in the time signature. This method works with time sigs with composite bottom as well. More...
bool	GetCompositeTop () const
	Returns true if the top part of the time signature is marked as composite. More...
bool	GetCompositeBottom () const
	Returns true if the bottom part of the time signature is marked as composite. More...
bool	GetAbbreviate () const
	Returns true if the time signature should be abbreviated (to cut and common time). More...
bool	IsBeatPosition (TimeEdu32 eduposition)
	Returns true if the position is a "beat" in the time signature. More...
int	CalcBeatPosition (TimeEdu32 eduposition)
TimeEdu32	CalcPrevBeatPosition (TimeEdu32 eduposition)
TimeEdu32	CalcNextBeatPosition (TimeEdu32 eduposition)
bool	IsIdentical (FCTimeSignature *pCompareSig)
	Returns true if the time signature is identical to the compared time signature. More...
bool	IsCompound ()
	Returns true if the time signature is a compound meter, such as 3/8, 6/8, etc. More...
bool	IsCommonTime ()
	Returns true if the time signature is in 4/4. More...
void	MakeString (FCString *pString)
	Creates a string representation of the time signature. More...
FCCompositeTimeSigTop *	CreateCompositeTop ()
	Creates, loads and initializes a composite top object. More...
bool	SaveNewCompositeTop (FCCompositeTimeSigTop *pCompositeTop)
	Saves a new composite top object and assigns the ID to the time sig. More...
FCCompositeTimeSigBottom *	CreateCompositeBottom ()
	Creates, loads and initializes a composite bottom object. More...
bool	SaveNewCompositeBottom (FCCompositeTimeSigBottom *pCompositeBottom)
	Saves a new composite bottom object and assigns the ID to the time sig. 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 EXTAG	Tag ()=0
	The Enigma tag for the derived class. More...
virtual EVERSION	EnigmaVersion ()
	The Enigma version for save/load/create/delete operations. More...
virtual int	DataSizeLoad ()=0
	Returns the data size for the data structure that should be loaded. 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...
virtual void	CloneMemoryFrom (__FCBaseData *pSource)
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	Save ()
	Saves the currently loaded to its current location. More...
virtual bool	Reload ()
	Refreshes the data for the object, to synch the data with Finale's current data. More...
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	DebugDump ()
	Outputs the class data/information for debugging purposes. 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...

Static Public Member Functions
static bool	IsCompoundBeatDuration (TimeEdu32 duration)
	Returns true if the time signature duration is a compound meter, such as 3/8, 6/8, etc. 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
virtual bool	LoadFirst ()
	Finding first time sig recs currently not supported. More...
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! More...
virtual __FCBaseData *	CreateObject ()=0
	Creates a new instance of the object. More...
bool	DataIsLoaded () const
	Returns true is any data has been loaded into the object. More...
void	_TagDocumentID ()
	For internal use only. 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...
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

Class for time signatures.

Member Function Documentation

int FCTimeSignature::CalcBeatPosition

(

TimeEdu32

eduposition

)

Returns the 0-based position index of the beat within the measure.

-1 if the beat isn't exactly on a beat position.

This method requires PDK_FRAMEWORK_COMPOSITETIMESIGS to be defined.

Lua-supported.

twobyte FCTimeSignature::CalcBeats

(

)

To get the number of beats for both standard or composite time signatures.

This method requires PDK_FRAMEWORK_COMPOSITETIMESIGS defined.

Lua-supported.

twobyte FCTimeSignature::CalcLargestBeatDuration

(

)

Gets the largest beat duration found in the time signature. This method works with time sigs with composite bottom as well.

This method requires PDK_FRAMEWORK_COMPOSITETIMESIGS defined.

Lua-supported.

twobyte FCTimeSignature::CalcLargestBeats

(

)

Gets the largest number of beats in the time signature. This method works with time sigs with composite bottom as well.

This method requires PDK_FRAMEWORK_COMPOSITETIMESIGS defined.

Lua-supported.

TimeEdu32 FCTimeSignature::CalcNextBeatPosition

(

TimeEdu32

eduposition

)

Returns the beat position after the current one (if any).

This method requires PDK_FRAMEWORK_COMPOSITETIMESIGS defined.

Lua-supported.

Returns

If no next position was found, the return value is the same as the eduposition value.

TimeEdu32 FCTimeSignature::CalcPrevBeatPosition

(

TimeEdu32

eduposition

)

Returns the beat position before the current one (if any).

This method requires PDK_FRAMEWORK_COMPOSITETIMESIGS defined.

Lua-supported.

twobyte FCTimeSignature::CalcSmallestBeatDuration

(

)

Gets the smallest beat duration found in the time signature. This method works with time sigs with composite bottom as well.

This method requires PDK_FRAMEWORK_COMPOSITETIMESIGS defined.

Lua-supported.

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

FCCompositeTimeSigBottom * FCTimeSignature::CreateCompositeBottom

(

)

Creates, loads and initializes a composite bottom object.

The object is always created. It's the caller's responsibility to delete the created object after use.

This method requires PDK_FRAMEWORK_COMPOSITETIMESIGS defined.

FCCompositeTimeSigTop * FCTimeSignature::CreateCompositeTop

(

)

Creates, loads and initializes a composite top object.

The object is always created. It's the caller's responsibility to delete the created object after use.

This method requires PDK_FRAMEWORK_COMPOSITETIMESIGS defined.

bool FCTimeSignature::GetAbbreviate ( ) const

inline

Returns true if the time signature should be abbreviated (to cut and common time).

Currently, Finale only supports this for time signatures for display.

Lua-supported (also as property).

twobyte FCTimeSignature::GetBeatDuration ( ) const

inline

Gets the beat duration. If the time signature has a composite bottom, this represent a composite record ID.

Lua-supported (also as property).

twobyte FCTimeSignature::GetBeats ( ) const

inline

Gets the number of beats. If the time signature has a composite top, this represent a composite record.

To get the number of beats for standard or composite time signature, use the CalcBeats method instead.

Lua-supported (also as property).

virtual const PDKFRAMEWORK_CLASSID FCTimeSignature::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 FCTimeSignature::GetCompositeBottom ( ) const

inline

Returns true if the bottom part of the time signature is marked as composite.

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

bool FCTimeSignature::GetCompositeTop ( ) const

inline

Returns true if the top part of the time signature is marked as composite.

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

bool FCTimeSignature::IsBeatPosition

(

TimeEdu32

eduposition

)

Returns true if the position is a "beat" in the time signature.

This method requires PDK_FRAMEWORK_COMPOSITETIMESIGS defined.

Lua-supported.

bool FCTimeSignature::IsCommonTime ( )

inline

Returns true if the time signature is in 4/4.

Lua-supported.

bool FCTimeSignature::IsCompound

(

)

Returns true if the time signature is a compound meter, such as 3/8, 6/8, etc.

If the time signature has a composite bottom, all bottom digits must be of a compound meter.

This method requires PDK_FRAMEWORK_COMPOSITETIMESIGS defined.

Lua-supported.

bool FCTimeSignature::IsCompoundBeatDuration ( TimeEdu32  duration )

static

Returns true if the time signature duration is a compound meter, such as 3/8, 6/8, etc.

This static method is called without a class instance.

Lua-supported.

bool FCTimeSignature::IsIdentical

(

FCTimeSignature *

pCompareSig

)

Returns true if the time signature is identical to the compared time signature.

This method will compare each digit in a composite time signature as well.

This method requires PDK_FRAMEWORK_COMPOSITETIMESIGS defined.

Lua-supported.

virtual bool FCTimeSignature::LoadFirst ( )

inlineprotectedvirtual

Finding first time sig recs currently not supported.

Todo:

Support FCTimeSignature:FindFirst for custom time sigs???

Implements __FCBaseData.

void FCTimeSignature::MakeString

(

FCString *

pString

)

Creates a string representation of the time signature.

If PDK_FRAMEWORK_COMPOSITETIMESIGS is defined, composite time signatures can be converted into strings as well.

Lua-supported.

bool FCTimeSignature::SaveNewCompositeBottom

(

FCCompositeTimeSigBottom *

pCompositeBottom

)

Saves a new composite bottom object and assigns the ID to the time sig.

The measure must be saved afterwards (the ID is transfered during the save).

Don't use this method if there already is a composite bottom for the measure.

This method requires PDK_FRAMEWORK_COMPOSITETIMESIGS defined.

bool FCTimeSignature::SaveNewCompositeTop

(

FCCompositeTimeSigTop *

pCompositeTop

)

Saves a new composite top object and assigns the ID to the time sig.

The measure must be saved afterwards (the ID is transfered during the save).

Don't use this method if there already is a composite top for the measure.

This method requires PDK_FRAMEWORK_COMPOSITETIMESIGS defined.

void FCTimeSignature::SetAbbreviate ( bool  state )

inline

Sets if the time signature should be abbreviated (to cut and common time).

Currently, Finale only supports this for time signatures for display.

Lua-supported (also as property).

void FCTimeSignature::SetBeatDuration ( twobyte  value )

inline

Sets the beat duration (in EDUs), or the composite bottom ID.

Lua-supported (also as property).

void FCTimeSignature::SetBeats ( twobyte  value )

inline

Sets the number of beats, or the composite top ID.

Lua-supported (also as property).