FCRawText Class Reference

The class for raw text objects. All other text classes are based on this class, but it can also be used by its own for tx_TextBlock text. More...

#include <ff_text.h>

Inheritance diagram for FCRawText:

Public Types
enum	RAWTEXTTYPES {   RAWTEXTTYPE_TEXTBLOCK = 0 , RAWTEXTTYPE_VERSELYRIC = 1 , RAWTEXTTYPE_CHORUSLYRIC = 2 , RAWTEXTTYPE_SECTIONLYRIC = 3 ,   RAWTEXTTYPE_CUSTOMLINE = 4 , RAWTEXTTYPE_EXPRESSION = 5 , RAWTEXTTYPE_FILEINFO = 6 , RAWTEXTTYPE_BOOKMARK = 7 ,   RAWTEXTTYPE_UNKNOWN = -1 }
	enumerates the possible raw text types. 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.
	FCRawText ()
	The constructor.
virtual	~FCRawText ()
	The (virtual) destructor.
RAWTEXTTYPES	GetBlockType () const
	Returns the text block type of this FCRawText.
int	GetNumChars () const
	Returns the number of characters in the raw text.
bool	Load (twobyte number)
	Loads the text with the indicated text number.
bool	LoadFirst () override
	Loads the first raw text entry.
bool	SaveAs (twobyte number)
	Saves the text by a new text number.
bool	SaveNew ()
	Saves the text at the first empty spot.
void	SetText (const FCString *pString)
	Sets the text for the object. (The object needs to be saved to Finale to take effect.)
void	GetText (FCString *pString) const
	Copies the object's text to a FCString object.
virtual twobyte	GetItemNo () const
	Gets the item number for the text.
FCString *	CreateString () const
	Creates a string object with the loaded text. If the string doesn't exist (or if it's empty), the string object will still be created.
bool	GetSubString (FCString *pString, const FCRange *pRange) const
	Gets a string object with the range of characters from loaded text.
void	DebugDump () override
	Outputs the class data/information for debugging purposes.
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 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	Reload ()
	Refreshes the data for the object, to synch the data with Finale's current data.
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	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.

Protected Member Functions
virtual void	SetRawTextNumber (twobyte number)
int	DataSizeLoad () const override
	Returns the data size for the data structure that should be loaded.
void *	Allocate () override
void	Deallocate () override
bool	IsDynamicSize () override
EVERSION	EnigmaVersion () const override
	The Enigma version for save/load/create/delete operations.
__FCBaseData *	CreateObject () override
virtual bool	HasUnicodeSupport () const
	Should return true if the data structure has Unicode support on the running platform.
Protected Member Functions inherited from __FCBaseData
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!
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.

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 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 raw text objects. All other text classes are based on this class, but it can also be used by its own for tx_TextBlock text.

Member Enumeration Documentation

RAWTEXTTYPES

enum FCRawText::RAWTEXTTYPES

enumerates the possible raw text types.

Lua-supported (0.68)

Remarks

The FCRawText for bookmarks is not directly accessible by Lua.

Enumerator
RAWTEXTTYPE_TEXTBLOCK	Text block. See FCTextBlock.
RAWTEXTTYPE_VERSELYRIC	Verse lyric. See FCVerseLyricsText.
RAWTEXTTYPE_CHORUSLYRIC	Chorus lyric. See FCChorusLyricsText.
RAWTEXTTYPE_SECTIONLYRIC	Section lyric. See FCSectionLyricsText.
RAWTEXTTYPE_CUSTOMLINE	Custom line text. See FCCustomSmartLineDef.
RAWTEXTTYPE_EXPRESSION	Text expression. See FCTextExpressionDef.
RAWTEXTTYPE_FILEINFO	File info. See FCFileInfoText.
RAWTEXTTYPE_BOOKMARK	Bookmarks. See FCBookmark.
RAWTEXTTYPE_UNKNOWN	Used by the Framework to report errors or unknown values.

Member Function Documentation

Allocate()

void * FCRawText::Allocate ( )

overrideprotectedvirtual

For data of static size, the overridden method can return a pointer to one single data structure. For dynamical-sized data, the overriden method should allocate data of the proper size.

Implements __FCBaseData.

ClassName()

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

Reimplemented in FCSectionLyricsText, FCStaffListCategoryText, FCStaffListStaffAssignText, FCStaffListText, FCTextRepeatText, and FCVerseLyricsText.

CreateObject()

__FCBaseData * FCRawText::CreateObject ( )

inlineoverrideprotectedvirtual

Todo

Implement copy support!

Implements __FCBaseData.

CreateString()

FCString * FCRawText::CreateString

(

)

const

Creates a string object with the loaded text. If the string doesn't exist (or if it's empty), the string object will still be created.

Lua-supported.

Returns

Pointer to a FCString object. C++ clients must dispose of this object after use, either with delete or with a smart pointer.

DataSizeLoad()

int FCRawText::DataSizeLoad ( ) const

overrideprotectedvirtual

Returns the data size for the data structure that should be loaded.

Must be overwritten by child classes.

Returns

The size in bytes for the data that should be loaded

Implements __FCBaseData.

Deallocate()

void FCRawText::Deallocate ( )

overrideprotectedvirtual

Should be overwritten by all child classes that use dynamicaly-sized data to free allocated data.

Reimplemented from __FCBaseData.

DebugDump()

void FCRawText::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 __FCBaseData.

EnigmaVersion()

EVERSION FCRawText::EnigmaVersion ( ) const

overrideprotectedvirtual

The Enigma version for save/load/create/delete operations.

Set this to a specific Finale version if some emulation is needed.

Returns

By default, this defaults to the version of the PDK. Override if necessary.

Reimplemented from __FCBaseData.

GetBlockType()

RAWTEXTTYPES FCRawText::GetBlockType ( ) const

inline

Returns the text block type of this FCRawText.

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

Returns

one of the RAWTEXTTYPES constants.

GetClassID()

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

GetItemNo()

virtual twobyte FCRawText::GetItemNo ( ) const

inlinevirtual

Gets the item number for the text.

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

Reimplemented in __FCOtherText.

GetNumChars()

int FCRawText::GetNumChars ( ) const

inline

Returns the number of characters in the raw text.

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

GetSubString()

bool FCRawText::GetSubString	(	FCString *	pString,
		const FCRange *	pRange ) const

Gets a string object with the range of characters from loaded text.

This function eliminates the overhead of calling CreateString followed by FCString::MakeSubString.

Warning

FCRawText represents characters internally as UTF-16-encoded code points. If the string includes characters outside the Basic Multilingual Plane (BMP), this function could potentially return a partial character. Lua clients should use particular care with this function, because converting from indices on UTF-8 strings to indices on UTF-16 strings is not straightforward. A much safer approach for Lua would be to load CreateString into a Lua string and then use the built-in utf8 Lua library to process the string.

Lua-supported (0.68).

Parameters

pString	the string to which to copy the substring.
pRange	the range of characters to copy.

Returns

Returns false if the range is invalid.

GetText()

void FCRawText::GetText

(

FCString *

pString

)

const

Copies the object's text to a FCString object.

Lua-supported.

Parameters

[out]

pString

Pointer to the FCString object that should get the text.

IsDynamicSize()

bool FCRawText::IsDynamicSize ( )

inlineoverrideprotectedvirtual

Classes that encapsulates dynamic-sized data should override this method to return true.

NOTE! It's up to the destructor of the child classes to clean up dynamically sized data.

Reimplemented from __FCBaseData.

Load()

bool FCRawText::Load

(

twobyte

number

)

Loads the text with the indicated text number.

Lua-supported.

LoadFirst()

bool FCRawText::LoadFirst ( )

inlineoverridevirtual

Loads the first raw text entry.

Implements __FCBaseData.

SaveAs()

bool FCRawText::SaveAs

(

twobyte

number

)

Saves the text by a new text number.

The new number now gets connected to the object.

Lua-supported (0.68).

SaveNew()

bool FCRawText::SaveNew

(

)

Saves the text at the first empty spot.

Lua-supported.

SetRawTextNumber()

virtual void FCRawText::SetRawTextNumber ( twobyte number )

inlineprotectedvirtual

Sets the item number for the text.

Reimplemented in __FCOtherText.

SetText()

void FCRawText::SetText

(

const FCString *

pString

)

Sets the text for the object. (The object needs to be saved to Finale to take effect.)

Lua-supported.

Parameters

[in]

pString

Pointer to the FCString object that contains the text.