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

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

#include <ff_prefs.h>

Inheritance diagram for FCGridsGuidesPrefs:
__FCPrefsBase __FCBaseData __FCBase

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 = 1, GGLINESTYLE_DASHED = 2, GGLINESTYLE_DOTTED = 3, GGLINESTYLE_CROSSHAIR = 4 }
 The line styles for grids and guides. 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...
 
 FCGridsGuidesPrefs ()
 The constructor. More...
 
virtual ~FCGridsGuidesPrefs ()
 The destructor.
 
virtual bool Save ()
 Overloaded version of Save(). More...
 
FCGuidesGetHorizontalGuides ()
 Returns a pointer to the collection object that contains the horizontal guides. More...
 
FCGuidesGetVerticalGuides ()
 Returns a pointer to the collection object that contains the vertical guides. More...
 
Efix32 GetGravityZoneSize () const
 Returns the Gravity zone size, in EFIXes. More...
 
bool GetGridShow () const
 Returns if the grid should display. More...
 
bool GetGridSnap () const
 Returns if items should snap to the grid. More...
 
twobyte GetGridStep () const
 Returns the "Display one in ??? Grid Lines" option. More...
 
utwobyte GetGridColorRed () const
 Returns the red color status of the grid, which is part of the RGB value. More...
 
utwobyte GetGridColorGreen () const
 Returns the green color status of the grid, which is part of the RGB value. More...
 
utwobyte GetGridColorBlue () const
 Returns the blue color status of the grid, which is part of the RGB value. More...
 
GGLINESTYLES GetGridLineStyle () const
 Returns the line style that should be used for grids. More...
 
Efix32 GetGridDistance () const
 Returns the distance between each grid element, in EFIXes. More...
 
bool GetGuideShow () const
 Returns if guides should display. More...
 
bool GetGuideSnap () const
 Returns if items should snap to guides. More...
 
utwobyte GetGuideColorRed () const
 Returns the red color status of the guide, which is part of the RGB value. More...
 
utwobyte GetGuideColorGreen () const
 Returns the green color status of the guide, which is part of the RGB value. More...
 
utwobyte GetGuideColorBlue () const
 Returns the blue color status of the guide, which is part of the RGB value. More...
 
GGLINESTYLES GetGuideLineStyle () const
 Returns the line style that should be used for guides. More...
 
bool GetGridSnapToItem (ITEMTOSNAP itemconstant)
 Returns the grid "snap state" of a specific item. More...
 
bool GetGuideSnapToItem (ITEMTOSNAP itemconstant)
 Returns the guide "snap state" of a specific item. More...
 
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. More...
 
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. More...
 
void SetGravityZoneSize (Efix32 value)
 Sets the Gravity zone size, in EFIXes. More...
 
void SetGridShow (bool state)
 Sets if the grid should display. More...
 
void SetGridSnap (bool state)
 Sets if items should snap to the grid. More...
 
void SetGridStep (twobyte value)
 Sets the "Display one in ??? Grid Lines" option. More...
 
void SetGridColorRed (utwobyte value)
 Returns the red color status of the grid, which is part of the RGB value. More...
 
void SetGridColorGreen (utwobyte value)
 Returns the green color status of the grid, which is part of the RGB value. More...
 
void SetGridColorBlue (utwobyte value)
 Returns the blue color status of the grid, which is part of the RGB value. More...
 
void SetGridLineStyle (GGLINESTYLES value)
 Sets the line style that should be used for grids. More...
 
void SetGridDistance (Efix32 value)
 Sets the distance between each grid element, in EFIXes. More...
 
void SetGuideShow (bool state)
 Sets if guides should display. More...
 
void SetGuideSnap (bool state)
 Sets if items should snap to guides. More...
 
void SetGuideColorRed (utwobyte value)
 Returns the red color status of the guide, which is part of the RGB value. More...
 
void SetGuideColorGreen (utwobyte value)
 Returns the green color status of the guide, which is part of the RGB value. More...
 
void SetGuideColorBlue (twobyte value)
 Returns the blue color status of the guide, which is part of the RGB value. More...
 
void SetGuideLineStyle (GGLINESTYLES value)
 Sets the line style that should be used for guides. More...
 
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. More...
 
void SetGuideSnapToItem (ITEMTOSNAP itemconstant, bool state)
 Sets the guide "snap state" of a specific item. More...
 
void SetGridColors (utwobyte red, utwobyte green, utwobyte blue)
 Sets the full RGB color of the grid. More...
 
void SetGuideColors (utwobyte red, utwobyte green, utwobyte blue)
 Sets the full RGB color of the guides. 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 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
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 EVERSION EnigmaVersion ()
 The Enigma version for save/load/create/delete operations. 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...
 
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 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...
 
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 document preferences related to guides and grids.

Member Enumeration Documentation

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.

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

The constructor.

Lua-supported.

Member Function Documentation

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

Efix32 FCGridsGuidesPrefs::GetGravityZoneSize ( ) const

Returns the Gravity zone size, in EFIXes.

Lua-supported (also as property).

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.
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.
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.
Efix32 FCGridsGuidesPrefs::GetGridDistance ( ) const

Returns the distance between each grid element, in EFIXes.

Lua-supported (also as property).

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.
bool FCGridsGuidesPrefs::GetGridShow ( ) const
inline

Returns if the grid should display.

Lua-supported (also as property).

bool FCGridsGuidesPrefs::GetGridSnap ( ) const
inline

Returns if items should snap to the grid.

Lua-supported (also as property).

bool FCGridsGuidesPrefs::GetGridSnapToItem ( ITEMTOSNAP  itemconstant)

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

Lua-supported.

Parameters
itemconstantAny 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.
twobyte FCGridsGuidesPrefs::GetGridStep ( ) const
inline

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

Lua-supported (also as property).

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.
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.
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.
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.
bool FCGridsGuidesPrefs::GetGuideShow ( ) const
inline

Returns if guides should display.

Lua-supported (also as property).

bool FCGridsGuidesPrefs::GetGuideSnap ( ) const
inline

Returns if items should snap to guides.

Lua-supported (also as property).

bool FCGridsGuidesPrefs::GetGuideSnapToItem ( ITEMTOSNAP  itemconstant)

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

Lua-supported.

Parameters
itemconstantAny 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.
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.

Use GetHorizontalGuides to get the object to the horizontal guides.

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

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

Use GetVerticalGuides to get the object to the horizontal guides.

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

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.
bool FCGridsGuidesPrefs::Save ( )
virtual

Overloaded version of Save().

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

Reimplemented from __FCPrefsBase.

void FCGridsGuidesPrefs::SetGravityZoneSize ( Efix32  value)

Sets the Gravity zone size, in EFIXes.

Lua-supported (also as property).

Parameters
valueThe value must be a positive value. Measurement is in EFIXes (1/64th of an EVPU).
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
valueA number between 0 and 255.
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
valueA number between 0 and 255.
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
valueA number between 0 and 255.
void FCGridsGuidesPrefs::SetGridColors ( utwobyte  red,
utwobyte  green,
utwobyte  blue 
)
inline

Sets the full RGB color of the grid.

Lua-supported.

Parameters
redA value between 0 and 255.
greenA value between 0 and 255.
blueA value between 0 and 255.
void FCGridsGuidesPrefs::SetGridDistance ( Efix32  value)

Sets the distance between each grid element, in EFIXes.

Lua-supported (also as property).

void FCGridsGuidesPrefs::SetGridLineStyle ( GGLINESTYLES  value)
inline

Sets the line style that should be used for grids.

Lua-supported (also as property).

Parameters
valueAny of the GGLINESTYLE_ constants.
void FCGridsGuidesPrefs::SetGridShow ( bool  state)
inline

Sets if the grid should display.

Lua-supported (also as property).

void FCGridsGuidesPrefs::SetGridSnap ( bool  state)
inline

Sets if items should snap to the grid.

Lua-supported (also as property).

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

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

Lua-supported.

Parameters
itemconstantAny of the SNAPITEM_ constants. The method will do nothing if an illegal constant is used.
stateTrue if the item should snap to the grid. False if the item should't snap.
void FCGridsGuidesPrefs::SetGridStep ( twobyte  value)
inline

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

Lua-supported (also as property).

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
valueA number between 0 and 255.
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
valueA number between 0 and 255.
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
valueA number between 0 and 255.
void FCGridsGuidesPrefs::SetGuideColors ( utwobyte  red,
utwobyte  green,
utwobyte  blue 
)
inline

Sets the full RGB color of the guides.

Lua-supported.

Parameters
redA value between 0 and 255.
greenA value between 0 and 255.
blueA value between 0 and 255.
void FCGridsGuidesPrefs::SetGuideLineStyle ( GGLINESTYLES  value)
inline

Sets the line style that should be used for guides.

Lua-supported (also as property).

Parameters
valueAny of the GGLINESTYLE_ constants, except GGLINESTYLE_CROSSHAIR.
void FCGridsGuidesPrefs::SetGuideShow ( bool  state)
inline

Sets if guides should display.

Lua-supported (also as property).

void FCGridsGuidesPrefs::SetGuideSnap ( bool  state)
inline

Sets if items should snap to guides.

Lua-supported (also as property).

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

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

Lua-supported.

Parameters
itemconstantAny of the SNAPITEM_ constants. The method will do nothing if an illegal constant is used.
stateTrue if the item should snap to the guide. False if the item should't snap.