FCSeparatePlacement Class Reference

Class that handles separate placement for repeats. More...

#include <ff_other.h>

Inheritance diagram for FCSeparatePlacement:

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.
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.
	FCSeparatePlacement ()
	The constructor.
void	SetMode (SEPARATEPLACEMENT_MODES mode)
	Sets the type of data that should be used when reading/saving the record.
SEPARATEPLACEMENT_MODES	GetMode () const
	Gets the type of data that should be used when reading/saving the record.
eStaff	GetStaff () const override
	Returns the staff that the separate placement should be matched to.
bool	HasStaffValue () const override
	Overridden method (returning true) since this class contains a staff value.
twobyte	GetMeasure () const override
	Sets the measure that the separate placement should be matched to.
Evpu16	GetHorizontalOffset1 () const
	Returns the 1st horizontal offset, compared to the standard positioning.
Evpu16	GetVerticalOffset1 () const
	Returns the 1st vertical offset, compared to the standard positioning.
Evpu16	GetHorizontalOffset2 () const
	Returns the 2nd horizontal offset, compared to the standard positioning.
Evpu16	GetVerticalOffset2 () const
	Returns the 2nd horizontal offset, compared to the standard positioning.
void	SetStaff (eStaff staff)
	Sets the staff that the separate placement should be matched to.
void	SetMeasure (twobyte meas)
	Sets the measure that the separate placement should be matched to.
void	SetHorizontalOffset1 (Evpu16 value)
	Sets the 1st horizontal offset, compared to the standard positioning.
void	SetVerticalOffset1 (Evpu16 value)
	Sets the 1st horizontal offset, compared to the standard positioning.
void	SetHorizontalOffset2 (Evpu16 value)
	Sets the 2nd horizontal offset, compared to the standard positioning.
void	SetVerticalOffset2 (Evpu16 value)
	Sets the 2nd vertical offset, compared to the standard positioning.
bool	GetVisible () const
	Returns the visibility state. (Whether "Show" is checked in the context menu.)
void	SetVisible (bool state)
	Sets the visibility state. (Whether "Show" is checked in the context menu.)
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 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	DebugDump () override
	Outputs the class data/information for debugging purposes.
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 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().

Member Enumeration Documentation

SEPARATEPLACEMENT_MODES

enum FCSeparatePlacement::SEPARATEPLACEMENT_MODES

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

Constructor & Destructor Documentation

FCSeparatePlacement()

FCSeparatePlacement::FCSeparatePlacement ( )

inline

The constructor.

Lua-supported.

Member Function Documentation

ClassName()

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

GetClassID()

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

GetHorizontalOffset1()

Evpu16 FCSeparatePlacement::GetHorizontalOffset1 ( ) const

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

GetHorizontalOffset2()

Evpu16 FCSeparatePlacement::GetHorizontalOffset2 ( ) const

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

GetMeasure()

twobyte FCSeparatePlacement::GetMeasure ( ) const

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

Returns

The 1-based measure where the positioning is located.

Reimplemented from __FCInciOther.

GetMode()

SEPARATEPLACEMENT_MODES FCSeparatePlacement::GetMode ( ) const

inline

Gets the type of data that should be used when reading/saving the record.

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

Returns

Any of these values:

• SEPARMODE_TEXTREPEAT - Text repeats
• SEPARMODE_BACKWARDREPEAT - Backward repeat brackets
• SEPARMODE_ENDINGREPEAT - Ending repeat brackets
• SEPARMODE_ENDINGREPEATTEXT - Text in ending repeats

GetStaff()

eStaff FCSeparatePlacement::GetStaff ( ) const

inlineoverridevirtual

Returns the staff that the separate placement should be matched to.

Lua-supported (also as property).

Reimplemented from __FCInciOther.

GetVerticalOffset1()

Evpu16 FCSeparatePlacement::GetVerticalOffset1 ( ) const

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

GetVerticalOffset2()

Evpu16 FCSeparatePlacement::GetVerticalOffset2 ( ) const

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

GetVisible()

bool FCSeparatePlacement::GetVisible ( ) const

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

HasStaffValue()

bool FCSeparatePlacement::HasStaffValue ( ) const

inlineoverridevirtual

Overridden method (returning true) since this class contains a staff value.

Reimplemented from __FCInciOther.

SetHorizontalOffset1()

void FCSeparatePlacement::SetHorizontalOffset1 ( Evpu16 value )

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

SetHorizontalOffset2()

void FCSeparatePlacement::SetHorizontalOffset2 ( Evpu16 value )

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

SetMeasure()

void FCSeparatePlacement::SetMeasure ( twobyte meas )

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

Parameters

meas	The 1-based measure number where the positioning is located.

SetMode()

void FCSeparatePlacement::SetMode ( SEPARATEPLACEMENT_MODES mode )

inline

Sets the type of data that should be used when reading/saving the record.

Parameters

mode	Any of these values: SEPARMODE_TEXTREPEAT - Text repeats SEPARMODE_BACKWARDREPEAT - Backward repeat brackets SEPARMODE_ENDINGREPEAT - Ending repeat brackets SEPARMODE_ENDINGREPEATTEXT - Text in ending repeats

SetStaff()

void FCSeparatePlacement::SetStaff ( eStaff staff )

inline

Sets the staff that the separate placement should be matched to.

Lua-supported (also as property).

Parameters

staff

The staff ID where the positioning is located.

SetVerticalOffset1()

void FCSeparatePlacement::SetVerticalOffset1 ( Evpu16 value )

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

SetVerticalOffset2()

void FCSeparatePlacement::SetVerticalOffset2 ( Evpu16 value )

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

SetVisible()

void FCSeparatePlacement::SetVisible ( bool state )

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