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

Encapsulates baselines offset values for lyrics, expressions, fretboards and chords. More...

#include <ff_details.h>

Inheritance diagram for FCBaseline:
__FCDetail __FCBaseData __FCBase

Public Types

enum  BASELINEMODES {
  BASELINEMODE_UNDEFINED = 0, BASELINEMODE_EXPRESSIONABOVE = 1, BASELINEMODE_EXPRESSIONBELOW = 2, BASELINEMODE_CHORD = 3,
  BASELINEMODE_FRETBOARD = 4, BASELINEMODE_LYRICSVERSE = 5, BASELINEMODE_LYRICSCHORUS = 6, BASELINEMODE_LYRICSSECTION = 7
}
 The mode constants of the object, used for both loading and saving objects. 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...
 
 FCBaseline ()
 The constructor. More...
 
Evpu16 GetVerticalOffset () const
 Returns the vertical offset of the baseline. This is the value that affects the baseline position. More...
 
twobyte GetLyricNumber () const
 Returns the connected lyric number for the baseline. More...
 
BASELINEMODES GetMode () const
 Returns the mode for the object. More...
 
eSsys GetSystem () const
 Returns the system number for the baseline. More...
 
bool GetGlobalScope () const
 Returns true if the object is referencing data that affects the whole piece. More...
 
eStaff GetStaff () const
 Returns the staff number ID for the baseline. More...
 
void SetVerticalOffset (Evpu16 value)
 Sets the vertical offset of the baseline. This is the value that affects the baseline position. More...
 
void SetLyricNumber (twobyte number)
 Sets the connected lyric number that the baseline should be connected to. More...
 
void SetMode (BASELINEMODES mode)
 Sets the mode for the object. If an automatic loader (such as LoadDefaultForMode or any of the loaders in FCBaselines) is used, this call is handled automatically. More...
 
bool Load (eSsys systemno, eStaff staffno, twobyte inci)
 Loads a baseline data structure. Normally, this isn't called directly. More...
 
bool SaveNew (eSsys systemno, eStaff staffno)
 Saves a new baseline data structure. Normally, this isn't called directly. More...
 
bool SaveAs (eSsys systemno, eStaff staffno, twobyte inci)
 Saves baseline data at a specific position. Normally, this isn't called directly. More...
 
bool LoadForStaff (eSsys systemno, eStaff staffno)
 Load a record for a staff. More...
 
bool LoadDefaultForMode (BASELINEMODES mode)
 Loads the (non-lyrics) default baseline value for the whole piece. More...
 
bool LoadDefaultForLyricNumber (BASELINEMODES mode, twobyte lyricno)
 Loads the default baseline value for a specific lyric number in the whole piece. More...
 
virtual bool Save ()
 Overridden method for saving the existing 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 Reload ()
 Refreshes the data for the object, to synch the data with Finale's current data. More...
 
virtual bool DeleteData ()
 Deletes the associated data from Finale's database. Be careful when deleting multiple objects. More...
 
virtual bool DeepDeleteData ()
 Deletes data and all data that's connected to the object. 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 DebugDump ()
 Outputs the class data/information for debugging purposes. 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...
 

Static Public Member Functions

static Evpu16 CalcTotalOffset (BASELINEMODES mode, eSsys system, eStaff staff)
 Static method for non-lyric modes that calculates the resulting offset for a system/staff. More...
 
static Evpu16 CalcTotalOffsetForLyricNumber (BASELINEMODES mode, eSsys system, eStaff staff, int lyricno)
 Static method that calculates the resulting baseline offset for a specific lyric number in a system/staff. More...
 
- 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...
 

Additional Inherited Members

- 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! More...
 
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

Encapsulates baselines offset values for lyrics, expressions, fretboards and chords.

Usually, these items are handled through the collection class FCBaselines, and obtained with the different load methods in the FCBaselines class. However, LoadDefaultForMode in this class is used to get global default offset values.

Baseline data can be stored on 3 different levels in Finale, and each are added together to get the final position.

The 3 levels of values are:

Use the static methods CalcTotalOffsetForLyricNumber or CalcTotalOffsetForLyricNumber to calculate the resulting baseline for any Finale data.

Member Enumeration Documentation

The mode constants of the object, used for both loading and saving objects.

Use GetMode and SetMode to use the contants.

Lua-supported.

Enumerator
BASELINEMODE_UNDEFINED 

Uninitialized state of the object.

BASELINEMODE_EXPRESSIONABOVE 

Baseline for expressions above the staff

BASELINEMODE_EXPRESSIONBELOW 

Baseline for expressions below the staff

BASELINEMODE_CHORD 

Baseline for chords.

BASELINEMODE_FRETBOARD 

Baseline for fretboards

BASELINEMODE_LYRICSVERSE 

Baseline for lyrics/verse.

BASELINEMODE_LYRICSCHORUS 

Baseline for lyrics/chorus.

BASELINEMODE_LYRICSSECTION 

Baseline for lyrics/section.

Constructor & Destructor Documentation

FCBaseline::FCBaseline ( )
inline

The constructor.

Lua-supported.

Member Function Documentation

Evpu16 FCBaseline::CalcTotalOffset ( BASELINEMODES  mode,
eSsys  system,
eStaff  staff 
)
static

Static method for non-lyric modes that calculates the resulting offset for a system/staff.

For lyric baseline modes, use CalcTotalOffsetForLyricNumber instead.

All data must be saved to Finale to get calculated. The value is calculated like this: global default+staff default+staff adjustment on system

Parameters
modeAny of the BASELINEMODE_ constants, except lyrics mode constants.
staffThe staff ID.
systemThe 1-based system number.
Returns
The calculated baseline offset. 0 if for the lyrics modes.
Evpu16 FCBaseline::CalcTotalOffsetForLyricNumber ( BASELINEMODES  mode,
eSsys  system,
eStaff  staff,
int  lyricno 
)
static

Static method that calculates the resulting baseline offset for a specific lyric number in a system/staff.

For non-lyric modes, use CalcTotalOffset instead.

All data must be saved to Finale to get calculated. The value is calculated like this: global default+lyric number default+lyric number adjustment on system/staff

Parameters
modeAny of the lyric mode constants (BASELINEMODE_LYRICSVERSE, BASELINEMODE_LYRICSCHORUS, BASELINEMODE_LYRICSSECTION).
staffThe staff ID.
systemThe 1-based system number.
lyricnoThe 1-based lyric number
Returns
The calculated baseline offset. 0 for non-lyrics modes.
virtual const char* FCBaseline::ClassName ( )
inlinevirtual

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

Lua-supported.

Reimplemented from __FCBaseData.

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

bool FCBaseline::GetGlobalScope ( ) const
inline

Returns true if the object is referencing data that affects the whole piece.

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

Returns
True - The object is either a global default value, or a staff-connected default value. False - The object is an adjustment value on a system.
twobyte FCBaseline::GetLyricNumber ( ) const

Returns the connected lyric number for the baseline.

Lua-supported (also as property).

Returns
For non-lyric modes, 0 is returned. Otherwise, the 1-based lyric number that the baseline is attached to.
BASELINEMODES FCBaseline::GetMode ( ) const
inline

Returns the mode for the object.

Lua-supported (also as property).

Returns
eStaff FCBaseline::GetStaff ( ) const
inline

Returns the staff number ID for the baseline.

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

eSsys FCBaseline::GetSystem ( ) const
inline

Returns the system number for the baseline.

For global scope baselines, this method will always return 0.

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

Returns
The 1-based system number.
Evpu16 FCBaseline::GetVerticalOffset ( ) const
inline

Returns the vertical offset of the baseline. This is the value that affects the baseline position.

Negative positions go down on the page, positive values go up.

Lua-supported (also as property).

bool FCBaseline::Load ( eSsys  systemno,
eStaff  staffno,
twobyte  inci 
)

Loads a baseline data structure. Normally, this isn't called directly.

The mode for the object must be set before calling this method.

Lua-supported.

bool FCBaseline::LoadDefaultForLyricNumber ( BASELINEMODES  mode,
twobyte  lyricno 
)
inline

Loads the default baseline value for a specific lyric number in the whole piece.

Lua-supported.

Parameters
lyricno1-based lyric number to match.
modeAny of the lyric mode constants (BASELINEMODE_LYRICSVERSE, BASELINEMODE_LYRICSCHORUS, BASELINEMODE_LYRICSSECTION)
Returns
True on success.
bool FCBaseline::LoadDefaultForMode ( BASELINEMODES  mode)
inline

Loads the (non-lyrics) default baseline value for the whole piece.

Use LoadDefaultForLyricNumber for lyric modes.

Lua-supported.

Parameters
modeAny of the BASELINEMODE_ constants, except the lyric modes.
Returns
True on success.
bool FCBaseline::LoadForStaff ( eSsys  systemno,
eStaff  staffno 
)

Load a record for a staff.

The mode for the object must be set before calling this method. This method will only work in non-lyric modes.

Lua-supported.

virtual bool FCBaseline::Save ( )
inlinevirtual

Overridden method for saving the existing record.

If the mode is undefined, false will be returned.

Reimplemented from __FCBaseData.

bool FCBaseline::SaveAs ( eSsys  systemno,
eStaff  staffno,
twobyte  inci 
)

Saves baseline data at a specific position. Normally, this isn't called directly.

The mode for the object must be set before calling this method.

bool FCBaseline::SaveNew ( eSsys  systemno,
eStaff  staffno 
)

Saves a new baseline data structure. Normally, this isn't called directly.

The mode for the object must be set before calling this method. Only lyrics modes are allowed.

void FCBaseline::SetLyricNumber ( twobyte  number)
inline

Sets the connected lyric number that the baseline should be connected to.

Lua-supported (also as property).

Parameters
numberA 1-based lyric number.
void FCBaseline::SetMode ( BASELINEMODES  mode)
inline

Sets the mode for the object. If an automatic loader (such as LoadDefaultForMode or any of the loaders in FCBaselines) is used, this call is handled automatically.

This will affect both loading and saving.

Lua-supported (also as property).

Parameters
modeAny of the BASELINEMODE_ constants.
void FCBaseline::SetVerticalOffset ( Evpu16  value)
inline

Sets the vertical offset of the baseline. This is the value that affects the baseline position.

Lua-supported (also as property).

Parameters
valueNegative offset positions go down on the page, positive values go up.