Finale PDK Framework  0.54
Public Types | Public Member Functions | List of all members
FCMeasure Class Reference

The class for a measure (the full vertical measure stack) in the document. It maps the Measure Attributes dialog settings, the internal measure optimization flag settings and more. More...

#include <ff_other.h>

Inheritance diagram for FCMeasure:
__FCNoInciOther __FCOther __FCBaseData __FCBase

Public Types

enum  BARLINE_STYLES {
  BARLINE_NONE = 0, BARLINE_NORMAL, BARLINE_DOUBLE, BARLINE_DASHED,
  BARLINE_THICK, BARLINE_FINAL, BARLINE_TICK, BARLINE_SHAPE,
  BARLINE_DEFAULT
}
 Settings used for FCMeasure::SetBarline(), FCMeasure::SetLeftBarline(), FCMeasure::GetBarline() and FCMeasure::GetLeftBarline(). More...
 
enum  POSITIONING_MODES { POSITIONING_TIMESIG = 0, POSITIONING_MANUALLY, POSITIONING_BEATCHART }
 Settings used for FCMeasure::SetPositioningNotesMode() and FCMeasure::GetPositioningNotesMode() More...
 
enum  SHOW_STATES { SHOWSTATE_IFNEEDED = 0, SHOWSTATE_SHOW, SHOWSTATE_HIDE }
 Settings used for FCMeasure::SetShowKeySignature(), FCMeasure::SetShowTimeSignature(), FCMeasure::GetShowKeySignature() and FCMeasure::GetShowKeySignature() More...
 
- 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...
 

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...
 
 FCMeasure ()
 The constructor. More...
 
virtual ~FCMeasure ()
 Destructor. More...
 
virtual bool Save ()
 Overloaded version of Save(), that transfer key/time sig data to the measure info.
 
virtual bool Load (CMPER itemno)
 Overloaded version of Load(), that removes any existing key/time sig data.
 
FCBeatChartElementsCreateBeatChartElements ()
 Creates a with the beat chart for the current measure. More...
 
FCExpressionsCreateExpressions ()
 Creates a with the expressions for the current measure. More...
 
FCTempoElementsCreateTempoElements ()
 Creates a with the Tempo Tool changes for the current measure. More...
 
void SetKeyless (bool state)
 Sets the keyless time signature mode for the measure. Only works on Finale 2014 and above.
 
void SetHideKeySigShowAccis (bool state)
 Sets the "Hide key signature and show all accidentals" key signature state for the measure. Only works on Finale 2014 and above.
 
void SetPageBreak (bool state)
 Sets the page break for a specific measure. More...
 
void SetBreakMMRest (bool state)
 Sets the "Break multi-measure rest" setting for a specific measure. More...
 
void SetForwardRepeat (bool state)
 Sets if a forward repeat should be displayed for the measure or not. More...
 
void SetExpressionFlag (bool state)
 Sets the flag that marks if a measure contains any expressions. More...
 
void SetTextFlag (bool state)
 Sets the flag that marks if a measure contains any measure-attached text blocks. More...
 
void SetBackwardRepeat (bool state)
 Sets if a backward repeat should be displayed for the measure or not. More...
 
void SetRepeatBracketFlag (bool state)
 Sets if there are repeat brackets displayed for the measure. More...
 
void SetTextRepeatFlag (bool state)
 Sets the stat that marks if there are text repeats in the measure. More...
 
void SetSystemBreak (bool state)
 Sets the measure to force a system break. More...
 
void SetHideCautionary (bool state)
 Sets the "Hide cautionary key/clefs/time sigs" setting for the measure. More...
 
void SetWidth (Evpu16 width)
 Sets the (relative) measure width. More...
 
void SetSpaceBefore (Evpu16 space)
 Sets the extra space before the music in the measure. More...
 
void SetSpaceAfter (Evpu16 space)
 Sets the extra space after the music in the measure. More...
 
void SetAllowHorizontalSplit (bool state)
 Sets the "Allow Horizontal Split Points" setting. More...
 
void SetShowKeySignature (SHOW_STATES state)
 Sets the if the key signature should show or hide. More...
 
void SetShowTimeSignature (SHOW_STATES state)
 Sets the if the time signature should show or hide. More...
 
void SetShowFullNames (bool state)
 Sets the "Show full staff & group name" setting. More...
 
void SetContainsManualMeasureNumbers (bool state)
 Marks the measure that it contains manually adjusted measure numbers (or not). More...
 
void SetBreakWordExtension (bool state)
 Sets the "Break Word Extension" state. More...
 
void SetIncludeInNumbering (bool state)
 Sets the "Include in numbering" setting. More...
 
void SetOverrideGroupBarlines (bool state)
 Sets the "Override group barlines" setting. More...
 
void SetPositioningNotesMode (POSITIONING_MODES mode)
 Sets the note positioning mode for the measure. More...
 
void SetPositionEvenly (bool state)
 Sets the "Position Evenly across Measure" setting. More...
 
void SetBarline (FCMeasure::BARLINE_STYLES style)
 Sets the barline style for the measure. More...
 
void SetBarlineShapeID (twobyte shapeID)
 Sets the barline shape ID (for use with the FCShapeDef class), for custom barlines. More...
 
void SetLeftBarlineShapeID (twobyte shapeID)
 Sets the left barline shape ID (for use with the FCShapeDef class), for custom left barlines. More...
 
void SetLeftBarline (BARLINE_STYLES style)
 Sets the left barline style for the measure. More...
 
void SetSmartShapeFlag (bool state)
 Set to true if a smart shape runs somewhere through the measure. Use with extreme care! More...
 
void SetChordFlag (bool state)
 Set to true if chords are available anywhere in the measure. More...
 
TimeEdu32 GetDuration ()
 Returns the duration of the measure, based on the standard time signature. More...
 
bool GetKeyless () const
 Returns the keyless time signature mode for the measure. Only works on Finale 2014 and above. More...
 
bool GetHideKeySigShowAccis () const
 Returns the "Hide key signature and show all accidentals" key signature state for the measure. Only works on Finale 2014 and above. More...
 
bool GetPageBreak () const
 Gets the page break state for a specific measure. More...
 
bool GetBreakMMRest () const
 Gets the state of the "Break multi-measure rest" setting for a specific measure. More...
 
bool GetSystemBreak () const
 Gets the system break state for the measure. More...
 
bool GetForwardRepeat () const
 Returns true if a forward repeat should be displayed for the measure. More...
 
bool GetExpressionFlag () const
 Gets the flag that marks if a measure contains any expressions. More...
 
bool GetTextFlag () const
 Gets the flag that marks if a measure contains any measure-attached text blocks. More...
 
bool GetBackwardRepeat () const
 Returns true if the backward repeat should be displayed for the measure. More...
 
bool GetRepeatBracketFlag () const
 Returns true if repeat brackets display for the measure. More...
 
bool GetTextRepeatFlag () const
 Returns true if there are text repeats in the measure. More...
 
bool GetHideCautionary () const
 Gets the state of the "Hide cautionary key/clefs/time sigs" setting for the measure. More...
 
Evpu16 GetWidth () const
 Gets the (relative) measure width. More...
 
Evpu16 GetSpaceBefore () const
 Gets the extra space before the music in the measure. More...
 
Evpu16 GetSpaceAfter () const
 Gets the extra space after the music in the measure. More...
 
bool GetAllowHorizontalSplit () const
 Gets the state of the "Allow Horizontal Split Points" setting. More...
 
SHOW_STATES GetShowKeySignature () const
 Sets the state for if the key signature should show or hide. More...
 
SHOW_STATES GetShowTimeSignature () const
 Gets the state for if the time signature should show or hide. More...
 
bool GetUseTimeSigForDisplay () const
 Returns if the measure should use another time sig for display. More...
 
bool GetShowFullNames () const
 Gets the state of the "Show full staff & group name" setting. More...
 
bool GetContainsManualMeasureNumbers () const
 Gets the state that marks if the measure contains manually adjusted measure numbers (or not). More...
 
bool GetBreakWordExtension () const
 Gets the "Break Word Extension" state. More...
 
bool GetIncludeInNumbering () const
 Gets the state of the "Include in numbering" setting. More...
 
bool GetOverrideGroupBarlines () const
 Gets the state of the "Override group barlines" setting. More...
 
POSITIONING_MODES GetPositioningNotesMode () const
 Gets the note positioning mode for the measure. More...
 
bool GetPositionEvenly () const
 Gets the state of the "Position Evenly across Measure" setting. More...
 
FCMeasure::BARLINE_STYLES GetBarline () const
 Gets the barline style for the measure. More...
 
BARLINE_STYLES GetLeftBarline () const
 Gets the left barline style for the measure. More...
 
CMPER GetBarlineShapeID () const
 Returns the barline shape ID (for use with the FCShapeDef class), for custom barlines. More...
 
CMPER GetLeftBarlineShapeID () const
 Returns the left barline shape ID (for use with the FCShapeDef class), for custom left barlines. More...
 
FCKeySignatureGetKeySignature () const
 Returns a pointer to the key signature object. More...
 
bool GetSmartShapeFlag () const
 Returns true if a smart shape runs somewhere through the measure. More...
 
bool GetChordFlag () const
 Returns true if chords are available anywhere in the measure. More...
 
FCTimeSignatureGetTimeSignature () const
 Returns a pointer to the time signature object. More...
 
FCTimeSignatureGetTimeSignatureForDisplay () const
 Returns a pointer to the time signature object. If time signature for display shouldn't be used, NULL will be returned. More...
 
void SetUseTimeSigForDisplay (bool value)
 Turns time sig for display ON or OFF. More...
 
- Public Member Functions inherited from __FCNoInciOther
 __FCNoInciOther ()
 The constructor.
 
virtual bool Reload ()
 Overridden Reload() method to support complex data types.
 
virtual bool SaveAs (CMPER itemno)
 Saves the data under another item number. The object will now be connected to the new item number. More...
 
virtual bool DeepSaveAs (CMPER itemno)
 Saves the data under another item number, but also makes a deep copy of the object. More...
 
virtual bool DeepDeleteData ()
 Deletes the data and all related data available in other data structures. More...
 
virtual bool SaveNew ()
 Creates the data as completely new item number. The object will now be connected to the new item number. More...
 
virtual CMPER GetItemNo () const
 Returns the item number. This typically points to items such as a page number, a measure number, a 1-based expression definition number, etc. More...
 
void SetItemNo (CMPER cmper)
 Sets the item number. Use with extreme care! This is mostly intended for situations when creating new records isn't supported by Finale (preventing SaveAs to work). More...
 
virtual bool LoadFirst ()
 Loads the first element of 1-based data. More...
 
virtual void DebugDump ()
 Outputs the class data/information for debugging purposes. More...
 
- Public Member Functions inherited from __FCOther
void SetCmperAndInci (CMPER cmper, twobyte inci)
 Sets both the CMPER and the incident number in the dataID record. Mainly for internal use.
 
 __FCOther ()
 The constructor.
 
bool IsIdenticalRecord (__FCOther *pCompare)
 Compares an object to see if both objects point to the same data record. 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 DeleteData ()
 Deletes the associated data from Finale's database. Be careful when deleting multiple objects. 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...
 
__FCBaseDataCreateClone ()
 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.
 
FCNumbersCreateRawDataDump ()
 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

- 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 * 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 __FCBaseDataCreateObject ()=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...
 
- 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 class for a measure (the full vertical measure stack) in the document. It maps the Measure Attributes dialog settings, the internal measure optimization flag settings and more.

Member Enumeration Documentation

Settings used for FCMeasure::SetBarline(), FCMeasure::SetLeftBarline(), FCMeasure::GetBarline() and FCMeasure::GetLeftBarline().

Lua-supported.

Enumerator
BARLINE_NONE 

Invisible barline

BARLINE_NORMAL 

Normal (thin) barline

BARLINE_DOUBLE 

Double (thin) barline

BARLINE_DASHED 

Dashed barline

BARLINE_THICK 

Thick barline

BARLINE_FINAL 

Final barline: left side thin, right side thick

BARLINE_TICK 

"Tick" barline (a small mark at the staff top)

BARLINE_SHAPE 

Custom shape barline

BARLINE_DEFAULT 

Used for left system barlines only (and affects left barline that appears at the beginning of a staff system only). Uses the default barline.

Settings used for FCMeasure::SetPositioningNotesMode() and FCMeasure::GetPositioningNotesMode()

Lua-supported.

Enumerator
POSITIONING_TIMESIG 

Position notes according to the time signature.

POSITIONING_MANUALLY 

Position notes manually (by dragging)

POSITIONING_BEATCHART 

Position notes according to the beat chart

Settings used for FCMeasure::SetShowKeySignature(), FCMeasure::SetShowTimeSignature(), FCMeasure::GetShowKeySignature() and FCMeasure::GetShowKeySignature()

Lua-supported.

Enumerator
SHOWSTATE_IFNEEDED 

Show if needed

SHOWSTATE_SHOW 

Always show

SHOWSTATE_HIDE 

Always hide

Constructor & Destructor Documentation

FCMeasure::FCMeasure ( )
inline

The constructor.

Lua-supported.

virtual FCMeasure::~FCMeasure ( )
inlinevirtual

Destructor.

Deletes the key signature object, if available.

Member Function Documentation

virtual const char* FCMeasure::ClassName ( )
inlinevirtual

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

Lua-supported.

Reimplemented from __FCNoInciOther.

FCBeatChartElements * FCMeasure::CreateBeatChartElements ( )

Creates a with the beat chart for the current measure.

It's the caller's responsibility to delete the returned object from the heap after use.

Returns
A FCBeatChartElements object with all beat chart elements for the measure.
FCExpressions * FCMeasure::CreateExpressions ( )

Creates a with the expressions for the current measure.

It's the caller's responsibility to delete the returned object from the heap after use.

Returns
A FCExpressions object with all expressions for the measure.
FCTempoElements * FCMeasure::CreateTempoElements ( )

Creates a with the Tempo Tool changes for the current measure.

It's the caller's responsibility to delete the returned object from the heap after use.

Returns
A FCTempoElements object with all Tempo Tool elements for the measure.
bool FCMeasure::GetAllowHorizontalSplit ( ) const
inline

Gets the state of the "Allow Horizontal Split Points" setting.

See SetAllowHorizontalSplit for more info.

Lua-supported (also as property).

Returns
True to allow horizontal split points.
bool FCMeasure::GetBackwardRepeat ( ) const
inline

Returns true if the backward repeat should be displayed for the measure.

This flag also affects (together with GetRepeatBracketFlag) the display state of FCBackwardRepeat brackets.

Lua-supported (also as property).

  • Returns
    True if a backward repeat is present.
FCMeasure::BARLINE_STYLES FCMeasure::GetBarline ( ) const

Gets the barline style for the measure.

Lua-supported (also as property).

Returns
The barline style.
CMPER FCMeasure::GetBarlineShapeID ( ) const
inline

Returns the barline shape ID (for use with the FCShapeDef class), for custom barlines.

Lua-supported (also as property).

bool FCMeasure::GetBreakMMRest ( ) const
inline

Gets the state of the "Break multi-measure rest" setting for a specific measure.

Lua-supported (also as property).

Returns
True to break a multi-measure rest.
bool FCMeasure::GetBreakWordExtension ( ) const
inline

Gets the "Break Word Extension" state.

Lua-supported (also as property).

Returns
True if word extensions should break.
bool FCMeasure::GetChordFlag ( ) const
inline

Returns true if chords are available anywhere in the measure.

This is an optimization flag. Finale will not read/display chords for measures where this flag is OFF.

Lua-supported (also as property).

virtual const PDKFRAMEWORK_CLASSID FCMeasure::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 FCMeasure::GetContainsManualMeasureNumbers ( ) const
inline

Gets the state that marks if the measure contains manually adjusted measure numbers (or not).

Lua-supported (also as property).

TimeEdu32 FCMeasure::GetDuration ( )
inline

Returns the duration of the measure, based on the standard time signature.

Lua-supported.

bool FCMeasure::GetExpressionFlag ( ) const
inline

Gets the flag that marks if a measure contains any expressions.

This is an optimization flag. Finale will not read/display any expressions for the measure if the flag is OFF.

Lua-supported (also as property).

bool FCMeasure::GetForwardRepeat ( ) const
inline

Returns true if a forward repeat should be displayed for the measure.

Lua-supported (also as property).

  • Returns
    True if a forward repeat should appear for the measure.
bool FCMeasure::GetHideCautionary ( ) const
inline

Gets the state of the "Hide cautionary key/clefs/time sigs" setting for the measure.

Lua-supported (also as property).

Returns
True to hide the cautionary symbols.
bool FCMeasure::GetHideKeySigShowAccis ( ) const
inline

Returns the "Hide key signature and show all accidentals" key signature state for the measure. Only works on Finale 2014 and above.

Returns
On Finale versions earlier than 2014, this method always returns false.
bool FCMeasure::GetIncludeInNumbering ( ) const
inline

Gets the state of the "Include in numbering" setting.

Lua-supported (also as property).

Returns
state True to include in measure number sequence.
bool FCMeasure::GetKeyless ( ) const
inline

Returns the keyless time signature mode for the measure. Only works on Finale 2014 and above.

Returns
On Finale versions earlier than 2014, this method always returns false.
FCKeySignature* FCMeasure::GetKeySignature ( ) const
inline

Returns a pointer to the key signature object.

To get the accurate key signature for a specific measure, use the FCCell version of GetKeySignature(), which would take independent key signatures into account.

Since there's more involved here than just creating and returning a pointer, this method should always be used internally as well to access the _pKeySig private member.

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

Returns
The pointer to the keysignature object.
FCMeasure::BARLINE_STYLES FCMeasure::GetLeftBarline ( ) const

Gets the left barline style for the measure.

A left barline will only show up when the measure is starting a system.

Lua-supported (also as property).

Returns
The barline style.
CMPER FCMeasure::GetLeftBarlineShapeID ( ) const
inline

Returns the left barline shape ID (for use with the FCShapeDef class), for custom left barlines.

Lua-supported (also as property).

bool FCMeasure::GetOverrideGroupBarlines ( ) const
inline

Gets the state of the "Override group barlines" setting.

Lua-supported (also as property).

Returns
True to override group barlines.
bool FCMeasure::GetPageBreak ( ) const
inline

Gets the page break state for a specific measure.

If the measure is the first measure of the system, a page break will occur.

Lua-supported (also as property).

Returns
True if page should break in the measure.
bool FCMeasure::GetPositionEvenly ( ) const
inline

Gets the state of the "Position Evenly across Measure" setting.

Lua-supported (also as property).

Returns
True if notes should space evenly across the measure.
FCMeasure::POSITIONING_MODES FCMeasure::GetPositioningNotesMode ( ) const

Gets the note positioning mode for the measure.

Lua-supported (also as property).

Returns
Any of the following values:
  • POSITIONING_TIMESIG - Position according to time signature.
  • POSITIONING_MANUALLY - Position manually (by dragging).
  • POSITIONING_BEATCHART - Use beat chart (and manual positioning)
bool FCMeasure::GetRepeatBracketFlag ( ) const
inline

Returns true if repeat brackets display for the measure.

This display state affects both FCEndingRepeat and FCBackwardRepeat objects.

If GetBackwardRepeat() returns true, there should be a FCBackwardRepeat object available for the measure.

Lua-supported (also as property).

bool FCMeasure::GetShowFullNames ( ) const

Gets the state of the "Show full staff & group name" setting.

This works on Finale 2011 and above. It will return false on earlier Finale versions.

Lua-supported (also as property).

Returns
The state of the setting. Always returns false on Finale versions earlier than Finale 2011.
FCMeasure::SHOW_STATES FCMeasure::GetShowKeySignature ( ) const

Sets the state for if the key signature should show or hide.

Lua-supported (also as property).

Returns
state Any of these values:
  • SHOWSTATE_IFNEEDED - Display when needed.
  • SHOWSTATE_SHOW - Always show.
  • SHOWSTATE_HIDE - Always hide.
FCMeasure::SHOW_STATES FCMeasure::GetShowTimeSignature ( ) const

Gets the state for if the time signature should show or hide.

Lua-supported (also as property).

Returns
Any of these values:
  • SHOWSTATE_IFNEEDED - Display when needed.
  • SHOWSTATE_SHOW - Always show.
  • SHOWSTATE_HIDE - Always hide.
bool FCMeasure::GetSmartShapeFlag ( ) const
inline

Returns true if a smart shape runs somewhere through the measure.

Lua-supported (also as property).

Evpu16 FCMeasure::GetSpaceAfter ( ) const
inline

Gets the extra space after the music in the measure.

Lua-supported (also as property).

Returns
The extra space in EVPUs.
Evpu16 FCMeasure::GetSpaceBefore ( ) const
inline

Gets the extra space before the music in the measure.

Lua-supported (also as property).

Returns
The extra space in EVPUs.
bool FCMeasure::GetSystemBreak ( ) const
inline

Gets the system break state for the measure.

Lua-supported (also as property).

Returns
True to break the measure.
bool FCMeasure::GetTextFlag ( ) const
inline

Gets the flag that marks if a measure contains any measure-attached text blocks.

This is an optimization flag. Finale will not read/display any measure-attached text blocks for the measure if the flag is OFF.

Lua-supported (also as property).

bool FCMeasure::GetTextRepeatFlag ( ) const
inline

Returns true if there are text repeats in the measure.

This is an optimization flag in Finale to only display text repeats in the measures where this flag is set. Use FCTextRepeats to get all text repeats attached to a measure.

Lua-supported (also as property).

FCTimeSignature* FCMeasure::GetTimeSignature ( ) const
inline

Returns a pointer to the time signature object.

To get the accurate time signature for a specific measure cell, use the FCCell::GetTimeSignature() version, which would take independent time signatures into account.

Since there's more involved here than just creating and returning a pointer, this method should always be used internally as well to access the _pTimeSig private member.

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

Returns
The pointer to the key signature object.
FCTimeSignature* FCMeasure::GetTimeSignatureForDisplay ( ) const
inline

Returns a pointer to the time signature object. If time signature for display shouldn't be used, NULL will be returned.

This pointer works in similar ways to the pointer returned at GetTimeSignature(). For more info, please refer to GetTimeSignature().

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

bool FCMeasure::GetUseTimeSigForDisplay ( ) const
inline

Returns if the measure should use another time sig for display.

Lua-supported (also as property).

Evpu16 FCMeasure::GetWidth ( ) const
inline

Gets the (relative) measure width.

Lua-supported (also as property).

Returns
The relative measure width in EVPUs.
void FCMeasure::SetAllowHorizontalSplit ( bool  state)
inline

Sets the "Allow Horizontal Split Points" setting.

Horizontal split points breaks up a measure on multiple systems. Generally, this option shouldn't be used (better to fake it), since it's not supported by every part of Finale.

Lua-supported (also as property).

Parameters
stateTrue to allow horizontal split points.
void FCMeasure::SetBackwardRepeat ( bool  state)
inline

Sets if a backward repeat should be displayed for the measure or not.

This flag also affects (together with GetRepeatBracketFlag) the display state of FCBackwardRepeat brackets.

IMPORTANT! If the backward repeat is set, the playback information/destination for the repeat must be set as well.

Lua-supported (also as property).

  • Parameters
    stateTrue to display a backward repeat.
void FCMeasure::SetBarline ( FCMeasure::BARLINE_STYLES  style)

Sets the barline style for the measure.

Lua-supported (also as property).

Parameters
styleThe barline style. Custom barlines can't be fully set using this method. Use SetBarlineShapeID as well.
void FCMeasure::SetBarlineShapeID ( twobyte  shapeID)
inline

Sets the barline shape ID (for use with the FCShapeDef class), for custom barlines.

Lua-supported (also as property).

void FCMeasure::SetBreakMMRest ( bool  state)
inline

Sets the "Break multi-measure rest" setting for a specific measure.

Lua-supported (also as property).

Parameters
stateTrue to break a multi-measure rest.
void FCMeasure::SetBreakWordExtension ( bool  state)
inline

Sets the "Break Word Extension" state.

Lua-supported (also as property).

Parameters
stateTrue to break word extensions.
void FCMeasure::SetChordFlag ( bool  state)
inline

Set to true if chords are available anywhere in the measure.

This is an optimization flag. Finale will not read/display chords for measures where this flag is OFF.

Lua-supported (also as property).

void FCMeasure::SetContainsManualMeasureNumbers ( bool  state)
inline

Marks the measure that it contains manually adjusted measure numbers (or not).

Lua-supported (also as property).

void FCMeasure::SetExpressionFlag ( bool  state)
inline

Sets the flag that marks if a measure contains any expressions.

This is an optimization flag. Finale will not read/display any expressions for the measure if the flag is OFF.

Lua-supported (also as property).

void FCMeasure::SetForwardRepeat ( bool  state)
inline

Sets if a forward repeat should be displayed for the measure or not.

Lua-supported (also as property).

  • Parameters
    stateTrue to display a forward repeat.
void FCMeasure::SetHideCautionary ( bool  state)
inline

Sets the "Hide cautionary key/clefs/time sigs" setting for the measure.

Lua-supported (also as property).

Parameters
stateTrue to hide the cautionary symbols.
void FCMeasure::SetIncludeInNumbering ( bool  state)
inline

Sets the "Include in numbering" setting.

Lua-supported (also as property).

Parameters
stateTrue to include in measure number sequence.
void FCMeasure::SetLeftBarline ( BARLINE_STYLES  style)

Sets the left barline style for the measure.

A left barline will only show up when the measure is starting a system.

Lua-supported (also as property).

Parameters
styleThe barline style. Custom barlines can't be fully set using this method. Use SetLeftBarlineShapeID as well
void FCMeasure::SetLeftBarlineShapeID ( twobyte  shapeID)
inline

Sets the left barline shape ID (for use with the FCShapeDef class), for custom left barlines.

Lua-supported (also as property).

void FCMeasure::SetOverrideGroupBarlines ( bool  state)
inline

Sets the "Override group barlines" setting.

Lua-supported (also as property).

Parameters
stateTrue to override group barlines.
void FCMeasure::SetPageBreak ( bool  state)
inline

Sets the page break for a specific measure.

If the measure is the first measure of the system, a page break will occur.

Lua-supported (also as property).

void FCMeasure::SetPositionEvenly ( bool  state)
inline

Sets the "Position Evenly across Measure" setting.

Lua-supported (also as property).

Parameters
stateTrue to space notes evenly across the measure.
void FCMeasure::SetPositioningNotesMode ( POSITIONING_MODES  mode)

Sets the note positioning mode for the measure.

Lua-supported (also as property).

Parameters
modeAny of the following values:
  • POSITIONING_TIMESIG - Position according to time signature.
  • POSITIONING_MANUALLY - Position manually (by dragging).
  • POSITIONING_BEATCHART - Use beat chart (and manual positioning)
void FCMeasure::SetRepeatBracketFlag ( bool  state)
inline

Sets if there are repeat brackets displayed for the measure.

This display state affects both FCEndingRepeat and FCBackwardRepeat objects.

If GetBackwardRepeat() returns true, there should be a FCBackwardRepeat object available for the measure.

Lua-supported (also as property).

void FCMeasure::SetShowFullNames ( bool  state)

Sets the "Show full staff & group name" setting.

This works on Finale 2011 and above. It will do nothing on earlier Finale versions.

Lua-supported (also as property).

Parameters
stateThe state of the setting.
void FCMeasure::SetShowKeySignature ( SHOW_STATES  state)

Sets the if the key signature should show or hide.

Lua-supported (also as property).

Parameters
stateAny of these values:
  • SHOWSTATE_IFNEEDED - Display when needed.
  • SHOWSTATE_SHOW - Always show.
  • SHOWSTATE_HIDE - Always hide.
void FCMeasure::SetShowTimeSignature ( SHOW_STATES  state)

Sets the if the time signature should show or hide.

Lua-supported (also as property).

Parameters
stateAny of these values:
  • SHOWSTATE_IFNEEDED - Display when needed.
  • SHOWSTATE_SHOW - Always show.
  • SHOWSTATE_HIDE - Always hide.
void FCMeasure::SetSmartShapeFlag ( bool  state)
inline

Set to true if a smart shape runs somewhere through the measure. Use with extreme care!

Lua-supported (also as property).

void FCMeasure::SetSpaceAfter ( Evpu16  space)
inline

Sets the extra space after the music in the measure.

Lua-supported (also as property).

Parameters
spaceThe extra space in EVPUs.
void FCMeasure::SetSpaceBefore ( Evpu16  space)
inline

Sets the extra space before the music in the measure.

Lua-supported (also as property).

Parameters
spaceThe extra space in EVPUs.
void FCMeasure::SetSystemBreak ( bool  state)
inline

Sets the measure to force a system break.

Lua-supported (also as property).

Parameters
stateTrue to break the measure.
void FCMeasure::SetTextFlag ( bool  state)
inline

Sets the flag that marks if a measure contains any measure-attached text blocks.

This is an optimization flag. Finale will not read/display any measure-attached text blocks for the measure if the flag is OFF.

Lua-supported (also as property).

void FCMeasure::SetTextRepeatFlag ( bool  state)
inline

Sets the stat that marks if there are text repeats in the measure.

This is an optimization flag in Finale, used to only display text repeats in the measures where this flag is set. Use FCTextRepeats to get all text repeats attached to a measure.

Lua-supported (also as property).

void FCMeasure::SetUseTimeSigForDisplay ( bool  value)
inline

Turns time sig for display ON or OFF.

If the time signature for is turned ON, it's possible to get get a FCTimeSignature object from the GetTimeSignatureForDisplay() method.

Lua-supported (also as property).

void FCMeasure::SetWidth ( Evpu16  width)
inline

Sets the (relative) measure width.

Lua-supported (also as property).

Parameters
widthThe relative measure width in EVPUs.