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

Contains the lyrics preferences data. More...

#include <ff_prefs.h>

Inheritance diagram for FCLyricsPrefs:
__FCPrefsBase __FCBaseData __FCBase

Public Types

enum  LYRICS_ALIGNMENTS { LYRICS_ALIGN_CENTER = 1, LYRICS_ALIGN_LEFT = 2, LYRICS_ALIGN_RIGHT = 3 }
 The alignment values for syllable positioning. More...
 
enum  LYRICS_JUSTIFICATIONS { LYRICS_JUSTI_CENTER = 1, LYRICS_JUSTI_LEFT = 2, LYRICS_JUSTI_RIGHT = 3 }
 The justification values for syllable positioning. More...
 
enum  SMARTHYPHEN_SYSTEMSTART { SMARTHYPHEN_SYSSTART_ALWAYS = 0, SMARTHYPHEN_SYSSTART_ONLYLATERSYLLABLE = 1, SMARTHYPHEN_SYSSTART_NEVER = 2 }
 Smart hyphen values to be used with GetHyphenSystemStart and SetHyphenSystemStart. 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

 FCLyricsPrefs ()
 The constructor. More...
 
bool GetUseSmartHyphens () const
 Returns if smart hyphens should be used. More...
 
twobyte GetHyphenSystemStart () const
 Gets the mode for how hyphens should be treated at start of systems. More...
 
Evpu16 GetMaxSpaceBetweenHyphens () const
 Returns the maximum space between hyphens, in EVPUs. More...
 
Efix16 GetWordExtLineThickness () const
 Returns the word extension line thickness, in EFIXes. More...
 
bool GetUseWordExtSyllable () const
 Returns if the positioning options (alignment/justification ) for syllables with word extensions should be used. More...
 
twobyte GetWordExtSyllableAlignment () const
 Returns the alignment option for syllables with word extensions. More...
 
twobyte GetWordExtSyllableJustification () const
 Returns the justification option for syllables with word extensions. More...
 
bool GetUseFirstSyllable () const
 Returns if the positioning options (alignment/justification ) for first syllables should be used. More...
 
twobyte GetFirstSyllableAlignment () const
 Returns the alignment option for first syllables. More...
 
twobyte GetFirstSyllableJustification () const
 Returns the justification option for first syllables. More...
 
bool GetUseStartSystemSyllable () const
 Returns if the positioning options (alignment/justification ) for syllables at start of systems should be used. More...
 
twobyte GetStartSystemSyllableAlignment () const
 Returns the alignment option for syllables at start of systems. More...
 
twobyte GetStartSystemSyllableJustification () const
 Returns the justification option for syllables at start of systems. More...
 
twobyte GetOtherSyllableAlignment () const
 Returns the alignment option for other kind of syllables (that aren't covered by other options). More...
 
twobyte GetOtherSyllableJustification () const
 Returns the justification option for other kind of syllables (that aren't covered by other options). More...
 
void SetUseSmartHyphens (bool state)
 Sets if smart hyphens should be used. More...
 
void SetHyphenSystemStart (twobyte value)
 Sets the mode for how hyphens should be treated at start of systems. More...
 
void SetMaxSpaceBetweenHyphens (Evpu16 value)
 Sets the maximum space between hyphens, in EVPUs. More...
 
void SetWordExtLineThickness (Efix16 value)
 Sets the word extension line thickness, in EFIXes. More...
 
void SetUseWordExtSyllable (bool state)
 Sets if the positioning options (alignment/justification ) for syllables with word extensions should be used. More...
 
void SetWordExtSyllableAlignment (twobyte value)
 Sets the alignment option for syllables with word extensions. More...
 
void SetWordExtSyllableJustification (twobyte value)
 Sets the justification option for syllables with word extensions. More...
 
void SetUseFirstSyllable (bool state)
 Sets if the positioning options (alignment/justification ) for first syllables should be used. More...
 
void SetFirstSyllableAlignment (twobyte value)
 Sets the alignment option for first syllables. More...
 
void SetFirstSyllableJustification (twobyte value)
 Sets the justification option for first syllables. More...
 
void SetUseStartSystemSyllable (bool state)
 Sets if the positioning options (alignment/justification ) for syllables at start of systems should be used. More...
 
void SetStartSystemSyllableAlignment (twobyte value)
 Sets the alignment option for syllables at start of systems. More...
 
void SetStartSystemSyllableJustification (twobyte value)
 Sets the justification option for syllables at start of systems. More...
 
void SetOtherSyllableAlignment (twobyte value)
 Sets the alignment option for other kind of syllables (that aren't covered by other options). More...
 
void SetOtherSyllableJustification (twobyte value)
 Sets the justification option for other kind of syllables (that aren't covered by other options). More...
 
- Public Member Functions inherited from __FCPrefsBase
virtual bool Reload ()
 Overridden version of Reload(), that handles prefs from multiple sources.
 
virtual bool Load (twobyte prefsno=1)
 The default Load method for preference data. All preference data loading must go through here at some point. More...
 
virtual bool Save ()
 Saves the currently loaded to its current location. More...
 
virtual bool LoadFirst ()
 Loads the very first element in the database, if any. More...
 
int GetItemNo () const
 Returns the prefs number for the loaded data. More...
 
- Public Member Functions inherited from __FCBaseData
virtual const PDKFRAMEWORK_CLASSID GetClassID ()=0
 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...
 
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...
 
virtual const char * ClassName ()
 Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child class. 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 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 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...
 

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

Contains the lyrics preferences data.

Member Enumeration Documentation

The alignment values for syllable positioning.

Lua-supported.

Enumerator
LYRICS_ALIGN_CENTER 

Centered alignment of lyrics

LYRICS_ALIGN_LEFT 

Left-side alignment of lyrics

LYRICS_ALIGN_RIGHT 

Right-side alignment of lyrics

The justification values for syllable positioning.

Lua-supported.

Enumerator
LYRICS_JUSTI_CENTER 

Centered justification of lyrics

LYRICS_JUSTI_LEFT 

Left-side alignment of lyrics

LYRICS_JUSTI_RIGHT 

Right-side alignment of lyrics

Smart hyphen values to be used with GetHyphenSystemStart and SetHyphenSystemStart.

Lua-supported.

Enumerator
SMARTHYPHEN_SYSSTART_ALWAYS 

Always put hyphen on next system.

SMARTHYPHEN_SYSSTART_ONLYLATERSYLLABLE 

Only put hyphens on next system when the first syllable is attached to the second note or later.

SMARTHYPHEN_SYSSTART_NEVER 

Never put hyphen on next system.

Constructor & Destructor Documentation

FCLyricsPrefs::FCLyricsPrefs ( )
inline

The constructor.

Lua-supported.

Member Function Documentation

twobyte FCLyricsPrefs::GetFirstSyllableAlignment ( ) const
inline

Returns the alignment option for first syllables.

This is used if GetUseFirstSyllable returns true.

Lua-supported (also as property).

Returns
Any of the LYRICS_ALIGN_ constants.
twobyte FCLyricsPrefs::GetFirstSyllableJustification ( ) const
inline

Returns the justification option for first syllables.

This is used if GetUseFirstSyllable returns true.

Lua-supported (also as property).

Returns
Any of the LYRICS_JUSTI_ constants.
twobyte FCLyricsPrefs::GetHyphenSystemStart ( ) const
inline

Gets the mode for how hyphens should be treated at start of systems.

Lua-supported (also as property).

Returns
Any of the SMARTHYPHEN_SYSSTART_ constants.
Evpu16 FCLyricsPrefs::GetMaxSpaceBetweenHyphens ( ) const
inline

Returns the maximum space between hyphens, in EVPUs.

Lua-supported (also as property).

twobyte FCLyricsPrefs::GetOtherSyllableAlignment ( ) const
inline

Returns the alignment option for other kind of syllables (that aren't covered by other options).

Lua-supported (also as property).

Returns
Any of the LYRICS_ALIGN_ constants.
twobyte FCLyricsPrefs::GetOtherSyllableJustification ( ) const
inline

Returns the justification option for other kind of syllables (that aren't covered by other options).

Lua-supported (also as property).

Returns
Any of the LYRICS_JUSTI_ constants.
twobyte FCLyricsPrefs::GetStartSystemSyllableAlignment ( ) const
inline

Returns the alignment option for syllables at start of systems.

This is used if GetUseStartSystemSyllable returns true.

Lua-supported (also as property).

Returns
Any of the LYRICS_ALIGN_ constants.
twobyte FCLyricsPrefs::GetStartSystemSyllableJustification ( ) const
inline

Returns the justification option for syllables at start of systems.

This is used if GetUseStartSystemSyllable returns true.

Lua-supported (also as property).

Returns
Any of the LYRICS_JUSTI_ constants.
bool FCLyricsPrefs::GetUseFirstSyllable ( ) const
inline

Returns if the positioning options (alignment/justification ) for first syllables should be used.

Lua-supported (also as property).

bool FCLyricsPrefs::GetUseSmartHyphens ( ) const
inline

Returns if smart hyphens should be used.

Lua-supported (also as property).

bool FCLyricsPrefs::GetUseStartSystemSyllable ( ) const
inline

Returns if the positioning options (alignment/justification ) for syllables at start of systems should be used.

Lua-supported (also as property).

bool FCLyricsPrefs::GetUseWordExtSyllable ( ) const
inline

Returns if the positioning options (alignment/justification ) for syllables with word extensions should be used.

Lua-supported (also as property).

Efix16 FCLyricsPrefs::GetWordExtLineThickness ( ) const
inline

Returns the word extension line thickness, in EFIXes.

Lua-supported (also as property).

twobyte FCLyricsPrefs::GetWordExtSyllableAlignment ( ) const
inline

Returns the alignment option for syllables with word extensions.

This is used if GetUseWordExtSyllable returns true.

Lua-supported (also as property).

Returns
Any of the LYRICS_ALIGN_ constants.
twobyte FCLyricsPrefs::GetWordExtSyllableJustification ( ) const
inline

Returns the justification option for syllables with word extensions.

This is used if GetUseWordExtSyllable returns true.

Lua-supported (also as property).

Returns
Any of the LYRICS_JUSTI_ constants.
void FCLyricsPrefs::SetFirstSyllableAlignment ( twobyte  value)
inline

Sets the alignment option for first syllables.

This is used if GetUseFirstSyllable returns true.

Lua-supported (also as property).

Parameters
valueAny of the LYRICS_ALIGN_ constants.
void FCLyricsPrefs::SetFirstSyllableJustification ( twobyte  value)
inline

Sets the justification option for first syllables.

This is used if GetUseFirstSyllable returns true.

Lua-supported (also as property).

Parameters
valueAny of the LYRICS_JUSTI_ constants.
void FCLyricsPrefs::SetHyphenSystemStart ( twobyte  value)
inline

Sets the mode for how hyphens should be treated at start of systems.

Lua-supported (also as property).

Parameters
valueAny of the SMARTHYPHEN_SYSSTART_ constants.
void FCLyricsPrefs::SetMaxSpaceBetweenHyphens ( Evpu16  value)
inline

Sets the maximum space between hyphens, in EVPUs.

Lua-supported (also as property).

void FCLyricsPrefs::SetOtherSyllableAlignment ( twobyte  value)
inline

Sets the alignment option for other kind of syllables (that aren't covered by other options).

Lua-supported (also as property).

Parameters
valueAny of the LYRICS_ALIGN_ constants.
void FCLyricsPrefs::SetOtherSyllableJustification ( twobyte  value)
inline

Sets the justification option for other kind of syllables (that aren't covered by other options).

Lua-supported (also as property).

Parameters
valueAny of the LYRICS_JUSTI_ constants.
void FCLyricsPrefs::SetStartSystemSyllableAlignment ( twobyte  value)
inline

Sets the alignment option for syllables at start of systems.

This is used if GetUseStartSystemSyllable returns true.

Lua-supported (also as property).

Parameters
valueAny of the LYRICS_ALIGN_ constants.
void FCLyricsPrefs::SetStartSystemSyllableJustification ( twobyte  value)
inline

Sets the justification option for syllables at start of systems.

This is used if GetUseStartSystemSyllable returns true.

Lua-supported (also as property).

Parameters
valueAny of the LYRICS_JUSTI_ constants.
void FCLyricsPrefs::SetUseFirstSyllable ( bool  state)
inline

Sets if the positioning options (alignment/justification ) for first syllables should be used.

Lua-supported (also as property).

void FCLyricsPrefs::SetUseSmartHyphens ( bool  state)
inline

Sets if smart hyphens should be used.

Lua-supported (also as property).

void FCLyricsPrefs::SetUseStartSystemSyllable ( bool  state)
inline

Sets if the positioning options (alignment/justification ) for syllables at start of systems should be used.

Lua-supported (also as property).

void FCLyricsPrefs::SetUseWordExtSyllable ( bool  state)
inline

Sets if the positioning options (alignment/justification ) for syllables with word extensions should be used.

Lua-supported (also as property).

void FCLyricsPrefs::SetWordExtLineThickness ( Efix16  value)
inline

Sets the word extension line thickness, in EFIXes.

Lua-supported (also as property).

void FCLyricsPrefs::SetWordExtSyllableAlignment ( twobyte  value)
inline

Sets the alignment option for syllables with word extensions.

This is used if GetUseWordExtSyllable returns true.

Lua-supported (also as property).

Parameters
valueAny of the LYRICS_ALIGN_ constants.
void FCLyricsPrefs::SetWordExtSyllableJustification ( twobyte  value)
inline

Sets the justification option for syllables with word extensions.

This is used if GetUseWordExtSyllable returns true.

Lua-supported (also as property).

Parameters
valueAny of the LYRICS_JUSTI_ constants.