FCBookmark Class Reference

The class for a Finale bookmark. More...

#include <ff_other.h>

Inheritance diagram for FCBookmark:

Public Types
enum	BOOKMARKTYPES { BOOKMARKTYPE_PAGEVIEW = 0 , BOOKMARKTYPE_SCROLLVIEW = 1 }
	The bookmark type. 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.
	FCBookmark ()
	The constructor.
FCString *	CreateNameString ()
	Creates a string with the name of the bookmark. This is the string that appears in Finale's Bookmarks menu.
bool	SaveNameString (const FCString *pString)
	Saves the name of the bookmark.
BOOKMARKTYPES	GetViewType () const
	Returns the view type for the bookmark.
ePercent	GetViewPercent () const
	Get the view percent to which to scale the view. This value is only used if GetUseViewPercent is true.
bool	GetUseViewPercent () const
	Indicates if the view will be scaled. The scale value is specified by GetViewPercent.
int	GetLocator () const
	Returns the locator for the bookmark.
int	GetHorizontalPosInst () const
	Returns the first scroll locator for the bookmark.
bool	GetUseHorizontalPosInst () const
	Indicates whether to use the value returned by GetHorizontalPosInst.
int	GetVerticalPosStaffSet () const
	Returns the second scroll locator for the bookmark.
bool	GetUseVerticalPosStaffSet () const
	Indicates whether to use the value returned by GetVerticalPosStaffSet.
void	SetViewType (BOOKMARKTYPES value)
	Sets the view type for the bookmark.
void	SetViewPercent (ePercent value)
	Set the view percent to which to scale the view. This value is only used if SetUseViewPercent is true.
void	SetUseViewPercent (bool state)
	Sets if the view will be scaled. The scale value is specified by SetViewPercent.
void	SetLocator (int value)
	Sets the locator for the bookmark.
void	SetHorizontalPosInst (int value)
	Sets the first scroll locator for the bookmark.
void	SetUseHorizontalPosInst (bool state)
	Sets whether to use the value specified by SetHorizontalPosInst.
void	SetVerticalPosStaffSet (int value)
	Sets the second scroll locator for the bookmark.
void	SetUseVerticalPosStaffSet (bool state)
	Sets whether to use the value specified by SetVerticalPosStaffSet.
bool	IsForPageView () const
	Returns true if this bookmark is for Page View.
bool	IsForScrollView () const
	Returns true if this bookmark is for Scroll View.
void	DebugDump () override
	Outputs the class data/information for debugging purposes.
Public Member Functions inherited from __FCNoInciOther
	__FCNoInciOther ()
	The constructor.
virtual bool	Load (CMPER itemno)
	Loads the indicated item.
bool	Reload () override
	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.
virtual bool	DeepSaveAs (CMPER itemno)
	Saves the data under another item number, but also makes a deep copy of the object.
bool	DeepDeleteData () override
	Deletes the data and all related data available in other data structures.
virtual bool	SaveNew ()
	Creates the data as completely new item number. The object will now be connected to the new item number.
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.
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).
bool	LoadFirst () override
	Loads the first element of 1-based data.
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.
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 EXTAG	Tag () const =0
	The Enigma tag for the derived class.
virtual EVERSION	EnigmaVersion () const
	The Enigma version for save/load/create/delete operations.
virtual int	DataSizeLoad () const =0
	Returns the data size for the data structure that should be loaded.
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.
virtual void	CloneMemoryFrom (__FCBaseData *pSource)
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	Save ()
	Saves the currently loaded to its current location.
virtual bool	DeleteData ()
	Deletes the associated data from Finale's database. Be careful when deleting multiple objects.
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	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 __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!
virtual __FCBaseData *	CreateObject ()=0
	Creates a new instance of the object.
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

The class for a Finale bookmark.

Warning

You can create or modify instances this class. However, Finale may not see the changes until you save the document, close it, and then reopen it.

You must define PDK_FRAMEWORK_ENIGMASTRINGS to use this class.

Member Enumeration Documentation

BOOKMARKTYPES

enum FCBookmark::BOOKMARKTYPES

The bookmark type.

Enumerator
BOOKMARKTYPE_PAGEVIEW	Assign To: Page View
BOOKMARKTYPE_SCROLLVIEW	Assign To: Scroll View

Constructor & Destructor Documentation

FCBookmark()

FCBookmark::FCBookmark ( )

inline

The constructor.

Lua-supported.

Member Function Documentation

ClassName()

const char * FCBookmark::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 __FCNoInciOther.

CreateNameString()

FCString * FCBookmark::CreateNameString ( )

inline

Creates a string with the name of the bookmark. This is the string that appears in Finale's Bookmarks menu.

Warning

Changes to this value do not appear in Finale's Bookmarks menu until you save the file and reopen it.

For C++ clients, it is the caller's responsibility to delete the string from the heap after use. Lua clients do not need to worry about this.

Lua-supported (0.68).

Returns

Pointer to the created FCString object or nil if none

DebugDump()

void FCBookmark::DebugDump ( )

inlineoverridevirtual

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.

GetClassID()

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

GetHorizontalPosInst()

int FCBookmark::GetHorizontalPosInst ( ) const

inline

Returns the first scroll locator for the bookmark.

This value is only used if GetUseHorizontalPosInst is true.

Lua-supported (also as a property) (0.68).

Returns

If the bookmark is for Page View, this is the evpu horizontal position on the page. If the bookmark is for Scroll View, this the staff number of the top staff to scroll into view.

GetLocator()

int FCBookmark::GetLocator ( ) const

inline

Returns the locator for the bookmark.

Lua-supported (also as a property) (0.68).

Returns

the page number if the bookmark is for Page View or the measure number if the bookmark is for Scroll View.

GetUseHorizontalPosInst()

bool FCBookmark::GetUseHorizontalPosInst ( ) const

inline

Indicates whether to use the value returned by GetHorizontalPosInst.

Lua-supported (also as a property) (0.68).

GetUseVerticalPosStaffSet()

bool FCBookmark::GetUseVerticalPosStaffSet ( ) const

inline

Indicates whether to use the value returned by GetVerticalPosStaffSet.

Lua-supported (also as a property) (0.68).

GetUseViewPercent()

bool FCBookmark::GetUseViewPercent ( ) const

inline

Indicates if the view will be scaled. The scale value is specified by GetViewPercent.

Lua-supported (also as a property) (0.68).

GetVerticalPosStaffSet()

int FCBookmark::GetVerticalPosStaffSet ( ) const

inline

Returns the second scroll locator for the bookmark.

This value is only used if GetUseVerticalPosStaffSet is true.

Lua-supported (also as a property) (0.68).

Returns

If the bookmark is for Page View, this is the evpu vertical position on the page. If the bookmark is for Scroll View, this the staff set number to use (1-8).

GetViewPercent()

ePercent FCBookmark::GetViewPercent ( ) const

inline

Get the view percent to which to scale the view. This value is only used if GetUseViewPercent is true.

Lua-supported (also as a property) (0.68).

Returns

0 or higher value indicating a percentage. (100 = 100%.)

GetViewType()

BOOKMARKTYPES FCBookmark::GetViewType ( ) const

inline

Returns the view type for the bookmark.

Lua-supported (also as a property) (0.68).

Returns

one of the BOOKMARKTYPES constants.

IsForPageView()

bool FCBookmark::IsForPageView ( ) const

inline

Returns true if this bookmark is for Page View.

This is a shortcut for comparing GetViewType to BOOKMARKTYPE_PAGEVIEW

Lua-supported (0.68).

IsForScrollView()

bool FCBookmark::IsForScrollView ( ) const

inline

Returns true if this bookmark is for Scroll View.

This is a shortcut for comparing GetViewType to BOOKMARKTYPE_SCROLLVIEW

Lua-supported (0.68).

SaveNameString()

bool FCBookmark::SaveNameString

(

const FCString *

pString

)

Saves the name of the bookmark.

If the string did not previously exist (CreateNameString returned nil), then you should also create or save the instance of FCBookmark after calling this function.

Warning

This name does not appear in Finale's bookmark menu until you save, close, and re-open the document file.

Lua-supported (0.68).

Parameters

pString

the string containing the new name. It should not contain any enigma font tags.

Returns

True if successful.

SetHorizontalPosInst()

void FCBookmark::SetHorizontalPosInst ( int value )

inline

Sets the first scroll locator for the bookmark.

This value is only used if SetUseHorizontalPosInst is true.

Lua-supported (also as a property) (0.68).

Parameters

value

If the bookmark is for Page View, this is the evpu horizontal position on the page. If the bookmark is for Scroll View, this the staff number of the top staff to scroll into view. (See SetViewType.)

SetLocator()

void FCBookmark::SetLocator ( int value )

inline

Sets the locator for the bookmark.

Lua-supported (also as a property) (0.68).

Parameters

value

If the bookmark is for Page View, this is a page number. If the bookmark is for Scroll View, this is a measure number. (See SetViewType.)

SetUseHorizontalPosInst()

void FCBookmark::SetUseHorizontalPosInst ( bool state )

inline

Sets whether to use the value specified by SetHorizontalPosInst.

Lua-supported (also as a property) (0.68).

SetUseVerticalPosStaffSet()

void FCBookmark::SetUseVerticalPosStaffSet ( bool state )

inline

Sets whether to use the value specified by SetVerticalPosStaffSet.

Lua-supported (also as a property) (0.68).

SetUseViewPercent()

void FCBookmark::SetUseViewPercent ( bool state )

inline

Sets if the view will be scaled. The scale value is specified by SetViewPercent.

Lua-supported (also as a property) (0.68).

SetVerticalPosStaffSet()

void FCBookmark::SetVerticalPosStaffSet ( int value )

inline

Sets the second scroll locator for the bookmark.

This value is only used if SetUseVerticalPosStaffSet is true.

Lua-supported (also as a property) (0.68).

Parameters

value

If the bookmark is for Page View, this is the evpu vertical position on the page. If the bookmark is for Scroll View, this the staff set number to use (1-8). (See SetViewType.)

SetViewPercent()

void FCBookmark::SetViewPercent ( ePercent value )

inline

Set the view percent to which to scale the view. This value is only used if SetUseViewPercent is true.

Lua-supported (also as a property) (0.68).

Parameters

value

0 or higher value indicating a percentage. (100 = 100%.)

SetViewType()

void FCBookmark::SetViewType ( BOOKMARKTYPES value )

inline

Sets the view type for the bookmark.

Lua-supported (also as a property) (0.68).

Parameters

value

one of the BOOKMARKTYPES constants.