FCTextRepeat Class Reference

Class for text repeat assignments to a measure. The assignment is connected with a FCTextRepeatDef definition. More...

#include <ff_other.h>

Inheritance diagram for FCTextRepeat:

Public Types
enum	REPSHOWMODES { REPSHOW_ALL = 0 , REPSHOW_TOPSTAFF , REPSHOW_STAFFLIST }
	Constants for use with FCTextRepeat::GetShowMode() and FCTextRepeat::SetShowMode(). More...
enum	REPTARGETTRIGGERS {   REPTARGET_UNDEFINED = 0 , REPTARGET_DEFID = 3 , REPTARGET_MEASURENUM = 1 , REPTARGET_BACKWARDS = 2 ,   REPTARGET_NEVERSKIPENDING = 5 , REPTARGET_FORWARDS = 8 , REPTARGET_NEXTENDING = 9 }
	The modes used by FCTextRepeat::GetTargetTrigger() and FCTextRepeat::SetTargetTrigger(). More...
enum	REPACTIONS {   REPACTION_NEVERJUMP = 0 , REPACTION_ALWAYSJUMP = 1 , REPACTION_JUMPONPASS = 2 , REPACTION_PLAYSECTION = 3 ,   REPACTION_STOPONPASS = 4 }
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.
	FCTextRepeat ()
	The constructor.
bool	AssignTextRepeatDef (FCTextRepeatDef *pDef)
	Assigns a saved text repeat definition to a text repeat.
FCTextRepeatDef *	CreateTextRepeatDef ()
	Creates a text repeat definition object for the text repeat.
FCSeparatePlacements *	CreateSeparatePlacements ()
	Creates a FCSeparatePlacements collection and loads it with all matching independent positioning records. The created collection might be empty.
twobyte	GetID () const
	Returns the definition ID for the text repeat.
void	SetID (twobyte id)
	Use with care! Sets the definition ID for the text repeat.
Evpu16	GetHorizontalPos () const
	Returns the horiozontal position (in EVPUs) from the measure's origin. The value is depending on the FCTextRepeatDef justification.
void	SetHorizontalPos (Evpu32 value)
	Sets the horizontal position (in EVPUs) from the measure's origin. The value is depending on the FCTextRepeatDef justification.
Evpu16	GetVerticalPos () const
	Returns the vertical position (in EVPUs) from the top reference line of the measure.
void	SetVerticalPos (Evpu32 value)
	Sets the vertical position (in EVPUs) from the top reference line of the measure.
int	GetTarget () const
	Returns the target measure or ID for the text repeat. This value is dependent on the GetTargetTrigger() value.
void	SetTarget (int value)
	Sets the target measure or ID for the text repeat. This value is dependent on the GetTargetTrigger() value.
bool	GetAutoUpdateTarget () const
	Returns the "Auto-update target" setting.
void	SetAutoUpdateTarget (bool state)
	Sets the "Auto-update target" setting.
bool	GetIndividualPositioning () const
	Returns if individual positioning on different staves should be allowed or not.
void	SetIndividualPositioning (bool state)
	Sets if individual positioning on different staves should be allowed..
bool	GetVisible () const
	Returns true if the repeat is visible. ("Show" is checked in the context menu.)
void	SetVisible (bool state)
	Sets if the repeat is visible. ("Show" is checked in the context menu.)
REPSHOWMODES	GetShowMode () const
	Returns where the text repeat should be shown.
void	SetShowMode (REPSHOWMODES mode)
	Sets where the text repeat should be shown.
twobyte	GetStaffListID () const
	Returns the staff list ID to be used for the text repeat assignment.
void	SetStaffListID (twobyte list)
	Sets the staff list ID to be used.
twobyte	GetTotalPasses () const
	Returns the number of passes for the text repeat assignment.
void	SetTotalPasses (twobyte totalpasses)
	Sets the number of passes for the text repeat assignment.
bool	GetJumpIfIgnore () const
	Returns the "Jump if ignoring repeats" setting.
void	SetJumpIfIgnore (bool state)
	Sets the "Jump if ignoring repeats" setting.
bool	GetResetOnRepeat () const
	Returns the "Reset on Repeat" setting.
void	SetResetOnRepeat (bool state)
	Sets the "Reset on Repeat" setting.
REPTARGETTRIGGERS	GetTargetTrigger () const
	Returns the target "trigger", which controls how the GetTarget() value will be interpreted.
void	SetTargetTrigger (REPTARGETTRIGGERS mode)
	Sets the target "trigger", which controls how the GetTarget() value will be interpreted.
REPACTIONS	GetAction () const
	Returns the action type for the text repeat assignment. This controls what should happen when the text repeat is encountered during playback.
void	SetAction (REPACTIONS mode)
	Sets the action type for the text repeat assignment. This controls what should happen when the text repeat is encountered during playback.
void	DebugDump () override
	Outputs the class data/information for debugging purposes.
Public Member Functions inherited from __FCInciOther
	__FCInciOther ()
	The constructor.
virtual bool	Load (CMPER itemno, twobyte inci)
	Loads the indicated record within the item number.
twobyte	CalcLastInci () override
	Overridden version of CalcLastInci for __FCInciOther-based classes.
bool	Reload () override
	Overridden version of Reload(), to support complex (mixed) data types.
virtual bool	SaveNew (CMPER itemno)
	Creates a new inci record with data.
void	_SetCmper (CMPER cmper)
	Primarily for internal use.
int	GetItemCmper () const
	Returns the cmper (main record) value for a loaded record.
int	GetItemInci () const
	Returns the inci (subrecord) value in the data ID for a loaded record.
virtual eMeas	GetMeasure () const
	Virtual method for returning the measure number.
virtual eStaff	GetStaff () const
	Virtual method for returning the staff number.
virtual bool	HasStaffValue () const
	Method that should return true if GetStaff() returns actual values.
virtual TimeEdu32	GetMeasurePos () const
	Virtual method for returning the position within the measure.
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	DeepDeleteData ()
	Deletes data and all data that's connected to the object.
virtual bool	LoadFirst ()=0
	Loads the very first element in the database, if any.
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 __FCBaseData *	CreateObject ()=0
	Creates a new instance of the object.
bool	DataIsLoaded () const
	Returns true is any data has been loaded into the object.
void	_TagDocumentID ()
	For internal use only.
Protected Member Functions inherited from __FCBase
	__FCBase ()
	The constructor.
Protected Attributes inherited from __FCBaseData
EDOCID	_connecteddocID
	The "connected" document ID., which is the document the where the document was loaded (or last saved). This is for a mechanism to prevent resaving of certain data in other documents.
void *	_datablock
	Pointer to the object's data block, the meaning is implementation-specific for each derived subclass.
bool	_heapdatablock
	Variable that tells if _datablock is dynamically created on the heap (and should be deleted at object destruction).
int	_loadedsize
	Loaded size of the data block for a loaded object, in bytes. Since the datablock is implementation-specific, the _loadedsize should be updated by child classes that create new data.
EDataID	_dataid
	The EdataID for the last loaded/saved object.

Detailed Description

Class for text repeat assignments to a measure. The assignment is connected with a FCTextRepeatDef definition.

Multiple text repeats can occur in the same measure.

A measure will only display text repeats when FCMeasure::GetTextRepeatFlag() is true.

Member Enumeration Documentation

REPACTIONS

enum FCTextRepeat::REPACTIONS

The constants to use with the FCTextRepeat::GetAction() and FCTextRepeat::SetAction() methods.

These constants are used both for FCTextRepeat and FCBackwardRepeat (in the FCBackwardRepeat::GetAction() and FCBackwardRepeat::SetAction() methods.)

Lua-supported.

Enumerator
REPACTION_NEVERJUMP	Never jump (=a text repeat Mark)
REPACTION_ALWAYSJUMP	Always jump
REPACTION_JUMPONPASS	Jump on pass
REPACTION_PLAYSECTION	Play section
REPACTION_STOPONPASS	Stop on pass

REPSHOWMODES

enum FCTextRepeat::REPSHOWMODES

Constants for use with FCTextRepeat::GetShowMode() and FCTextRepeat::SetShowMode().

These constants are also used for the FCEndingRepeat and FCBackwardRepeat classes.

Lua-supported.

Enumerator
REPSHOW_ALL	Show on all staves
REPSHOW_TOPSTAFF	Show on top staff only
REPSHOW_STAFFLIST	Use a staff list.

REPTARGETTRIGGERS

enum FCTextRepeat::REPTARGETTRIGGERS

The modes used by FCTextRepeat::GetTargetTrigger() and FCTextRepeat::SetTargetTrigger().

These constants are also used for the FCEndingRepeat class (in the FCEndingRepeat::GetTargetTrigger() and FCEndingRepeat::SetTargetTrigger() methods).

These constants are also used for the FCBackwardRepeat class (in the FCBackwardRepeat::GetTargetTrigger() and FCBackwardRepeat::SetTargetTrigger() methods).

Lua-supported.

Enumerator
REPTARGET_UNDEFINED	Undefined target trigger. This can occur as a return value for GetTargetTrigger, but it can't be used with SetTargetTrigger.
REPTARGET_DEFID	A text repeat def ID. Used only by text repeats.
REPTARGET_MEASURENUM	A measure number. Used both by text repeats, ending repeats and backward repeats.
REPTARGET_BACKWARDS	Move n measures backwards. This is also used for moving forward, using negative jump values. Used by text repeats.
REPTARGET_NEVERSKIPENDING	Never skip ending. Used only by ending repeats.
REPTARGET_FORWARDS	Move n measures forwards. This is also used for moving backwards, using negative jump values. Used both by ending repeats and backward repeats.
REPTARGET_NEXTENDING	Next ending. Used only by ending repeats and backward repeats.

Constructor & Destructor Documentation

FCTextRepeat()

FCTextRepeat::FCTextRepeat ( )

inline

The constructor.

Lua-supported.

Member Function Documentation

AssignTextRepeatDef()

bool FCTextRepeat::AssignTextRepeatDef

(

FCTextRepeatDef *

pDef

)

Assigns a saved text repeat definition to a text repeat.

Lua-supported.

Returns

True if the assignment was successful.

ClassName()

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

CreateSeparatePlacements()

FCSeparatePlacements * FCTextRepeat::CreateSeparatePlacements

(

)

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

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.

CreateTextRepeatDef()

FCTextRepeatDef * FCTextRepeat::CreateTextRepeatDef

(

)

Creates a text repeat definition object for the text repeat.

Returns

Pointer to the created object. The object must be deleted from the heap after use.

DebugDump()

void FCTextRepeat::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 __FCBaseData.

GetAction()

FCTextRepeat::REPACTIONS FCTextRepeat::GetAction

(

)

const

Returns the action type for the text repeat assignment. This controls what should happen when the text repeat is encountered during playback.

Lua-supported (also as property).

Returns

Any of the REPACTION_ constants.

GetAutoUpdateTarget()

bool FCTextRepeat::GetAutoUpdateTarget ( ) const

inline

Returns the "Auto-update target" setting.

Lua-supported (also as property).

GetClassID()

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

GetHorizontalPos()

Evpu16 FCTextRepeat::GetHorizontalPos ( ) const

inline

Returns the horiozontal position (in EVPUs) from the measure's origin. The value is depending on the FCTextRepeatDef justification.

Lua-supported (also as property).

GetID()

twobyte FCTextRepeat::GetID ( ) const

inline

Returns the definition ID for the text repeat.

Use FCTextRepeatDef load the definition.

Lua-supported.

Returns

The 1-based text repeat definition ID.

GetIndividualPositioning()

bool FCTextRepeat::GetIndividualPositioning ( ) const

inline

Returns if individual positioning on different staves should be allowed or not.

If individual positioning is used, the FCSeparatePlacements can be used to contain the positioning info for the staves.

Lua-supported (also as property).

GetJumpIfIgnore()

bool FCTextRepeat::GetJumpIfIgnore ( ) const

inline

Returns the "Jump if ignoring repeats" setting.

Lua-supported (also as property).

GetResetOnRepeat()

bool FCTextRepeat::GetResetOnRepeat ( ) const

inline

Returns the "Reset on Repeat" setting.

Lua-supported (also as property).

GetShowMode()

FCTextRepeat::REPSHOWMODES FCTextRepeat::GetShowMode

(

)

const

Returns where the text repeat should be shown.

Lua-supported (also as property).

Returns

Any of the REPSHOW_ constants.

GetStaffListID()

twobyte FCTextRepeat::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.

GetTarget()

int FCTextRepeat::GetTarget ( ) const

inline

Returns the target measure or ID for the text repeat. This value is dependent on the GetTargetTrigger() value.

Lua-supported (also as property).

GetTargetTrigger()

FCTextRepeat::REPTARGETTRIGGERS FCTextRepeat::GetTargetTrigger

(

)

const

Returns the target "trigger", which controls how the GetTarget() value will be interpreted.

Lua-supported (also as property).

Returns

Any of the TEXTREPTARGET_ constants.

GetTotalPasses()

twobyte FCTextRepeat::GetTotalPasses ( ) const

inline

Returns the number of passes for the text repeat assignment.

Lua-supported (also as property).

GetVerticalPos()

Evpu16 FCTextRepeat::GetVerticalPos ( ) const

inline

Returns the vertical position (in EVPUs) from the top reference line of the measure.

Lua-supported (also as property).

GetVisible()

bool FCTextRepeat::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).

SetAction()

void FCTextRepeat::SetAction

(

FCTextRepeat::REPACTIONS

mode

)

Sets the action type for the text repeat assignment. This controls what should happen when the text repeat is encountered during playback.

Lua-supported (also as property).

Parameters

mode	Any of the REPACTION_ constants.

SetAutoUpdateTarget()

void FCTextRepeat::SetAutoUpdateTarget ( bool state )

inline

Sets the "Auto-update target" setting.

Lua-supported (also as property).

SetHorizontalPos()

void FCTextRepeat::SetHorizontalPos ( Evpu32 value )

inline

Sets the horizontal position (in EVPUs) from the measure's origin. The value is depending on the FCTextRepeatDef justification.

Lua-supported (also as property).

SetID()

void FCTextRepeat::SetID ( twobyte id )

inline

Use with care! Sets the definition ID for the text repeat.

See GetID for more info.

Lua-supported.

Parameters

id	The 1-based text repeat definition ID.

SetIndividualPositioning()

void FCTextRepeat::SetIndividualPositioning ( bool state )

inline

Sets if individual positioning on different staves should be allowed..

If individual positioning is used, the FCSeparatePlacements can be used to contain the positioning info for the staves.

Lua-supported (also as property).

SetJumpIfIgnore()

void FCTextRepeat::SetJumpIfIgnore ( bool state )

inline

Sets the "Jump if ignoring repeats" setting.

Lua-supported (also as property).

SetResetOnRepeat()

void FCTextRepeat::SetResetOnRepeat ( bool state )

inline

Sets the "Reset on Repeat" setting.

Lua-supported (also as property).

SetShowMode()

void FCTextRepeat::SetShowMode

(

FCTextRepeat::REPSHOWMODES

mode

)

Sets where the text repeat should be shown.

Lua-supported (also as property).

Parameters

mode	Any of the REPSHOW_ constants.

SetStaffListID()

void FCTextRepeat::SetStaffListID ( twobyte list )

inline

Sets the staff list ID to be used.

Lua-supported (also as property).

SetTarget()

void FCTextRepeat::SetTarget ( int value )

inline

Sets the target measure or ID for the text repeat. This value is dependent on the GetTargetTrigger() value.

Lua-supported (also as property).

SetTargetTrigger()

void FCTextRepeat::SetTargetTrigger

(

FCTextRepeat::REPTARGETTRIGGERS

mode

)

Sets the target "trigger", which controls how the GetTarget() value will be interpreted.

If the GetAction() is REPACTION_NEVERJUMP or REPACTION_STOPONPASS, this method will not do anything.

Lua-supported (also as property).

Parameters

mode	Any of the REPTARGET_ constants.

SetTotalPasses()

void FCTextRepeat::SetTotalPasses ( twobyte totalpasses )

inline

Sets the number of passes for the text repeat assignment.

Lua-supported (also as property).

SetVerticalPos()

void FCTextRepeat::SetVerticalPos ( Evpu32 value )

inline

Sets the vertical position (in EVPUs) from the top reference line of the measure.

Lua-supported (also as property).

SetVisible()

void FCTextRepeat::SetVisible ( bool state )

inline

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

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