FCCustomSmartLineDef Class Reference

The class for a custom smart shape lines. More...

#include <ff_smartshapes.h>

Inheritance diagram for FCCustomSmartLineDef:

Public Types
enum	TEXT_REFERENCE {   TEXTREF_LEFTSTART = 0 , TEXTREF_LEFTCONTINUATION , TEXTREF_RIGHTEND , TEXTREF_CENTERFULL ,   TEXTREF_CENTERABBREVIATED }
	Constant used to reference the different text positions in this class' methods. 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.
	FCCustomSmartLineDef ()
	The constructor. It sets the _use2012version flag.
bool	DeepDeleteData () override
	Overridden version of DeepDeleteData(). It deletes the text strings as well as the data.
twobyte	GetRawStringNumber (TEXT_REFERENCE reference)
	Returns the raw string number for one of the attached text blocks.
Evpu16	GetHorizontalTextPos (TEXT_REFERENCE reference)
	Returns the horizontal position for one of the attached text blocks.
Evpu16	GetVerticalTextPos (TEXT_REFERENCE reference)
	Returns the vertical position for one of the attached text blocks.
void	SetHorizontalTextPos (TEXT_REFERENCE reference, Evpu16 position)
	Sets the horizontal position for one of the attached text blocks.
void	SetVerticalTextPos (TEXT_REFERENCE reference, Evpu16 position)
	Sets the vertical position for one of the attached text blocks.
twobyte	GetLineStyle () const
	Returns any of these constants: CUSTOMLINE_SOLID, CUSTOMLINE_DASHED, CUSTOMLINE_CHARACTER.
Efix16	GetLineWidth () const
	Returns the line width for solid and dashed lines.
twobyte	GetStartArrowheadStyle () const
	Returns the style of the start arrowhead.
twobyte	GetEndArrowheadStyle () const
	Returns the style of the end arrowhead.
twobyte	GetStartArrowheadShapeID () const
	Returns the (custom) shape ID for the start arrowhead, if a shape is used.
twobyte	GetEndArrowheadShapeID () const
	Returns the (custom) shape ID for the end arrowhead, if a shape is used.
eUniChar32	GetLineCharacter () const
	Returns the character used for character lines.
FCString *	CreateTextString (TEXT_REFERENCE reference)
	Creates a text string object of the indicated position text.
bool	SaveTextString (TEXT_REFERENCE reference, FCString *pString)
	Resaves a text string to an already existing text position block.
bool	SaveNewTextString (TEXT_REFERENCE reference, FCString *pString)
	Saves a text string to a new text position block.
twobyte	GetLineCharacterBaselineShift () const
	Returns the vertical adjustment value for characters on a character line. In EMs.
void	SetLineCharacterBaselineShift (twobyte baseline)
	Sets the vertical adjustment value for characters on a character line. In EMs.
void	GetLineCharacterFontInfo (FCFontInfo *pFontInfo)
	Gets the font information for a character line.
void	SetLineCharacterFontInfo (FCFontInfo *pFontInfo)
	Sets the font information for a character line.
bool	GetHorizontal () const
	Returns if the shape should only be allowed to be horizontal or not.
void	SetHorizontal (bool state)
	Sets if the shape should only be allowed to be horizontal or not.
bool	GetUseAfterStartTextOffset () const
	Gets whether the shape line should use the horizontal start "after text" adjustment setting.
void	SetUseAfterStartTextOffset (bool state)
	Sets if the shape line should use the horizontal start "after text" adjustment setting.
Evpu16	GetStartLineHorizontalOffset () const
	Gets the horizontal start line adjustment setting.
void	SetStartLineHorizontalOffset (Evpu16 value)
	Sets the horizontal start line adjustment setting.
bool	GetUseBeforeEndTextOffset () const
	Gets whether the shape line should use the horizontal end "before text" adjustment setting.
void	SetUseBeforeEndTextOffset (bool state)
	Sets if the shape line should use the horizontal end "before text" adjustment setting.
Evpu16	GetEndLineHorizontalOffset () const
	Gets the horizontal end line adjustment setting.
void	SetEndLineHorizontalOffset (Evpu16 value)
	Sets the horizontal end line adjustment setting.
bool	GetUseAfterContinuationTextOffset () const
	Gets whether the shape line should use the horizontal continuation "after text" adjustment setting.
void	SetUseAfterContinuationTextOffset (bool state)
	Sets if the shape line should use the horizontal continuation "after text" adjustment setting.
Evpu16	GetContinuationLineHorizontalOffset () const
	Gets the horizontal continuation line adjustment setting.
void	SetContinuationLineHorizontalOffset (Evpu16 value)
	Sets the horizontal continuation line adjustment setting.
Evpu16	GetLineVerticalOffset () const
	Gets the vertical position adjustment for lines.
void	SetLineVerticalOffset (Evpu16 value)
	Sets the vertical position adjustment for lines.
void	SetLineStyle (twobyte value)
	Sets the line style to any of these constants: CUSTOMLINE_SOLID, CUSTOMLINE_DASHED, CUSTOMLINE_CHARACTER.
void	SetLineWidth (Efix16 value)
	Sets the line width for solid and dashed lines.
Efix16	GetLineDashLength () const
	Returns the line dash length for solid and dashed lines, in EFIXes.
void	SetLineDashLength (Efix16 value)
	Sets the line dash length for dashed lines, in EFIXes.
Efix16	GetLineDashSpace () const
	Returns the line dash length for dashed lines, in EFIXes.
void	SetLineDashSpace (Efix16 value)
	Sets the line dash length for dashed lines, in EFIXes.
void	SetStartArrowheadStyle (twobyte value)
	Sets the style of the start arrowhead.
void	SetStartArrowheadShapeID (twobyte shapeID)
	Sets the (custom) shape ID for the start arrowhead.
void	SetEndArrowheadStyle (twobyte value)
	Returns the style of the end arrowhead.
Efix16	GetStartHookLength () const
	Returns the start hook length if the end arrowhead styles has been set to hook. The value is in EFIXes.
void	SetStartHookLength (Efix16 value)
	Sets the start hook length if the end arrowhead styles has been set to hook. The value is in EFIXes.
Efix16	GetEndHookLength () const
	Sets the end hook length if the end arrowhead styles has been set to hook. The value is in EFIXes.
void	SetEndHookLength (Efix16 value)
	Sets the end hook length if the end arrowhead styles has been set to hook. The value is in EFIXes.
void	SetEndArrowheadShapeID (twobyte shapeID)
	Sets the (custom) shape ID for the end arrowhead.
void	SetLineCharacter (eUniChar32 character)
	Sets the character used for character lines.
void	DebugDump () override
	Outputs the class data/information for debugging purposes.
Public Member Functions inherited from __FCNoInciOther
	__FCNoInciOther ()
	The constructor.
virtual bool	Load (CMPER itemno)
	Loads the indicated item.
bool	Reload () override
	Overridden Reload() method to support complex data types.
virtual bool	SaveAs (CMPER itemno)
	Saves the data under another item number. The object will now be connected to the new item number.
virtual bool	DeepSaveAs (CMPER itemno)
	Saves the data under another item number, but also makes a deep copy of the object.
virtual bool	SaveNew ()
	Creates the data as completely new item number. The object will now be connected to the new item number.
virtual CMPER	GetItemNo () const
	Returns the item number. This typically points to items such as a page number, a measure number, a 1-based expression definition number, etc.
void	SetItemNo (CMPER cmper)
	Sets the item number. Use with extreme care! This is mostly intended for situations when creating new records isn't supported by Finale (preventing SaveAs to work).
bool	LoadFirst () override
	Loads the first element of 1-based data.
Public Member Functions inherited from __FCOther
void	SetCmperAndInci (CMPER cmper, twobyte inci)
	Sets both the CMPER and the incident number in the dataID record. Mainly for internal use.
	__FCOther ()
	The constructor.
bool	IsIdenticalRecord (__FCOther *pCompare)
	Compares an object to see if both objects point to the same data record.
Public Member Functions inherited from __FCBaseData
EDOCID	GetConnectedDocID () const
	Returns the document ID that was connected to the last load/save of the data.
bool	VerifyConnectedDocID ()
	Checks that the stored document ID for the data object matches the current document's ID.
virtual EXTAG	Tag () const =0
	The Enigma tag for the derived class.
virtual EVERSION	EnigmaVersion () const
	The Enigma version for save/load/create/delete operations.
virtual int	DataSizeLoad () const =0
	Returns the data size for the data structure that should be loaded.
virtual int	DataSizeSave () const
	Returns the data size for the data structure that should be saved or created.
void	_CloneFrom (__FCBaseData *pSource)
	For internal use only. Copies object data (except data block) from another object.
virtual void	CloneMemoryFrom (__FCBaseData *pSource)
const EDataID *	_GetDataID ()
	Intended ONLY for the _CloneFrom implementation.
int	_GetLoadedSize () const
	Intended ONLY for the _CloneFrom implementation.
const void *	GetDataBlock ()
	Intended ONLY for the _CloneFrom implementation.
EXTAG	GetCustomTag () const
	Returns the custom Enigma tag, if any.
void	SetCustomTag (EXTAG tag)
	Sets the custom Enigma tag, for classes that support multiple Enigma tags.
	__FCBaseData ()
	The constructor.
virtual	~__FCBaseData ()
	Virtual destructor.
virtual bool	Save ()
	Saves the currently loaded to its current location.
virtual bool	DeleteData ()
	Deletes the associated data from Finale's database. Be careful when deleting multiple objects.
virtual bool	LoadLast ()
	Loads the very last element in the database, if any.
virtual bool	LoadNext ()
	Loads the next element from the database, if any.
virtual bool	LoadPrevious ()
	Loads the previous element in the database, if any.
bool	RelinkToCurrentView ()
	Relinks the contents in the current view so that the score and part(s) match.
bool	RelinkToScore ()
	Relinks all parts to the contents of the score.
__FCBaseData *	CreateClone ()
	Creates an identical copy of an object.
void	DebugDataDump () override
	Outputs a memory dump of the data block in the object for debugging purposes.
void	DebugDataByteArrayDump () override
	Outputs a memory dump of the data block in the object for debugging purposes, as a C++ byte array.
void	DebugDataOffsetDump (int offset, int size)
	For debug mode only. Dumps a data memory block at a specific offset and with a specific size.
FCNumbers *	CreateRawDataDump ()
	Creates a byte collection with the raw loaded data block for the object (if the object type supports single data blocks). This method is only intended for debug purposes.
Public Member Functions inherited from __FCBase
virtual	~__FCBase ()
	Virtual destructor, so all inherited classes get the virtual destructor.
void	DebugMsgInt (const char *pszPrefixText, int i)
	Creates a simple Message Box for debug purposes. The text appears with the extra digit (in decimal presentation) appearing afterwards.
void	DebugMsgHex (const char *pszPrefixText, int i)
	Creates a simple Message Box for debug purposes. The text appears with the extra digit (as a hexadecimal number) appearing afterwards.
void	DebugMsgString (const char *pszPrefixText, const char *thestring)
	Creates a simple Message Box for debug purposes. The text appears with the extra string appearing afterwards.
void	DebugMsg (const char *pszMsg)
	Creates a simple Message Box for debug purposes with just one text string.
void	DebugOutMenuInfo (FCUI *pUI, int menuixd_horiz, int menuixd_vert) const
	Outputs the menu command info for debugging purposes.
int	DebugOutFormat (const char *fmt,...)
	Outputs debug text using C style "printf" syntax.
void	Set16BitFlag (FLAG_16 *flag, FLAG_16 flagbits, bool state)
	Sets a 16 bit flag.
void	Set32BitFlag (FLAG_32 *flag, FLAG_32 flagbits, bool state)
	Sets/resets a 32 bit flag, by using a bit mask.
bool	GetBitFlag (FLAG_32 flag, FLAG_32 flagbits) const
	Gets a state from flag bits. Returns true if any bit in the mask is set.
int	GetBitCount (FLAG_32 flag)
	Returns the total number of set bits in a 32-bit unsigned int.
void	SetSpecific32Bit (FLAG_32 *flag, int bitnumber, bool state)
	Sets/resets a single bit in a 32 bit flag, by specifying one specific bit.
void	SetUserData (void *pData)
	Sets the user data attached to the instance of an object.
void	SetUserData2 (void *pData)
	Sets the additional user data attached to the instance of an object.
void *	GetUserData () const
	Gets the user data attached to the instance of an object.
void *	GetUserData2 () const
	Gets the additional user data attached to the instance of an object.
virtual bool	IsIdentical (const __FCBase *pCompareObject) const
	Returns true if the data in the passed object is considered to be identical to the current object, otherwise false.
void	StoreXML_String (tinyxml2::XMLElement *pParentNode, const char *pszElementName, FCString *pStringValue)
	Helper function to store FCString objects in the XML file.
void	StoreXML_Integer (tinyxml2::XMLElement *pParentNode, const char *pszElementName, int value)
	Helper function to store integer objects in the XML file.
void	StoreXML_Bool (tinyxml2::XMLElement *pParentNode, const char *pszElementName, bool value)
	Helper function to store boolean objects in the XML file.
void	StoreXML_StringAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, FCString *pStringValue)
	Helper function to store FCString objects in the XML file, as an attribute to a node.
void	StoreXML_IntegerAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, int value)
	Helper function to store integer objects in the XML file, as an attribute to a node.
void	StoreXML_BoolAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, bool value)
	Helper function to store boolean objects in the XML file, as an attribute to a node.
void	StoreXML_FloatAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, float value)
	Helper function to store floating point objects in the XML file, as an attribute to a node.
virtual void	StoreToXML (tinyxml2::XMLElement *pParentNode)
	Virtual method that is used to store an object's data.
bool	ReadXML_String (tinyxml2::XMLElement *pParentNode, const char *pszElementName, FCString *pStringValue)
	Helper method to read FCString objects from the XML file.
bool	ReadXML_Integer (tinyxml2::XMLElement *pParentNode, const char *pszElementName, int *pValue)
	Helper method to read integer objects from the XML file.
bool	ReadXML_Bool (tinyxml2::XMLElement *pParentNode, const char *pszElementName, bool *pValue)
	Helper method to read boolean objects from the XML file.
bool	ReadXML_StringAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, FCString *pStringValue)
	Helper method to read FCString objects from the XML file, as an attribute to a node.
bool	ReadXML_IntegerAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, int *pValue)
	Helper method to read integer objects from the XML file, as an attribute to a node.
bool	ReadXML_BoolAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, bool *pValue)
	Helper method to read boolean objects from the XML file, as an attribute to a node.
bool	ReadXML_FloatAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, float *pValue)
	Helper method to read floating point objects from the XML file, as an attribute to a node.
virtual bool	ReadFromXML (tinyxml2::XMLElement *pParentNode)
	Virtual method that is used to read object data.

Additional Inherited Members
Static Public Member Functions inherited from __FCBase
static void	DebugOutPtr (const char *pszPrefixText, void *ptr)
	Static method that outputs a line for debugging purposes. The prefix text appears with the extra ptr (in hexadeximal representation) appearing afterwards.
static void	DebugOutInt (const char *pszPrefixText, int i)
	Static method that outputs a line for debugging purposes. The text appears with the extra digit (in decimal presentation) appearing afterwards.
static void	DebugOutFloat (const char *pszPrefixText, double f)
	Static method that outputs a line for debugging purposes. The text appears with the extra float value appearing afterwards.
static void	DebugOutTag (const char *pszPrefixText, EXTAG extag)
	Static method that outputs a line for debugging purposes. The text appears with the EXTAG (in text) appearing afterwards.
static void	DebugOutHex (const char *pszPrefixText, int i)
	Static method that outputs a line for debugging purposes. The text appears with the extra digit (in hexadecimal presentation) appearing afterwards.
static void	DebugOutBin (const char *pszPrefixText, int i)
	Static method that outputs a line for debugging purposes. The text appears with the extra digit (in binary presentation) appearing afterwards.
static void	DebugOutString (const char *pszPrefixText, const char *thestring)
	Static method that outputs a line for debugging purposes (C string version). The text appears with the extra string appearing afterwards.
static void	DebugOutString (const char *pszPrefixText, FCString *pString)
	Static method that outputs a line for debugging purposes (FCString version). The text appears with the extra string appearing afterwards.
static void	DebugOutBool (const char *pszPrefixText, bool state)
	Static method that outputs a line for debugging purposes. The boolean state appears afterwards as either "TRUE" or "FALSE".
static void	DebugOutBlock (const void *pBuffer, int startoffset, int size)
	Static method that outputs a memory block for debugging purposes. Eight bytes per line will appear (as hex digits) until the whole memory block is dumped.
static void	DebugOutByteArrayBlock (const void *pBuffer, int startoffset, int size)
	Static method that outputs a memory block for debugging purposes. Eight bytes per line will appear (as hex digits) as a C++ onebyte array, until the whole memory block is dumped.
static void	DebugOut (const char *pszLine)
	Static method to output a line of text for debugging purposes.
Protected Member Functions inherited from __FCBaseData
virtual void *	Allocate ()=0
virtual void	Deallocate ()
virtual bool	IsDynamicSize ()
bool	LoadDataBlock ()
	Loads the data. If the object is of dynamic size, the old memory block is freed and a new is allocated.
void	ClearData ()
virtual twobyte	CalcLastInci ()
	For internal use only!
virtual __FCBaseData *	CreateObject ()=0
	Creates a new instance of the object.
bool	DataIsLoaded () const
	Returns true is any data has been loaded into the object.
void	_TagDocumentID ()
	For internal use only.
Protected Member Functions inherited from __FCBase
	__FCBase ()
	The constructor.
Protected Attributes inherited from __FCBaseData
EDOCID	_connecteddocID
	The "connected" document ID., which is the document the where the document was loaded (or last saved). This is for a mechanism to prevent resaving of certain data in other documents.
void *	_datablock
	Pointer to the object's data block, the meaning is implementation-specific for each derived subclass.
bool	_heapdatablock
	Variable that tells if _datablock is dynamically created on the heap (and should be deleted at object destruction).
int	_loadedsize
	Loaded size of the data block for a loaded object, in bytes. Since the datablock is implementation-specific, the _loadedsize should be updated by child classes that create new data.
EDataID	_dataid
	The EdataID for the last loaded/saved object.

Detailed Description

The class for a custom smart shape lines.

This class uses the both the pre-2012 and 2012 format of the structure and tag. When it's running on Finale 2012 or above, the class uses the 2012 version.

Member Enumeration Documentation

TEXT_REFERENCE

enum FCCustomSmartLineDef::TEXT_REFERENCE

Constant used to reference the different text positions in this class' methods.

Lua-supported.

Constructor & Destructor Documentation

FCCustomSmartLineDef()

FCCustomSmartLineDef::FCCustomSmartLineDef

(

)

The constructor. It sets the _use2012version flag.

Lua-supported.

Member Function Documentation

ClassName()

const char * FCCustomSmartLineDef::ClassName ( ) const

inlineoverridevirtual

Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child class.

Lua-supported.

Reimplemented from __FCNoInciOther.

CreateTextString()

FCString * FCCustomSmartLineDef::CreateTextString ( TEXT_REFERENCE reference )

inline

Creates a text string object of the indicated position text.

Lua-supported.

Parameters

reference

Any of these constants TEXTREF_LEFTSTART, TEXTREF_LEFTCONTINUATION, TEXTREF_RIGHTEND, TEXTREF_CENTERFULL, TEXTREF_CENTERABBREVIATED

Returns

NULL on error or if there are no string. Otherwise the pointer to the text object.

DebugDump()

void FCCustomSmartLineDef::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 __FCNoInciOther.

DeepDeleteData()

bool FCCustomSmartLineDef::DeepDeleteData ( )

overridevirtual

Overridden version of DeepDeleteData(). It deletes the text strings as well as the data.

Reimplemented from __FCNoInciOther.

GetClassID()

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

GetContinuationLineHorizontalOffset()

Evpu16 FCCustomSmartLineDef::GetContinuationLineHorizontalOffset ( ) const

inline

Gets the horizontal continuation line adjustment setting.

See comments at SetContinuationLineHorizontalOffset.

Lua-supported (also as property) (0.61)

GetEndArrowheadShapeID()

twobyte FCCustomSmartLineDef::GetEndArrowheadShapeID ( ) const

inline

Returns the (custom) shape ID for the end arrowhead, if a shape is used.

Lua-supported (also as property).

Returns

0 if custom shape isn't used as the end style. Otherwise, the shape ID.

GetEndArrowheadStyle()

twobyte FCCustomSmartLineDef::GetEndArrowheadStyle ( ) const

inline

Returns the style of the end arrowhead.

Lua-supported (also as property).

Returns

Any of these values: CLENDPOINT_NONE, CLENDPOINT_PRESET, CLENDPOINT_CUSTOM, CLENDPOINT_HOOK

GetEndHookLength()

Efix16 FCCustomSmartLineDef::GetEndHookLength ( ) const

inline

Sets the end hook length if the end arrowhead styles has been set to hook. The value is in EFIXes.

Lua-supported (also as property).

GetEndLineHorizontalOffset()

Evpu16 FCCustomSmartLineDef::GetEndLineHorizontalOffset ( ) const

inline

Gets the horizontal end line adjustment setting.

See comments at SetEndLineHorizontalOffset.

Lua-supported (also as property) (0.61)

GetHorizontal()

bool FCCustomSmartLineDef::GetHorizontal ( ) const

inline

Returns if the shape should only be allowed to be horizontal or not.

Lua-supported (also as property).

GetHorizontalTextPos()

Evpu16 FCCustomSmartLineDef::GetHorizontalTextPos ( TEXT_REFERENCE reference )

inline

Returns the horizontal position for one of the attached text blocks.

Lua-supported.

Parameters

reference

Any of the TEXTREF_ constants.

Returns

The distance in EVPUs.

GetLineCharacter()

eUniChar32 FCCustomSmartLineDef::GetLineCharacter ( ) const

inline

Returns the character used for character lines.

Lua-supported (also as property).

Returns

0 if character isn't used as the line style. Otherwise, the character.

GetLineCharacterBaselineShift()

twobyte FCCustomSmartLineDef::GetLineCharacterBaselineShift ( ) const

inline

Returns the vertical adjustment value for characters on a character line. In EMs.

Lua-supported (also as property).

GetLineCharacterFontInfo()

void FCCustomSmartLineDef::GetLineCharacterFontInfo ( FCFontInfo * pFontInfo )

inline

Gets the font information for a character line.

Lua-supported.

GetLineDashLength()

Efix16 FCCustomSmartLineDef::GetLineDashLength ( ) const

inline

Returns the line dash length for solid and dashed lines, in EFIXes.

Lua-supported (also as property).

GetLineDashSpace()

Efix16 FCCustomSmartLineDef::GetLineDashSpace ( ) const

inline

Returns the line dash length for dashed lines, in EFIXes.

Currently only works on Finale 2012 and above.

Lua-supported (also as property).

GetLineStyle()

twobyte FCCustomSmartLineDef::GetLineStyle ( ) const

inline

Returns any of these constants: CUSTOMLINE_SOLID, CUSTOMLINE_DASHED, CUSTOMLINE_CHARACTER.

Lua-supported (also as property).

GetLineVerticalOffset()

Evpu16 FCCustomSmartLineDef::GetLineVerticalOffset ( ) const

inline

Gets the vertical position adjustment for lines.

Lua-supported (also as property) (0.61)

GetLineWidth()

Efix16 FCCustomSmartLineDef::GetLineWidth ( ) const

inline

Returns the line width for solid and dashed lines.

Lua-supported (also as property).

GetRawStringNumber()

twobyte FCCustomSmartLineDef::GetRawStringNumber ( TEXT_REFERENCE reference )

inline

Returns the raw string number for one of the attached text blocks.

Lua-supported.

Parameters

reference

Any of the TEXTREF_ constants.

Returns

0 if not found.

GetStartArrowheadShapeID()

twobyte FCCustomSmartLineDef::GetStartArrowheadShapeID ( ) const

inline

Returns the (custom) shape ID for the start arrowhead, if a shape is used.

Lua-supported (also as property).

Returns

0 if no custom shape is used as the start style. Otherwise, the shape ID.

GetStartArrowheadStyle()

twobyte FCCustomSmartLineDef::GetStartArrowheadStyle ( ) const

inline

Returns the style of the start arrowhead.

Lua-supported (also as property).

Returns

Any of these values: CLENDPOINT_NONE, CLENDPOINT_PRESET, CLENDPOINT_CUSTOM, CLENDPOINT_HOOK

GetStartHookLength()

Efix16 FCCustomSmartLineDef::GetStartHookLength ( ) const

inline

Returns the start hook length if the end arrowhead styles has been set to hook. The value is in EFIXes.

Lua-supported (also as property).

GetStartLineHorizontalOffset()

Evpu16 FCCustomSmartLineDef::GetStartLineHorizontalOffset ( ) const

inline

Gets the horizontal start line adjustment setting.

See comments at SetStartLineHorizontalOffset.

Lua-supported (also as property) (0.61)

GetUseAfterContinuationTextOffset()

bool FCCustomSmartLineDef::GetUseAfterContinuationTextOffset ( ) const

inline

Gets whether the shape line should use the horizontal continuation "after text" adjustment setting.

Lua-supported (also as property) (0.61)

GetUseAfterStartTextOffset()

bool FCCustomSmartLineDef::GetUseAfterStartTextOffset ( ) const

inline

Gets whether the shape line should use the horizontal start "after text" adjustment setting.

Lua-supported (also as property) (0.61)

GetUseBeforeEndTextOffset()

bool FCCustomSmartLineDef::GetUseBeforeEndTextOffset ( ) const

inline

Gets whether the shape line should use the horizontal end "before text" adjustment setting.

Lua-supported (also as property) (0.61)

GetVerticalTextPos()

Evpu16 FCCustomSmartLineDef::GetVerticalTextPos ( TEXT_REFERENCE reference )

inline

Returns the vertical position for one of the attached text blocks.

Lua-supported.

Parameters

reference

Any of the TEXTREF_ constants.

Returns

The position in EVPUs.

SaveNewTextString()

bool FCCustomSmartLineDef::SaveNewTextString ( TEXT_REFERENCE reference, FCString * pString )

inline

Saves a text string to a new text position block.

Parameters

reference	Any of these constants TEXTREF_LEFTSTART, TEXTREF_LEFTCONTINUATION, TEXTREF_RIGHTEND, TEXTREF_CENTERFULL, TEXTREF_CENTERABBREVIATED
pString	Pointer to the FCString object.

Lua-supported.

Returns

True on success.

SaveTextString()

bool FCCustomSmartLineDef::SaveTextString ( TEXT_REFERENCE reference, FCString * pString )

inline

Resaves a text string to an already existing text position block.

Lua-supported.

Parameters

reference	Any of these constants TEXTREF_LEFTSTART, TEXTREF_LEFTCONTINUATION, TEXTREF_RIGHTEND, TEXTREF_CENTERFULL, TEXTREF_CENTERABBREVIATED
pString	Pointer to the FCString object.

Returns

True on success.

SetContinuationLineHorizontalOffset()

void FCCustomSmartLineDef::SetContinuationLineHorizontalOffset ( Evpu16 value )

inline

Sets the horizontal continuation line adjustment setting.

If GetUseAfterContinuationTextOffset is true then this value specifies the gap between the end of the continuation text and the start of line. Otherwise it specifies an offset from the the left handle to the start of the continuation line (ignoring any continuation text).

Lua-supported (also as property) (0.61)

SetEndArrowheadShapeID()

void FCCustomSmartLineDef::SetEndArrowheadShapeID ( twobyte shapeID )

inline

Sets the (custom) shape ID for the end arrowhead.

The ArrowheadStyle needs to be set to CLENDPOINT_CUSTOM, which isn't done here.

Lua-supported (also as property).

SetEndArrowheadStyle()

void FCCustomSmartLineDef::SetEndArrowheadStyle ( twobyte value )

inline

Returns the style of the end arrowhead.

Lua-supported (also as property).

Parameters

value

Any of these values: CLENDPOINT_NONE, CLENDPOINT_PRESET, CLENDPOINT_CUSTOM, CLENDPOINT_HOOK

SetEndHookLength()

void FCCustomSmartLineDef::SetEndHookLength ( Efix16 value )

inline

Sets the end hook length if the end arrowhead styles has been set to hook. The value is in EFIXes.

Lua-supported (also as property).

SetEndLineHorizontalOffset()

void FCCustomSmartLineDef::SetEndLineHorizontalOffset ( Evpu16 value )

inline

Sets the horizontal end line adjustment setting.

If GetUseBeforeEndTextOffset is true then this value specifies the gap between the end of the line and beginning of the end text. Otherwise it specifies an offset from the end of the line to the right handle (ignoring any end text).

Lua-supported (also as property) (0.61)

SetHorizontal()

void FCCustomSmartLineDef::SetHorizontal ( bool state )

inline

Sets if the shape should only be allowed to be horizontal or not.

Lua-supported (also as property).

SetHorizontalTextPos()

void FCCustomSmartLineDef::SetHorizontalTextPos ( TEXT_REFERENCE reference, Evpu16 position )

inline

Sets the horizontal position for one of the attached text blocks.

Lua-supported.

Parameters

reference	Any of the TEXTREF_ constants.
position	The position in EVPUs.

SetLineCharacter()

void FCCustomSmartLineDef::SetLineCharacter ( eUniChar32 character )

inline

Sets the character used for character lines.

The line style needs to be set to CUSTOMLINE_CHARACTER separately as well.

Lua-supported (also as property).

Parameters

character

The character to use as the line.

SetLineCharacterBaselineShift()

void FCCustomSmartLineDef::SetLineCharacterBaselineShift ( twobyte baseline )

inline

Sets the vertical adjustment value for characters on a character line. In EMs.

Lua-supported (also as property).

SetLineCharacterFontInfo()

void FCCustomSmartLineDef::SetLineCharacterFontInfo ( FCFontInfo * pFontInfo )

inline

Sets the font information for a character line.

Lua-supported.

SetLineDashLength()

void FCCustomSmartLineDef::SetLineDashLength ( Efix16 value )

inline

Sets the line dash length for dashed lines, in EFIXes.

Currently only works on Finale 2012 and above.

Lua-supported (also as property).

SetLineDashSpace()

void FCCustomSmartLineDef::SetLineDashSpace ( Efix16 value )

inline

Sets the line dash length for dashed lines, in EFIXes.

Currently only works on Finale 2012 and above.

Lua-supported (also as property).

SetLineStyle()

void FCCustomSmartLineDef::SetLineStyle ( twobyte value )

inline

Sets the line style to any of these constants: CUSTOMLINE_SOLID, CUSTOMLINE_DASHED, CUSTOMLINE_CHARACTER.

Lua-supported (also as property).

SetLineVerticalOffset()

void FCCustomSmartLineDef::SetLineVerticalOffset ( Evpu16 value )

inline

Sets the vertical position adjustment for lines.

Lua-supported (also as property) (0.61)

SetLineWidth()

void FCCustomSmartLineDef::SetLineWidth ( Efix16 value )

inline

Sets the line width for solid and dashed lines.

Lua-supported (also as property).

SetStartArrowheadShapeID()

void FCCustomSmartLineDef::SetStartArrowheadShapeID ( twobyte shapeID )

inline

Sets the (custom) shape ID for the start arrowhead.

The ArrowheadStyle needs to be set to CLENDPOINT_CUSTOM, which isn't done here.

Lua-supported (also as property).

SetStartArrowheadStyle()

void FCCustomSmartLineDef::SetStartArrowheadStyle ( twobyte value )

inline

Sets the style of the start arrowhead.

Lua-supported (also as property).

Parameters

value

Any of these values: CLENDPOINT_NONE, CLENDPOINT_PRESET, CLENDPOINT_CUSTOM, CLENDPOINT_HOOK

SetStartHookLength()

void FCCustomSmartLineDef::SetStartHookLength ( Efix16 value )

inline

Sets the start hook length if the end arrowhead styles has been set to hook. The value is in EFIXes.

Lua-supported (also as property).

SetStartLineHorizontalOffset()

void FCCustomSmartLineDef::SetStartLineHorizontalOffset ( Evpu16 value )

inline

Sets the horizontal start line adjustment setting.

If GetUseAfterStartTextOffset is true then this value specifies the gap between the end of the start text and the start of line. Otherwise it specifies an offset from the the left handle to the start of the line (ignoring any start text).

Lua-supported (also as property) (0.61)

SetUseAfterContinuationTextOffset()

void FCCustomSmartLineDef::SetUseAfterContinuationTextOffset ( bool state )

inline

Sets if the shape line should use the horizontal continuation "after text" adjustment setting.

Lua-supported (also as property) (0.61)

SetUseAfterStartTextOffset()

void FCCustomSmartLineDef::SetUseAfterStartTextOffset ( bool state )

inline

Sets if the shape line should use the horizontal start "after text" adjustment setting.

Lua-supported (also as property) (0.61)

SetUseBeforeEndTextOffset()

void FCCustomSmartLineDef::SetUseBeforeEndTextOffset ( bool state )

inline

Sets if the shape line should use the horizontal end "before text" adjustment setting.

Lua-supported (also as property) (0.61)

SetVerticalTextPos()

void FCCustomSmartLineDef::SetVerticalTextPos ( TEXT_REFERENCE reference, Evpu16 position )

inline

Sets the vertical position for one of the attached text blocks.

Lua-supported.

Parameters

reference	Any of the TEXTREF_ constants.
position	The position in EVPUs.