FCEndingRepeat Class Reference

The class for a start of repeat bracket in the document. There can only be one ending repeat in each measure. More...

#include <ff_other.h>

Inheritance diagram for FCEndingRepeat:

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.
	FCEndingRepeat ()
	The constructor.
bool	DeepDeleteData () override
	Reimplementation of DeepDeleteData(). Deletes both the basic repeat ending data and the optional repeat text.
bool	DeepSaveAs (CMPER itemno) override
	Reimplementation of DeepDeleteAs(). Saves both the basic repeat ending data and the optional repeat text.
twobyte	GetStaffListID () const
	Returns the staff list ID to be used for the text repeat assignment.
bool	GetSkipOnIgnore () const
	Returns the "Skip ending if ignoring repeats" setting.
eMeas	GetTargetMeasure () const
	Returns the target measure number.
bool	GetIndividualPositioning () const
	Returns true if the bracket has individual staff positioning enabled.
bool	GetVisible () const
	Returns true if the repeat is visible. ("Show" is checked in the context menu.)
Evpu16	GetVerticalTopBracketPosition () const
	Returns the top vertical position of the bracket.
Evpu16	GetHorizontalLeftBracketPosition () const
	Returns the horizontal position of the bracket's left side.
Evpu16	GetVerticalLeftBracketPosition () const
	Returns the vertical position of the bracket's left side.
Evpu16	GetHorizontalRightBracketPosition () const
	Returns the horizontal position of the bracket's right side.
Evpu16	GetVerticalRightBracketPosition () const
	Returns the vertical position of the bracket's right side.
Evpu16	GetHorizontalTextPosition () const
	Returns the horizontal position of the repeat text.
Evpu16	GetVerticalTextPosition () const
	Returns the vertical position of the repeat text.
FCTextRepeat::REPSHOWMODES	GetShowMode () const
	Returns where the ending repeat should be shown.
int	GetPassNumbersCount () const
	Returns the number of pass numbers available to the ending repeat.
FCTextRepeat::REPTARGETTRIGGERS	GetTargetTrigger () const
	Returns the target trigger for the ending repeat. This value also affects how the GetTargetMeasure() will be interpreted.
void	SetStaffListID (twobyte list)
	Sets the staff list ID to be used.
void	SetSkipOnIgnore (bool state)
	Returns the "Skip ending if ignoring repeats" setting.
void	SetTargetMeasure (eMeas measure)
	Returns the target measure number. The value is dependent on GetTargetTrigger(), which is set with SetTargetTrigger().
void	SetIndividualPositioning (bool state)
	Sets if the repeat bracket has individual staff positioning enabled or not.
void	SetVisible (bool state)
	Sets if the repeat is visible. ("Show" is checked in the context menu.)
void	SetVerticalTopBracketPosition (Evpu16 position)
	Sets the top vertical position of the repeat bracket.
void	SetHorizontalLeftBracketPosition (Evpu16 position)
	Sets the horizontal position of the repeat bracket's left side.
void	SetVerticalLeftBracketPosition (Evpu16 position)
	Sets the vertical position of the repeat bracket's left side.
void	SetHorizontalRightBracketPosition (Evpu16 position)
	Sets the horizontal position of the repeat bracket's right side.
void	SetVerticalRightBracketPosition (Evpu16 position)
	Sets the vertical position of the repeat bracket's right side.
void	SetHorizontalTextPosition (Evpu16 position)
	Sets the horizontal position of the repeat text.
void	SetVerticalTextPosition (Evpu16 position)
	Sets the vertical position of the repeat text.
void	SetShowMode (FCTextRepeat::REPSHOWMODES mode)
	Sets where the ending repeat should be shown.
FCString *	CreateTextString ()
	Loads the text for an ending repeat and returns it in a FCString object.
bool	SaveTextString (FCString *pString)
	Saves a FCString object for the ending repeat.
bool	GetPassNumbers (FCNumbers *pNumbers)
	Fills the pass numbers in a FCNumbers collection.
bool	SetPassNumbers (FCNumbers *pNumbers)
	Sets the pass numbers for the repeat ending.
void	SetTargetTrigger (FCTextRepeat::REPTARGETTRIGGERS value)
	Set the target trigger for the ending repeat. This method should also be combined with a SetTargetMeasure() call.
FCSeparatePlacements *	CreateSeparatePlacements ()
	Creates a FCSeparatePlacements collection and loads it with all matching independent positioning records. The created collection might be empty.
FCSeparatePlacements *	CreateTextSeparatePlacements ()
	Creates a FCSeparatePlacements collection and loads it with all matching independent positioning records. The created collection might be empty.
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	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.
void	DebugDump () override
	Outputs the class data/information for debugging purposes.
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
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...
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 start of repeat bracket in the document. There can only be one ending repeat in each measure.

Make sure to use DeepDeleteData() rather than DeleteData(). Also, use DeepSaveAs() rather than SaveAs().

An ending repeat will only display in a measure if FCMeasure::GetRepeatBracketFlag is true.

Constructor & Destructor Documentation

FCEndingRepeat()

FCEndingRepeat::FCEndingRepeat ( )

inline

The constructor.

Lua-supported.

Member Function Documentation

ClassName()

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

CreateSeparatePlacements()

FCSeparatePlacements * FCEndingRepeat::CreateSeparatePlacements

(

)

Creates a FCSeparatePlacements collection and loads it with all matching independent positioning records. The created collection might be empty.

This collection controls the positioning of the ending bracket.

The GetIndividualPositioning() must return true, otherwise the return value will be NULL.

Lua-supported.

Returns

NULL if GetIndividualPositioning() is false or on error. Otherwise, the created FCSeparatePlacements collection.

CreateTextSeparatePlacements()

FCSeparatePlacements * FCEndingRepeat::CreateTextSeparatePlacements

(

)

Creates a FCSeparatePlacements collection and loads it with all matching independent positioning records. The created collection might be empty.

This collection controls the positioning of the text in the ending repeat.

The GetIndividualPositioning() must return true, otherwise the return value will be NULL.

Lua-supported.

Returns

NULL if GetIndividualPositioning() is false or on error. Otherwise, the created FCSeparatePlacements collection.

CreateTextString()

FCString * FCEndingRepeat::CreateTextString

(

)

Loads the text for an ending repeat and returns it in a FCString object.

The caller must delete the text object from the heap.

Lua-supported.

Returns

NULL on error. Otherwise, a pointer to the FCString object.

DeepDeleteData()

bool FCEndingRepeat::DeepDeleteData ( )

overridevirtual

Reimplementation of DeepDeleteData(). Deletes both the basic repeat ending data and the optional repeat text.

Lua-supported (through inheritance).

Reimplemented from __FCNoInciOther.

DeepSaveAs()

bool FCEndingRepeat::DeepSaveAs ( CMPER itemno )

overridevirtual

Reimplementation of DeepDeleteAs(). Saves both the basic repeat ending data and the optional repeat text.

Lua-supported (through inheritance).

Reimplemented from __FCNoInciOther.

GetClassID()

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

GetHorizontalLeftBracketPosition()

Evpu16 FCEndingRepeat::GetHorizontalLeftBracketPosition ( ) const

inline

Returns the horizontal position of the bracket's left side.

Lua-supported (also as property).

GetHorizontalRightBracketPosition()

Evpu16 FCEndingRepeat::GetHorizontalRightBracketPosition ( ) const

inline

Returns the horizontal position of the bracket's right side.

Lua-supported (also as property).

GetHorizontalTextPosition()

Evpu16 FCEndingRepeat::GetHorizontalTextPosition ( ) const

inline

Returns the horizontal position of the repeat text.

Lua-supported (also as property).

GetIndividualPositioning()

bool FCEndingRepeat::GetIndividualPositioning ( ) const

inline

Returns true if the bracket has individual staff positioning enabled.

Lua-supported (also as property).

GetPassNumbers()

bool FCEndingRepeat::GetPassNumbers

(

FCNumbers *

pNumbers

)

Fills the pass numbers in a FCNumbers collection.

Lua-supported.

Parameters

pNumbers

Pointer to a FCNumbers collection that should be filled with the values.

Returns

True on success. False if the pNumbers argument is NULL.

GetPassNumbersCount()

int FCEndingRepeat::GetPassNumbersCount ( ) const

inline

Returns the number of pass numbers available to the ending repeat.

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

GetShowMode()

FCTextRepeat::REPSHOWMODES FCEndingRepeat::GetShowMode

(

)

const

Returns where the ending repeat should be shown.

Lua-supported (also as property).

Returns

Any of the REPSHOW_ constants (from FCTextRepeat).

GetSkipOnIgnore()

bool FCEndingRepeat::GetSkipOnIgnore ( ) const

inline

Returns the "Skip ending if ignoring repeats" setting.

Lua-supported (also as property).

GetStaffListID()

twobyte FCEndingRepeat::GetStaffListID ( ) const

inline

Returns the staff list ID to be used for the text repeat assignment.

Lua-supported (also as property).

Returns

If no staff list is used, 0 is returned.

GetTargetMeasure()

eMeas FCEndingRepeat::GetTargetMeasure ( ) const

inline

Returns the target measure number.

Lua-supported (also as property).

GetTargetTrigger()

FCTextRepeat::REPTARGETTRIGGERS FCEndingRepeat::GetTargetTrigger ( ) const

inline

Returns the target trigger for the ending repeat. This value also affects how the GetTargetMeasure() will be interpreted.

Returns

The FCTextRepeat::REPTARGETTRIGGERS constants. REPTARGET_NEXTENDING, REPTARGET_MEASURENUM, REPTARGET_FORWARDS and REPTARGET_NEVERSKIPENDING can be returned. REPTARGET_UNDEFINED will only be returned on internal errors.

GetVerticalLeftBracketPosition()

Evpu16 FCEndingRepeat::GetVerticalLeftBracketPosition ( ) const

inline

Returns the vertical position of the bracket's left side.

Lua-supported (also as property).

GetVerticalRightBracketPosition()

Evpu16 FCEndingRepeat::GetVerticalRightBracketPosition ( ) const

inline

Returns the vertical position of the bracket's right side.

Lua-supported (also as property).

GetVerticalTextPosition()

Evpu16 FCEndingRepeat::GetVerticalTextPosition ( ) const

inline

Returns the vertical position of the repeat text.

Lua-supported (also as property).

GetVerticalTopBracketPosition()

Evpu16 FCEndingRepeat::GetVerticalTopBracketPosition ( ) const

inline

Returns the top vertical position of the bracket.

Lua-supported (also as property).

GetVisible()

bool FCEndingRepeat::GetVisible ( ) const

inline

Returns true if the repeat is visible. ("Show" is checked in the context menu.)

This value can be overridden staff-by-staff if GetIndividualPositioning is true. See FCSeparatePlacement::GetVisible.

Lua-supported (also as property) (0.65).

SaveTextString()

bool FCEndingRepeat::SaveTextString

(

FCString *

pString

)

Saves a FCString object for the ending repeat.

There is no need to resave the ending repeat after this call to get the text change to stick.

Lua-supported.

Parameters

pString

Pointer to a FCString object that should be saved.

Returns

true on success.

SetHorizontalLeftBracketPosition()

void FCEndingRepeat::SetHorizontalLeftBracketPosition ( Evpu16 position )

inline

Sets the horizontal position of the repeat bracket's left side.

Lua-supported (also as property).

SetHorizontalRightBracketPosition()

void FCEndingRepeat::SetHorizontalRightBracketPosition ( Evpu16 position )

inline

Sets the horizontal position of the repeat bracket's right side.

Lua-supported (also as property).

SetHorizontalTextPosition()

void FCEndingRepeat::SetHorizontalTextPosition ( Evpu16 position )

inline

Sets the horizontal position of the repeat text.

Lua-supported (also as property).

SetIndividualPositioning()

void FCEndingRepeat::SetIndividualPositioning ( bool state )

inline

Sets if the repeat bracket has individual staff positioning enabled or not.

Lua-supported (also as property).

SetPassNumbers()

bool FCEndingRepeat::SetPassNumbers

(

FCNumbers *

pNumbers

)

Sets the pass numbers for the repeat ending.

The numbers will be added in the order they appear in the collection.

Lua-supported.

Parameters

pNumbers

Pointer to a FCNumbers collection, containing the numbers. All numbers must be 1 or above and there must not be any duplicates of a number.

Returns

True on success.

SetShowMode()

void FCEndingRepeat::SetShowMode

(

FCTextRepeat::REPSHOWMODES

mode

)

Sets where the ending repeat should be shown.

Lua-supported (also as property).

Parameters

mode	Any of the REPSHOW_ constants (from FCTextRepeat).

SetSkipOnIgnore()

void FCEndingRepeat::SetSkipOnIgnore ( bool state )

inline

Returns the "Skip ending if ignoring repeats" setting.

Lua-supported (also as property).

SetStaffListID()

void FCEndingRepeat::SetStaffListID ( twobyte list )

inline

Sets the staff list ID to be used.

Lua-supported (also as property).

SetTargetMeasure()

void FCEndingRepeat::SetTargetMeasure ( eMeas measure )

inline

Returns the target measure number. The value is dependent on GetTargetTrigger(), which is set with SetTargetTrigger().

Lua-supported (also as property).

SetTargetTrigger()

void FCEndingRepeat::SetTargetTrigger ( FCTextRepeat::REPTARGETTRIGGERS value )

inline

Set the target trigger for the ending repeat. This method should also be combined with a SetTargetMeasure() call.

Parameters

value

The FCTextRepeat::REPTARGETTRIGGERS constants. REPTARGET_NEXTENDING, REPTARGET_MEASURENUM, REPTARGET_FORWARDS and REPTARGET_NEVERSKIPENDING can be used.

SetVerticalLeftBracketPosition()

void FCEndingRepeat::SetVerticalLeftBracketPosition ( Evpu16 position )

inline

Sets the vertical position of the repeat bracket's left side.

Lua-supported (also as property).

SetVerticalRightBracketPosition()

void FCEndingRepeat::SetVerticalRightBracketPosition ( Evpu16 position )

inline

Sets the vertical position of the repeat bracket's right side.

Lua-supported (also as property).

SetVerticalTextPosition()

void FCEndingRepeat::SetVerticalTextPosition ( Evpu16 position )

inline

Sets the vertical position of the repeat text.

Lua-supported (also as property).

SetVerticalTopBracketPosition()

void FCEndingRepeat::SetVerticalTopBracketPosition ( Evpu16 position )

inline

Sets the top vertical position of the repeat bracket.

Lua-supported (also as property) (0.65).

SetVisible()

void FCEndingRepeat::SetVisible ( bool state )

inline

Sets if the repeat is visible. ("Show" is checked in the context menu.)

Lua-supported (also as property) (0.65).