Finale PDK Framework  0.54
Public Types | Public Member Functions | List of all members
FCPageText Class Reference

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

#include <ff_other.h>

Inheritance diagram for FCPageText:
__FCInciOther __FCOther __FCBaseData __FCBase

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_ALLOTMENT, FCID_ARTICULATION,
  FCID_ARTICULATIONDEF, FCID_BACKWARDREPEAT, FCID_BASELINE, FCID_BEAMMOD,
  FCID_BEATCHARTELEMENT, 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_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_KEYSIGNATURE, FCID_LAYERPREFS, 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_PERCUSSIONNOTEMOD, FCID_PIANOBRACEPREFS, FCID_PLAYBACKPREFS, FCID_RAWTEXT,
  FCID_REPEATPREFS, FCID_SECONDARYBEAMBREAKMOD, 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

virtual const char * ClassName ()
 Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child class. More...
 
virtual const PDKFRAMEWORK_CLASSID GetClassID ()
 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. More...
 
 FCPageText ()
 The constructor. More...
 
FCStringCreateTextString ()
 Gets a pointer to the text string, as a string object. More...
 
FCTextBlockCreateTextBlock ()
 Creates a FCTextBlock object that belongs to the page text. (It might return NULL.) More...
 
twobyte GetFirstPage () const
 Returns the page number for the first page. More...
 
twobyte GetLastPage () const
 Returns the page number for the last page. More...
 
TEXT_HORIZONTAL_ALIGN GetHorizontalAlignment () const
 Returns the horizontal alignment for the text block on left-side (or all) pages. More...
 
TEXT_VERTICAL_ALIGN GetVerticalAlignment () const
 Returns the vertical alignment for the text block. More...
 
TEXT_HORIZONTAL_ALIGN GetHorizontalAlignmentRightPage () const
 Returns the horizontal alignment for a right-side page text block. More...
 
TEXT_ASSIGNMENT GetPageAssignment () const
 Returns the page assignment (all/odd/even). More...
 
bool GetPageEdgeRef () const
 Returns true if positioning is referenced from the page edge. More...
 
bool GetFrameEdgeRef () const
 Returns if the frame edge is used as the positioning reference or not. More...
 
twobyte GetHorizontalPos () const
 Returns the horizontal position for the text block. More...
 
twobyte GetHorizontalPosRightPage () const
 Returns the horizontal position for the text block on right-side pages (if used). More...
 
twobyte GetVerticalPos () const
 Returns the vertical position for the text block. More...
 
twobyte GetVerticalPosRightPage () const
 Returns the vertical position for the text block for right-side pages (if used). More...
 
bool GetVisible () const
 Returns true if the text block is visible (in the score/part that's currently in focus). More...
 
bool GetIndependentRightPage () const
 Returns true if the right-side page positioning is used. More...
 
CMPER GetTextBlockID () const
 Returns the connected block ID for the text. For use with FCTextBlock. More...
 
void _SetTextBlockID (CMPER textblockid)
 Sets the connected block ID for the text. For use with FCTextBlock. More...
 
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. More...
 
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. More...
 
bool SaveTextString (FCString *pString)
 Resaves a raw text string. This method requires that the text block already exists. More...
 
void SetHorizontalAlignment (TEXT_HORIZONTAL_ALIGN alignment)
 Sets the horizontal alignment for left-side (or all) pages. More...
 
void SetHorizontalAlignmentRightPage (TEXT_HORIZONTAL_ALIGN alignment)
 Sets the horizontal alignment for right-side pages. More...
 
void SetVerticalAlignment (TEXT_VERTICAL_ALIGN alignment)
 Sets the vertical alignment for the text block. More...
 
void SetPageAssignment (TEXT_ASSIGNMENT assign)
 Sets the page assignment (all/odd/even). More...
 
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. More...
 
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. More...
 
void SetHorizontalPos (twobyte value)
 Sets the horizontal position for the text block. More...
 
void SetHorizontalPosRightPage (twobyte value)
 Sets the horizontal position for the text block on right-side pages. More...
 
void SetVerticalPos (twobyte value)
 Sets the vertical position for the text block. Smaller values go downward, higher values go upward. More...
 
void SetVerticalPosRightPage (twobyte value)
 Sets the vertical position for the text block for right-side pages. More...
 
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). More...
 
void SetIndependentRightPage (bool state)
 Sets if the right-side page positioning is used. More...
 
void SetPageEdgeRef (bool state)
 Sets if positioning is referenced from the page edge, or from the margin. More...
 
void SetFrameEdgeRef (bool state)
 Sets if the frame edge of the text block is used as the positioning reference. More...
 
virtual bool DeepDeleteData ()
 Reimplementation to delete block and raw text as well.
 
virtual void DebugDump ()
 Outputs the class data/information for debugging purposes. More...
 
- Public Member Functions inherited from __FCInciOther
 __FCInciOther ()
 The constructor. More...
 
virtual bool Load (CMPER itemno, twobyte inci)
 Loads the indicated record within the item number. More...
 
virtual twobyte CalcLastInci ()
 Overridden version of CalcLastInci for __FCInciOther-based classes.
 
virtual bool Reload ()
 Overridden version of Reload(), to support complex (mixed) data types.
 
virtual bool SaveNew (CMPER itemno)
 Creates a new inci record with data. More...
 
void _SetCmper (CMPER cmper)
 Primarily for internal use. More...
 
int GetItemCmper () const
 Returns the cmper (main record) value for a loaded record. More...
 
int GetItemInci () const
 Returns the inci (subrecord) value in the data ID for a loaded record. More...
 
virtual eMeas GetMeasure () const
 Virtual method for returning the measure number. More...
 
virtual eStaff GetStaff () const
 Virtual method for returning the staff number. More...
 
virtual bool HasStaffValue ()
 Method that should return true if GetStaff() returns actual values.
 
virtual TimeEdu32 GetMeasurePos () const
 Virtual method for returning the position within the measure. More...
 
- 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. More...
 
- Public Member Functions inherited from __FCBaseData
EDOCID GetConnectedDocID () const
 Returns the document ID that was connected to the last load/save of the data. More...
 
bool VerifyConnectedDocID ()
 Checks that the stored document ID for the data object matches the current document's ID. More...
 
virtual EXTAG Tag ()=0
 The Enigma tag for the derived class. More...
 
virtual EVERSION EnigmaVersion ()
 The Enigma version for save/load/create/delete operations. More...
 
virtual int DataSizeLoad ()=0
 Returns the data size for the data structure that should be loaded. More...
 
virtual int DataSizeSave ()
 Returns the data size for the data structure that should be saved or created. More...
 
void _CloneFrom (__FCBaseData *pSource)
 For internal use only. Copies object data (except data block) from another object. More...
 
virtual void CloneMemoryFrom (__FCBaseData *pSource)
 
const EDataID * _GetDataID ()
 Intended ONLY for the _CloneFrom implementation. More...
 
int _GetLoadedSize () const
 Intended ONLY for the _CloneFrom implementation. More...
 
const void * GetDataBlock ()
 Intended ONLY for the _CloneFrom implementation. More...
 
EXTAG GetCustomTag ()
 Returns the custom Enigma tag, if any. More...
 
void SetCustomTag (EXTAG tag)
 Sets the custom Enigma tag, for classes that support multiple Enigma tags. More...
 
 __FCBaseData ()
 The constructor.
 
virtual ~__FCBaseData ()
 Virtual destructor.
 
virtual bool Save ()
 Saves the currently loaded to its current location. More...
 
virtual bool DeleteData ()
 Deletes the associated data from Finale's database. Be careful when deleting multiple objects. More...
 
virtual bool LoadFirst ()=0
 Loads the very first element in the database, if any. More...
 
virtual bool LoadLast ()
 Loads the very last element in the database, if any. More...
 
virtual bool LoadNext ()
 Loads the next element from the database, if any. More...
 
virtual bool LoadPrevious ()
 Loads the previous element in the database, if any. More...
 
__FCBaseDataCreateClone ()
 Creates an identical copy of an object. More...
 
virtual void DebugDataDump ()
 Outputs a memory dump of the data block in the object for debugging purposes. More...
 
virtual void DebugDataByteArrayDump ()
 Outputs a memory dump of the data block in the object for debugging purposes, as a C++ byte array. More...
 
void DebugDataOffsetDump (int offset, int size)
 For debug mode only. Dumps a data memory block at a specific offset and with a specific size.
 
FCNumbersCreateRawDataDump ()
 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. More...
 
- Public Member Functions inherited from __FCBase
 __FCBase ()
 The constructor.
 
virtual ~__FCBase ()
 Virtual destructor, so all inherited classes get the virtual destructor. More...
 
void DebugMsgDigit (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. More...
 
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. More...
 
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. More...
 
void DebugMsg (const char *pszMsg)
 Creates a simple Message Box for debug purposes with just one text string. More...
 
void DebugOutMenuInfo (FCUI *pUI, int menuixd_horiz, int menuixd_vert) const
 Outputs the menu command info for debugging purposes. More...
 
int DebugOutFormat (const char *fmt,...)
 Outputs debug text using C style "printf" syntax. More...
 
void Set16BitFlag (FLAG_16 *flag, FLAG_16 flagbits, bool state)
 Sets a 16 bit flag in the data block. More...
 
void Set32BitFlag (FLAG_32 *flag, FLAG_32 flagbits, bool state)
 Sets a 32 bit flag in the data block. More...
 
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. More...
 
void SetUserData (void *pData)
 Sets the user data attached to the instance of an object. More...
 
void SetUserData2 (void *pData)
 Sets the additional user data attached to the instance of an object. More...
 
void * GetUserData () const
 Gets the user data attached to the instance of an object. More...
 
void * GetUserData2 () const
 Gets the additional user data attached to the instance of an object. More...
 
virtual bool IsIdentical (__FCBase *pCompareObject)
 Returns true if the data in the passed object is considered to be identical to the current object, otherwise false. More...
 
void StoreXML_String (tinyxml2::XMLElement *pParentNode, const char *pszElementName, FCString *pStringValue)
 Helper function to store FCString objects in the XML file. More...
 
void StoreXML_Integer (tinyxml2::XMLElement *pParentNode, const char *pszElementName, int value)
 Helper function to store integer objects in the XML file. More...
 
void StoreXML_Bool (tinyxml2::XMLElement *pParentNode, const char *pszElementName, bool value)
 Helper function to store boolean objects in the XML file. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
virtual void StoreToXML (tinyxml2::XMLElement *pParentNode)
 Virtual method that is used to store an object's data. More...
 
bool ReadXML_String (tinyxml2::XMLElement *pParentNode, const char *pszElementName, FCString *pStringValue)
 Helper method to read FCString objects from the XML file. More...
 
bool ReadXML_Integer (tinyxml2::XMLElement *pParentNode, const char *pszElementName, int *pValue)
 Helper method to read integer objects from the XML file. More...
 
bool ReadXML_Bool (tinyxml2::XMLElement *pParentNode, const char *pszElementName, bool *pValue)
 Helper method to read boolean objects from the XML file. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
virtual bool ReadFromXML (tinyxml2::XMLElement *pParentNode)
 Virtual method that is used to read object data. More...
 

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. More...
 
static void DebugOutDigit (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. More...
 
static void DebugOutFloat (const char *pszPrefixText, float f)
 Static method that outputs a line for debugging purposes. The text appears with the extra float value appearing afterwards. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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". More...
 
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. More...
 
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. More...
 
static void DebugOut (const char *pszLine)
 Static method to output a line of text for debugging purposes. More...
 
- 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 __FCBaseDataCreateObject ()=0
 Creates a new instance of the object. More...
 
bool DataIsLoaded () const
 Returns true is any data has been loaded into the object. More...
 
void _TagDocumentID ()
 For internal use only. More...
 
- 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. More...
 
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

Constants for how text blocks are displayed.

Lua-supported.

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.

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 ( )
inline

The constructor.

Lua-supported.

Member Function Documentation

void FCPageText::_SetTextBlockID ( CMPER  textblockid)
inline

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

virtual const char* FCPageText::ClassName ( )
inlinevirtual

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

Lua-supported.

Reimplemented from __FCOther.

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.
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.
virtual void FCPageText::DebugDump ( )
inlinevirtual

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.

virtual const PDKFRAMEWORK_CLASSID FCPageText::GetClassID ( )
inlinevirtual

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.

Implements __FCBaseData.

twobyte FCPageText::GetFirstPage ( ) const
inline

Returns the page number for the first page.

Lua-supported (also as property).

Returns
The page number.
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
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
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.
twobyte FCPageText::GetHorizontalPos ( ) const
inline

Returns the horizontal position for the text block.

Lua-supported (also as property).

twobyte FCPageText::GetHorizontalPosRightPage ( ) const
inline

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

Lua-supported (also as property).

bool FCPageText::GetIndependentRightPage ( ) const
inline

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

Lua-supported (also as property).

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".
TEXT_ASSIGNMENT FCPageText::GetPageAssignment ( ) const
inline

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

Returns
Any of the TEXTASSIGN_ constants.
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
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.
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).

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
twobyte FCPageText::GetVerticalPos ( ) const
inline

Returns the vertical position for the text block.

Lua-supported (also as property).

twobyte FCPageText::GetVerticalPosRightPage ( ) const
inline

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

Lua-supported (also as property).

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).

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.

bool FCPageText::SaveTextString ( FCString pString)

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

Lua-supported.

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
pageThe page number.
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
statetrue = frame edge reference
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
alignmentAny of the TEXTHORIZALIGN_ constants.
void FCPageText::SetHorizontalAlignmentRightPage ( TEXT_HORIZONTAL_ALIGN  alignment)
inline

Sets the horizontal alignment for right-side pages.

Lua-supported (also as property).

Parameters
alignmentAny of the TEXTHORIZALIGN_ constants.
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).

void FCPageText::SetHorizontalPosRightPage ( twobyte  value)
inline

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

Lua-supported (also as property).

void FCPageText::SetIndependentRightPage ( bool  state)
inline

Sets if the right-side page positioning is used.

Lua-supported (also as property).

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
pageThe page number. 0 if it's the "end of document".
void FCPageText::SetPageAssignment ( TEXT_ASSIGNMENT  assign)
inline

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

Parameters
assignAny of the TEXTASSIGN_ constants.
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
statetrue = page edge reference, false = margin reference
void FCPageText::SetVerticalAlignment ( TEXT_VERTICAL_ALIGN  alignment)
inline

Sets the vertical alignment for the text block.

Lua-supported (also as property).

Parameters
alignmentAny of the TEXTVERTALIGN_ constants
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).

void FCPageText::SetVerticalPosRightPage ( twobyte  value)
inline

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

Lua-supported (also as property).

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).