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

Class to encapsulate enclosures (available for example in expressions and measure numbers.) More...

#include <ff_other.h>

Inheritance diagram for FCEnclosure:
__FCNoInciOther __FCOther __FCBaseData __FCBase

Public Types

enum  ENCLOSURESHAPE {
  ENCLOSURE_NONE = 0, ENCLOSURE_RECTANGLE = 1, ENCLOSURE_ELLIPSE = 2, ENCLOSURE_TRIANGLE = 3,
  ENCLOSURE_DIAMOND = 4, ENCLOSURE_PENTAGON = 5, ENCLOSURE_HEXAGON = 6, ENCLOSURE_SEPTAGON = 7,
  ENCLOSURE_OCTAGON = 8
}
 The enclosure shapes. More...
 
enum  ENCLOSUREMODES { ENCLOSUREMODE_NONE = 0, ENCLOSUREMODE_MINWIDTH, ENCLOSUREMODE_MATCHDIMENSIONS }
 The enclosure sizing options. 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...
 
 FCEnclosure ()
 The construtor. More...
 
void _AssignEDTEnclosure (void *pPointer)
 For internal use ONLY! Assigns enclosure data to the class (for structures that doesn't load their own enclosure data).
 
void SetShape (ENCLOSURESHAPE shape)
 Sets the shape for the enclosure. More...
 
void SetLineWidth (int width)
 Sets the line width (in 64ths of a EVPUs). More...
 
void SetHorizontalOffset (int offset)
 Sets the horizontal offset. More...
 
void SetVerticalOffset (int offset)
 Sets the vertical offset. More...
 
void SetHorizontalMargin (int margin)
 Sets the horizontal margin (which is half the width value in the enclosure dialog box). More...
 
void SetVerticalMargin (int margin)
 Sets the vertical margin (which is half the height value in the enclosure dialog box). More...
 
void SetFixedSize (bool state)
 Sets the "fixed size" state. More...
 
void SetOpaque (bool state)
 Sets the "opaque" state. More...
 
void SetRoundedCorners (bool state)
 Sets if rounded corners should be used (on Finale 25.4 and later) for the enclosure. More...
 
void SetRoundedCornerRadius (Efix32 radius)
 Sets the corner radius (in EFIXes) for rounded corners on Finale 25.4 and above. More...
 
void SetMode (ENCLOSUREMODES enclosuremode)
 Set the enclosure sizing option. More...
 
ENCLOSURESHAPE GetShape () const
 Returns the shape of the enclosure. More...
 
int GetLineWidth () const
 Returns the line width (in 64ths of an EVPUs). More...
 
int GetHorizontalOffset () const
 Returns the horizontal offset. More...
 
int GetVerticalOffset () const
 Returns the vertical offset. More...
 
int GetHorizontalMargin () const
 Returns the horizontal margin (which is half the width value in the enclosure dialog box). More...
 
int GetVerticalMargin () const
 Returns the vertical margin (which is half the height value in the enclosure dialog box). More...
 
bool GetFixedSize () const
 Returns the "fixed size" state. More...
 
bool GetOpaque () const
 Returns the "opaque" state. More...
 
bool GetRoundedCorners () const
 Returns if rounded corners should be used (on Finale 25.4 and later) for the enclosure. More...
 
Efix32 GetRoundedCornerRadius () const
 Returns the corner radius (in EFIXes) for rounded corners on Finale 25.4 and above. More...
 
ENCLOSUREMODES GetMode () const
 Returns the enclosure sizing option. More...
 
virtual void DebugDump ()
 Outputs the class data/information for debugging purposes. More...
 
- Public Member Functions inherited from __FCNoInciOther
 __FCNoInciOther ()
 The constructor.
 
virtual bool Load (CMPER itemno)
 Loads the indicated item. More...
 
virtual bool Reload ()
 Overridden Reload() method to support complex data types.
 
virtual bool SaveAs (CMPER itemno)
 Saves the data under another item number. The object will now be connected to the new item number. More...
 
virtual bool DeepSaveAs (CMPER itemno)
 Saves the data under another item number, but also makes a deep copy of the object. More...
 
virtual bool DeepDeleteData ()
 Deletes the data and all related data available in other data structures. More...
 
virtual bool SaveNew ()
 Creates the data as completely new item number. The object will now be connected to the new item number. More...
 
virtual CMPER GetItemNo () const
 Returns the item number. This typically points to items such as a page number, a measure number, a 1-based expression definition number, etc. More...
 
void SetItemNo (CMPER cmper)
 Sets the item number. Use with extreme care! This is mostly intended for situations when creating new records isn't supported by Finale (preventing SaveAs to work). More...
 
virtual bool LoadFirst ()
 Loads the first element of 1-based data. More...
 
- Public Member Functions inherited from __FCOther
void SetCmperAndInci (CMPER cmper, twobyte inci)
 Sets both the CMPER and the incident number in the dataID record. Mainly for internal use.
 
 __FCOther ()
 The constructor.
 
bool IsIdenticalRecord (__FCOther *pCompare)
 Compares an object to see if both objects point to the same data record. More...
 
- Public Member Functions inherited from __FCBaseData
EDOCID GetConnectedDocID () const
 Returns the document ID that was connected to the last load/save of the data. More...
 
bool VerifyConnectedDocID ()
 Checks that the stored document ID for the data object matches the current document's ID. More...
 
virtual EXTAG Tag ()=0
 The Enigma tag for the derived class. More...
 
virtual EVERSION EnigmaVersion ()
 The Enigma version for save/load/create/delete operations. More...
 
virtual int DataSizeLoad ()=0
 Returns the data size for the data structure that should be loaded. More...
 
virtual int DataSizeSave ()
 Returns the data size for the data structure that should be saved or created. More...
 
void _CloneFrom (__FCBaseData *pSource)
 For internal use only. Copies object data (except data block) from another object. More...
 
virtual void CloneMemoryFrom (__FCBaseData *pSource)
 
const EDataID * _GetDataID ()
 Intended ONLY for the _CloneFrom implementation. More...
 
int _GetLoadedSize () const
 Intended ONLY for the _CloneFrom implementation. More...
 
const void * GetDataBlock ()
 Intended ONLY for the _CloneFrom implementation. More...
 
EXTAG GetCustomTag ()
 Returns the custom Enigma tag, if any. More...
 
void SetCustomTag (EXTAG tag)
 Sets the custom Enigma tag, for classes that support multiple Enigma tags. More...
 
 __FCBaseData ()
 The constructor.
 
virtual ~__FCBaseData ()
 Virtual destructor.
 
virtual bool Save ()
 Saves the currently loaded to its current location. More...
 
virtual bool DeleteData ()
 Deletes the associated data from Finale's database. Be careful when deleting multiple objects. More...
 
virtual bool LoadLast ()
 Loads the very last element in the database, if any. More...
 
virtual bool LoadNext ()
 Loads the next element from the database, if any. More...
 
virtual bool LoadPrevious ()
 Loads the previous element in the database, if any. More...
 
__FCBaseDataCreateClone ()
 Creates an identical copy of an object. More...
 
virtual void DebugDataDump ()
 Outputs a memory dump of the data block in the object for debugging purposes. More...
 
virtual void DebugDataByteArrayDump ()
 Outputs a memory dump of the data block in the object for debugging purposes, as a C++ byte array. More...
 
void DebugDataOffsetDump (int offset, int size)
 For debug mode only. Dumps a data memory block at a specific offset and with a specific size.
 
FCNumbersCreateRawDataDump ()
 Creates a byte collection with the raw loaded data block for the object (if the object type supports single data blocks). This method is only intended for debug purposes. More...
 
- Public Member Functions inherited from __FCBase
 __FCBase ()
 The constructor.
 
virtual ~__FCBase ()
 Virtual destructor, so all inherited classes get the virtual destructor. More...
 
void DebugMsgDigit (const char *pszPrefixText, int i)
 Creates a simple Message Box for debug purposes. The text appears with the extra digit (in decimal presentation) appearing afterwards. More...
 
void DebugMsgHex (const char *pszPrefixText, int i)
 Creates a simple Message Box for debug purposes. The text appears with the extra digit (as a hexadecimal number) appearing afterwards. More...
 
void DebugMsgString (const char *pszPrefixText, const char *thestring)
 Creates a simple Message Box for debug purposes. The text appears with the extra string appearing afterwards. More...
 
void DebugMsg (const char *pszMsg)
 Creates a simple Message Box for debug purposes with just one text string. More...
 
void DebugOutMenuInfo (FCUI *pUI, int menuixd_horiz, int menuixd_vert) const
 Outputs the menu command info for debugging purposes. More...
 
int DebugOutFormat (const char *fmt,...)
 Outputs debug text using C style "printf" syntax. More...
 
void Set16BitFlag (FLAG_16 *flag, FLAG_16 flagbits, bool state)
 Sets a 16 bit flag in the data block. More...
 
void Set32BitFlag (FLAG_32 *flag, FLAG_32 flagbits, bool state)
 Sets a 32 bit flag in the data block. More...
 
bool GetBitFlag (FLAG_32 flag, FLAG_32 flagbits) const
 Gets a state from flag bits. Returns true if any bit in the mask is set. More...
 
void SetUserData (void *pData)
 Sets the user data attached to the instance of an object. More...
 
void SetUserData2 (void *pData)
 Sets the additional user data attached to the instance of an object. More...
 
void * GetUserData () const
 Gets the user data attached to the instance of an object. More...
 
void * GetUserData2 () const
 Gets the additional user data attached to the instance of an object. More...
 
virtual bool IsIdentical (__FCBase *pCompareObject)
 Returns true if the data in the passed object is considered to be identical to the current object, otherwise false. More...
 
void StoreXML_String (tinyxml2::XMLElement *pParentNode, const char *pszElementName, FCString *pStringValue)
 Helper function to store FCString objects in the XML file. More...
 
void StoreXML_Integer (tinyxml2::XMLElement *pParentNode, const char *pszElementName, int value)
 Helper function to store integer objects in the XML file. More...
 
void StoreXML_Bool (tinyxml2::XMLElement *pParentNode, const char *pszElementName, bool value)
 Helper function to store boolean objects in the XML file. More...
 
void StoreXML_StringAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, FCString *pStringValue)
 Helper function to store FCString objects in the XML file, as an attribute to a node. More...
 
void StoreXML_IntegerAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, int value)
 Helper function to store integer objects in the XML file, as an attribute to a node. More...
 
void StoreXML_BoolAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, bool value)
 Helper function to store boolean objects in the XML file, as an attribute to a node. More...
 
void StoreXML_FloatAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, float value)
 Helper function to store floating point objects in the XML file, as an attribute to a node. More...
 
virtual void StoreToXML (tinyxml2::XMLElement *pParentNode)
 Virtual method that is used to store an object's data. More...
 
bool ReadXML_String (tinyxml2::XMLElement *pParentNode, const char *pszElementName, FCString *pStringValue)
 Helper method to read FCString objects from the XML file. More...
 
bool ReadXML_Integer (tinyxml2::XMLElement *pParentNode, const char *pszElementName, int *pValue)
 Helper method to read integer objects from the XML file. More...
 
bool ReadXML_Bool (tinyxml2::XMLElement *pParentNode, const char *pszElementName, bool *pValue)
 Helper method to read boolean objects from the XML file. More...
 
bool ReadXML_StringAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, FCString *pStringValue)
 Helper method to read FCString objects from the XML file, as an attribute to a node. More...
 
bool ReadXML_IntegerAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, int *pValue)
 Helper method to read integer objects from the XML file, as an attribute to a node. More...
 
bool ReadXML_BoolAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, bool *pValue)
 Helper method to read boolean objects from the XML file, as an attribute to a node. More...
 
bool ReadXML_FloatAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, float *pValue)
 Helper method to read floating point objects from the XML file, as an attribute to a node. More...
 
virtual bool ReadFromXML (tinyxml2::XMLElement *pParentNode)
 Virtual method that is used to read object data. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from __FCBase
static void DebugOutPtr (const char *pszPrefixText, void *ptr)
 Static method that outputs a line for debugging purposes. The prefix text appears with the extra ptr (in hexadeximal representation) appearing afterwards. More...
 
static void DebugOutDigit (const char *pszPrefixText, int i)
 Static method that outputs a line for debugging purposes. The text appears with the extra digit (in decimal presentation) appearing afterwards. More...
 
static void DebugOutFloat (const char *pszPrefixText, float f)
 Static method that outputs a line for debugging purposes. The text appears with the extra float value appearing afterwards. More...
 
static void DebugOutTag (const char *pszPrefixText, EXTAG extag)
 Static method that outputs a line for debugging purposes. The text appears with the EXTAG (in text) appearing afterwards. More...
 
static void DebugOutHex (const char *pszPrefixText, int i)
 Static method that outputs a line for debugging purposes. The text appears with the extra digit (in hexadecimal presentation) appearing afterwards. More...
 
static void DebugOutBin (const char *pszPrefixText, int i)
 Static method that outputs a line for debugging purposes. The text appears with the extra digit (in binary presentation) appearing afterwards. More...
 
static void DebugOutString (const char *pszPrefixText, const char *thestring)
 Static method that outputs a line for debugging purposes (C string version). The text appears with the extra string appearing afterwards. More...
 
static void DebugOutString (const char *pszPrefixText, FCString *pString)
 Static method that outputs a line for debugging purposes (FCString version). The text appears with the extra string appearing afterwards. More...
 
static void DebugOutBool (const char *pszPrefixText, bool state)
 Static method that outputs a line for debugging purposes. The boolean state appears afterwards as either "TRUE" or "FALSE". More...
 
static void DebugOutBlock (const void *pBuffer, int startoffset, int size)
 Static method that outputs a memory block for debugging purposes. Eight bytes per line will appear (as hex digits) until the whole memory block is dumped. More...
 
static void DebugOutByteArrayBlock (const void *pBuffer, int startoffset, int size)
 Static method that outputs a memory block for debugging purposes. Eight bytes per line will appear (as hex digits) as a C++ onebyte array, until the whole memory block is dumped. More...
 
static void DebugOut (const char *pszLine)
 Static method to output a line of text for debugging purposes. More...
 
- Protected Member Functions inherited from __FCBaseData
virtual void * Allocate ()=0
 
virtual void Deallocate ()
 
virtual bool IsDynamicSize ()
 
bool LoadDataBlock ()
 Loads the data. If the object is of dynamic size, the old memory block is freed and a new is allocated.
 
void ClearData ()
 
virtual 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

Class to encapsulate enclosures (available for example in expressions and measure numbers.)

Member Enumeration Documentation

The enclosure sizing options.

Enumerator
ENCLOSUREMODE_NONE 

Options: None

ENCLOSUREMODE_MINWIDTH 

"Enforce Minimum Width" - don't let shape get taller than it is wide.

ENCLOSUREMODE_MATCHDIMENSIONS 

"Match Height and Width" - keep width and height equal.

The enclosure shapes.

Enumerator
ENCLOSURE_NONE 

No shape

ENCLOSURE_RECTANGLE 

Rectangle

ENCLOSURE_ELLIPSE 

Circle/ellipse

ENCLOSURE_TRIANGLE 

Triangle

ENCLOSURE_DIAMOND 

Diamond

ENCLOSURE_PENTAGON 

Pentagon

ENCLOSURE_HEXAGON 

Hexagon

ENCLOSURE_SEPTAGON 

Septagon

ENCLOSURE_OCTAGON 

Octagon

Constructor & Destructor Documentation

FCEnclosure::FCEnclosure ( )
inline

The construtor.

Defaults to pointing to self-contained storage.

Member Function Documentation

virtual const char* FCEnclosure::ClassName ( )
inlinevirtual

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

Lua-supported.

Reimplemented from __FCNoInciOther.

virtual void FCEnclosure::DebugDump ( )
inlinevirtual

Outputs the class data/information for debugging purposes.

Accessible if PDK_FRAMEWORK_DEBUG is defined.

When child class inherit this method to output the contents of its own members, it should call the parent before providing its own output.

Reimplemented from __FCNoInciOther.

virtual const PDKFRAMEWORK_CLASSID FCEnclosure::GetClassID ( )
inlinevirtual

Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has problems to resolve the true classes of inherited objects.

This method must be overwritten by all child classes.

Lua-supported.

Implements __FCBaseData.

bool FCEnclosure::GetFixedSize ( ) const
inline

Returns the "fixed size" state.

Lua-supported (also as property).

int FCEnclosure::GetHorizontalMargin ( ) const
inline

Returns the horizontal margin (which is half the width value in the enclosure dialog box).

Lua-supported (also as property).

int FCEnclosure::GetHorizontalOffset ( ) const
inline

Returns the horizontal offset.

Lua-supported (also as property).

int FCEnclosure::GetLineWidth ( ) const
inline

Returns the line width (in 64ths of an EVPUs).

Lua-supported (also as property).

ENCLOSUREMODES FCEnclosure::GetMode ( ) const
inline

Returns the enclosure sizing option.

Lua-supported (also as property).

bool FCEnclosure::GetOpaque ( ) const
inline

Returns the "opaque" state.

Lua-supported (also as property).

Efix32 FCEnclosure::GetRoundedCornerRadius ( ) const
inline

Returns the corner radius (in EFIXes) for rounded corners on Finale 25.4 and above.

If rounded corners are used or not are retrieved with the GetRoundedCorners() method.

Returns
The rounded corner radius, on supported Finale versions. Always 0 on Finale versions earlier than Finale 25.4.
bool FCEnclosure::GetRoundedCorners ( ) const
inline

Returns if rounded corners should be used (on Finale 25.4 and later) for the enclosure.

The rounded corner radius is retrieved with GetRoundedCornerRadius().

Returns
True is rounded corners are used for the enclosure. Always false on Finale versions earlier than Finale 25.4.
ENCLOSURESHAPE FCEnclosure::GetShape ( ) const
inline

Returns the shape of the enclosure.

Lua-supported (also as property).

Returns
Any of the ENCLOSURE_ constants.
int FCEnclosure::GetVerticalMargin ( ) const
inline

Returns the vertical margin (which is half the height value in the enclosure dialog box).

Lua-supported (also as property).

int FCEnclosure::GetVerticalOffset ( ) const
inline

Returns the vertical offset.

Lua-supported (also as property).

void FCEnclosure::SetFixedSize ( bool  state)
inline

Sets the "fixed size" state.

Lua-supported (also as property).

void FCEnclosure::SetHorizontalMargin ( int  margin)
inline

Sets the horizontal margin (which is half the width value in the enclosure dialog box).

Lua-supported (also as property).

void FCEnclosure::SetHorizontalOffset ( int  offset)
inline

Sets the horizontal offset.

Lua-supported (also as property).

void FCEnclosure::SetLineWidth ( int  width)
inline

Sets the line width (in 64ths of a EVPUs).

Lua-supported (also as property).

void FCEnclosure::SetMode ( ENCLOSUREMODES  enclosuremode)
inline

Set the enclosure sizing option.

Lua-supported (also as property).

void FCEnclosure::SetOpaque ( bool  state)
inline

Sets the "opaque" state.

Lua-supported (also as property).

void FCEnclosure::SetRoundedCornerRadius ( Efix32  radius)
inline

Sets the corner radius (in EFIXes) for rounded corners on Finale 25.4 and above.

If rounded corners are used or not are set with the SetRoundedCorners() method.

Parameters
radiusThe rounded corner radius (in EFIXes), on supported Finale versions. Does nothing on Finale versions earlier than Finae 25.4.
void FCEnclosure::SetRoundedCorners ( bool  state)
inline

Sets if rounded corners should be used (on Finale 25.4 and later) for the enclosure.

The rounded corner radius is set with SetRoundedCornerRadius().

Parameters
stateTrue if rounded corners should be used for the enclosure.
void FCEnclosure::SetShape ( ENCLOSURESHAPE  shape)
inline

Sets the shape for the enclosure.

Lua-supported (also as property).

Parameters
shapeAny of the ENCLOSURE_ constants.
void FCEnclosure::SetVerticalMargin ( int  margin)
inline

Sets the vertical margin (which is half the height value in the enclosure dialog box).

Lua-supported (also as property).

void FCEnclosure::SetVerticalOffset ( int  offset)
inline

Sets the vertical offset.

Lua-supported (also as property).