The class for a measure number region. More...

#include <ff_other.h>

Inheritance diagram for FCMeasureNumberRegion:

Public Types
enum	NUMBERINGSTYLE { NUMBERING_DIGITS = 0 , NUMBERING_LOWERCASEDOUBLE , NUMBERING_UPPERCASEDOUBLE , NUMBERING_LOWERCASE , NUMBERING_UPPERCASE , NUMBERING_TIME_SECONDS , NUMBERING_TIME_10 , NUMBERING_TIME_100 , NUMBERING_TIME_1000 , NUMBERING_FRAMES , NUMBERING_CUSTOM = 101 }
	Numbering styles for measure numbers. More...

enum	NUMBERVIEWS { NUMBERVIEW_ALL = 0 , NUMBERVIEW_PAGEONLY , NUMBERVIEW_SCROLLONLY }
	The number views where the region should show. More...

enum	MNALIGNMENTS { MNALIGN_LEFT = 0 , MNALIGN_CENTER , MNALIGN_RIGHT }
	The measure number alignment values. More...

enum	MNJUSTIFICATIONS { MNJUSTIFY_LEFT = TEXT_JUSTIFY_LEFT , MNJUSTIFY_CENTER = TEXT_JUSTIFY_CENTER , MNJUSTIFY_RIGHT = TEXT_JUSTIFY_RIGHT }
	The measure number justification values. More...

Public Types inherited from __FCBase
enum	PDKFRAMEWORK_CLASSID { FCID_UNKNOWN = 0 , FCID_ACCIDENTALMOD , FCID_ACTIVELYRIC , FCID_ALLOTMENT , FCID_ARTICULATION , FCID_ARTICULATIONDEF , FCID_BACKWARDREPEAT , FCID_BASELINE , FCID_BEAMMOD , FCID_BEATCHARTELEMENT , FCID_BOOKMARK , FCID_BROKENBEAMMOD , FCID_CATEGORYDEF , FCID_CELLCLEFCHANGE , FCID_CELLFRAMEHOLD , FCID_CELLGRAPHIC , FCID_CELLTEXT , FCID_CENTERSMARTSHAPE , FCID_CHORD , FCID_CHORDPREFS , FCID_CHORDSUFFIXELEMENT , FCID_CHORUSSYLLABLE , FCID_CLEFDEF , FCID_COMPOSITETIMESIGBOTTOMELEMENT , FCID_COMPOSITETIMESIGTOPELEMENT , FCID_CROSSSTAFFMOD , FCID_CUSTOMSMARTLINEDEF , FCID_CUSTOMSTEMMOD , FCID_DISTANCEPREFS , FCID_DOTMOD , FCID_ENCLOSURE , FCID_ENDINGREPEAT , FCID_ENIGMATEXTSTYLE , FCID_ENTRYALTERMOD , FCID_EXECUTABLESHAPEDEF , FCID_EXPRESSION , FCID_FONTINFO , FCID_FONTPREFS , FCID_FREEZESYSTEM , FCID_FRETBOARDSTYLEDEF , FCID_FRETBOARDSTYLEDEFS , FCID_FRETBOARDGROUPDEF , FCID_FRETBOARDGROUPDEFS , FCID_FRETINSTRUMENTDEF , FCID_GENERALPREFS , FCID_GRIDSGUIDESPREFS , FCID_GROUP , FCID_GROUPNAMEPOSITIONPREFS , FCID_HUMANPLAYBACKPREFS , FCID_INDEPENDENTCELLDETAIL , FCID_INSTRUMENTDEF , FCID_INSTRUMENTPLAYBACKDATA , FCID_KEYMODEDEF , FCID_KEYSIGNATURE , FCID_LAYERPREFS , FCID_LYRICSBASELINE , FCID_LYRICSPREFS , FCID_MEASURE , FCID_MEASURENUMBERREGION , FCID_METATOOLASSIGNMENT , FCID_MIDIEXPRESSION , FCID_MISCDOCPREFS , FCID_MULTIMEASUREREST , FCID_MULTIMEASURERESTPREFS , FCID_MULTISTAFFINSTRUMENT , FCID_MULTISTAFFINSTRUMENTS , FCID_MUSICCHARACTERPREFS , FCID_MUSICSPACINGPREFS , FCID_NUMBER , FCID_NOTEHEADMOD , FCID_OTHERINCI , FCID_PERCUSSIONLAYOUTNOTE , FCID_PERCUSSIONSTAFF , FCID_PERFORMANCEMOD , FCID_PAGE , FCID_PAGEFORMATPREFS , FCID_PAGEGRAPHIC , FCID_PAGETEXT , FCID_PART , FCID_PARTEXTRACTPREFS , FCID_PARTSCOPEPREFS , FCID_PARTSTAFFVOICING , FCID_PERCUSSIONNOTEMOD , FCID_PIANOBRACEPREFS , FCID_PLAYBACKPREFS , FCID_RAWTEXT , FCID_REPEATPREFS , FCID_SECONDARYBEAMBREAKMOD , FCID_BEAMEXTENSIONMOD , FCID_SECTIONSYLLABLE , FCID_SEPARATEMEASURENUMBER , FCID_SEPARATEPLACEMENT , FCID_SHAPEDEF , FCID_SHAPEEXPRESSIONDEF , FCID_SLURCONTOURPREFS , FCID_SIZEPREFS , FCID_SMARTSHAPE , FCID_SMARTSHAPEENTRYMARK , FCID_SMARTSHAPEMEASUREMARK , FCID_SMARTSHAPEPREFS , FCID_STAFF , FCID_STAFFLIST , FCID_STAFFNAMEPOSITION , FCID_STAFFNAMEPOSITIONPREFS , FCID_STAFFSTYLEASSIGN , FCID_STAFFSTYLEDEF , FCID_STAFFSYSTEM , FCID_STEMCONNECTIONTABLE , FCID_STEMMOD , FCID_STRING , FCID_SYLLABLEENTRYMOD , FCID_SYSTEMSTAFF , FCID_TABLATURENOTEMOD , FCID_TEMPOELEMENT , FCID_TEXTBLOCK , FCID_TEXTEXPRESSIONDEF , FCID_TEXTREPEAT , FCID_TEXTREPEATDEF , FCID_TIEMOD , FCID_TIEPREFS , FCID_TIECONTOURPREFS , FCID_TIEPLACEMENTPREFS , FCID_TIMESIGNATURE , FCID_TUPLET , FCID_TUPLETPREFS , FCID_VERSESYLLABLE }
	Constants for the GetClassID method. More...

enum	MEASUREMENTUNITS { MEASUREMENTUNIT_DEFAULT = UNIT_DEFAULT , MEASUREMENTUNIT_EVPUS = UNIT_EVPUS , MEASUREMENTUNIT_INCHES = UNIT_INCHES , MEASUREMENTUNIT_CENTIMETERS = UNIT_CENTS , MEASUREMENTUNIT_POINTS = UNIT_POINTS , MEASUREMENTUNIT_PICAS = UNIT_PICAS , MEASUREMENTUNIT_SPACES = UNIT_SPACES , MEASUREMENTUNIT_MILLIMETERS = 100 }
	Constants for Finale's standard measurement units. More...

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

const PDKFRAMEWORK_CLASSID	GetClassID () const override
	Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has problems to resolve the true classes of inherited objects.

	FCMeasureNumberRegion ()
	The constructor.

void	SetStartMeasure (twobyte measure)
	Sets the start measure for the measure number region.

void	SetEndMeasure (twobyte measure)
	Sets the end measure for the measure number region.

void	SetStartNumber (twobyte offset)
	Sets the start measure for the measure number region.

void	SetPrefix (FCString *pString)
	Sets the prefix string.

void	SetSuffix (FCString *pString)
	Sets the suffix string.

void	SetUseScoreInfoForParts (bool value)
	Sets if parts should use the score information section of the measure number region appearance.

void	SetID (twobyte newid)
	Sets the unique measure number region ID. USE WITH CARE!!!

void	SetStartFontInfo (FCFontInfo *pFontInfo, bool parts)
	Sets the start font for the measure number region.

void	SetMultipleFontInfo (FCFontInfo *pFontInfo, bool parts)
	Sets the multiple font for the measure number region.

void	SetMultiMeasureFontInfo (FCFontInfo *pFontInfo, bool parts)
	Sets the font to be used for multi-measure rests.

void	SetUseEnclosureStart (bool use, bool parts)
	Sets if enclosures should be used for start numbers.

void	SetExcludeOtherStaves (bool exclude, bool parts)
	Sets if the numbers should be excluded on other staves.

void	SetUseEnclosureMultiple (bool use, bool parts)
	Sets if enclosures should be used for multiple numbers.

void	SetShowOnTopStaff (bool showontop, bool parts)
	Sets if the measure number should be shown on top staff or not.

void	SetShowOnSystemStart (bool showonstart, bool parts)
	Sets if the measure number should be shown on system starts or not.

void	SetShowOnBottomStaff (bool showonbottom, bool parts)
	Sets if the measure number should be displayed on the bottom staff or not.

void	SetShowMultiples (bool showmultiples, bool parts)
	Sets if the "multiple" numbering should be used or not.

void	SetHideFirstNumber (bool hide, bool parts)
	Sets if the first occurence should be hidden or not.

void	SetShowMultiMeasureRange (bool show, bool parts)
	Sets if the measure range should be displayed for multimeasure rests or not.

void	SetShowOnMultiMeasureRests (bool show, bool parts)
	Sets if the measure numbers should show on multimeasure rests.

void	SetMultipleValue (twobyte value, bool parts)
	Sets the "Show on every" value for multiple measure numbers.

void	SetMultipleStartMeasure (twobyte measure, bool parts)
	Sets the "Show on every" start value for multiple measure numbers.

void	SetMultiMeasureBracketLeft (eUniChar32 character, bool parts)
	Sets the left-side range bracket character for multimeasure rest ranges.

void	SetMultiMeasureBracketRight (eUniChar32 character, bool parts)
	Sets the right-side range bracket character for multimeasure rest ranges.

void	SetBreakMultiMeasureRests (bool breakstate, bool parts)
	Sets if "multiple" measure numbers should break multimeasure rests or not.

void	SetStartAlignment (MNALIGNMENTS alignment, bool parts)
	Sets the alignment for start measure numbers.

void	SetStartJustification (MNJUSTIFICATIONS justification, bool parts)
	Sets the justification for the start measure numbers.

void	SetMultipleAlignment (MNALIGNMENTS alignment, bool parts)
	Sets the alignment for "multiple" measure numbers.

void	SetMultipleJustification (MNJUSTIFICATIONS justification, bool parts)
	Sets the justification for the "multiple" measure numbers.

void	SetMultiMeasureAlignment (MNALIGNMENTS alignment, bool parts)
	Sets the alignment for multimeasure measure numbers.

void	SetMultiMeasureJustification (MNJUSTIFICATIONS justification, bool parts)
	Sets the justification for the start measure numbers.

void	SetStartHorizontalPosition (twobyte distance, bool parts)
	Sets the default horizontal position of start numbers.

void	SetStartVerticalPosition (twobyte distance, bool parts)
	Sets the default vertical position of start numbers.

void	SetMultipleHorizontalPosition (twobyte distance, bool parts)
	Sets the horizontal position of multiple numbers.

void	SetMultipleVerticalPosition (twobyte distance, bool parts)
	Sets the vertical position of multiple numbers.

void	SetMultiMeasureHorizontalPosition (twobyte distance, bool parts)
	Sets the horizontal position of multimeasure rest numbers.

void	SetMultiMeasureVerticalPosition (twobyte distance, bool parts)
	Sets the vertical position of multimeasure rest numbers.

void	SetView (NUMBERVIEWS view)
	Sets the view where the region should show.

void	SetNumberingStyle (NUMBERINGSTYLE style)
	Sets the numbering style.

void	SetBase (twobyte base)
	Sets the base for the measure numbering style.

void	SetStartCharacter (eUniChar32 character)
	Sets the starting character of the measure numbering style.

void	SetTime (bool state)
	Sets if a time mode is used.

void	SetTimeFrames (bool state)
	Returns true if "frames" for time measure numbers.

void	SetUseHours (bool state)
	Returns if time measure numbers should include hours.

void	SetTimePrecision (twobyte precision)
	Sets the time precision, for the time modes that aren't based on frames.

void	SetCountFromOne (bool value)
	Sets if the measuring should start from one instead of zero.

void	SetNoZero (bool value)
	Sets if no zero should be used.

void	SetDoubleUp (bool value)
	Sets if the double-up (=duplicating the first character) style should be used or not.

twobyte	GetStartMeasure () const
	Returns the start measure of the measure number region.

twobyte	GetEndMeasure () const
	Returns the end measure of the measure number region.

twobyte	GetStartNumber () const
	Returns the measure region's starting number (for display).

bool	GetTime () const
	Returns true if a time mode is used.

bool	GetTimeFrames () const
	Returns true if "frames" for time measure numbers.

bool	GetUseHours () const
	Returns if time measure numbers should include hours.

twobyte	GetTimePrecision () const
	Returns the time precision, for the time modes that aren't based on frames.

bool	GetNoZero () const
	Returns if no zero should be used.

bool	GetDoubleUp () const
	Returns true if the numbering model is a "double up" (a, b, c, .... aa, bb, cc, etc)

bool	GetCountFromOne () const
	Returns true if the numbering model starts with 1 (numbers) or 0 (letters).

eUniChar32	GetStartCharacter () const
	Gets the base character.

twobyte	GetBase () const
	Returns the number base.

bool	GetUseScoreInfoForParts () const
	Returns true if parts should use the score information section of the measure number region appearance.

twobyte	GetID ()
	Returns the unique measure number region ID.

bool	GetDisplayedNumber (eMeas number, FCString *pString)
	Formats the displayed number for a measure (without prefix/suffix)

bool	GetDisplayedNumberWithID (eMeas number, FCString *pString)
	Formats the displayed number for a measure, with the region ID.

void	GetPrefix (FCString *pString)
	Copies the prefix string to a FCString object.

void	GetSuffix (FCString *pString)
	Gets the suffix string.

FCEnclosure *	GetEnclosureStart (bool parts)
	Gets the pointer to the start enclosure object. This object is a part of the measure number region and should not be saved separately.

FCEnclosure *	GetEnclosureMultiple (bool parts)
	Gets the pointer to the multiple enclosure object. This object is a part of the measure number region and should not be saved separately.

bool	GetUseEnclosureStart (bool parts)
	Returns true if start measure numbers should use the enclosure data.

bool	GetExcludeOtherStaves (bool parts)
	Returns true if measure numbers should be excluded on other staves.

bool	GetUseEnclosureMultiple (bool parts)
	Returns true if "multiple" measure numbers should use the enclosure data.

bool	GetShowOnTopStaff (bool parts)
	Returns true if top staff should show a measure number.

bool	GetShowOnSystemStart (bool parts)
	Returns true if the system start should show a measure number.

bool	GetShowOnBottomStaff (bool parts)
	Returns true if bottom staff should show a measure number.

bool	GetShowMultiples (bool parts)
	Returns true if repeated numbered sequences are used.

bool	GetHideFirstNumber (bool parts)
	Returns true if the first number in the measure number region should be hidden.

bool	GetShowMultiMeasureRange (bool parts)
	Returns true if the measure range should be displayed for multimeasure rests.

bool	GetShowOnMultiMeasureRests (bool parts)
	Returns true if the measure numbers should show on multimeasure rests.

twobyte	GetMultipleValue (bool parts)
	Returns the "Show on every" value for multiple measure numbers.

twobyte	GetMultipleStartMeasure (bool parts)
	Returns the "Show on every" value for multiple measure numbers.

eUniChar32	GetMultiMeasureBracketLeft (bool parts)
	Returns the left-side range bracket character for multimeasure rest ranges.

eUniChar32	GetMultiMeasureBracketRight (bool parts)
	Returns the right-side range bracket character for multimeasure rest ranges.

bool	GetBreakMultiMeasureRests (bool parts)
	Returns true if multiple measure numbers should break multi-measure rests.

MNALIGNMENTS	GetStartAlignment (bool parts)
	Returns the alignment for start measure numbers.

MNJUSTIFICATIONS	GetStartJustification (bool parts)
	Returns the justifications for start measure numbers.

MNALIGNMENTS	GetMultipleAlignment (bool parts)
	Returns the alignment for "multiple" measure numbers.

MNJUSTIFICATIONS	GetMultipleJustification (bool parts)
	Returns the justifications for "multiple" measure numbers.

MNALIGNMENTS	GetMultiMeasureAlignment (bool parts)
	Returns the alignment for multimeasure rest measure numbers.

MNJUSTIFICATIONS	GetMultiMeasureJustification (bool parts)
	Returns the justifications for multimeasure rest measure numbers.

twobyte	GetStartHorizontalPosition (bool parts)
	Returns the default horizontal position for start numbers.

twobyte	GetStartVerticalPosition (bool parts)
	Returns the default vertical position for start numbers.

twobyte	GetMultipleHorizontalPosition (bool parts)
	Returns the default horizontal position for the multiple numbers.

twobyte	GetMultipleVerticalPosition (bool parts)
	Returns the default vertical position for the multiple numbers.

twobyte	GetMultiMeasureHorizontalPosition (bool parts)
	Returns the horizontal position of for multimeasure rests.

twobyte	GetMultiMeasureVerticalPosition (bool parts)
	Returns the vertical position of for multimeasure rests.

NUMBERVIEWS	GetView () const
	Returns the view where the number region should show.

NUMBERINGSTYLE	GetNumberingStyle () const
	Returns the numbering style.

void	GetStartFontInfo (FCFontInfo *pFontInfo, bool parts)
	Gets the start font for the measure number region.

FCFontInfo *	CreateStartFontInfo (bool parts)
	Creates a FCFontInfo object with the font information about the start measure numbers.

void	GetMultipleFontInfo (FCFontInfo *pFontInfo, bool parts)
	Gets the multiple font for the measure number region.

FCFontInfo *	CreateMultipleFontInfo (bool parts)
	Creates a FCFontInfo object with the font information about the "multiple" measure numbers.

void	GetMultiMeasureFontInfo (FCFontInfo *pFontInfo, bool parts)
	Gets the font to be used for multi-measure rests.

FCFontInfo *	CreateMultiMeasureFontInfo (bool parts)
	Creates a FCFontInfo object with the font information about the multimeasure rest measure numbers.

FCString *	CreateDisplayedString (twobyte measure)
	Creates a string with the measure number as it would be displayed for the measure.

void	CloneFormattingFrom (FCMeasureNumberRegion *pRegionFrom, bool score, bool parts)
	Copies the formatting part (visual appearance + positioning) of the measure number region.

bool	IsMeasureIncluded (twobyte measureno)
	Returns true if the measure is within the measure number region.

bool	AssignAllNonNumberedMeasures (FCNumbers *pAllNonNumberedMeasures)
	Assigns a reference table for all non-numbered measures in the document.

void	_SetTempNonIncludedMeasures (FCNumbers *pNonNumberedMeasuresToUse)
	For internal use only.

void	_RestoreTempNonIncludedMeasures ()
	For internal use only.

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

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

virtual bool	Load (CMPER itemno)
	Loads the indicated item.

bool	Reload () override
	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.

virtual bool	DeepSaveAs (CMPER itemno)
	Saves the data under another item number, but also makes a deep copy of the object.

bool	DeepDeleteData () override
	Deletes the data and all related data available in other data structures.

virtual bool	SaveNew ()
	Creates the data as completely new item number. The object will now be connected to the new item number.

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.

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

bool	LoadFirst () override
	Loads the first element of 1-based data.

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.

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 EXTAG	Tag () const =0
	The Enigma tag for the derived class.

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	LoadLast ()
	Loads the very last element in the database, if any.

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

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

bool	RelinkToCurrentView ()
	Relinks the contents in the current view so that the score and part(s) match.

bool	RelinkToScore ()
	Relinks all parts to the contents of the score.

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

void	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

The class for a measure number region.

Member Enumeration Documentation

◆ MNALIGNMENTS

enum FCMeasureNumberRegion::MNALIGNMENTS

The measure number alignment values.

Lua-supported.

Enumerator
MNALIGN_LEFT	Left alignment
MNALIGN_CENTER	Centered
MNALIGN_RIGHT	Right aligned

◆ MNJUSTIFICATIONS

enum FCMeasureNumberRegion::MNJUSTIFICATIONS

The measure number justification values.

Lua-supported.

Enumerator
MNJUSTIFY_LEFT	Left justified
MNJUSTIFY_CENTER	Center justified
MNJUSTIFY_RIGHT	Right justified

◆ NUMBERINGSTYLE

enum FCMeasureNumberRegion::NUMBERINGSTYLE

Numbering styles for measure numbers.

All these can be returned by GetNumberingStyle().

All and NUMBERING_CUSTOM can be used by SetNumberingStyle().

Lua-supported.

Enumerator
NUMBERING_DIGITS	"1, 2, 3, 4"
NUMBERING_LOWERCASEDOUBLE	"a, b, c...aa, bb, cc"
NUMBERING_UPPERCASEDOUBLE	"A, B, C...AA, BB, CC"
NUMBERING_LOWERCASE	"a, b, c...aa, ab, ac"
NUMBERING_UPPERCASE	"A, B, C...AA, AB, AC"
NUMBERING_TIME_SECONDS	Time stamp numbering - Use time in whole seconds
NUMBERING_TIME_10	Time stamp numbering - Use time in 1/10 of a second
NUMBERING_TIME_100	Time stamp numbering - Use time in 1/100 of a second
NUMBERING_TIME_1000	Time stamp numbering - Use time in 1/1000 of a second
NUMBERING_FRAMES	Time stamp numbering - Use frames
NUMBERING_CUSTOM	Custom numbering

◆ NUMBERVIEWS

enum FCMeasureNumberRegion::NUMBERVIEWS

The number views where the region should show.

Lua-supported.

Enumerator
NUMBERVIEW_ALL	Show in all views
NUMBERVIEW_PAGEONLY	Show in Page View only
NUMBERVIEW_SCROLLONLY	Show in Scroll/Studio View only

Constructor & Destructor Documentation

◆ FCMeasureNumberRegion()

FCMeasureNumberRegion::FCMeasureNumberRegion ( )

The constructor.

Lua-supported.

Member Function Documentation

◆ _RestoreTempNonIncludedMeasures()

void FCMeasureNumberRegion::_RestoreTempNonIncludedMeasures ( )

inline

For internal use only.

See _SetTempAllMeasures() docs.

◆ _SetTempNonIncludedMeasures()

void FCMeasureNumberRegion::_SetTempNonIncludedMeasures ( FCNumbers * pNonNumberedMeasuresToUse )

inline

For internal use only.

_SetTempNonIncludedMeasures()+_RestoreTempNonIncludedMeasures() are used by FCMeasureNumberRegions as a mechanism to temporarily set a collection of all measures for a FCMeasureNumberRegions object.

Since FCMeasureNumberRegions can't claim ownership over the FCMeasure collection in another object, this approach is used instead.

_SetTempNonIncludedMeasures() and _RestoreTempNonIncludedMeasures() must ALWAYS appear in pairs around the method call.

◆ AssignAllNonNumberedMeasures()

bool FCMeasureNumberRegion::AssignAllNonNumberedMeasures ( FCNumbers * pAllNonNumberedMeasures )

Assigns a reference table for all non-numbered measures in the document.

Use this method to provide accurate calculation of the displayed measure number strings in the document. The reference table is used to check the "Include in measure number regions" setting.

This function replaces AssignAllMeasures in versions before v0.54.

Lua-supported.

Parameters

pAllNonNumberedMeasures A pointer to a collection containing all 1-based measures that don't have measure numbering.

Returns: True on success.

◆ ClassName()

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

◆ CloneFormattingFrom()

void FCMeasureNumberRegion::CloneFormattingFrom	(	FCMeasureNumberRegion *	pRegionFrom,
		bool	score,
		bool	parts )

Copies the formatting part (visual appearance + positioning) of the measure number region.

Parameters

pRegionFrom	Source measure number region to retrieve data from.
score	Copy to score formatting data.
parts	Copy to parts formatting data. If the source uses score info for parts, the source's score data will be copied.

Todo: Implement pre-2010 FCMeasureNumberRegion::CloneFormattingFrom()

◆ CreateDisplayedString()

FCString * FCMeasureNumberRegion::CreateDisplayedString ( twobyte measure )

Creates a string with the measure number as it would be displayed for the measure.

If the document contains measures that shouldn't be included for measure numbering, use AssignAllNonNumberedMeasures() prior to calling this method.

Lua-supported (0.55)

Parameters

measure The 1-based measure number.

Returns: The pointer to a created string object. This must be destroyed after use. If the measure number is out of range for the region, NULL is returned.

◆ CreateMultiMeasureFontInfo()

FCFontInfo * FCMeasureNumberRegion::CreateMultiMeasureFontInfo ( bool parts )

inline

Creates a FCFontInfo object with the font information about the multimeasure rest measure numbers.

The caller is responsible to delete the created object from the heap after use.

Lua-supported.

Parameters

parts If true, gets the parts font (for Finale 2010 and above). If false, gets the score font.

Returns: Pointer to a FCFontInfo object.

◆ CreateMultipleFontInfo()

FCFontInfo * FCMeasureNumberRegion::CreateMultipleFontInfo ( bool parts )

inline

Creates a FCFontInfo object with the font information about the "multiple" measure numbers.

The caller is responsible to delete the created object from the heap after use.

Lua-supported.

Parameters

parts If true, gets the parts font (for Finale 2010 and above). If false, gets the score font.

Returns: Pointer to a FCFontInfo object.

◆ CreateStartFontInfo()

FCFontInfo * FCMeasureNumberRegion::CreateStartFontInfo ( bool parts )

inline

Creates a FCFontInfo object with the font information about the start measure numbers.

The caller is responsible to delete the created object from the heap after use.

Lua-supported.

Parameters

parts If true, gets the parts font (for Finale 2010 and above). If false, gets the score font.

Returns: Pointer to a FCFontInfo object.

◆ DebugDump()

void FCMeasureNumberRegion::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 __FCNoInciOther.

◆ GetBase()

twobyte FCMeasureNumberRegion::GetBase ( ) const

Returns the number base.

Used for custom measure number styles. For most numbering cases, this method isn't required, since it can be handled automatically by the GetNumberingStyle method.

Lua-supported.

Returns: 10 for decimal digits, 26 for letters.

◆ GetBreakMultiMeasureRests()

bool FCMeasureNumberRegion::GetBreakMultiMeasureRests ( bool parts )

Returns true if multiple measure numbers should break multi-measure rests.

Lua-supported.

◆ GetClassID()

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

◆ GetCountFromOne()

bool FCMeasureNumberRegion::GetCountFromOne ( ) const

Returns true if the numbering model starts with 1 (numbers) or 0 (letters).

Used for custom measure number styles. For most numbering cases, this method isn't required, since it can be handled automatically by the GetNumberingStyle method.

Lua-supported.

Returns: The number index where the counting should start. 1 - numbers 0 - letters.

◆ GetDisplayedNumber()

bool FCMeasureNumberRegion::GetDisplayedNumber	(	eMeas	number,
		FCString *	pString )

Formats the displayed number for a measure (without prefix/suffix)

If the document contains measures that shouldn't be included for measure numbering, use AssignAllNonNumberedMeasures() prior to calling this method.

Parameters

number	The 1-based measure number
pString	Pointer to the FCString object that should contain the information. This cannot be NULL.

Returns: True if successful. False if the number is out of range, or if the target string object is NULL.

◆ GetDisplayedNumberWithID()

bool FCMeasureNumberRegion::GetDisplayedNumberWithID	(	eMeas	number,
		FCString *	pString )

Formats the displayed number for a measure, with the region ID.

Instead of a string with a syntax like "10", this method would create a string with a syntax like "1:10".

If the document contains measures that shouldn't be included for measure numbering, use AssignAllNonNumberedMeasures() prior to calling this method.

Parameters

number	The 1-based measure number
pString	Pointer to the FCString object that should contain the information.

Returns: True if successful. False if the number is out of range.

◆ GetDoubleUp()

bool FCMeasureNumberRegion::GetDoubleUp ( ) const

Returns true if the numbering model is a "double up" (a, b, c, .... aa, bb, cc, etc)

The double-up affects what happens after the counter wraps around. For letters, a double-up sequence would be: a,b,c,....z,aa,bb,cc,dd,...zz,aaa,bbb,ccc...

Used for custom measure number styles. For most numbering cases, this method isn't required, since it can be handled automatically by the GetNumberingStyle method.

Lua-supported.

Returns: If true for letters, a double-up sequence would be: a,b,c,....z,aa,bb,cc,dd,...zz,aaa,bbb,ccc...

◆ GetEnclosureMultiple()

FCEnclosure * FCMeasureNumberRegion::GetEnclosureMultiple ( bool parts )

inline

Gets the pointer to the multiple enclosure object. This object is a part of the measure number region and should not be saved separately.

In, C++ this pointer should not be freed.

Lua-supported.

Parameters

parts If true, gets the multiple enclosure for parts. If false, gets the score enclosure.

◆ GetEnclosureStart()

FCEnclosure * FCMeasureNumberRegion::GetEnclosureStart ( bool parts )

inline

Gets the pointer to the start enclosure object. This object is a part of the measure number region and should not be saved separately.

In C++, this pointer should not be freed.

Lua-supported.

Parameters

parts If true, gets the parts enclosure. If false, gets the score enclosure.

◆ GetEndMeasure()

twobyte FCMeasureNumberRegion::GetEndMeasure ( ) const

Returns the end measure of the measure number region.

Lua-supported (also as property).

◆ GetExcludeOtherStaves()

bool FCMeasureNumberRegion::GetExcludeOtherStaves ( bool parts )

Returns true if measure numbers should be excluded on other staves.

This method always returns false on pre-2010 versions.

Lua-supported.

◆ GetHideFirstNumber()

bool FCMeasureNumberRegion::GetHideFirstNumber ( bool parts )

Returns true if the first number in the measure number region should be hidden.

Lua-supported.

◆ GetID()

twobyte FCMeasureNumberRegion::GetID ( )

Returns the unique measure number region ID.

Returns: The 1-based unique ID for the region.

◆ GetMultiMeasureAlignment()

FCMeasureNumberRegion::MNALIGNMENTS FCMeasureNumberRegion::GetMultiMeasureAlignment ( bool parts )

Returns the alignment for multimeasure rest measure numbers.

Returns: Any of the MNALIGN_ constants.

◆ GetMultiMeasureBracketLeft()

eUniChar32 FCMeasureNumberRegion::GetMultiMeasureBracketLeft ( bool parts )

Returns the left-side range bracket character for multimeasure rest ranges.

Lua-supported.

Returns: Always 0 on Finale versions earlier than 2010.

◆ GetMultiMeasureBracketRight()

eUniChar32 FCMeasureNumberRegion::GetMultiMeasureBracketRight ( bool parts )

Returns the right-side range bracket character for multimeasure rest ranges.

Lua-supported.

Returns: Always 0 on Finale versions earlier than 2010.

◆ GetMultiMeasureFontInfo()

void FCMeasureNumberRegion::GetMultiMeasureFontInfo	(	FCFontInfo *	pFontInfo,
		bool	parts )

Gets the font to be used for multi-measure rests.

This method does nothing if run of pre-Finale2010 systems.

Lua-supported.

Parameters

pFontInfo	Pointer to the font information object.
parts	If true, gets the parts multi-measure font. If false, gets the score multi-measure font.

◆ GetMultiMeasureHorizontalPosition()

twobyte FCMeasureNumberRegion::GetMultiMeasureHorizontalPosition ( bool parts )

Returns the horizontal position of for multimeasure rests.

Lua-supported.

◆ GetMultiMeasureJustification()

FCMeasureNumberRegion::MNJUSTIFICATIONS FCMeasureNumberRegion::GetMultiMeasureJustification ( bool parts )

Returns the justifications for multimeasure rest measure numbers.

Returns: Any of the MNJUSTI_ constants.

◆ GetMultiMeasureVerticalPosition()

twobyte FCMeasureNumberRegion::GetMultiMeasureVerticalPosition ( bool parts )

Returns the vertical position of for multimeasure rests.

Lua-supported.

◆ GetMultipleAlignment()

FCMeasureNumberRegion::MNALIGNMENTS FCMeasureNumberRegion::GetMultipleAlignment ( bool parts )

Returns the alignment for "multiple" measure numbers.

Returns: Any of the MNALIGN_ constants.

◆ GetMultipleFontInfo()

void FCMeasureNumberRegion::GetMultipleFontInfo	(	FCFontInfo *	pFontInfo,
		bool	parts )

Gets the multiple font for the measure number region.

This method does nothing if run of pre-Finale2010 systems.

Lua-supported.

Parameters

pFontInfo	Pointer to the font information object.
parts	If true, gets the parts "multiple" font. If false, gets the score "multiple" font.

◆ GetMultipleHorizontalPosition()

twobyte FCMeasureNumberRegion::GetMultipleHorizontalPosition ( bool parts )

Returns the default horizontal position for the multiple numbers.

Lua-supported.

◆ GetMultipleJustification()

FCMeasureNumberRegion::MNJUSTIFICATIONS FCMeasureNumberRegion::GetMultipleJustification ( bool parts )

Returns the justifications for "multiple" measure numbers.

Returns: Any of the MNJUSTI_ constants.

◆ GetMultipleStartMeasure()

twobyte FCMeasureNumberRegion::GetMultipleStartMeasure ( bool parts )

Returns the "Show on every" value for multiple measure numbers.

Lua-supported.

◆ GetMultipleValue()

twobyte FCMeasureNumberRegion::GetMultipleValue ( bool parts )

Returns the "Show on every" value for multiple measure numbers.

Lua-supported.

◆ GetMultipleVerticalPosition()

twobyte FCMeasureNumberRegion::GetMultipleVerticalPosition ( bool parts )

Returns the default vertical position for the multiple numbers.

Lua-supported.

◆ GetNoZero()

bool FCMeasureNumberRegion::GetNoZero ( ) const

Returns if no zero should be used.

Used for custom measure number styles. For most numbering cases, this method isn't required, since it can be handled automatically by the GetNumberingStyle method.

Lua-supported.

Returns: For letter numbering, this would typically be the reverse of the double-up value.

◆ GetNumberingStyle()

FCMeasureNumberRegion::NUMBERINGSTYLE FCMeasureNumberRegion::GetNumberingStyle ( ) const

Returns the numbering style.

Lua-supported (also as property).

Returns: Any of the NUMBERING_ constants.

◆ GetPrefix()

void FCMeasureNumberRegion::GetPrefix ( FCString * pString )

Copies the prefix string to a FCString object.

Lua-supported.

Parameters

pString The FCString object that should contain the prefix. This cannot not be NULL.

◆ GetShowMultiMeasureRange()

bool FCMeasureNumberRegion::GetShowMultiMeasureRange ( bool parts )

Returns true if the measure range should be displayed for multimeasure rests.

Lua-supported.

Returns: Always false on Finale versions earlier than Finale 2010.

◆ GetShowMultiples()

bool FCMeasureNumberRegion::GetShowMultiples ( bool parts )

Returns true if repeated numbered sequences are used.

Lua-supported.

◆ GetShowOnBottomStaff()

bool FCMeasureNumberRegion::GetShowOnBottomStaff ( bool parts )

Returns true if bottom staff should show a measure number.

Lua-supported.

◆ GetShowOnMultiMeasureRests()

bool FCMeasureNumberRegion::GetShowOnMultiMeasureRests ( bool parts )

Returns true if the measure numbers should show on multimeasure rests.

Lua-supported.

Returns: Always false on Finale versions earlier than Finale 2010.

◆ GetShowOnSystemStart()

bool FCMeasureNumberRegion::GetShowOnSystemStart ( bool parts )

Returns true if the system start should show a measure number.

Lua-supported.

◆ GetShowOnTopStaff()

bool FCMeasureNumberRegion::GetShowOnTopStaff ( bool parts )

Returns true if top staff should show a measure number.

Lua-supported.

◆ GetStartAlignment()

FCMeasureNumberRegion::MNALIGNMENTS FCMeasureNumberRegion::GetStartAlignment ( bool parts )

Returns the alignment for start measure numbers.

Returns: Any of the MNALIGN_ constants.

◆ GetStartCharacter()

eUniChar32 FCMeasureNumberRegion::GetStartCharacter ( ) const

Gets the base character.

On Finale 2012 and above, this is a Unicode character.

Used for custom measure number styles. For most numbering cases, this method isn't required, since it can be handled automatically by the GetNumberingStyle method.

Lua-supported.

Returns: '0' for decimal digits, 'a' or 'A' for letters.

◆ GetStartFontInfo()

void FCMeasureNumberRegion::GetStartFontInfo	(	FCFontInfo *	pFontInfo,
		bool	parts )

Gets the start font for the measure number region.

When run on Finale versions earlier than 2010, it will be used to just set the main font.

Lua-supported.

Parameters

pFontInfo	Pointer to the font information object.
parts	If true, gets the parts font (for Finale 2010 and above). If false, gets the score font.

◆ GetStartHorizontalPosition()

twobyte FCMeasureNumberRegion::GetStartHorizontalPosition ( bool parts )

Returns the default horizontal position for start numbers.

Lua-supported.

◆ GetStartJustification()

FCMeasureNumberRegion::MNJUSTIFICATIONS FCMeasureNumberRegion::GetStartJustification ( bool parts )

Returns the justifications for start measure numbers.

Returns: Any of the MNJUSTI_ constants.

◆ GetStartMeasure()

twobyte FCMeasureNumberRegion::GetStartMeasure ( ) const

Returns the start measure of the measure number region.

Lua-supported (also as property).

◆ GetStartNumber()

twobyte FCMeasureNumberRegion::GetStartNumber ( ) const

Returns the measure region's starting number (for display).

Lua-supported (also as property).

Returns: 1-based offset value. Even if it's a non-numeric format, it's 1-based (A = 1, B = 2, etc).

◆ GetStartVerticalPosition()

twobyte FCMeasureNumberRegion::GetStartVerticalPosition ( bool parts )

Returns the default vertical position for start numbers.

Lua-supported.

◆ GetSuffix()

void FCMeasureNumberRegion::GetSuffix ( FCString * pString )

Gets the suffix string.

Lua-supported.

Parameters

pString The FCString object that should contain the suffix. This cannot not be NULL.

◆ GetTime()

bool FCMeasureNumberRegion::GetTime ( ) const

Returns true if a time mode is used.

A time mode will either displaying the time or the frame, dependent on the GetTimeFrames() return value.

◆ GetTimeFrames()

bool FCMeasureNumberRegion::GetTimeFrames ( ) const

Returns true if "frames" for time measure numbers.

The return value makes sense only if the GetTime() returns true.

◆ GetTimePrecision()

twobyte FCMeasureNumberRegion::GetTimePrecision ( ) const

Returns the time precision, for the time modes that aren't based on frames.

Returns: The number of decimals for the precision. 0 means whole seconds.

◆ GetUseEnclosureMultiple()

bool FCMeasureNumberRegion::GetUseEnclosureMultiple ( bool parts )

Returns true if "multiple" measure numbers should use the enclosure data.

Lua-supported.

◆ GetUseEnclosureStart()

bool FCMeasureNumberRegion::GetUseEnclosureStart ( bool parts )

Returns true if start measure numbers should use the enclosure data.

This method always returns false on pre-2010 versions.

Lua-supported.

◆ GetUseHours()

bool FCMeasureNumberRegion::GetUseHours ( ) const

Returns if time measure numbers should include hours.

The return value makes sense only if the GetTime() returns true.

Lua-supported.

◆ GetUseScoreInfoForParts()

bool FCMeasureNumberRegion::GetUseScoreInfoForParts ( ) const

Returns true if parts should use the score information section of the measure number region appearance.

If run on versions earlier than Finale 2010, this method will always return true.

Lua-supported (also as property).

Returns: True - parts should use the settings for the score.

◆ GetView()

FCMeasureNumberRegion::NUMBERVIEWS FCMeasureNumberRegion::GetView ( ) const

Returns the view where the number region should show.

Returns: Any of the NUMBERVIEW_ constants. On versions lower than Finale 2010, NUMBERVIEW_ALL is always returned.

◆ IsMeasureIncluded()

bool FCMeasureNumberRegion::IsMeasureIncluded ( twobyte measureno )

inline

Returns true if the measure is within the measure number region.

Lua-supported.

Parameters

measureno The measure number (1-based)

Returns: True if the measure appears in the measure number region.

◆ SetBase()

void FCMeasureNumberRegion::SetBase ( twobyte base )

Sets the base for the measure numbering style.

Used for custom measure number styles. For most numbering cases, this method isn't required, since it can be handled automatically by the GetNumberingStyle method.

Lua-supported.

Parameters

base	For numbers, this value is 10. For letters, this value is 26.

◆ SetBreakMultiMeasureRests()

void FCMeasureNumberRegion::SetBreakMultiMeasureRests	(	bool	breakstate,
		bool	parts )

Sets if "multiple" measure numbers should break multimeasure rests or not.

This method does nothing on Finale versions earlier than 2010.

Lua-supported.

Parameters

breakstate	True - break multimeasure rests. False - don't break.
parts	If true, set the parts info. If false, set the score info.

◆ SetCountFromOne()

void FCMeasureNumberRegion::SetCountFromOne ( bool value )

Sets if the measuring should start from one instead of zero.

This is typically set for numbers.

Used for custom measure number styles. For most numbering cases, this method isn't required, since it can be handled automatically by the GetNumberingStyle method.

Lua-supported.

Parameters

value For letters, 0 is used for base. For numbers, 1 is used as base.

◆ SetDoubleUp()

void FCMeasureNumberRegion::SetDoubleUp ( bool value )

Sets if the double-up (=duplicating the first character) style should be used or not.

The double-up affects what happens after the counter wraps around. For letters, a double-up sequence would be: a,b,c,....z,aa,bb,cc,dd,...zz,aaa,bbb,ccc...

Used for custom measure number styles. For most numbering cases, this method isn't required, since it can be handled automatically by the GetNumberingStyle method.

Lua-supported.

Parameters

value For letters, true would produce: a,b,c,....z,aa,bb,cc,dd,...zz,aaa,bbb,ccc...

◆ SetEndMeasure()

void FCMeasureNumberRegion::SetEndMeasure ( twobyte measure )

Sets the end measure for the measure number region.

Lua-supported (also as property).

Parameters

measure The 1-based end measure number (inclusive).

◆ SetExcludeOtherStaves()

void FCMeasureNumberRegion::SetExcludeOtherStaves	(	bool	exclude,
		bool	parts )

Sets if the numbers should be excluded on other staves.

Lua-supported.

Parameters

exclude	If true, exclude numering on other staves.
parts	If true, sets the parts' flag. If false, sets the score's flag.

◆ SetHideFirstNumber()

void FCMeasureNumberRegion::SetHideFirstNumber	(	bool	hide,
		bool	parts )

Sets if the first occurence should be hidden or not.

Lua-supported.

Parameters

hide	If set, hide first number in region.
parts	If true, set the parts info. If false, set the score info.

◆ SetMultiMeasureAlignment()

void FCMeasureNumberRegion::SetMultiMeasureAlignment	(	MNALIGNMENTS	alignment,
		bool	parts )

Sets the alignment for multimeasure measure numbers.

Parameters

alignment	Any of the MNALIGN_ constants.
parts	If true, set the parts info. If false, set the score info.

◆ SetMultiMeasureBracketLeft()

void FCMeasureNumberRegion::SetMultiMeasureBracketLeft	(	eUniChar32	character,
		bool	parts )

Sets the left-side range bracket character for multimeasure rest ranges.

This method does nothing on Finale versions earlier than 2010.

Lua-supported.

Parameters

character	The left-side bracket character.
parts	If true, set the parts info. If false, set the score info.

◆ SetMultiMeasureBracketRight()

void FCMeasureNumberRegion::SetMultiMeasureBracketRight	(	eUniChar32	character,
		bool	parts )

Sets the right-side range bracket character for multimeasure rest ranges.

This method does nothing on Finale versions earlier than 2010.

Lua-supported.

Parameters

character	The right-side bracket character.
parts	If true, set the parts info. If false, set the score info.

◆ SetMultiMeasureFontInfo()

void FCMeasureNumberRegion::SetMultiMeasureFontInfo	(	FCFontInfo *	pFontInfo,
		bool	parts )

Sets the font to be used for multi-measure rests.

This method does nothing if run of pre-Finale2010 systems.

Lua-supported.

Parameters

pFontInfo	Pointer to the font information object.
parts	If true, sets the parts' multi-measure font. If false, sets the score's multi-measure font.

◆ SetMultiMeasureHorizontalPosition()

void FCMeasureNumberRegion::SetMultiMeasureHorizontalPosition	(	twobyte	distance,
		bool	parts )

Sets the horizontal position of multimeasure rest numbers.

Lua-supported.

Parameters

distance	The default horizontal position, in EVPUs.
parts	If true, set the parts info. If false, set the score info.

◆ SetMultiMeasureJustification()

void FCMeasureNumberRegion::SetMultiMeasureJustification	(	MNJUSTIFICATIONS	justification,
		bool	parts )

Sets the justification for the start measure numbers.

Parameters

justification	Any of the MNJUSTI_ constants.
parts	If true, set the parts info. If false, set the score info.

◆ SetMultiMeasureVerticalPosition()

void FCMeasureNumberRegion::SetMultiMeasureVerticalPosition	(	twobyte	distance,
		bool	parts )

Sets the vertical position of multimeasure rest numbers.

Lua-supported.

Parameters

distance	The default vertical position, in EVPUs.
parts	If true, set the parts info. If false, set the score info.

◆ SetMultipleAlignment()

void FCMeasureNumberRegion::SetMultipleAlignment	(	MNALIGNMENTS	alignment,
		bool	parts )

Sets the alignment for "multiple" measure numbers.

Parameters

alignment	Any of the MNALIGN_ constants.
parts	If true, set the parts info. If false, set the score info.

◆ SetMultipleFontInfo()

void FCMeasureNumberRegion::SetMultipleFontInfo	(	FCFontInfo *	pFontInfo,
		bool	parts )

Sets the multiple font for the measure number region.

This method does nothing if run of pre-Finale2010 systems.

Lua-supported.

Parameters

pFontInfo	Pointer to the font information object.
parts	If true, sets the parts' "multiple" font. If false, sets the score "multiple" font.

◆ SetMultipleHorizontalPosition()

void FCMeasureNumberRegion::SetMultipleHorizontalPosition	(	twobyte	distance,
		bool	parts )

Sets the horizontal position of multiple numbers.

Lua-supported.

Parameters

distance	The default horizontal position, in EVPUs.
parts	If true, set the parts info. If false, set the score info.

◆ SetMultipleJustification()

void FCMeasureNumberRegion::SetMultipleJustification	(	MNJUSTIFICATIONS	justification,
		bool	parts )

Sets the justification for the "multiple" measure numbers.

Parameters

justification	Any of the MNJUSTI_ constants.
parts	If true, set the parts info. If false, set the score info.

◆ SetMultipleStartMeasure()

void FCMeasureNumberRegion::SetMultipleStartMeasure	(	twobyte	measure,
		bool	parts )

Sets the "Show on every" start value for multiple measure numbers.

Lua-supported.

Parameters

[in]	measure	The 1-based start value for "Show on every" measure numbering.
[in]	parts	If true, set the parts info. If false, set the score info.

◆ SetMultipleValue()

void FCMeasureNumberRegion::SetMultipleValue	(	twobyte	value,
		bool	parts )

Sets the "Show on every" value for multiple measure numbers.

Lua-supported.

Parameters

value	The "show on every" value. Example: 5 would display measure numbers every 5th bar.
parts	If true, set the parts info. If false, set the score info.

◆ SetMultipleVerticalPosition()

void FCMeasureNumberRegion::SetMultipleVerticalPosition	(	twobyte	distance,
		bool	parts )

Sets the vertical position of multiple numbers.

Lua-supported.

Parameters

distance	The default vertical position, in EVPUs.
parts	If true, set the parts info. If false, set the score info.

◆ SetNoZero()

void FCMeasureNumberRegion::SetNoZero ( bool value )

Sets if no zero should be used.

Used for custom measure number styles. For most numbering cases, this method isn't required, since it can be handled automatically by the GetNumberingStyle method.

Lua-supported.

Parameters

value For letter numbering, this should typically be the reverse of the double-up value.

◆ SetNumberingStyle()

void FCMeasureNumberRegion::SetNumberingStyle ( NUMBERINGSTYLE style )

Sets the numbering style.

Lua-supported (also as property).

Parameters

style Any of the NUMBERING_ constants.

◆ SetPrefix()

void FCMeasureNumberRegion::SetPrefix ( FCString * pString )

Sets the prefix string.

Lua-supported.

◆ SetShowMultiMeasureRange()

void FCMeasureNumberRegion::SetShowMultiMeasureRange	(	bool	show,
		bool	parts )

Sets if the measure range should be displayed for multimeasure rests or not.

This will do nothing on Finale versions earlier than Finale 2010.

Lua-supported.

Parameters

show	If set, show the multi-measure rest ranges in the region.
parts	If true, set the parts info. If false, set the score info.

◆ SetShowMultiples()

void FCMeasureNumberRegion::SetShowMultiples	(	bool	showmultiples,
		bool	parts )

Sets if the "multiple" numbering should be used or not.

Lua-supported.

Parameters

showmultiples	If true, use "multiple" numbering.
parts	If true, set the parts info. If false, set the score info.

◆ SetShowOnBottomStaff()

void FCMeasureNumberRegion::SetShowOnBottomStaff	(	bool	showonbottom,
		bool	parts )

Sets if the measure number should be displayed on the bottom staff or not.

Lua-supported.

Parameters

showonbottom	If true, show number on bottom staff.
parts	If true, set the parts info. If false, set the score info.

◆ SetShowOnMultiMeasureRests()

void FCMeasureNumberRegion::SetShowOnMultiMeasureRests	(	bool	show,
		bool	parts )

Sets if the measure numbers should show on multimeasure rests.

This method will do nothing on Finale versions earlier than Finale 2010.

Lua-supported.

Parameters

show	If set, show measure numbers at multi-measure rests.
parts	If true, set the parts info. If false, set the score info.

◆ SetShowOnSystemStart()

void FCMeasureNumberRegion::SetShowOnSystemStart	(	bool	showonstart,
		bool	parts )

Sets if the measure number should be shown on system starts or not.

Lua-supported.

Parameters

showonstart	If true, show measure number on system starts.
parts	If true, set the parts info. If false, set the score info.

◆ SetShowOnTopStaff()

void FCMeasureNumberRegion::SetShowOnTopStaff	(	bool	showontop,
		bool	parts )

Sets if the measure number should be shown on top staff or not.

Lua-supported.

Parameters

showontop	If true, show on top staff.
parts	If true, set the parts info. If false, set the score info.

◆ SetStartAlignment()

void FCMeasureNumberRegion::SetStartAlignment	(	MNALIGNMENTS	alignment,
		bool	parts )

Sets the alignment for start measure numbers.

Parameters

alignment	Any of the MNALIGN_ constants.
parts	If true, set the parts info. If false, set the score info.

◆ SetStartCharacter()

void FCMeasureNumberRegion::SetStartCharacter ( eUniChar32 character )

Sets the starting character of the measure numbering style.

On Finale 2012 and above, this is a Unicode character.

Used for custom measure number styles. For most numbering cases, this method isn't required, since it can be handled automatically by the GetNumberingStyle method.

Lua-supported.

Parameters

character '0' for digits. 'a' or 'A' for letters.

◆ SetStartFontInfo()

void FCMeasureNumberRegion::SetStartFontInfo	(	FCFontInfo *	pFontInfo,
		bool	parts )

Sets the start font for the measure number region.

When run on Finale versions earlier than 2010, it will be used to just set the main font.

Lua-supported.

Parameters

pFontInfo	Pointer to the font information object.
parts	If true, sets the parts' font (for Finale 2010 and above). If false, sets the score font.

◆ SetStartHorizontalPosition()

void FCMeasureNumberRegion::SetStartHorizontalPosition	(	twobyte	distance,
		bool	parts )

Sets the default horizontal position of start numbers.

Lua-supported.

Parameters

distance	The default horizontal position, in EVPUs.
parts	If true, set the parts info. If false, set the score info.

◆ SetStartJustification()

void FCMeasureNumberRegion::SetStartJustification	(	MNJUSTIFICATIONS	justification,
		bool	parts )

Sets the justification for the start measure numbers.

Parameters

justification	Any of the MNJUSTI_ constants.
parts	If true, set the parts info. If false, set the score info.

◆ SetStartMeasure()

void FCMeasureNumberRegion::SetStartMeasure ( twobyte measure )

Sets the start measure for the measure number region.

Lua-supported (also as property).

Parameters

measure The 1-based start measure number.

◆ SetStartNumber()

void FCMeasureNumberRegion::SetStartNumber ( twobyte offset )

Sets the start measure for the measure number region.

Lua-supported (also as property).

Parameters

offset 1-based offset value. Even if it's a non-numeric format, it's 1-based (A = 1, B = 2, etc).

◆ SetStartVerticalPosition()

void FCMeasureNumberRegion::SetStartVerticalPosition	(	twobyte	distance,
		bool	parts )

Sets the default vertical position of start numbers.

Lua-supported.

Parameters

distance	The default vertical position, in EVPUs.
parts	If true, set the parts info. If false, set the score info.

◆ SetSuffix()

void FCMeasureNumberRegion::SetSuffix ( FCString * pString )

Sets the suffix string.

Lua-supported.

◆ SetTime()

void FCMeasureNumberRegion::SetTime ( bool state )

Sets if a time mode is used.

A time mode will either displaying the time or the frame, dependent on the GetTimeFrames() return value.

◆ SetTimeFrames()

void FCMeasureNumberRegion::SetTimeFrames ( bool state )

Returns true if "frames" for time measure numbers.

The return value makes sense only if the GetTime() returns true.

◆ SetTimePrecision()

void FCMeasureNumberRegion::SetTimePrecision ( twobyte precision )

Sets the time precision, for the time modes that aren't based on frames.

Parameters

precision The number of decimals for the precision. 0 means whole seconds.

◆ SetUseEnclosureMultiple()

void FCMeasureNumberRegion::SetUseEnclosureMultiple	(	bool	use,
		bool	parts )

Sets if enclosures should be used for multiple numbers.

Lua-supported.

Parameters

use	If true, use enclosure data.
parts	If true, sets the parts' flag. If false, sets the score's flag.

◆ SetUseEnclosureStart()

void FCMeasureNumberRegion::SetUseEnclosureStart	(	bool	use,
		bool	parts )

Sets if enclosures should be used for start numbers.

This method does nothing if run of pre-Finale2010 systems.

Lua-supported.

Parameters

use	If true, use enclosure data.
parts	If true, sets the parts' flag. If false, sets the score's flag.

◆ SetUseHours()

void FCMeasureNumberRegion::SetUseHours ( bool state )

Returns if time measure numbers should include hours.

The return value makes sense only if the GetTime() returns true.

Lua-supported.

◆ SetUseScoreInfoForParts()

void FCMeasureNumberRegion::SetUseScoreInfoForParts ( bool value )

Sets if parts should use the score information section of the measure number region appearance.

Lua-supported (also as property).

◆ SetView()

void FCMeasureNumberRegion::SetView ( NUMBERVIEWS view )

Sets the view where the region should show.

This method does nothin on Finale versions lower than Finale 2010.

Parameters

view	Any of the NUMBERVIEW_ constants.

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ MNALIGNMENTS

◆ MNJUSTIFICATIONS

◆ NUMBERINGSTYLE

◆ NUMBERVIEWS

Constructor & Destructor Documentation

◆ FCMeasureNumberRegion()

Member Function Documentation

◆ _RestoreTempNonIncludedMeasures()

◆ _SetTempNonIncludedMeasures()

◆ AssignAllNonNumberedMeasures()

◆ ClassName()

◆ CloneFormattingFrom()

◆ CreateDisplayedString()

◆ CreateMultiMeasureFontInfo()

◆ CreateMultipleFontInfo()

◆ CreateStartFontInfo()

◆ DebugDump()

◆ GetBase()

◆ GetBreakMultiMeasureRests()

◆ GetClassID()

◆ GetCountFromOne()

◆ GetDisplayedNumber()

◆ GetDisplayedNumberWithID()

◆ GetDoubleUp()

◆ GetEnclosureMultiple()

◆ GetEnclosureStart()

◆ GetEndMeasure()

◆ GetExcludeOtherStaves()

◆ GetHideFirstNumber()

◆ GetID()

◆ GetMultiMeasureAlignment()

◆ GetMultiMeasureBracketLeft()

◆ GetMultiMeasureBracketRight()

◆ GetMultiMeasureFontInfo()

◆ GetMultiMeasureHorizontalPosition()

◆ GetMultiMeasureJustification()

◆ GetMultiMeasureVerticalPosition()

◆ GetMultipleAlignment()

◆ GetMultipleFontInfo()

◆ GetMultipleHorizontalPosition()

◆ GetMultipleJustification()

◆ GetMultipleStartMeasure()

◆ GetMultipleValue()

◆ GetMultipleVerticalPosition()

◆ GetNoZero()

◆ GetNumberingStyle()

◆ GetPrefix()

◆ GetShowMultiMeasureRange()

◆ GetShowMultiples()

◆ GetShowOnBottomStaff()

◆ GetShowOnMultiMeasureRests()

◆ GetShowOnSystemStart()

◆ GetShowOnTopStaff()

◆ GetStartAlignment()

◆ GetStartCharacter()

◆ GetStartFontInfo()

◆ GetStartHorizontalPosition()

◆ GetStartJustification()

◆ GetStartMeasure()

◆ GetStartNumber()

◆ GetStartVerticalPosition()

◆ GetSuffix()

◆ GetTime()

◆ GetTimeFrames()

◆ GetTimePrecision()

◆ GetUseEnclosureMultiple()

◆ GetUseEnclosureStart()

◆ GetUseHours()

◆ GetUseScoreInfoForParts()

◆ GetView()

◆ IsMeasureIncluded()

◆ SetBase()

◆ SetBreakMultiMeasureRests()

◆ SetCountFromOne()

◆ SetDoubleUp()