FCTextBlock Class Reference

Class for a text block. More...

#include <ff_other.h>

Inheritance diagram for FCTextBlock:

Public Types
enum	TEXTBLOCKJUSTIFY {   TEXTJUSTIFY_LEFT = TEXT_JUSTIFY_LEFT , TEXTJUSTIFY_RIGHT = TEXT_JUSTIFY_RIGHT , TEXTJUSTIFY_CENTER = TEXT_JUSTIFY_CENTER , TEXTJUSTIFY_FULL = TEXT_JUSTIFY_FULL ,   TEXTJUSTIFY_FORCED_FULL = TEXT_JUSTIFY_FORCED_FULL }
	Constants for text justification.
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.
	FCTextBlock ()
	The constructor.
twobyte	GetRawTextID () const
	Returns the text ID for the raw text.
void	_SetRawTextID (twobyte therawtextid)
	Sets the text ID for the raw text.
EXTAG	GetRawTextExtag ()
	Returns the full EXTAG that is used to store the raw text.
twobyte	GetShapeID () const
	Return the layout shape ID for the text block.
FCString *	CreateRawTextString ()
	Creates a string object for the connected raw text.
bool	SaveRawTextString (FCString *pString)
	Saves the raw text string in an existing text block.
bool	SaveNewRawTextString (FCString *pString)
	Saves a new raw text string.
void	SetShapeID (twobyte shapeID)
	Sets the layout shape ID for the text block.
void	SetRawText (twobyte theid, ETAG tag=LO_UTWOBYTE(tx_TextBlock))
	Sets the raw text ID and tag for the raw text. This can be used prior to SaveNewRawTextString to set the tag, for example by using the id of 0.
void	SetJustification (FLAG_16 justification)
	Sets the justification to any of the text block justification styles.
bool	DeepDeleteData () override
	Reimplementation to delete raw text as well.
twobyte	GetLineSpacing () const
	Returns the line spacing value for the text block.
void	SetLineSpacing (twobyte linespacing)
	Sets the line spacing value for the text block.
FLAG_16	GetJustification () const
	Returns the justification for the text block.
bool	GetFrameReference () const
	Returns if the text block should be positioned by the frame layout or not. This is a compatibility bit for text blocks created in very early Finale versions.
bool	GetLineSpacingIsPercent () const
	Returns if the line spacing value should be percent or points.
bool	GetWordWrap () const
	Returns true if the text should word wrap automatically.
bool	GetExpandSingleWord () const
	Returns the "expand single word" state, which effects the full justification modes.
bool	GetRoundedCorners () const
	Returns if the text frame should use rounded corners.
Efix32	GetRoundedCornerRadius () const
	Returns the rounded corner radius, to use when rounded corners are enabled for the text block frame.
void	SetFrameReference (bool state)
	Sets if the text block should be positioned by the frame layout or not.
void	SetLineSpacingIsPercent (bool state)
	Sets if the line spacing value should be percent or points.
void	SetWordWrap (bool state)
	Sets if the text should word wrap automatically.
void	SetExpandSingleWord (bool state)
	Sets the "expand single word" state, which effects the full justification modes.
void	SetRoundedCorners (bool state)
	Sets if the text frame should use rounded corners.
void	SetRoundedCornerRadius (Efix32 radius)
	Sets the rounded corner radius, to use when rounded corners are enabled for the text block frame.
void	SetLineWidth (int value)
	Sets the line width (in EFIXes) of the frame's border.
void	SetLineInset (int value)
	Sets the inset between text and border (in EFIXes) for the frame's border.
void	SetHorizontalTextOffset (int value)
	Sets the horizontal offset for the text (relative to the left frame side).
void	SetVerticalTextOffset (int value)
	Sets the vertical offset for the text (relative to the left frame side).
void	SetShowBorders (bool state)
	Sets if the borders should display for the txt block, or not.
void	SetWidth (Evpu16 width)
	Sets the fixed width of the frame.
void	SetHeight (Evpu16 height)
	Sets the fixed height of the frame.
int	GetLineWidth () const
	Returns the line width of the frame's border.
int	GetLineInset () const
	Returns the inset between text and border (in EFIXes) for the frame's border.
int	GetHorizontalTextOffset () const
	Returns the horizontal offset for the text (relative to the left frame side).
int	GetVerticalTextOffset () const
	Returns the vertical offset for the text (relative to the left frame side).
bool	GetShowBorders () const
	Returns if the borders should display for the txt block, or not.
Evpu16	GetWidth () const
	Returns the fixed width of the frame.
Evpu16	GetHeight () const
	Returns the fixed height of the frame.
bool	GetExpandHorizontally () const
	Returns if the text block is set to "Expand Vertically" for a standard frame.
bool	GetExpandVertically () const
	Returns if the text block is set to "Expand Vertically" for a standard frame.
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

Class for a text block.

Member Function Documentation

ClassName()

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

CreateRawTextString()

FCString * FCTextBlock::CreateRawTextString

(

)

Creates a string object for the connected raw text.

Lua-supported.

Returns

Pointer to the text object. This has to be deleted from the heap after use.

DebugDump()

void FCTextBlock::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 FCTextBlock::DeepDeleteData ( )

inlineoverridevirtual

Reimplementation to delete raw text as well.

Reimplemented from __FCNoInciOther.

GetClassID()

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

GetExpandHorizontally()

bool FCTextBlock::GetExpandHorizontally ( ) const

inline

Returns if the text block is set to "Expand Vertically" for a standard frame.

Technically, this method returns if the GetWidth() returns 0 or not.

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

GetExpandSingleWord()

bool FCTextBlock::GetExpandSingleWord ( ) const

inline

Returns the "expand single word" state, which effects the full justification modes.

Lua-supported (also as property).

GetExpandVertically()

bool FCTextBlock::GetExpandVertically ( ) const

inline

Returns if the text block is set to "Expand Vertically" for a standard frame.

Technically, this method returns if the GetHeight() returns 0 or not.

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

GetFrameReference()

bool FCTextBlock::GetFrameReference ( ) const

inline

Returns if the text block should be positioned by the frame layout or not. This is a compatibility bit for text blocks created in very early Finale versions.

Lua-supported (also as property).

Returns

true - bounding rectangle of the object. false - the origin of the layout.

GetHeight()

Evpu16 FCTextBlock::GetHeight ( ) const

inline

Returns the fixed height of the frame.

This value doesn't correspond to any setting found in the Finale UI.

Lua-supported (also as property).

Returns

0 means "Expand Vertically" for a standard frame. Otherwise, the fixed height of the frame in EVPUs.

GetHorizontalTextOffset()

int FCTextBlock::GetHorizontalTextOffset ( ) const

inline

Returns the horizontal offset for the text (relative to the left frame side).

Lua-supported (also as property).

GetJustification()

FLAG_16 FCTextBlock::GetJustification ( ) const

inline

Returns the justification for the text block.

Lua-supported (also as property).

Returns

Any of the TEXTJUSTIFY_ constants.

GetLineInset()

int FCTextBlock::GetLineInset ( ) const

inline

Returns the inset between text and border (in EFIXes) for the frame's border.

Lua-supported (also as property).

GetLineSpacing()

twobyte FCTextBlock::GetLineSpacing ( ) const

inline

Returns the line spacing value for the text block.

Lua-supported (also as property).

GetLineSpacingIsPercent()

bool FCTextBlock::GetLineSpacingIsPercent ( ) const

inline

Returns if the line spacing value should be percent or points.

Lua-supported (also as property).

Returns

true - line spacing in percent, false - line spacing in EVPUs

GetLineWidth()

int FCTextBlock::GetLineWidth ( ) const

inline

Returns the line width of the frame's border.

Lua-supported (also as property).

GetRawTextID()

twobyte FCTextBlock::GetRawTextID ( ) const

inline

Returns the text ID for the raw text.

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

GetRoundedCornerRadius()

Efix32 FCTextBlock::GetRoundedCornerRadius ( ) const

inline

Returns the rounded corner radius, to use when rounded corners are enabled for the text block frame.

This only works on Finale 25.4 and higher.

The rounded corners state is retrieved with the GetRoundedCorners() method.

Returns

The corner radius in EFIXes. Always 0 on versions earlier than Finale 25.4.

GetRoundedCorners()

bool FCTextBlock::GetRoundedCorners ( ) const

inline

Returns if the text frame should use rounded corners.

This only works on Finale 25.4 and higher.

The corner radius is retrieved by GetRoundedCornerRadius().

Returns

true - use rounded corners. Always false on versions earlier than Finale 25.4.

GetShapeID()

twobyte FCTextBlock::GetShapeID ( ) const

inline

Return the layout shape ID for the text block.

Lua-supported (also as property).

Returns

0 if no shape.

GetShowBorders()

bool FCTextBlock::GetShowBorders ( ) const

inline

Returns if the borders should display for the txt block, or not.

Lua-supported (also as property).

GetVerticalTextOffset()

int FCTextBlock::GetVerticalTextOffset ( ) const

inline

Returns the vertical offset for the text (relative to the left frame side).

Lua-supported (also as property).

GetWidth()

Evpu16 FCTextBlock::GetWidth ( ) const

inline

Returns the fixed width of the frame.

This value doesn't correspond to any setting found in the Finale UI.

Lua-supported (also as property).

Returns

0 means "Expand Horizontally" for a standard frame. Otherwise, the fixed width of the frame in EVPUs.

GetWordWrap()

bool FCTextBlock::GetWordWrap ( ) const

inline

Returns true if the text should word wrap automatically.

Lua-supported (also as property).

Returns

true - automatic word wrap

SaveNewRawTextString()

bool FCTextBlock::SaveNewRawTextString

(

FCString *

pString

)

Saves a new raw text string.

The raw text ID is updated for text block, so the text block must be saved afterwards. The tag in the text block must be valid.

Returns

True on success.

SaveRawTextString()

bool FCTextBlock::SaveRawTextString

(

FCString *

pString

)

Saves the raw text string in an existing text block.

The raw text ID and tag in the text block must be valid.

Lua-supported.

Returns

True on success.

SetExpandSingleWord()

void FCTextBlock::SetExpandSingleWord ( bool state )

inline

Sets the "expand single word" state, which effects the full justification modes.

Lua-supported (also as property).

SetFrameReference()

void FCTextBlock::SetFrameReference ( bool state )

inline

Sets if the text block should be positioned by the frame layout or not.

Remarks

You should generally not change this value. It is a compatibility bit for text blocks created in very early Finale versions.

Lua-supported (also as property).

Parameters

state

true - bounding rectangle of the object. false - the origin of the layout.

SetHeight()

void FCTextBlock::SetHeight ( Evpu16 height )

inline

Sets the fixed height of the frame.

This value doesn't correspond to any setting found in the Finale UI.

Lua-supported (also as property).

Parameters

height

0 means "Expand Vertically" for a standard frame. Otherwise, the fixed height of the frame in EVPUs.

SetHorizontalTextOffset()

void FCTextBlock::SetHorizontalTextOffset ( int value )

inline

Sets the horizontal offset for the text (relative to the left frame side).

Lua-supported (also as property).

SetJustification()

void FCTextBlock::SetJustification ( FLAG_16 justification )

inline

Sets the justification to any of the text block justification styles.

Lua-supported (also as property).

Parameters

justification

Any of the TEXTJUSTIFY_ constants.

SetLineInset()

void FCTextBlock::SetLineInset ( int value )

inline

Sets the inset between text and border (in EFIXes) for the frame's border.

Lua-supported (also as property).

SetLineSpacing()

void FCTextBlock::SetLineSpacing ( twobyte linespacing )

inline

Sets the line spacing value for the text block.

Lua-supported (also as property).

SetLineSpacingIsPercent()

void FCTextBlock::SetLineSpacingIsPercent ( bool state )

inline

Sets if the line spacing value should be percent or points.

Lua-supported (also as property).

Parameters

state

true - line spacing in percent, false - line spacing in EVPUs

SetLineWidth()

void FCTextBlock::SetLineWidth ( int value )

inline

Sets the line width (in EFIXes) of the frame's border.

Lua-supported (also as property).

SetRoundedCornerRadius()

void FCTextBlock::SetRoundedCornerRadius ( Efix32 radius )

inline

Sets the rounded corner radius, to use when rounded corners are enabled for the text block frame.

This only works on Finale 25.4 and higher. The method will do nothing on earlier Finale versions.

The rounded corners are enabled/disabled with the SetRoundedCorners() method.

Parameters

radius

The corner radius in EFIXes.

SetRoundedCorners()

void FCTextBlock::SetRoundedCorners ( bool state )

inline

Sets if the text frame should use rounded corners.

This only works on Finale 25.4 and higher. The method will do nothing on earler Finale versions

The corner radius is set by SetRoundedCornerRadius().

Parameters

state

true - use rounded corners.

SetShapeID()

void FCTextBlock::SetShapeID ( twobyte shapeID )

inline

Sets the layout shape ID for the text block.

Lua-supported (also as property).

SetShowBorders()

void FCTextBlock::SetShowBorders ( bool state )

inline

Sets if the borders should display for the txt block, or not.

Lua-supported (also as property).

SetVerticalTextOffset()

void FCTextBlock::SetVerticalTextOffset ( int value )

inline

Sets the vertical offset for the text (relative to the left frame side).

Lua-supported (also as property).

SetWidth()

void FCTextBlock::SetWidth ( Evpu16 width )

inline

Sets the fixed width of the frame.

This value doesn't correspond to any setting found in the Finale UI.

Lua-supported (also as property).

Parameters

width

0 means "Expand Horizontally" for a standard frame. Otherwise, the fixed width of the frame in EVPUs.

SetWordWrap()

void FCTextBlock::SetWordWrap ( bool state )

inline

Sets if the text should word wrap automatically.

Lua-supported (also as property).

Parameters

state

true - automatic word wrap