Finale PDK Framework 0.74
|
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>
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. More... | |
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. More... | |
FCEndingRepeat () | |
The constructor. More... | |
bool | DeepDeleteData () override |
Reimplementation of DeepDeleteData(). Deletes both the basic repeat ending data and the optional repeat text. More... | |
bool | DeepSaveAs (CMPER itemno) override |
Reimplementation of DeepDeleteAs(). Saves both the basic repeat ending data and the optional repeat text. More... | |
twobyte | GetStaffListID () const |
Returns the staff list ID to be used for the text repeat assignment. More... | |
bool | GetSkipOnIgnore () const |
Returns the "Skip ending if ignoring repeats" setting. More... | |
eMeas | GetTargetMeasure () const |
Returns the target measure number. More... | |
bool | GetIndividualPositioning () const |
Returns true if the bracket has individual staff positioning enabled. More... | |
bool | GetVisible () const |
Returns true if the repeat is visible. ("Show" is checked in the context menu.) More... | |
Evpu16 | GetVerticalTopBracketPosition () const |
Returns the top vertical position of the bracket. More... | |
Evpu16 | GetHorizontalLeftBracketPosition () const |
Returns the horizontal position of the bracket's left side. More... | |
Evpu16 | GetVerticalLeftBracketPosition () const |
Returns the vertical position of the bracket's left side. More... | |
Evpu16 | GetHorizontalRightBracketPosition () const |
Returns the horizontal position of the bracket's right side. More... | |
Evpu16 | GetVerticalRightBracketPosition () const |
Returns the vertical position of the bracket's right side. More... | |
Evpu16 | GetHorizontalTextPosition () const |
Returns the horizontal position of the repeat text. More... | |
Evpu16 | GetVerticalTextPosition () const |
Returns the vertical position of the repeat text. More... | |
FCTextRepeat::REPSHOWMODES | GetShowMode () const |
Returns where the ending repeat should be shown. More... | |
int | GetPassNumbersCount () const |
Returns the number of pass numbers available to the ending repeat. More... | |
FCTextRepeat::REPTARGETTRIGGERS | GetTargetTrigger () const |
Returns the target trigger for the ending repeat. This value also affects how the GetTargetMeasure() will be interpreted. More... | |
void | SetStaffListID (twobyte list) |
Sets the staff list ID to be used. More... | |
void | SetSkipOnIgnore (bool state) |
Returns the "Skip ending if ignoring repeats" setting. More... | |
void | SetTargetMeasure (eMeas measure) |
Returns the target measure number. The value is dependent on GetTargetTrigger(), which is set with SetTargetTrigger(). More... | |
void | SetIndividualPositioning (bool state) |
Sets if the repeat bracket has individual staff positioning enabled or not. More... | |
void | SetVisible (bool state) |
Sets if the repeat is visible. ("Show" is checked in the context menu.) More... | |
void | SetVerticalTopBracketPosition (Evpu16 position) |
Sets the top vertical position of the repeat bracket. More... | |
void | SetHorizontalLeftBracketPosition (Evpu16 position) |
Sets the horizontal position of the repeat bracket's left side. More... | |
void | SetVerticalLeftBracketPosition (Evpu16 position) |
Sets the vertical position of the repeat bracket's left side. More... | |
void | SetHorizontalRightBracketPosition (Evpu16 position) |
Sets the horizontal position of the repeat bracket's right side. More... | |
void | SetVerticalRightBracketPosition (Evpu16 position) |
Sets the vertical position of the repeat bracket's right side. More... | |
void | SetHorizontalTextPosition (Evpu16 position) |
Sets the horizontal position of the repeat text. More... | |
void | SetVerticalTextPosition (Evpu16 position) |
Sets the vertical position of the repeat text. More... | |
void | SetShowMode (FCTextRepeat::REPSHOWMODES mode) |
Sets where the ending repeat should be shown. More... | |
FCString * | CreateTextString () |
Loads the text for an ending repeat and returns it in a FCString object. More... | |
bool | SaveTextString (FCString *pString) |
Saves a FCString object for the ending repeat. More... | |
bool | GetPassNumbers (FCNumbers *pNumbers) |
Fills the pass numbers in a FCNumbers collection. More... | |
bool | SetPassNumbers (FCNumbers *pNumbers) |
Sets the pass numbers for the repeat ending. More... | |
void | SetTargetTrigger (FCTextRepeat::REPTARGETTRIGGERS value) |
Set the target trigger for the ending repeat. This method should also be combined with a SetTargetMeasure() call. More... | |
FCSeparatePlacements * | CreateSeparatePlacements () |
Creates a FCSeparatePlacements collection and loads it with all matching independent positioning records. The created collection might be empty. More... | |
FCSeparatePlacements * | CreateTextSeparatePlacements () |
Creates a FCSeparatePlacements collection and loads it with all matching independent positioning records. The created collection might be empty. More... | |
Public Member Functions inherited from __FCNoInciOther | |
__FCNoInciOther () | |
The constructor. | |
virtual bool | Load (CMPER itemno) |
Loads the indicated item. More... | |
bool | Reload () override |
Overridden Reload() method to support complex data types. More... | |
virtual bool | SaveAs (CMPER itemno) |
Saves the data under another item number. The object will now be connected to the new item number. More... | |
virtual bool | SaveNew () |
Creates the data as completely new item number. The object will now be connected to the new item number. More... | |
virtual CMPER | GetItemNo () const |
Returns the item number. This typically points to items such as a page number, a measure number, a 1-based expression definition number, etc. More... | |
void | SetItemNo (CMPER cmper) |
Sets the item number. Use with extreme care! This is mostly intended for situations when creating new records isn't supported by Finale (preventing SaveAs to work). More... | |
bool | LoadFirst () override |
Loads the first element of 1-based data. More... | |
void | DebugDump () override |
Outputs the class data/information for debugging purposes. More... | |
Public Member Functions inherited from __FCOther | |
void | SetCmperAndInci (CMPER cmper, twobyte inci) |
Sets both the CMPER and the incident number in the dataID record. Mainly for internal use. | |
__FCOther () | |
The constructor. | |
bool | IsIdenticalRecord (__FCOther *pCompare) |
Compares an object to see if both objects point to the same data record. More... | |
Public Member Functions inherited from __FCBaseData | |
EDOCID | GetConnectedDocID () const |
Returns the document ID that was connected to the last load/save of the data. More... | |
bool | VerifyConnectedDocID () |
Checks that the stored document ID for the data object matches the current document's ID. More... | |
virtual EXTAG | Tag () const =0 |
The Enigma tag for the derived class. More... | |
virtual EVERSION | EnigmaVersion () const |
The Enigma version for save/load/create/delete operations. More... | |
virtual int | DataSizeLoad () const =0 |
Returns the data size for the data structure that should be loaded. More... | |
virtual int | DataSizeSave () const |
Returns the data size for the data structure that should be saved or created. More... | |
void | _CloneFrom (__FCBaseData *pSource) |
For internal use only. Copies object data (except data block) from another object. More... | |
virtual void | CloneMemoryFrom (__FCBaseData *pSource) |
const EDataID * | _GetDataID () |
Intended ONLY for the _CloneFrom implementation. More... | |
int | _GetLoadedSize () const |
Intended ONLY for the _CloneFrom implementation. More... | |
const void * | GetDataBlock () |
Intended ONLY for the _CloneFrom implementation. More... | |
EXTAG | GetCustomTag () const |
Returns the custom Enigma tag, if any. More... | |
void | SetCustomTag (EXTAG tag) |
Sets the custom Enigma tag, for classes that support multiple Enigma tags. More... | |
__FCBaseData () | |
The constructor. | |
virtual | ~__FCBaseData () |
Virtual destructor. | |
virtual bool | Save () |
Saves the currently loaded to its current location. More... | |
virtual bool | DeleteData () |
Deletes the associated data from Finale's database. Be careful when deleting multiple objects. More... | |
virtual bool | LoadLast () |
Loads the very last element in the database, if any. More... | |
virtual bool | LoadNext () |
Loads the next element from the database, if any. More... | |
virtual bool | LoadPrevious () |
Loads the previous element in the database, if any. More... | |
bool | RelinkToCurrentView () |
Relinks the contents in the current view so that the score and part(s) match. More... | |
bool | RelinkToScore () |
Relinks all parts to the contents of the score. More... | |
__FCBaseData * | CreateClone () |
Creates an identical copy of an object. More... | |
void | DebugDataDump () override |
Outputs a memory dump of the data block in the object for debugging purposes. More... | |
void | DebugDataByteArrayDump () override |
Outputs a memory dump of the data block in the object for debugging purposes, as a C++ byte array. More... | |
void | DebugDataOffsetDump (int offset, int size) |
For debug mode only. Dumps a data memory block at a specific offset and with a specific size. | |
FCNumbers * | CreateRawDataDump () |
Creates a byte collection with the raw loaded data block for the object (if the object type supports single data blocks). This method is only intended for debug purposes. More... | |
Public Member Functions inherited from __FCBase | |
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. More... | |
void | DebugMsgHex (const char *pszPrefixText, int i) |
Creates a simple Message Box for debug purposes. The text appears with the extra digit (as a hexadecimal number) appearing afterwards. More... | |
void | DebugMsgString (const char *pszPrefixText, const char *thestring) |
Creates a simple Message Box for debug purposes. The text appears with the extra string appearing afterwards. More... | |
void | DebugMsg (const char *pszMsg) |
Creates a simple Message Box for debug purposes with just one text string. More... | |
void | DebugOutMenuInfo (FCUI *pUI, int menuixd_horiz, int menuixd_vert) const |
Outputs the menu command info for debugging purposes. More... | |
int | DebugOutFormat (const char *fmt,...) |
Outputs debug text using C style "printf" syntax. More... | |
void | Set16BitFlag (FLAG_16 *flag, FLAG_16 flagbits, bool state) |
Sets a 16 bit flag. More... | |
void | Set32BitFlag (FLAG_32 *flag, FLAG_32 flagbits, bool state) |
Sets/resets a 32 bit flag, by using a bit mask. More... | |
bool | GetBitFlag (FLAG_32 flag, FLAG_32 flagbits) const |
Gets a state from flag bits. Returns true if any bit in the mask is set. More... | |
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. More... | |
void | SetUserData (void *pData) |
Sets the user data attached to the instance of an object. More... | |
void | SetUserData2 (void *pData) |
Sets the additional user data attached to the instance of an object. More... | |
void * | GetUserData () const |
Gets the user data attached to the instance of an object. More... | |
void * | GetUserData2 () const |
Gets the additional user data attached to the instance of an object. More... | |
virtual bool | IsIdentical (const __FCBase *pCompareObject) const |
Returns true if the data in the passed object is considered to be identical to the current object, otherwise false. More... | |
void | StoreXML_String (tinyxml2::XMLElement *pParentNode, const char *pszElementName, FCString *pStringValue) |
Helper function to store FCString objects in the XML file. More... | |
void | StoreXML_Integer (tinyxml2::XMLElement *pParentNode, const char *pszElementName, int value) |
Helper function to store integer objects in the XML file. More... | |
void | StoreXML_Bool (tinyxml2::XMLElement *pParentNode, const char *pszElementName, bool value) |
Helper function to store boolean objects in the XML file. More... | |
void | StoreXML_StringAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, FCString *pStringValue) |
Helper function to store FCString objects in the XML file, as an attribute to a node. More... | |
void | StoreXML_IntegerAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, int value) |
Helper function to store integer objects in the XML file, as an attribute to a node. More... | |
void | StoreXML_BoolAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, bool value) |
Helper function to store boolean objects in the XML file, as an attribute to a node. More... | |
void | StoreXML_FloatAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, float value) |
Helper function to store floating point objects in the XML file, as an attribute to a node. More... | |
virtual void | StoreToXML (tinyxml2::XMLElement *pParentNode) |
Virtual method that is used to store an object's data. More... | |
bool | ReadXML_String (tinyxml2::XMLElement *pParentNode, const char *pszElementName, FCString *pStringValue) |
Helper method to read FCString objects from the XML file. More... | |
bool | ReadXML_Integer (tinyxml2::XMLElement *pParentNode, const char *pszElementName, int *pValue) |
Helper method to read integer objects from the XML file. More... | |
bool | ReadXML_Bool (tinyxml2::XMLElement *pParentNode, const char *pszElementName, bool *pValue) |
Helper method to read boolean objects from the XML file. More... | |
bool | ReadXML_StringAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, FCString *pStringValue) |
Helper method to read FCString objects from the XML file, as an attribute to a node. More... | |
bool | ReadXML_IntegerAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, int *pValue) |
Helper method to read integer objects from the XML file, as an attribute to a node. More... | |
bool | ReadXML_BoolAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, bool *pValue) |
Helper method to read boolean objects from the XML file, as an attribute to a node. More... | |
bool | ReadXML_FloatAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, float *pValue) |
Helper method to read floating point objects from the XML file, as an attribute to a node. More... | |
virtual bool | ReadFromXML (tinyxml2::XMLElement *pParentNode) |
Virtual method that is used to read object data. More... | |
Additional Inherited Members | |
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. More... | |
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. More... | |
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. More... | |
static void | DebugOutTag (const char *pszPrefixText, EXTAG extag) |
Static method that outputs a line for debugging purposes. The text appears with the EXTAG (in text) appearing afterwards. More... | |
static void | DebugOutHex (const char *pszPrefixText, int i) |
Static method that outputs a line for debugging purposes. The text appears with the extra digit (in hexadecimal presentation) appearing afterwards. More... | |
static void | DebugOutBin (const char *pszPrefixText, int i) |
Static method that outputs a line for debugging purposes. The text appears with the extra digit (in binary presentation) appearing afterwards. More... | |
static void | DebugOutString (const char *pszPrefixText, const char *thestring) |
Static method that outputs a line for debugging purposes (C string version). The text appears with the extra string appearing afterwards. More... | |
static void | DebugOutString (const char *pszPrefixText, FCString *pString) |
Static method that outputs a line for debugging purposes (FCString version). The text appears with the extra string appearing afterwards. More... | |
static void | DebugOutBool (const char *pszPrefixText, bool state) |
Static method that outputs a line for debugging purposes. The boolean state appears afterwards as either "TRUE" or "FALSE". More... | |
static void | DebugOutBlock (const void *pBuffer, int startoffset, int size) |
Static method that outputs a memory block for debugging purposes. Eight bytes per line will appear (as hex digits) until the whole memory block is dumped. More... | |
static void | DebugOutByteArrayBlock (const void *pBuffer, int startoffset, int size) |
Static method that outputs a memory block for debugging purposes. Eight bytes per line will appear (as hex digits) as a C++ onebyte array, until the whole memory block is dumped. More... | |
static void | DebugOut (const char *pszLine) |
Static method to output a line of text for debugging purposes. More... | |
Protected Member Functions inherited from __FCBaseData | |
virtual void * | Allocate ()=0 |
virtual void | Deallocate () |
virtual bool | IsDynamicSize () |
bool | LoadDataBlock () |
Loads the data. If the object is of dynamic size, the old memory block is freed and a new is allocated. | |
void | ClearData () |
virtual twobyte | CalcLastInci () |
For internal use only! More... | |
virtual __FCBaseData * | CreateObject ()=0 |
Creates a new instance of the object. More... | |
bool | DataIsLoaded () const |
Returns true is any data has been loaded into the object. | |
void | _TagDocumentID () |
For internal use only. More... | |
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. More... | |
EDataID | _dataid |
The EdataID for the last loaded/saved object. | |
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.
|
inline |
The constructor.
Lua-supported.
|
inlineoverridevirtual |
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child class.
Lua-supported.
Reimplemented from __FCNoInciOther.
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.
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.
FCString * FCEndingRepeat::CreateTextString | ( | ) |
|
overridevirtual |
Reimplementation of DeepDeleteData(). Deletes both the basic repeat ending data and the optional repeat text.
Lua-supported (through inheritance).
Reimplemented from __FCNoInciOther.
|
overridevirtual |
Reimplementation of DeepDeleteAs(). Saves both the basic repeat ending data and the optional repeat text.
Lua-supported (through inheritance).
Reimplemented from __FCNoInciOther.
|
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.
|
inline |
Returns the horizontal position of the bracket's left side.
Lua-supported (also as property).
|
inline |
Returns the horizontal position of the bracket's right side.
Lua-supported (also as property).
|
inline |
Returns the horizontal position of the repeat text.
Lua-supported (also as property).
|
inline |
Returns true if the bracket has individual staff positioning enabled.
Lua-supported (also as property).
bool FCEndingRepeat::GetPassNumbers | ( | FCNumbers * | pNumbers | ) |
|
inline |
Returns the number of pass numbers available to the ending repeat.
Lua-supported (also as a read-only property).
FCTextRepeat::REPSHOWMODES FCEndingRepeat::GetShowMode | ( | ) | const |
Returns where the ending repeat should be shown.
Lua-supported (also as property).
|
inline |
Returns the "Skip ending if ignoring repeats" setting.
Lua-supported (also as property).
|
inline |
Returns the staff list ID to be used for the text repeat assignment.
Lua-supported (also as property).
|
inline |
Returns the target measure number.
Lua-supported (also as property).
|
inline |
Returns the target trigger for the ending repeat. This value also affects how the GetTargetMeasure() will be interpreted.
|
inline |
Returns the vertical position of the bracket's left side.
Lua-supported (also as property).
|
inline |
Returns the vertical position of the bracket's right side.
Lua-supported (also as property).
|
inline |
Returns the vertical position of the repeat text.
Lua-supported (also as property).
|
inline |
Returns the top vertical position of the bracket.
Lua-supported (also as property).
|
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).
bool FCEndingRepeat::SaveTextString | ( | FCString * | pString | ) |
|
inline |
Sets the horizontal position of the repeat bracket's left side.
Lua-supported (also as property).
|
inline |
Sets the horizontal position of the repeat bracket's right side.
Lua-supported (also as property).
|
inline |
Sets the horizontal position of the repeat text.
Lua-supported (also as property).
|
inline |
Sets if the repeat bracket has individual staff positioning enabled or not.
Lua-supported (also as property).
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.
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. |
void FCEndingRepeat::SetShowMode | ( | FCTextRepeat::REPSHOWMODES | mode | ) |
Sets where the ending repeat should be shown.
Lua-supported (also as property).
mode | Any of the REPSHOW_ constants (from FCTextRepeat). |
|
inline |
Returns the "Skip ending if ignoring repeats" setting.
Lua-supported (also as property).
|
inline |
Sets the staff list ID to be used.
Lua-supported (also as property).
|
inline |
Returns the target measure number. The value is dependent on GetTargetTrigger(), which is set with SetTargetTrigger().
Lua-supported (also as property).
|
inline |
Set the target trigger for the ending repeat. This method should also be combined with a SetTargetMeasure() call.
value | The FCTextRepeat::REPTARGETTRIGGERS constants. REPTARGET_NEXTENDING, REPTARGET_MEASURENUM, REPTARGET_FORWARDS and REPTARGET_NEVERSKIPENDING can be used. |
|
inline |
Sets the vertical position of the repeat bracket's left side.
Lua-supported (also as property).
|
inline |
Sets the vertical position of the repeat bracket's right side.
Lua-supported (also as property).
|
inline |
Sets the vertical position of the repeat text.
Lua-supported (also as property).
|
inline |
Sets the top vertical position of the repeat bracket.
Lua-supported (also as property) (0.65).
|
inline |
Sets if the repeat is visible. ("Show" is checked in the context menu.)
Lua-supported (also as property) (0.65).