Finale PDK Framework 0.77
|
Class that handles separate placement for repeats. More...
#include <ff_other.h>
Public Types | |
enum | SEPARATEPLACEMENT_MODES { SEPARMODE_BACKWARDREPEAT = 0 , SEPARMODE_TEXTREPEAT = 1 , SEPARMODE_ENDINGREPEAT = 2 , SEPARMODE_ENDINGREPEATTEXT = 3 } |
Modes for which placement type to load. More... | |
Public Types inherited from __FCBase | |
enum | PDKFRAMEWORK_CLASSID { FCID_UNKNOWN = 0 , FCID_ACCIDENTALMOD , FCID_ACTIVELYRIC , FCID_ALLOTMENT , FCID_ARTICULATION , FCID_ARTICULATIONDEF , FCID_BACKWARDREPEAT , FCID_BASELINE , FCID_BEAMMOD , FCID_BEATCHARTELEMENT , FCID_BOOKMARK , FCID_BROKENBEAMMOD , FCID_CATEGORYDEF , FCID_CELLCLEFCHANGE , FCID_CELLFRAMEHOLD , FCID_CELLGRAPHIC , FCID_CELLTEXT , FCID_CENTERSMARTSHAPE , FCID_CHORD , FCID_CHORDPREFS , FCID_CHORDSUFFIXELEMENT , FCID_CHORUSSYLLABLE , FCID_CLEFDEF , FCID_COMPOSITETIMESIGBOTTOMELEMENT , FCID_COMPOSITETIMESIGTOPELEMENT , FCID_CROSSSTAFFMOD , FCID_CUSTOMSMARTLINEDEF , FCID_CUSTOMSTEMMOD , FCID_DISTANCEPREFS , FCID_DOTMOD , FCID_ENCLOSURE , FCID_ENDINGREPEAT , FCID_ENIGMATEXTSTYLE , FCID_ENTRYALTERMOD , FCID_EXECUTABLESHAPEDEF , FCID_EXPRESSION , FCID_FONTINFO , FCID_FONTPREFS , FCID_FREEZESYSTEM , FCID_FRETBOARDSTYLEDEF , FCID_FRETBOARDSTYLEDEFS , FCID_FRETBOARDGROUPDEF , FCID_FRETBOARDGROUPDEFS , FCID_FRETINSTRUMENTDEF , FCID_GENERALPREFS , FCID_GRIDSGUIDESPREFS , FCID_GROUP , FCID_GROUPNAMEPOSITIONPREFS , FCID_HUMANPLAYBACKPREFS , FCID_INDEPENDENTCELLDETAIL , FCID_INSTRUMENTDEF , FCID_INSTRUMENTPLAYBACKDATA , FCID_KEYMODEDEF , FCID_KEYSIGNATURE , FCID_LAYERPREFS , FCID_LYRICSBASELINE , FCID_LYRICSPREFS , FCID_MEASURE , FCID_MEASURENUMBERREGION , FCID_METATOOLASSIGNMENT , FCID_MIDIEXPRESSION , FCID_MISCDOCPREFS , FCID_MULTIMEASUREREST , FCID_MULTIMEASURERESTPREFS , FCID_MULTISTAFFINSTRUMENT , FCID_MULTISTAFFINSTRUMENTS , FCID_MUSICCHARACTERPREFS , FCID_MUSICSPACINGPREFS , FCID_NUMBER , FCID_NOTEHEADMOD , FCID_OTHERINCI , FCID_PERCUSSIONLAYOUTNOTE , FCID_PERCUSSIONSTAFF , FCID_PERFORMANCEMOD , FCID_PAGE , FCID_PAGEFORMATPREFS , FCID_PAGEGRAPHIC , FCID_PAGETEXT , FCID_PART , FCID_PARTEXTRACTPREFS , FCID_PARTSCOPEPREFS , FCID_PARTSTAFFVOICING , FCID_PERCUSSIONNOTEMOD , FCID_PIANOBRACEPREFS , FCID_PLAYBACKPREFS , FCID_RAWTEXT , FCID_REPEATPREFS , FCID_SECONDARYBEAMBREAKMOD , FCID_BEAMEXTENSIONMOD , FCID_SECTIONSYLLABLE , FCID_SEPARATEMEASURENUMBER , FCID_SEPARATEPLACEMENT , FCID_SHAPEDEF , FCID_SHAPEEXPRESSIONDEF , FCID_SLURCONTOURPREFS , FCID_SIZEPREFS , FCID_SMARTSHAPE , FCID_SMARTSHAPEENTRYMARK , FCID_SMARTSHAPEMEASUREMARK , FCID_SMARTSHAPEPREFS , FCID_STAFF , FCID_STAFFLIST , FCID_STAFFNAMEPOSITION , FCID_STAFFNAMEPOSITIONPREFS , FCID_STAFFSTYLEASSIGN , FCID_STAFFSTYLEDEF , FCID_STAFFSYSTEM , FCID_STEMCONNECTIONTABLE , FCID_STEMMOD , FCID_STRING , FCID_SYLLABLEENTRYMOD , FCID_SYSTEMSTAFF , FCID_TABLATURENOTEMOD , FCID_TEMPOELEMENT , FCID_TEXTBLOCK , FCID_TEXTEXPRESSIONDEF , FCID_TEXTREPEAT , FCID_TEXTREPEATDEF , FCID_TIEMOD , FCID_TIEPREFS , FCID_TIECONTOURPREFS , FCID_TIEPLACEMENTPREFS , FCID_TIMESIGNATURE , FCID_TUPLET , FCID_TUPLETPREFS , FCID_VERSESYLLABLE } |
Constants for the GetClassID method. More... | |
enum | MEASUREMENTUNITS { MEASUREMENTUNIT_DEFAULT = UNIT_DEFAULT , MEASUREMENTUNIT_EVPUS = UNIT_EVPUS , MEASUREMENTUNIT_INCHES = UNIT_INCHES , MEASUREMENTUNIT_CENTIMETERS = UNIT_CENTS , MEASUREMENTUNIT_POINTS = UNIT_POINTS , MEASUREMENTUNIT_PICAS = UNIT_PICAS , MEASUREMENTUNIT_SPACES = UNIT_SPACES , MEASUREMENTUNIT_MILLIMETERS = 100 } |
Constants for Finale's standard measurement units. More... | |
Public Member Functions | |
const char * | ClassName () const override |
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child class. 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... | |
FCSeparatePlacement () | |
The constructor. More... | |
void | SetMode (SEPARATEPLACEMENT_MODES mode) |
Sets the type of data that should be used when reading/saving the record. More... | |
SEPARATEPLACEMENT_MODES | GetMode () const |
Gets the type of data that should be used when reading/saving the record. More... | |
eStaff | GetStaff () const override |
Returns the staff that the separate placement should be matched to. More... | |
bool | HasStaffValue () const override |
Overridden method (returning true) since this class contains a staff value. More... | |
twobyte | GetMeasure () const override |
Sets the measure that the separate placement should be matched to. More... | |
Evpu16 | GetHorizontalOffset1 () const |
Returns the 1st horizontal offset, compared to the standard positioning. More... | |
Evpu16 | GetVerticalOffset1 () const |
Returns the 1st vertical offset, compared to the standard positioning. More... | |
Evpu16 | GetHorizontalOffset2 () const |
Returns the 2nd horizontal offset, compared to the standard positioning. More... | |
Evpu16 | GetVerticalOffset2 () const |
Returns the 2nd horizontal offset, compared to the standard positioning. More... | |
void | SetStaff (eStaff staff) |
Sets the staff that the separate placement should be matched to. More... | |
void | SetMeasure (twobyte meas) |
Sets the measure that the separate placement should be matched to. More... | |
void | SetHorizontalOffset1 (Evpu16 value) |
Sets the 1st horizontal offset, compared to the standard positioning. More... | |
void | SetVerticalOffset1 (Evpu16 value) |
Sets the 1st horizontal offset, compared to the standard positioning. More... | |
void | SetHorizontalOffset2 (Evpu16 value) |
Sets the 2nd horizontal offset, compared to the standard positioning. More... | |
void | SetVerticalOffset2 (Evpu16 value) |
Sets the 2nd vertical offset, compared to the standard positioning. More... | |
bool | GetVisible () const |
Returns the visibility state. (Whether "Show" is checked in the context menu.) More... | |
void | SetVisible (bool state) |
Sets the visibility state. (Whether "Show" is checked in the context menu.) More... | |
Public Member Functions inherited from __FCInciOther | |
__FCInciOther () | |
The constructor. | |
virtual bool | Load (CMPER itemno, twobyte inci) |
Loads the indicated record within the item number. More... | |
twobyte | CalcLastInci () override |
Overridden version of CalcLastInci for __FCInciOther-based classes. More... | |
bool | Reload () override |
Overridden version of Reload(), to support complex (mixed) data types. More... | |
virtual bool | SaveNew (CMPER itemno) |
Creates a new inci record with data. More... | |
void | _SetCmper (CMPER cmper) |
Primarily for internal use. More... | |
int | GetItemCmper () const |
Returns the cmper (main record) value for a loaded record. More... | |
int | GetItemInci () const |
Returns the inci (subrecord) value in the data ID for a loaded record. More... | |
virtual TimeEdu32 | GetMeasurePos () const |
Virtual method for returning the position within the measure. 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 | DeepDeleteData () |
Deletes data and all data that's connected to the object. More... | |
virtual bool | LoadFirst ()=0 |
Loads the very first element in the database, if any. 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 | DebugDump () override |
Outputs the class data/information for debugging purposes. 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 | |
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 __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. | |
Class that handles separate placement for repeats.
Don't create instances of this class directly. Instead, use it through in a FCSeparatePlacements collection. (In JW Lua, it's not possible to create FCSeparatePlacement objects directly.)
The FCTextRepeat, FCEndingRepeat and FCBackwardRepeat all have CreateSeparatePlacements() methods that will create a FCSeparatePlacements collection automatically.
To add new FCSeparatePlacement data, use FCSeparatePlacements::AssureStaffPlacement().
Modes for which placement type to load.
Lua-supported (0.65)
Enumerator | |
---|---|
SEPARMODE_BACKWARDREPEAT | Separate placement for backward repeat brackets (in the FCBackwardRepeat class). |
SEPARMODE_TEXTREPEAT | Separate placement for text repeats (in the FCTextRepeat class). |
SEPARMODE_ENDINGREPEAT | Separate placement for ending repeat brackets (in the FCEndingRepeat class). |
SEPARMODE_ENDINGREPEATTEXT | Separate text handle placement for ending repeats (in the FCEndingRepeat class). |
|
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 __FCInciOther.
|
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 1st horizontal offset, compared to the standard positioning.
For text repeats, it's the horizontal offset of the text repeat. For backward repeats, it's the right-most bracket handle offset. For ending repeats, it's the left-most bracket handle offset. For ending repeat texts, it's the horizontal text handle offset.
Lua-supported (also as property).
|
inline |
Returns the 2nd horizontal offset, compared to the standard positioning.
For backward repeats, it's the left-most bracket handle offset. For ending repeats, it's the right-most bracket handle offset. For text repeats and ending repeat texts, this value isn't used, and zero is returned.
Lua-supported (also as property).
|
inlineoverridevirtual |
Sets the measure that the separate placement should be matched to.
This value is only valid for mode SEPARMODE_TEXTREPEAT. All other modes return zero.
Lua-supported (also as property).
Reimplemented from __FCInciOther.
|
inline |
Gets the type of data that should be used when reading/saving the record.
Lua-supported (also as read-only property) (0.65).
|
inlineoverridevirtual |
Returns the staff that the separate placement should be matched to.
Lua-supported (also as property).
Reimplemented from __FCInciOther.
|
inline |
Returns the 1st vertical offset, compared to the standard positioning.
For text repeats, it's the vertical offset of the text repeat. For backward repeats, it's the right-most bracket handle vertical offset. For ending repeats, it's the left-most bracket handle vertical offset. For ending repeat texts, it's the vertical text handle offset.
Lua-supported (also as property).
|
inline |
Returns the 2nd horizontal offset, compared to the standard positioning.
For backward repeats, it's the left-most bracket handle vertical offset. For ending repeats, it's the right-most bracket handle vertical offset. For text repeats and ending repeat texts, this value isn't used, and zero is returned.
Lua-supported (also as property).
|
inline |
Returns the visibility state. (Whether "Show" is checked in the context menu.)
This value always returns true for mode SEPARMODE_ENDINGREPEATTEXT.
Lua-supported (also as property) (0.65).
|
inlineoverridevirtual |
Overridden method (returning true) since this class contains a staff value.
Reimplemented from __FCInciOther.
|
inline |
Sets the 1st horizontal offset, compared to the standard positioning.
For text repeats, it's the horizontal offset of the text repeat. For backward repeats, it's the right-most bracket handle offset. For ending repeats, it's the left-most bracket handle offset. For ending repeat texts, it's the horizontal text handle offset.
Lua-supported (also as property).
|
inline |
Sets the 2nd horizontal offset, compared to the standard positioning.
For backward repeats, it's the left-most bracket handle offset. For ending repeats, it's the right-most bracket handle offset. For text repeats and ending repeat texts, no action is taken.
Lua-supported (also as property).
|
inline |
Sets the measure that the separate placement should be matched to.
This value is only valid for mode SEPARMODE_TEXTREPEAT. No action is taken for other modes.
Lua-supported (also as property).
meas | The 1-based measure number where the positioning is located. |
|
inline |
Sets the type of data that should be used when reading/saving the record.
mode | Any of these values:
|
|
inline |
Sets the staff that the separate placement should be matched to.
Lua-supported (also as property).
staff | The staff ID where the positioning is located. |
|
inline |
Sets the 1st horizontal offset, compared to the standard positioning.
For text repeats, it's the vertical offset of the text repeat. For backward repeats, it's the right-most bracket handle vertical offset. For ending repeats, it's the left-most bracket handle vertical offset. For ending repeat texts, it's the vertical text handle offset.
Lua-supported (also as property).
|
inline |
Sets the 2nd vertical offset, compared to the standard positioning.
For backward repeats, it's the left-most bracket handle vertical offset. For ending repeats, it's the right-most bracket handle vertical offset. For text repeats and ending repeat texts, no action is taken.
Lua-supported (also as property).
|
inline |
Sets the visibility state. (Whether "Show" is checked in the context menu.)
No action is taken for mode SEPARMODE_ENDINGREPEATTEXT.
Lua-supported (also as property) (0.65).