The class for a smart shape entry connection style. More...

#include <ff_prefs.h>

Inheritance diagram for FCSmartShapeEntryConnectStyle:

Public Types
enum	SSENTCNCTSTYLE_INDICES { SSENTCNCTSTYLE_HEAD_LEFT_TOP = 0 , SSENTCNCTSTYLE_HEAD_RIGHT_TOP , SSENTCNCTSTYLE_HEAD_RIGHT_BOTTOM , SSENTCNCTSTYLE_HEAD_LEFT_BOTTOM , SSENTCNCTSTYLE_STEM_LEFT_TOP , SSENTCNCTSTYLE_STEM_RIGHT_TOP , SSENTCNCTSTYLE_STEM_RIGHT_BOTTOM , SSENTCNCTSTYLE_STEM_LEFT_BOTTOM , SSENTCNCTSTYLE_NOTE_LEFT_TOP , SSENTCNCTSTYLE_NOTE_RIGHT_TOP , SSENTCNCTSTYLE_NOTE_RIGHT_BOTTOM , SSENTCNCTSTYLE_NOTE_LEFT_BOTTOM , SSENTCNCTSTYLE_NOTE_LEFT_CENTER , SSENTCNCTSTYLE_NOTE_RIGHT_CENTER , SSENTCNCTSTYLE_LYRIC_RIGHT_CENTER , SSENTCNCTSTYLE_LYRIC_LEFT_CENTER , SSENTCNCTSTYLE_LYRIC_RIGHT_BOTTOM , SSENTCNCTSTYLE_HEAD_RIGHT_LYRBASELINE , SSENTCNCTSTYLE_DURATION_LYRBASELINE , SSENTCNCTSTYLE_SYSTEM_LEFT , SSENTCNCTSTYLE_SYSTEM_RIGHT }
	An enum that defines each possible entry connection index. (See GetConnectionIndex.) 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.

SSENTCNCTSTYLE_INDICES	GetConnectionIndex () const
	Returns the connection index for this instance.

Evpu16	GetHorizontalOffset () const
	Return the horizontal offset from the default defined by GetConnectionIndex.

Evpu16	GetVerticalOffset () const
	Return the vertical offset from the default defined by GetConnectionIndex.

void	SetHorizontalOffset (Evpu16 value)
	Sets the horizontal offset from the default defined by GetConnectionIndex.

void	SetVerticalOffset (Evpu16 value)
	Sets the vertical offset from the default defined by GetConnectionIndex.

Public Member Functions inherited from __FCBase
virtual const PDKFRAMEWORK_CLASSID	GetClassID () const
	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.

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.

virtual void	DebugDump ()
	Outputs the class data/information for debugging purposes.

virtual void	DebugDataDump ()
	Outputs a memory dump of the data block in the object for debugging purposes.

virtual void	DebugDataByteArrayDump ()
	Outputs a memory dump of the data block in the object for debugging purposes, as a C++ byte array.

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 __FCBase
	__FCBase ()
	The constructor.

Detailed Description

The class for a smart shape entry connection style.

This is a special class that doesn't save its own document data. Instead, the data is stored by the FCSmartShapePrefs class. FCSmartShapeEntryConnectStyle is not useful in versions of Finale before Finale 26.2, and it always returns zero for all values in unsupported Finale versions.

To an instance of this class, call FCSmartShapePrefs::CreateEntryConnectStyle.

This class was added in version 0.65.

Member Enumeration Documentation

◆ SSENTCNCTSTYLE_INDICES

enum FCSmartShapeEntryConnectStyle::SSENTCNCTSTYLE_INDICES

An enum that defines each possible entry connection index. (See GetConnectionIndex.)

Each connection index defines a vertical and horizontal location relative to a note entry (FCNoteEntry.)

Lua-supported (0.65)

Enumerator
SSENTCNCTSTYLE_HEAD_LEFT_TOP	Connection to left, top of note(s).
SSENTCNCTSTYLE_HEAD_RIGHT_TOP	Connection to right, top side of note(s).
SSENTCNCTSTYLE_HEAD_RIGHT_BOTTOM	Connection to right, bottom side of note(s).
SSENTCNCTSTYLE_HEAD_LEFT_BOTTOM	Connection to left, bottom side of note(s).
SSENTCNCTSTYLE_STEM_LEFT_TOP	Connection to left, top side of stem.
SSENTCNCTSTYLE_STEM_RIGHT_TOP	Connection to right, top side of stem.
SSENTCNCTSTYLE_STEM_RIGHT_BOTTOM	Connection to right, bottom side of stem.
SSENTCNCTSTYLE_STEM_LEFT_BOTTOM	Connection to left, bottom side of stem.
SSENTCNCTSTYLE_NOTE_LEFT_TOP	Connection to left, top side of individual notehead.
SSENTCNCTSTYLE_NOTE_RIGHT_TOP	Connection to right, top side of individual notehead.
SSENTCNCTSTYLE_NOTE_RIGHT_BOTTOM	Connection to right, bottom side of individual notehead.
SSENTCNCTSTYLE_NOTE_LEFT_BOTTOM	Connection to left, bottom side of individual notehead.
SSENTCNCTSTYLE_NOTE_LEFT_CENTER	Connection to left side and vertical center of individual notehead.
SSENTCNCTSTYLE_NOTE_RIGHT_CENTER	Connection to right side and vertical center of individual notehead.
SSENTCNCTSTYLE_LYRIC_RIGHT_CENTER	Connection to right side and vertical center of lyric.
SSENTCNCTSTYLE_LYRIC_LEFT_CENTER	Connection to left side and vertical center of lyric.
SSENTCNCTSTYLE_LYRIC_RIGHT_BOTTOM	Connection to right, bottom side of lyric.
SSENTCNCTSTYLE_HEAD_RIGHT_LYRBASELINE	Connection to right side of note(s) and lyric baseline.
SSENTCNCTSTYLE_DURATION_LYRBASELINE	Connection to duration and lyric baseline.
SSENTCNCTSTYLE_SYSTEM_LEFT	Connection to system left.
SSENTCNCTSTYLE_SYSTEM_RIGHT	Connection to system right.

Member Function Documentation

◆ ClassName()

const char * FCSmartShapeEntryConnectStyle::ClassName ( ) const

inlineoverridevirtual

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

Lua-supported.

Implements __FCBase.

◆ GetConnectionIndex()

SSENTCNCTSTYLE_INDICES FCSmartShapeEntryConnectStyle::GetConnectionIndex ( ) const

inline

Returns the connection index for this instance.

The connection index defines the default location of the smart shape endpoint that is coded with the index.

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

◆ GetHorizontalOffset()

Evpu16 FCSmartShapeEntryConnectStyle::GetHorizontalOffset ( ) const

inline

Return the horizontal offset from the default defined by GetConnectionIndex.

Lua-supported (also as property).

◆ GetVerticalOffset()

Evpu16 FCSmartShapeEntryConnectStyle::GetVerticalOffset ( ) const

inline

Return the vertical offset from the default defined by GetConnectionIndex.

Lua-supported (also as property).

◆ SetHorizontalOffset()

void FCSmartShapeEntryConnectStyle::SetHorizontalOffset ( Evpu16 value )

inline

Sets the horizontal offset from the default defined by GetConnectionIndex.

Lua-supported (also as property).

◆ SetVerticalOffset()

void FCSmartShapeEntryConnectStyle::SetVerticalOffset ( Evpu16 value )

inline

Sets the vertical offset from the default defined by GetConnectionIndex.

Lua-supported (also as property).

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ SSENTCNCTSTYLE_INDICES

Member Function Documentation

◆ ClassName()

◆ GetConnectionIndex()

◆ GetHorizontalOffset()

◆ GetVerticalOffset()

◆ SetHorizontalOffset()

◆ SetVerticalOffset()