Class for document preferences related to guides and grids. More...

#include <ff_prefs.h>

Inheritance diagram for FCGridsGuidesPrefs:

Public Types
enum	ITEMTOSNAP { SNAPITEM_BRACKETS = 1 , SNAPITEM_CHORDS = 2 , SNAPITEM_EXPRESSIONS = 3 , SNAPITEM_FRETBOARDS = 4 , SNAPITEM_GRAPHICSMOVE = 5 , SNAPITEM_GRAPHICSSIZING = 6 , SNAPITEM_MEASURENUMBERS = 7 , SNAPITEM_REPEATS = 8 , SNAPITEM_SPECIALTOOLS = 9 , SNAPITEM_STAFFNAMES = 10 , SNAPITEM_STAVES = 11 , SNAPITEM_TEXTBLOCKMOVE = 12 , SNAPITEM_TEXTBLOCKSIZING = 13 }
	Constants for setting/getting the items that the grids/guides should snap to. More...

enum	GGLINESTYLES { GGLINESTYLE_SOLID = GGSTYLE_SOLID , GGLINESTYLE_DASHED = GGSTYLE_DASHES , GGLINESTYLE_DOTTED = GGSTYLE_DOTS , GGLINESTYLE_CROSSHAIR = GGSTYLE_CROSSHAIRS }
	The line styles for grids and guides. 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.

	FCGridsGuidesPrefs ()
	The constructor.

virtual	~FCGridsGuidesPrefs ()
	The destructor.

bool	Save () override
	Overloaded version of Save().

FCGuides *	GetHorizontalGuides ()
	Returns a pointer to the collection object that contains the horizontal guides.

FCGuides *	GetVerticalGuides ()
	Returns a pointer to the collection object that contains the vertical guides.

Efix32	GetGravityZoneSize () const
	Returns the Gravity zone size, in EFIXes.

bool	GetGridShow () const
	Returns if the grid should display.

bool	GetGridSnap () const
	Returns if items should snap to the grid.

twobyte	GetGridStep () const
	Returns the "Display one in ??? Grid Lines" option.

utwobyte	GetGridColorRed () const
	Returns the red color status of the grid, which is part of the RGB value.

utwobyte	GetGridColorGreen () const
	Returns the green color status of the grid, which is part of the RGB value.

utwobyte	GetGridColorBlue () const
	Returns the blue color status of the grid, which is part of the RGB value.

GGLINESTYLES	GetGridLineStyle () const
	Returns the line style that should be used for grids.

Efix32	GetGridDistance () const
	Returns the distance between each grid element, in EFIXes.

bool	GetGuideShow () const
	Returns if guides should display.

bool	GetGuideSnap () const
	Returns if items should snap to guides.

utwobyte	GetGuideColorRed () const
	Returns the red color status of the guide, which is part of the RGB value.

utwobyte	GetGuideColorGreen () const
	Returns the green color status of the guide, which is part of the RGB value.

utwobyte	GetGuideColorBlue () const
	Returns the blue color status of the guide, which is part of the RGB value.

GGLINESTYLES	GetGuideLineStyle () const
	Returns the line style that should be used for guides.

bool	GetGridSnapToItem (ITEMTOSNAP itemconstant)
	Returns the grid "snap state" of a specific item.

bool	GetGuideSnapToItem (ITEMTOSNAP itemconstant)
	Returns the guide "snap state" of a specific item.

int	GetHorizontalGuideCount () const
	Returns the number of horizontal guides (=the guides where the line goes horizontally). This value must be identical to the number of actual guides in the document.

int	GetVerticalGuideCount () const
	Returns the number of vertical guides (=the guides where the line goes vertically). This value must be identical to the number of actual guides in the document.

void	SetGravityZoneSize (Efix32 value)
	Sets the Gravity zone size, in EFIXes.

void	SetGridShow (bool state)
	Sets if the grid should display.

void	SetGridSnap (bool state)
	Sets if items should snap to the grid.

void	SetGridStep (twobyte value)
	Sets the "Display one in ??? Grid Lines" option.

void	SetGridColorRed (utwobyte value)
	Returns the red color status of the grid, which is part of the RGB value.

void	SetGridColorGreen (utwobyte value)
	Returns the green color status of the grid, which is part of the RGB value.

void	SetGridColorBlue (utwobyte value)
	Returns the blue color status of the grid, which is part of the RGB value.

void	SetGridLineStyle (GGLINESTYLES value)
	Sets the line style that should be used for grids.

void	SetGridDistance (Efix32 value)
	Sets the distance between each grid element, in EFIXes.

void	SetGuideShow (bool state)
	Sets if guides should display.

void	SetGuideSnap (bool state)
	Sets if items should snap to guides.

void	SetGuideColorRed (utwobyte value)
	Returns the red color status of the guide, which is part of the RGB value.

void	SetGuideColorGreen (utwobyte value)
	Returns the green color status of the guide, which is part of the RGB value.

void	SetGuideColorBlue (twobyte value)
	Returns the blue color status of the guide, which is part of the RGB value.

void	SetGuideLineStyle (GGLINESTYLES value)
	Sets the line style that should be used for guides.

void	SetHorizontalGuideCount (int value)
	Sets the number of horizontal guides (=the guides where the line goes horizontally). This value must be identical to the number of actual guides.

void	SetVerticalGuideCount (int value)
	Sets the number of vertical guides (=the guides where the line goes vertically). This value must be identical to the number of actual guides.

void	SetGridSnapToItem (ITEMTOSNAP itemconstant, bool state)
	Sets the grid "snap state" of a specific item.

void	SetGuideSnapToItem (ITEMTOSNAP itemconstant, bool state)
	Sets the guide "snap state" of a specific item.

void	SetGridColors (utwobyte red, utwobyte green, utwobyte blue)
	Sets the full RGB color of the grid.

void	SetGuideColors (utwobyte red, utwobyte green, utwobyte blue)
	Sets the full RGB color of the guides.

Public Member Functions inherited from __FCPrefsBase
bool	Reload () override
	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.

bool	LoadFirst () override
	Loads the very first element in the database, if any.

int	GetItemNo () const
	Returns the prefs number for the loaded data.

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 EVERSION	EnigmaVersion () const
	The Enigma version for save/load/create/delete operations.

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.

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	DeleteData ()
	Deletes the associated data from Finale's database. Be careful when deleting multiple objects.

virtual bool	DeepDeleteData ()
	Deletes data and all data that's connected to the object.

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

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

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

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

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

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

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

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 __FCPrefsBase
	__FCPrefsBase ()
	standard constructor

Protected Member Functions inherited from __FCBaseData
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!

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 document preferences related to guides and grids.

Member Enumeration Documentation

◆ GGLINESTYLES

enum FCGridsGuidesPrefs::GGLINESTYLES

The line styles for grids and guides.

For use with the setters SetGridLineStyle and SetGuideLineStyle, and with the getters GetGridLineStyle and GetGuideLineStyle.

Lua-supported.

Enumerator
GGLINESTYLE_SOLID	Use a solid line.
GGLINESTYLE_DASHED	Use a dashed line style.
GGLINESTYLE_DOTTED	Use a dotted line style.
GGLINESTYLE_CROSSHAIR	Use cross hairs. This style can only be used for grids.

◆ ITEMTOSNAP

enum FCGridsGuidesPrefs::ITEMTOSNAP

Constants for setting/getting the items that the grids/guides should snap to.

Use GetGridSnapToItem or GetGuideSnapToItem to get a snap state.

Use SetGridSnapToItem or SetGuideSnapToItem to set a snap state.

Lua-supported.

Enumerator
SNAPITEM_BRACKETS	Snap when handling brackets.
SNAPITEM_CHORDS	Snap when moving chords.
SNAPITEM_EXPRESSIONS	Snap when moving expressions.
SNAPITEM_FRETBOARDS	Snap when moving fretboards.
SNAPITEM_GRAPHICSMOVE	Snap when moving graphics.
SNAPITEM_GRAPHICSSIZING	Snap when resizing graphics.
SNAPITEM_MEASURENUMBERS	Snap when moving measure numbers.
SNAPITEM_REPEATS	Snap when handling repeats.
SNAPITEM_SPECIALTOOLS	Snap in Special Tools.
SNAPITEM_STAFFNAMES	Snap when moving staff names.
SNAPITEM_STAVES	Snap when moving staff handles.
SNAPITEM_TEXTBLOCKMOVE	Snap when moving text blocks.
SNAPITEM_TEXTBLOCKSIZING	Snap when resizing text blocks.

Constructor & Destructor Documentation

◆ FCGridsGuidesPrefs()

FCGridsGuidesPrefs::FCGridsGuidesPrefs ( )

inline

The constructor.

Lua-supported.

Member Function Documentation

◆ ClassName()

const char * FCGridsGuidesPrefs::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 __FCPrefsBase.

◆ GetClassID()

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

◆ GetGravityZoneSize()

Efix32 FCGridsGuidesPrefs::GetGravityZoneSize ( ) const

Returns the Gravity zone size, in EFIXes.

Lua-supported (also as property).

◆ GetGridColorBlue()

utwobyte FCGridsGuidesPrefs::GetGridColorBlue ( ) const

inline

Returns the blue color status of the grid, which is part of the RGB value.

Lua-supported (also as property).

Returns: A number between 0 and 255.

◆ GetGridColorGreen()

utwobyte FCGridsGuidesPrefs::GetGridColorGreen ( ) const

inline

Returns the green color status of the grid, which is part of the RGB value.

Lua-supported (also as property).

Returns: A number between 0 and 255.

◆ GetGridColorRed()

utwobyte FCGridsGuidesPrefs::GetGridColorRed ( ) const

inline

Returns the red color status of the grid, which is part of the RGB value.

Lua-supported (also as property).

Returns: A number between 0 and 255.

◆ GetGridDistance()

Efix32 FCGridsGuidesPrefs::GetGridDistance ( ) const

Returns the distance between each grid element, in EFIXes.

Lua-supported (also as property).

◆ GetGridLineStyle()

GGLINESTYLES FCGridsGuidesPrefs::GetGridLineStyle ( ) const

inline

Returns the line style that should be used for grids.

Lua-supported (also as property).

Returns: Any of the GGLINESTYLE_ constants.

◆ GetGridShow()

bool FCGridsGuidesPrefs::GetGridShow ( ) const

inline

Returns if the grid should display.

Lua-supported (also as property).

◆ GetGridSnap()

bool FCGridsGuidesPrefs::GetGridSnap ( ) const

inline

Returns if items should snap to the grid.

Lua-supported (also as property).

◆ GetGridSnapToItem()

bool FCGridsGuidesPrefs::GetGridSnapToItem ( ITEMTOSNAP itemconstant )

Returns the grid "snap state" of a specific item.

Lua-supported.

Parameters

itemconstant Any of the SNAPITEM_ constants. The method will return false if an illegal constant is used.

Returns: True if the item should snap to the grid.

◆ GetGridStep()

twobyte FCGridsGuidesPrefs::GetGridStep ( ) const

inline

Returns the "Display one in ??? Grid Lines" option.

Lua-supported (also as property).

◆ GetGuideColorBlue()

utwobyte FCGridsGuidesPrefs::GetGuideColorBlue ( ) const

inline

Returns the blue color status of the guide, which is part of the RGB value.

Lua-supported (also as property).

Returns: A number between 0 and 255.

◆ GetGuideColorGreen()

utwobyte FCGridsGuidesPrefs::GetGuideColorGreen ( ) const

inline

Returns the green color status of the guide, which is part of the RGB value.

Lua-supported (also as property).

Returns: A number between 0 and 255.

◆ GetGuideColorRed()

utwobyte FCGridsGuidesPrefs::GetGuideColorRed ( ) const

inline

Returns the red color status of the guide, which is part of the RGB value.

Lua-supported (also as property).

Returns: A number between 0 and 255.

◆ GetGuideLineStyle()

GGLINESTYLES FCGridsGuidesPrefs::GetGuideLineStyle ( ) const

inline

Returns the line style that should be used for guides.

Lua-supported (also as property).

Returns: Any of the GGLINESTYLE_ constants, except GGLINESTYLE_CROSSHAIR.

◆ GetGuideShow()

bool FCGridsGuidesPrefs::GetGuideShow ( ) const

inline

Returns if guides should display.

Lua-supported (also as property).

◆ GetGuideSnap()

bool FCGridsGuidesPrefs::GetGuideSnap ( ) const

inline

Returns if items should snap to guides.

Lua-supported (also as property).

◆ GetGuideSnapToItem()

bool FCGridsGuidesPrefs::GetGuideSnapToItem ( ITEMTOSNAP itemconstant )

Returns the guide "snap state" of a specific item.

Lua-supported.

Parameters

itemconstant Any of the SNAPITEM_ constants. The method will return false if an illegal constant is used.

Returns: True if the item should snap to the guide.

◆ GetHorizontalGuideCount()

int FCGridsGuidesPrefs::GetHorizontalGuideCount ( ) const

inline

Returns the number of horizontal guides (=the guides where the line goes horizontally). This value must be identical to the number of actual guides in the document.

Deprecated: This function is deprecated and always returns 0 in Finale 26.2 and higher. To find out the number, use GetHorizontalGuides instead.

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

◆ GetHorizontalGuides()

FCGuides * FCGridsGuidesPrefs::GetHorizontalGuides ( )

Returns a pointer to the collection object that contains the horizontal guides.

The object pointer will only be available if the object has been loaded.

Lua-supported.

Returns: An object of the FCGuides class.

◆ GetVerticalGuideCount()

int FCGridsGuidesPrefs::GetVerticalGuideCount ( ) const

inline

Returns the number of vertical guides (=the guides where the line goes vertically). This value must be identical to the number of actual guides in the document.

Deprecated: This function is deprecated and always returns 0 in Finale 26.2 and higher. To find out the number, use GetVerticalGuides instead.

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

◆ GetVerticalGuides()

FCGuides * FCGridsGuidesPrefs::GetVerticalGuides ( )

Returns a pointer to the collection object that contains the vertical guides.

The object pointer will only be available if the object has been loaded.

Lua-supported.

Returns: An object of the FCGuides class.

◆ Save()

bool FCGridsGuidesPrefs::Save ( )

overridevirtual

Overloaded version of Save().

In addition to the standard data saving, it also handles the saving of the guides, if they have been changed.

Due to a bug in Finale 26.2 and higher, you should use FCGuides::SaveAll to save guides when running in those Finale versions. If you need to save FCGridsGuidesPrefs as well, do it in a separate Undo block from saving the guides. Note that this function still attempts to save the guides in Finale 26.2 and higher. (One hopes the bug might be fixed in the future.) Therefore the safest approach for this workaround is probably to reload FCGridsGuidesPrefs before saving it, after saving the guides.

Reimplemented from __FCPrefsBase.

◆ SetGravityZoneSize()

void FCGridsGuidesPrefs::SetGravityZoneSize ( Efix32 value )

Sets the Gravity zone size, in EFIXes.

Lua-supported (also as property).

Parameters

value The value must be a positive value. Measurement is in EFIXes (1/64th of an EVPU).

◆ SetGridColorBlue()

void FCGridsGuidesPrefs::SetGridColorBlue ( utwobyte value )

inline

Returns the blue color status of the grid, which is part of the RGB value.

Lua-supported (also as property).

Parameters

value A number between 0 and 255.

◆ SetGridColorGreen()

void FCGridsGuidesPrefs::SetGridColorGreen ( utwobyte value )

inline

Returns the green color status of the grid, which is part of the RGB value.

Lua-supported (also as property).

Parameters

value A number between 0 and 255.

◆ SetGridColorRed()

void FCGridsGuidesPrefs::SetGridColorRed ( utwobyte value )

inline

Returns the red color status of the grid, which is part of the RGB value.

Lua-supported (also as property).

Parameters

value A number between 0 and 255.

◆ SetGridColors()

void FCGridsGuidesPrefs::SetGridColors	(	utwobyte	red,
		utwobyte	green,
		utwobyte	blue )

inline

Sets the full RGB color of the grid.

Lua-supported.

Parameters

red	A value between 0 and 255.
green	A value between 0 and 255.
blue	A value between 0 and 255.

◆ SetGridDistance()

void FCGridsGuidesPrefs::SetGridDistance ( Efix32 value )

Sets the distance between each grid element, in EFIXes.

Lua-supported (also as property).

◆ SetGridLineStyle()

void FCGridsGuidesPrefs::SetGridLineStyle ( GGLINESTYLES value )

inline

Sets the line style that should be used for grids.

Lua-supported (also as property).

Parameters

value Any of the GGLINESTYLE_ constants.

◆ SetGridShow()

void FCGridsGuidesPrefs::SetGridShow ( bool state )

inline

Sets if the grid should display.

Lua-supported (also as property).

◆ SetGridSnap()

void FCGridsGuidesPrefs::SetGridSnap ( bool state )

inline

Sets if items should snap to the grid.

Lua-supported (also as property).

◆ SetGridSnapToItem()

void FCGridsGuidesPrefs::SetGridSnapToItem	(	ITEMTOSNAP	itemconstant,
		bool	state )

Sets the grid "snap state" of a specific item.

Lua-supported.

Parameters

itemconstant	Any of the SNAPITEM_ constants. The method will do nothing if an illegal constant is used.
state	True if the item should snap to the grid. False if the item should't snap.

◆ SetGridStep()

void FCGridsGuidesPrefs::SetGridStep ( twobyte value )

Sets the "Display one in ??? Grid Lines" option.

Lua-supported (also as property).

◆ SetGuideColorBlue()

void FCGridsGuidesPrefs::SetGuideColorBlue ( twobyte value )

inline

Returns the blue color status of the guide, which is part of the RGB value.

Lua-supported (also as property).

Parameters

value A number between 0 and 255.

◆ SetGuideColorGreen()

void FCGridsGuidesPrefs::SetGuideColorGreen ( utwobyte value )

inline

Returns the green color status of the guide, which is part of the RGB value.

Lua-supported (also as property).

Parameters

value A number between 0 and 255.

◆ SetGuideColorRed()

void FCGridsGuidesPrefs::SetGuideColorRed ( utwobyte value )

inline

Returns the red color status of the guide, which is part of the RGB value.

Lua-supported (also as property).

Parameters

value A number between 0 and 255.

◆ SetGuideColors()

void FCGridsGuidesPrefs::SetGuideColors	(	utwobyte	red,
		utwobyte	green,
		utwobyte	blue )

inline

Sets the full RGB color of the guides.

Lua-supported.

Parameters

red	A value between 0 and 255.
green	A value between 0 and 255.
blue	A value between 0 and 255.

◆ SetGuideLineStyle()

void FCGridsGuidesPrefs::SetGuideLineStyle ( GGLINESTYLES value )

inline

Sets the line style that should be used for guides.

Lua-supported (also as property).

Parameters

value Any of the GGLINESTYLE_ constants, except GGLINESTYLE_CROSSHAIR.

◆ SetGuideShow()

void FCGridsGuidesPrefs::SetGuideShow ( bool state )

inline

Sets if guides should display.

Lua-supported (also as property).

◆ SetGuideSnap()

void FCGridsGuidesPrefs::SetGuideSnap ( bool state )

inline

Sets if items should snap to guides.

Lua-supported (also as property).

◆ SetGuideSnapToItem()

void FCGridsGuidesPrefs::SetGuideSnapToItem	(	ITEMTOSNAP	itemconstant,
		bool	state )

Sets the guide "snap state" of a specific item.

Lua-supported.

Parameters

itemconstant	Any of the SNAPITEM_ constants. The method will do nothing if an illegal constant is used.
state	True if the item should snap to the guide. False if the item should't snap.

◆ SetHorizontalGuideCount()

void FCGridsGuidesPrefs::SetHorizontalGuideCount ( int value )

inline

Sets the number of horizontal guides (=the guides where the line goes horizontally). This value must be identical to the number of actual guides.

This function does nothing in Finale 26.2 or higher.

◆ SetVerticalGuideCount()

void FCGridsGuidesPrefs::SetVerticalGuideCount ( int value )

inline

Sets the number of vertical guides (=the guides where the line goes vertically). This value must be identical to the number of actual guides.

This function does nothing in Finale 26.2 or higher.

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ GGLINESTYLES

◆ ITEMTOSNAP

Constructor & Destructor Documentation

◆ FCGridsGuidesPrefs()

Member Function Documentation

◆ ClassName()

◆ GetClassID()

◆ GetGravityZoneSize()

◆ GetGridColorBlue()

◆ GetGridColorGreen()

◆ GetGridColorRed()

◆ GetGridDistance()

◆ GetGridLineStyle()

◆ GetGridShow()

◆ GetGridSnap()

◆ GetGridSnapToItem()

◆ GetGridStep()

◆ GetGuideColorBlue()

◆ GetGuideColorGreen()

◆ GetGuideColorRed()

◆ GetGuideLineStyle()

◆ GetGuideShow()

◆ GetGuideSnap()

◆ GetGuideSnapToItem()

◆ GetHorizontalGuideCount()

◆ GetHorizontalGuides()

◆ GetVerticalGuideCount()

◆ GetVerticalGuides()

◆ Save()

◆ SetGravityZoneSize()

◆ SetGridColorBlue()

◆ SetGridColorGreen()

◆ SetGridColorRed()

◆ SetGridColors()

◆ SetGridDistance()

◆ SetGridLineStyle()

◆ SetGridShow()

◆ SetGridSnap()

◆ SetGridSnapToItem()

◆ SetGridStep()

◆ SetGuideColorBlue()

◆ SetGuideColorGreen()

◆ SetGuideColorRed()

◆ SetGuideColors()

◆ SetGuideLineStyle()

◆ SetGuideShow()

◆ SetGuideSnap()

◆ SetGuideSnapToItem()

◆ SetHorizontalGuideCount()

◆ SetVerticalGuideCount()