Class for a page-connected text block. More...

#include <ff_other.h>

Inheritance diagram for FCPageText:

Public Types
enum	TEXT_HORIZONTAL_ALIGN { TEXTHORIZALIGN_LEFT = TEXT_HALIGN_LEFT , TEXTHORIZALIGN_RIGHT = TEXT_HALIGN_RIGHT , TEXTHORIZALIGN_CENTER = TEXT_HALIGN_CENTER }
	Horizontal alignment constants for text blocks. More...

enum	TEXT_VERTICAL_ALIGN { TEXTVERTALIGN_TOP = TEXT_VALIGN_TOP , TEXTVERTALIGN_BOTTOM = TEXT_VALIGN_BOTTOM , TEXTVERTALIGN_CENTER = TEXT_VALIGN_CENTER }
	Vertical alignment constants for text blocks. More...

enum	TEXT_ASSIGNMENT { TEXTASSIGN_ALL = PAGETEXT_ASSIGN_ALL , TEXTASSIGN_ODD = PAGETEXT_ASSIGN_ODD , TEXTASSIGN_EVEN = PAGETEXT_ASSIGN_EVEN }
	Constants for how text blocks are displayed. 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.

	FCPageText ()
	The constructor.

FCString *	CreateTextString ()
	Gets a pointer to the text string, as a string object.

FCTextBlock *	CreateTextBlock ()
	Creates a FCTextBlock object that belongs to the page text. (It might return NULL.)

twobyte	GetFirstPage () const
	Returns the page number for the first page.

twobyte	GetLastPage () const
	Returns the page number for the last page.

TEXT_HORIZONTAL_ALIGN	GetHorizontalAlignment () const
	Returns the horizontal alignment for the text block on left-side (or all) pages.

TEXT_VERTICAL_ALIGN	GetVerticalAlignment () const
	Returns the vertical alignment for the text block.

TEXT_HORIZONTAL_ALIGN	GetHorizontalAlignmentRightPage () const
	Returns the horizontal alignment for a right-side page text block.

TEXT_ASSIGNMENT	GetPageAssignment () const
	Returns the page assignment (all/odd/even).

bool	GetPageEdgeRef () const
	Returns true if positioning is referenced from the page edge.

bool	GetFrameEdgeRef () const
	Returns if the frame edge is used as the positioning reference or not.

twobyte	GetHorizontalPos () const
	Returns the horizontal position for the text block.

twobyte	GetHorizontalPosRightPage () const
	Returns the horizontal position for the text block on right-side pages (if used).

twobyte	GetVerticalPos () const
	Returns the vertical position for the text block.

twobyte	GetVerticalPosRightPage () const
	Returns the vertical position for the text block for right-side pages (if used).

bool	GetVisible () const
	Returns true if the text block is visible (in the score/part that's currently in focus).

bool	GetIndependentRightPage () const
	Returns true if the right-side page positioning is used.

CMPER	GetTextBlockID () const
	Returns the connected block ID for the text. For use with FCTextBlock.

void	_SetTextBlockID (CMPER textblockid)
	Sets the connected block ID for the text. For use with FCTextBlock.

CMPER	GetStringID () const
	Returns the raw text ID for the page text (as an Engima string). This ID is "owned" by the connected FCTextBlock object.

bool	SaveNewTextBlock (FCString *pString)
	Saves a new raw text block (both a raw text and the connected text block) and assigns it to the page text block. The page text block needs to be saved separately afterwards.

bool	SaveTextString (FCString *pString)
	Resaves a raw text string. This method requires that the text block already exists.

void	SetHorizontalAlignment (TEXT_HORIZONTAL_ALIGN alignment)
	Sets the horizontal alignment for left-side (or all) pages.

void	SetHorizontalAlignmentRightPage (TEXT_HORIZONTAL_ALIGN alignment)
	Sets the horizontal alignment for right-side pages.

void	SetVerticalAlignment (TEXT_VERTICAL_ALIGN alignment)
	Sets the vertical alignment for the text block.

void	SetPageAssignment (TEXT_ASSIGNMENT assign)
	Sets the page assignment (all/odd/even).

void	SetFirstPage (ePage page)
	Sets the page number for the starting page. If a text block page only should appear on one page, this must still be set.

void	SetLastPage (ePage page)
	Sets the page number for the last page. If a text block page only should appear on one page, this must still be set.

void	SetHorizontalPos (twobyte value)
	Sets the horizontal position for the text block.

void	SetHorizontalPosRightPage (twobyte value)
	Sets the horizontal position for the text block on right-side pages.

void	SetVerticalPos (twobyte value)
	Sets the vertical position for the text block. Smaller values go downward, higher values go upward.

void	SetVerticalPosRightPage (twobyte value)
	Sets the vertical position for the text block for right-side pages.

void	SetVisible (bool visible)
	Sets if the text block should be visible or not (in the score/part that's currently in focus - works in Fin2012).

void	SetIndependentRightPage (bool state)
	Sets if the right-side page positioning is used.

void	SetPageEdgeRef (bool state)
	Sets if positioning is referenced from the page edge, or from the margin.

void	SetFrameEdgeRef (bool state)
	Sets if the frame edge of the text block is used as the positioning reference.

bool	DeepDeleteData () override
	Reimplementation to delete block and raw text as well.

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

Public Member Functions inherited from __FCInciOther
	__FCInciOther ()
	The constructor.

virtual bool	Load (CMPER itemno, twobyte inci)
	Loads the indicated record within the item number.

twobyte	CalcLastInci () override
	Overridden version of CalcLastInci for __FCInciOther-based classes.

bool	Reload () override
	Overridden version of Reload(), to support complex (mixed) data types.

virtual bool	SaveNew (CMPER itemno)
	Creates a new inci record with data.

void	_SetCmper (CMPER cmper)
	Primarily for internal use.

int	GetItemCmper () const
	Returns the cmper (main record) value for a loaded record.

int	GetItemInci () const
	Returns the inci (subrecord) value in the data ID for a loaded record.

virtual eMeas	GetMeasure () const
	Virtual method for returning the measure number.

virtual eStaff	GetStaff () const
	Virtual method for returning the staff number.

virtual bool	HasStaffValue () const
	Method that should return true if GetStaff() returns actual values.

virtual TimeEdu32	GetMeasurePos () const
	Virtual method for returning the position within the measure.

Public Member Functions inherited from __FCOther
void	SetCmperAndInci (CMPER cmper, twobyte inci)
	Sets both the CMPER and the incident number in the dataID record. Mainly for internal use.

	__FCOther ()
	The constructor.

bool	IsIdenticalRecord (__FCOther *pCompare)
	Compares an object to see if both objects point to the same data record.

Public Member Functions inherited from __FCBaseData
EDOCID	GetConnectedDocID () const
	Returns the document ID that was connected to the last load/save of the data.

bool	VerifyConnectedDocID ()
	Checks that the stored document ID for the data object matches the current document's ID.

virtual EXTAG	Tag () const =0
	The Enigma tag for the derived class.

virtual EVERSION	EnigmaVersion () const
	The Enigma version for save/load/create/delete operations.

virtual int	DataSizeLoad () const =0
	Returns the data size for the data structure that should be loaded.

virtual int	DataSizeSave () const
	Returns the data size for the data structure that should be saved or created.

void	_CloneFrom (__FCBaseData *pSource)
	For internal use only. Copies object data (except data block) from another object.

virtual void	CloneMemoryFrom (__FCBaseData *pSource)

const EDataID *	_GetDataID ()
	Intended ONLY for the _CloneFrom implementation.

int	_GetLoadedSize () const
	Intended ONLY for the _CloneFrom implementation.

const void *	GetDataBlock ()
	Intended ONLY for the _CloneFrom implementation.

EXTAG	GetCustomTag () const
	Returns the custom Enigma tag, if any.

void	SetCustomTag (EXTAG tag)
	Sets the custom Enigma tag, for classes that support multiple Enigma tags.

	__FCBaseData ()
	The constructor.

virtual	~__FCBaseData ()
	Virtual destructor.

virtual bool	Save ()
	Saves the currently loaded to its current location.

virtual bool	DeleteData ()
	Deletes the associated data from Finale's database. Be careful when deleting multiple objects.

virtual bool	LoadFirst ()=0
	Loads the very first element in the database, if any.

virtual bool	LoadLast ()
	Loads the very last element in the database, if any.

virtual bool	LoadNext ()
	Loads the next element from the database, if any.

virtual bool	LoadPrevious ()
	Loads the previous element in the database, if any.

bool	RelinkToCurrentView ()
	Relinks the contents in the current view so that the score and part(s) match.

bool	RelinkToScore ()
	Relinks all parts to the contents of the score.

__FCBaseData *	CreateClone ()
	Creates an identical copy of an object.

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

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

void	DebugDataOffsetDump (int offset, int size)
	For debug mode only. Dumps a data memory block at a specific offset and with a specific size.

FCNumbers *	CreateRawDataDump ()
	Creates a byte collection with the raw loaded data block for the object (if the object type supports single data blocks). This method is only intended for debug purposes.

Public Member Functions inherited from __FCBase
virtual	~__FCBase ()
	Virtual destructor, so all inherited classes get the virtual destructor.

void	DebugMsgInt (const char *pszPrefixText, int i)
	Creates a simple Message Box for debug purposes. The text appears with the extra digit (in decimal presentation) appearing afterwards.

void	DebugMsgHex (const char *pszPrefixText, int i)
	Creates a simple Message Box for debug purposes. The text appears with the extra digit (as a hexadecimal number) appearing afterwards.

void	DebugMsgString (const char pszPrefixText, const char thestring)
	Creates a simple Message Box for debug purposes. The text appears with the extra string appearing afterwards.

void	DebugMsg (const char *pszMsg)
	Creates a simple Message Box for debug purposes with just one text string.

void	DebugOutMenuInfo (FCUI *pUI, int menuixd_horiz, int menuixd_vert) const
	Outputs the menu command info for debugging purposes.

int	DebugOutFormat (const char *fmt,...)
	Outputs debug text using C style "printf" syntax.

void	Set16BitFlag (FLAG_16 *flag, FLAG_16 flagbits, bool state)
	Sets a 16 bit flag.

void	Set32BitFlag (FLAG_32 *flag, FLAG_32 flagbits, bool state)
	Sets/resets a 32 bit flag, by using a bit mask.

bool	GetBitFlag (FLAG_32 flag, FLAG_32 flagbits) const
	Gets a state from flag bits. Returns true if any bit in the mask is set.

int	GetBitCount (FLAG_32 flag)
	Returns the total number of set bits in a 32-bit unsigned int.

void	SetSpecific32Bit (FLAG_32 *flag, int bitnumber, bool state)
	Sets/resets a single bit in a 32 bit flag, by specifying one specific bit.

void	SetUserData (void *pData)
	Sets the user data attached to the instance of an object.

void	SetUserData2 (void *pData)
	Sets the additional user data attached to the instance of an object.

void *	GetUserData () const
	Gets the user data attached to the instance of an object.

void *	GetUserData2 () const
	Gets the additional user data attached to the instance of an object.

virtual bool	IsIdentical (const __FCBase *pCompareObject) const
	Returns true if the data in the passed object is considered to be identical to the current object, otherwise false.

void	StoreXML_String (tinyxml2::XMLElement pParentNode, const char pszElementName, FCString *pStringValue)
	Helper function to store FCString objects in the XML file.

void	StoreXML_Integer (tinyxml2::XMLElement pParentNode, const char pszElementName, int value)
	Helper function to store integer objects in the XML file.

void	StoreXML_Bool (tinyxml2::XMLElement pParentNode, const char pszElementName, bool value)
	Helper function to store boolean objects in the XML file.

void	StoreXML_StringAttribute (tinyxml2::XMLElement pNode, const char pszAttributeName, FCString *pStringValue)
	Helper function to store FCString objects in the XML file, as an attribute to a node.

void	StoreXML_IntegerAttribute (tinyxml2::XMLElement pNode, const char pszAttributeName, int value)
	Helper function to store integer objects in the XML file, as an attribute to a node.

void	StoreXML_BoolAttribute (tinyxml2::XMLElement pNode, const char pszAttributeName, bool value)
	Helper function to store boolean objects in the XML file, as an attribute to a node.

void	StoreXML_FloatAttribute (tinyxml2::XMLElement pNode, const char pszAttributeName, float value)
	Helper function to store floating point objects in the XML file, as an attribute to a node.

virtual void	StoreToXML (tinyxml2::XMLElement *pParentNode)
	Virtual method that is used to store an object's data.

bool	ReadXML_String (tinyxml2::XMLElement pParentNode, const char pszElementName, FCString *pStringValue)
	Helper method to read FCString objects from the XML file.

bool	ReadXML_Integer (tinyxml2::XMLElement pParentNode, const char pszElementName, int *pValue)
	Helper method to read integer objects from the XML file.

bool	ReadXML_Bool (tinyxml2::XMLElement pParentNode, const char pszElementName, bool *pValue)
	Helper method to read boolean objects from the XML file.

bool	ReadXML_StringAttribute (tinyxml2::XMLElement pNode, const char pszAttributeName, FCString *pStringValue)
	Helper method to read FCString objects from the XML file, as an attribute to a node.

bool	ReadXML_IntegerAttribute (tinyxml2::XMLElement pNode, const char pszAttributeName, int *pValue)
	Helper method to read integer objects from the XML file, as an attribute to a node.

bool	ReadXML_BoolAttribute (tinyxml2::XMLElement pNode, const char pszAttributeName, bool *pValue)
	Helper method to read boolean objects from the XML file, as an attribute to a node.

bool	ReadXML_FloatAttribute (tinyxml2::XMLElement pNode, const char pszAttributeName, float *pValue)
	Helper method to read floating point objects from the XML file, as an attribute to a node.

virtual bool	ReadFromXML (tinyxml2::XMLElement *pParentNode)
	Virtual method that is used to read object data.

Additional Inherited Members
Static Public Member Functions inherited from __FCBase
static void	DebugOutPtr (const char pszPrefixText, void ptr)
	Static method that outputs a line for debugging purposes. The prefix text appears with the extra ptr (in hexadeximal representation) appearing afterwards.

static void	DebugOutInt (const char *pszPrefixText, int i)
	Static method that outputs a line for debugging purposes. The text appears with the extra digit (in decimal presentation) appearing afterwards.

static void	DebugOutFloat (const char *pszPrefixText, double f)
	Static method that outputs a line for debugging purposes. The text appears with the extra float value appearing afterwards.

static void	DebugOutTag (const char *pszPrefixText, EXTAG extag)
	Static method that outputs a line for debugging purposes. The text appears with the EXTAG (in text) appearing afterwards.

static void	DebugOutHex (const char *pszPrefixText, int i)
	Static method that outputs a line for debugging purposes. The text appears with the extra digit (in hexadecimal presentation) appearing afterwards.

static void	DebugOutBin (const char *pszPrefixText, int i)
	Static method that outputs a line for debugging purposes. The text appears with the extra digit (in binary presentation) appearing afterwards.

static void	DebugOutString (const char pszPrefixText, const char thestring)
	Static method that outputs a line for debugging purposes (C string version). The text appears with the extra string appearing afterwards.

static void	DebugOutString (const char pszPrefixText, FCString pString)
	Static method that outputs a line for debugging purposes (FCString version). The text appears with the extra string appearing afterwards.

static void	DebugOutBool (const char *pszPrefixText, bool state)
	Static method that outputs a line for debugging purposes. The boolean state appears afterwards as either "TRUE" or "FALSE".

static void	DebugOutBlock (const void *pBuffer, int startoffset, int size)
	Static method that outputs a memory block for debugging purposes. Eight bytes per line will appear (as hex digits) until the whole memory block is dumped.

static void	DebugOutByteArrayBlock (const void *pBuffer, int startoffset, int size)
	Static method that outputs a memory block for debugging purposes. Eight bytes per line will appear (as hex digits) as a C++ onebyte array, until the whole memory block is dumped.

static void	DebugOut (const char *pszLine)
	Static method to output a line of text for debugging purposes.

Protected Member Functions inherited from __FCBaseData
virtual void *	Allocate ()=0

virtual void	Deallocate ()

virtual bool	IsDynamicSize ()

bool	LoadDataBlock ()
	Loads the data. If the object is of dynamic size, the old memory block is freed and a new is allocated.

void	ClearData ()

virtual __FCBaseData *	CreateObject ()=0
	Creates a new instance of the object.

bool	DataIsLoaded () const
	Returns true is any data has been loaded into the object.

void	_TagDocumentID ()
	For internal use only.

Protected Member Functions inherited from __FCBase
	__FCBase ()
	The constructor.

Protected Attributes inherited from __FCBaseData
EDOCID	_connecteddocID
	The "connected" document ID., which is the document the where the document was loaded (or last saved). This is for a mechanism to prevent resaving of certain data in other documents.

void *	_datablock
	Pointer to the object's data block, the meaning is implementation-specific for each derived subclass.

bool	_heapdatablock
	Variable that tells if _datablock is dynamically created on the heap (and should be deleted at object destruction).

int	_loadedsize
	Loaded size of the data block for a loaded object, in bytes. Since the datablock is implementation-specific, the _loadedsize should be updated by child classes that create new data.

EDataID	_dataid
	The EdataID for the last loaded/saved object.

Detailed Description

Class for a page-connected text block.

Each FCPageText object is linked to a FCTextBlock, which is linked to a raw text string object.

Text blocks that appear on page ranges should be saved to cmper 0, such as SaveNew(0). Text blocks that appear on a single page should be saved to the 1-based page number, such as SaveNew(pagenumber).

Member Enumeration Documentation

◆ TEXT_ASSIGNMENT

enum FCPageText::TEXT_ASSIGNMENT

Constants for how text blocks are displayed.

Lua-supported.

Enumerator
TEXTASSIGN_ALL	Assign to all pages.
TEXTASSIGN_ODD	Assign to odd pages.
TEXTASSIGN_EVEN	Assign to even pages.

◆ TEXT_HORIZONTAL_ALIGN

enum FCPageText::TEXT_HORIZONTAL_ALIGN

Horizontal alignment constants for text blocks.

Lua-supported.

Enumerator
TEXTHORIZALIGN_LEFT	Left alignment for text block.
TEXTHORIZALIGN_RIGHT	Right alignment for text block.
TEXTHORIZALIGN_CENTER	Center alignment for text block.

◆ TEXT_VERTICAL_ALIGN

enum FCPageText::TEXT_VERTICAL_ALIGN

Vertical alignment constants for text blocks.

Lua-supported.

Enumerator
TEXTVERTALIGN_TOP	Top alignment for text block.
TEXTVERTALIGN_BOTTOM	Bottom alignment for text block.
TEXTVERTALIGN_CENTER	Center alignment for text block.

Constructor & Destructor Documentation

◆ FCPageText()

FCPageText::FCPageText ( )

inline

The constructor.

Lua-supported.

Member Function Documentation

◆ ClassName()

const char * FCPageText::ClassName ( ) const

inlineoverridevirtual

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

Lua-supported.

Reimplemented from __FCInciOther.

◆ CreateTextBlock()

FCTextBlock * FCPageText::CreateTextBlock ( )

Creates a FCTextBlock object that belongs to the page text. (It might return NULL.)

The created object is saved separately. The caller must delete the created object from the heap.

Lua-supported.

Returns: NULL if the page text hasn't been loaded. Otherwise, pointer to the created object.

◆ CreateTextString()

FCString * FCPageText::CreateTextString ( )

inline

Gets a pointer to the text string, as a string object.

Lua-supported.

Returns: Pointer to the created string object. This object must be deleted from the heap by the caller after use.

◆ DebugDump()

void FCPageText::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.

◆ DeepDeleteData()

bool FCPageText::DeepDeleteData ( )

inlineoverridevirtual

Reimplementation to delete block and raw text as well.

Reimplemented from __FCBaseData.

◆ GetClassID()

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

◆ GetFirstPage()

twobyte FCPageText::GetFirstPage ( ) const

inline

Returns the page number for the first page.

Lua-supported (also as property).

Returns: The page number.

◆ GetFrameEdgeRef()

bool FCPageText::GetFrameEdgeRef ( ) const

inline

Returns if the frame edge is used as the positioning reference or not.

Lua-supported (also as property).

Returns: true = frame edge reference

◆ GetHorizontalAlignment()

TEXT_HORIZONTAL_ALIGN FCPageText::GetHorizontalAlignment ( ) const

inline

Returns the horizontal alignment for the text block on left-side (or all) pages.

Lua-supported (also as property).

Returns: Any of the TEXTHORIZALIGN_ constants

◆ GetHorizontalAlignmentRightPage()

TEXT_HORIZONTAL_ALIGN FCPageText::GetHorizontalAlignmentRightPage ( ) const

inline

Returns the horizontal alignment for a right-side page text block.

Lua-supported (also as property).

Returns: Any of the TEXTHORIZALIGN_ constants.

◆ GetHorizontalPos()

twobyte FCPageText::GetHorizontalPos ( ) const

inline

Returns the horizontal position for the text block.

Lua-supported (also as property).

◆ GetHorizontalPosRightPage()

twobyte FCPageText::GetHorizontalPosRightPage ( ) const

inline

Returns the horizontal position for the text block on right-side pages (if used).

Lua-supported (also as property).

◆ GetIndependentRightPage()

bool FCPageText::GetIndependentRightPage ( ) const

inline

Returns true if the right-side page positioning is used.

Lua-supported (also as property).

◆ GetLastPage()

twobyte FCPageText::GetLastPage ( ) const

inline

Returns the page number for the last page.

Lua-supported (also as property).

Returns: The page number. 0 if it's the "end of document".

◆ GetPageAssignment()

TEXT_ASSIGNMENT FCPageText::GetPageAssignment ( ) const

inline

Returns the page assignment (all/odd/even).

Returns: Any of the TEXTASSIGN_ constants.

◆ GetPageEdgeRef()

bool FCPageText::GetPageEdgeRef ( ) const

inline

Returns true if positioning is referenced from the page edge.

Lua-supported (also as property).

Returns: true = page edge reference, false = margin reference

◆ GetStringID()

CMPER FCPageText::GetStringID ( ) const

Returns the raw text ID for the page text (as an Engima string). This ID is "owned" by the connected FCTextBlock object.

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

Returns: 0 if no string exists. Otherwise, the raw string text ID.

◆ GetTextBlockID()

CMPER FCPageText::GetTextBlockID ( ) const

inline

Returns the connected block ID for the text. For use with FCTextBlock.

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

◆ GetVerticalAlignment()

TEXT_VERTICAL_ALIGN FCPageText::GetVerticalAlignment ( ) const

inline

Returns the vertical alignment for the text block.

Lua-supported (also as property).

Returns: Any of the TEXTVERTALIGN_ constants

◆ GetVerticalPos()

twobyte FCPageText::GetVerticalPos ( ) const

inline

Returns the vertical position for the text block.

Lua-supported (also as property).

◆ GetVerticalPosRightPage()

twobyte FCPageText::GetVerticalPosRightPage ( ) const

inline

Returns the vertical position for the text block for right-side pages (if used).

Lua-supported (also as property).

◆ GetVisible()

bool FCPageText::GetVisible ( ) const

inline

Returns true if the text block is visible (in the score/part that's currently in focus).

Lua-supported (also as property).

◆ SaveNewTextBlock()

bool FCPageText::SaveNewTextBlock ( FCString * pString )

Saves a new raw text block (both a raw text and the connected text block) and assigns it to the page text block. The page text block needs to be saved separately afterwards.

Lua-supported.

◆ SaveTextString()

bool FCPageText::SaveTextString ( FCString * pString )

Resaves a raw text string. This method requires that the text block already exists.

Lua-supported.

◆ SetFirstPage()

void FCPageText::SetFirstPage ( ePage page )

inline

Sets the page number for the starting page. If a text block page only should appear on one page, this must still be set.

Lua-supported (also as property).

Parameters

page	The page number.

◆ SetFrameEdgeRef()

void FCPageText::SetFrameEdgeRef ( bool state )

inline

Sets if the frame edge of the text block is used as the positioning reference.

Lua-supported (also as property).

Parameters

state true = frame edge reference

◆ SetHorizontalAlignment()

void FCPageText::SetHorizontalAlignment ( TEXT_HORIZONTAL_ALIGN alignment )

inline

Sets the horizontal alignment for left-side (or all) pages.

If independent right page positioning is OFF, the same alignment value is also automatically set for the right page data.

Lua-supported (also as property).

Parameters

alignment Any of the TEXTHORIZALIGN_ constants.

◆ SetHorizontalAlignmentRightPage()

void FCPageText::SetHorizontalAlignmentRightPage ( TEXT_HORIZONTAL_ALIGN alignment )

inline

Sets the horizontal alignment for right-side pages.

Lua-supported (also as property).

Parameters

alignment Any of the TEXTHORIZALIGN_ constants.

◆ SetHorizontalPos()

void FCPageText::SetHorizontalPos ( twobyte value )

inline

Sets the horizontal position for the text block.

If independent right page positioning is OFF, the same position value is also automatically set for the right page data.

Lua-supported (also as property).

◆ SetHorizontalPosRightPage()

void FCPageText::SetHorizontalPosRightPage ( twobyte value )

inline

Sets the horizontal position for the text block on right-side pages.

Lua-supported (also as property).

◆ SetIndependentRightPage()

void FCPageText::SetIndependentRightPage ( bool state )

inline

Sets if the right-side page positioning is used.

Lua-supported (also as property).

◆ SetLastPage()

void FCPageText::SetLastPage ( ePage page )

inline

Sets the page number for the last page. If a text block page only should appear on one page, this must still be set.

Lua-supported (also as property).

Parameters

page	The page number. 0 if it's the "end of document".

◆ SetPageAssignment()

void FCPageText::SetPageAssignment ( TEXT_ASSIGNMENT assign )

inline

Sets the page assignment (all/odd/even).

Parameters

assign Any of the TEXTASSIGN_ constants.

◆ SetPageEdgeRef()

void FCPageText::SetPageEdgeRef ( bool state )

inline

Sets if positioning is referenced from the page edge, or from the margin.

Please note that this method sets both the horizontal and vertical page reference state. Although Finale internally supports separate page references, the Finale UI doesn't.

Lua-supported (also as property).

Parameters

state true = page edge reference, false = margin reference

◆ SetVerticalAlignment()

void FCPageText::SetVerticalAlignment ( TEXT_VERTICAL_ALIGN alignment )

inline

Sets the vertical alignment for the text block.

Lua-supported (also as property).

Parameters

alignment Any of the TEXTVERTALIGN_ constants

◆ SetVerticalPos()

void FCPageText::SetVerticalPos ( twobyte value )

inline

Sets the vertical position for the text block. Smaller values go downward, higher values go upward.

If independent right page positioning is OFF, the same position value is also automatically set for the right page data.

Lua-supported (also as property).

◆ SetVerticalPosRightPage()

void FCPageText::SetVerticalPosRightPage ( twobyte value )

inline

Sets the vertical position for the text block for right-side pages.

Lua-supported (also as property).

◆ SetVisible()

void FCPageText::SetVisible ( bool visible )

inline

Sets if the text block should be visible or not (in the score/part that's currently in focus - works in Fin2012).

Lua-supported (also as property).

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ TEXT_ASSIGNMENT

◆ TEXT_HORIZONTAL_ALIGN

◆ TEXT_VERTICAL_ALIGN

Constructor & Destructor Documentation

◆ FCPageText()

Member Function Documentation

◆ ClassName()

◆ CreateTextBlock()

◆ CreateTextString()

◆ DebugDump()

◆ DeepDeleteData()

◆ GetClassID()

◆ GetFirstPage()

◆ GetFrameEdgeRef()

◆ GetHorizontalAlignment()

◆ GetHorizontalAlignmentRightPage()

◆ GetHorizontalPos()

◆ GetHorizontalPosRightPage()

◆ GetIndependentRightPage()

◆ GetLastPage()

◆ GetPageAssignment()

◆ GetPageEdgeRef()

◆ GetStringID()

◆ GetTextBlockID()

◆ GetVerticalAlignment()

◆ GetVerticalPos()

◆ GetVerticalPosRightPage()

◆ GetVisible()

◆ SaveNewTextBlock()

◆ SaveTextString()

◆ SetFirstPage()

◆ SetFrameEdgeRef()

◆ SetHorizontalAlignment()

◆ SetHorizontalAlignmentRightPage()

◆ SetHorizontalPos()

◆ SetHorizontalPosRightPage()

◆ SetIndependentRightPage()

◆ SetLastPage()

◆ SetPageAssignment()

◆ SetPageEdgeRef()

◆ SetVerticalAlignment()

◆ SetVerticalPos()

◆ SetVerticalPosRightPage()

◆ SetVisible()