Standard class for basic user interface functionality. More...

#include <ff_ui.h>

Inheritance diagram for FCUI:

Public Types
enum	ALERT_RETURNS { OKRETURN = 0, CANCELRETURN, YESRETURN, NORETURN, UNKNOWNRETURN }
	The return values used by the alert box methods. More...

enum	MENU_COMMANDS { MENUCMD_NULL = 0, MENUCMD_NOTESPACING, MENUCMD_BEATSPACING, MENUCMD_TIMESIGSPACING, MENUCMD_RESPELLNOTES, MENUCMD_MOVETOPREVSYSTEM, MENUCMD_MOVETONEXTSYSTEM, MENUCMD_LOCKSYSTEMS, MENUCMD_UNLOCKSYSTEMS, MENUCMD_CHECKTIES, MENUCMD_FILLWITHRESTS, MENUCMD_REMOVEMANUALSLURADJUSTMENTS, MENUCMD_RESETALLGROUPSANDBRACKETS, MENUCMD_STEMDIRECTIONUP, MENUCMD_STEMDIRECTIONDOWN, MENUCMD_STEMDIRECTIONDEFAULT, MENUCMD_CLEARALLITEMS, MENUCMD_EHSPELLING_DEFAULT, MENUCMD_EHSPELLING_FAVORSHARPS, MENUCMD_EHSPELLING_FAVORFLATS, MENUCMD_EHSPELLING_USESPELLINGTABLES, MENUCMD_REBEAM, MENUCMD_VIEWSCROLLVIEW, MENUCMD_VIEWPAGEVIEW, MENUCMD_VIEWSTUDIOVIEW, MENUCMD_REDRAWSCREEN, MENUCMD_EDITSCORE, MENUCMD_STAFFSETALLSTAVES, MENUCMD_STAFFSET1, MENUCMD_STAFFSET2, MENUCMD_STAFFSET3, MENUCMD_STAFFSET4, MENUCMD_STAFFSET5, MENUCMD_STAFFSET6, MENUCMD_STAFFSET7, MENUCMD_STAFFSET8, MENUCMD_RETRANSCRIBE, MENUCMD_CREATEMMRESTS, MENUCMD_BREAKMMRESTS, MENUCMD_SELECTIONTOOL, MENUCMD_STAFFTOOL, MENUCMD_MEASURETOOL, MENUCMD_KEYSIGTOOL, MENUCMD_TIMESIGTOOL, MENUCMD_CLEFTOOL, MENUCMD_REPEATTOOL, MENUCMD_ARTICULATIONTOOL, MENUCMD_CHORDTOOL, MENUCMD_EXPRESSIONTOOL, MENUCMD_GRAPHICSTOOL, MENUCMD_HANDGRABBERTOOL, MENUCMD_HYPERSCRIBETOOL, MENUCMD_LYRICSTOOL, MENUCMD_MIDITOOL, MENUCMD_MIRRORTOOL, MENUCMD_NOTEMOVERTOOL, MENUCMD_OSSIATOOL, MENUCMD_PAGELAYOUTTOOL, MENUCMD_RESIZETOOL, MENUCMD_SPEEDYENTRYTOOL, MENUCMD_TEMPOTOOL, MENUCMD_TEXTTOOL, MENUCMD_TUPLETTOOL, MENUCMD_ZOOMTOOL }
	The menu commands available to the FCUI::MenuCommand() method. 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
	FCUI (EWND parent)
	The constructor. More...

const char *	ClassName ()
	Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child class. More...

void	AlertErrorCString (const char pszMessage, const char pszTitle=NULL)
	Displays a error message box / alert, with an OK button. C string version. More...

void	AlertErrorUTF8 (const char pszMessage, const char pszTitle=NULL)
	Displays a error message box / alert, with an OK button. UTF8 string version. More...

void	AlertError (FCString pMessage, FCString pTitle=NULL)
	Displays a error message box / alert, with an OK button. FCString version. More...

ALERT_RETURNS	AlertYesNoCString (const char pszMessage, const char pszTitle=NULL)
	Displays a error message box / alert, with Yes+No buttons. C string version. More...

ALERT_RETURNS	AlertYesNoUTF8 (const char pszMessage, const char pszTitle=NULL)
	Displays a error message box / alert, with Yes+No buttons. UTF8 version. More...

ALERT_RETURNS	AlertYesNo (FCString pMessage, FCString pTitle=NULL)
	Displays a error message box / alert, with Yes+No buttons. FCString version. More...

FCUI::ALERT_RETURNS	AlertYesNoCancelUTF8 (const char pszMessage, const char pszTitle)
	Displays a error message box / alert, with Yes+No+Cancel buttons. UTF8 version. More...

ALERT_RETURNS	AlertYesNoCancel (FCString pMessage, FCString pTitle=NULL)
	Displays a error message box / alert, with Yes+No+Cancel buttons. FCString version. More...

ALERT_RETURNS	AlertOkCancelCString (const char pszMessage, const char pszTitle=NULL)
	Displays a error message box / alert, with OK+Cancel buttons. C string version. More...

ALERT_RETURNS	AlertOkCancelUTF8 (const char pszMessage, const char pszTitle=NULL)
	Displays a error message box / alert, with OK+Cancel buttons. UTF8 version. More...

ALERT_RETURNS	AlertOkCancel (FCString pMessage, FCString pTitle=NULL)
	Displays a error message box / alert, with Ok+Cancel buttons. FCString version. More...

void	AlertNeutralCString (const char pszMessage, const char pszTitle=NULL)
	Displays a standard message box / alert, with an OK button. C string verison. More...

void	AlertNeutralUTF8 (const char pszMessage, const char pszTitle=NULL)
	Displays a standard message box / alert, with an OK button. UTF8 verison. More...

void	AlertNeutral (FCString pMessage, FCString pTitle=NULL)
	Displays a standard message box / alert, with an OK button. FCString version. More...

void	AlertInfoCString (const char pszMessage, const char pszTitle=NULL)
	Displays an information message box / alert, with an OK button. C string version. More...

void	AlertInfoUTF8 (const char pszMessage, const char pszTitle=NULL)
	Displays an information message box / alert, with an OK button. UTF8 version. More...

void	AlertInfo (FCString pMessage, FCString pTitle=NULL)
	Displays an information message box / alert, with an OK button. FCString version. More...

bool	MenuCommand (MENU_COMMANDS menucmd)
	Executes a supported menu command from Finale's menu. More...

bool	MenuPositionCommand (int mainmenuidx, int dropdownidx, int submenuidx)
	Executes a menu command from a specific location in Finale's menu. Use this method with care! More...

void	RedrawDocument ()
	Visually redraws the current document. More...

bool	IsPageView ()
	Returns true if the current view for the current document is Page View. More...

bool	IsPartView ()
	Returns true if the current view is in a part (=not in the score). More...

void	GetDecimalSeparator (FCString *pString)
	Fills a FCString with the decimal separator used for the current user's locale. More...

void	SetUseIsFontAvailableAPI (bool state)
	Sets if Finale's own API for checking font availability should be used for IsFontAvailable(). More...

bool	GetUseIsFontAvailableAPI () const
	Returns if Finale's own API for checking font availability should be used for IsFontAvailable(). More...

bool	IsOnWindows ()
	Returns true if the user runs on Windows. More...

bool	IsOnMac ()
	Returns true if the user runs on the Mac. More...

bool	TextToClipboard (const char *pszText)
	Copies text to the operating system's clipboard. More...

bool	TextToClipboardUTF8 (const char *pszText)
	Copies text to the operating system's clipboard from an UTF8 source. More...

twobyte	GetCurrentPage () const
	Returns the currently displayed page number in Page View. More...

twobyte	GetCurrentMeasure () const
	Returns the currently displayed measure number in Scroll View. More...

twobyte	GetZoomLevel () const
	Returns the current zoom level. More...

int	GetMaxLayers () const
	Returns the maximum number of layers that Finale supports. More...

EWND	GetDocumentWindow ()
	Return the window handle to the current document window. More...

bool	ActivateDocumentWindow ()
	Brings the current document window to user focus. More...

EWND	GetActiveWindow ()
	Returns the currently active window.

bool	ActivateWindow (EWND hwnd)
	Activates a specific window.

EWND	GetParentWindow ()
	Returns the window handle to the main window (that was passed to the constructor.) More...

void	MoveToMeasure (int measure, int staffno=0)
	Moves the view to the indicated 1-based measure. More...

void	Beep ()
	Gives a beep from the speaker. More...

int	GetScreenWidth () const
	Returns the width in pixels of the primary screen. More...

int	GetScreenHeight () const
	Returns the height in pixels of the primary screen. More...

CMPER	DisplayTextExpressionDialog (CMPER cmperinit=0)
	Displays the text expression definition selection dialog. More...

CMPER	DisplayArticulationDialog (CMPER cmperinit=0)
	Displays the articulation definition selection dialog. More...

CMPER	DisplayShapeDialog (CMPER cmperinit=0)
	Displays the shape definition selection dialog box. More...

eUniChar32	DisplaySymbolDialog (FCFontInfo *pFontInfo, eUniChar32 symbolinit=0)
	Displays the symbol selection dialog. More...

bool	IsFontAvailable (FCString *pFontName)
	Returns true if the font name exists on the running system. More...

bool	DisplayWebURL (FCString *pURLString)
	Displays an URL in an external web browser. More...

bool	DisplayShellFolder (FCString *pFolderString)
	Opens the file or folder in the operating system's workspace. More...

void	StartPerformanceTimer ()
	Starts the high-resolution timer.

void	StopPerformanceTimer ()
	Stops the high-resolution timer.

double	ReturnPerformanceTiming ()
	Calculates the time difference after a start+stop of the hi-resolution timer.

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

Public Member Functions inherited from __FCBase
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...

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

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

Static Public Member Functions
static double	GetHiResTimer ()
	Returns a high-resolution timer value, mainly for use with internal profilers. More...

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

Detailed Description

Standard class for basic user interface functionality.

Member Enumeration Documentation

enum FCUI::ALERT_RETURNS

The return values used by the alert box methods.

Lua-supported.

Enumerator
OKRETURN	'OK' button was pressed
CANCELRETURN	'Cancel' button was pressed
YESRETURN	'Yes' button was pressed
NORETURN	'No' button was pressed
UNKNOWNRETURN	Unknown alert box behaviour.

enum FCUI::MENU_COMMANDS

The menu commands available to the FCUI::MenuCommand() method.

Lua-supported.

Enumerator
MENUCMD_NULL	No menu command
MENUCMD_NOTESPACING	Apply Note Spacing. A region selection must exist. Please note that Finale might display a warning alert to the user if the region selection isn't using the full-measure boundaries.
MENUCMD_BEATSPACING	Apply Beat Spacing. A region selection must exist. Please note that Finale might display a warning alert to the user if the region selection isn't using the full-measure boundaries.
MENUCMD_TIMESIGSPACING	Apply Time Signature Spacing. A region selection must exist. Please note that Finale might display a warning alert to the user if the region selection isn't using the full-measure boundaries.
MENUCMD_RESPELLNOTES	"Respell Notes" in the "Utilities" menu. A selected measure region is required.
MENUCMD_MOVETOPREVSYSTEM	"Move to Previous System" in the "Utilities" menu. A selected measure region in Page View is required.
MENUCMD_MOVETONEXTSYSTEM	"Move to Next System" in the "Utilities" menu. A selected measure region in Page View is required.
MENUCMD_LOCKSYSTEMS	"Lock Systems" in the "Utilities" menu. A selected measure region in Page View is required.
MENUCMD_UNLOCKSYSTEMS	"Unlock Systems" in the "Utilities" menu. A selected measure region in Page View is required.
MENUCMD_CHECKTIES	"Check Ties" in the "Utilities" menu. A selected measure region is required.
MENUCMD_FILLWITHRESTS	"Fill with Rests" in the "Utilities" menu. A selected measure region is required.
MENUCMD_REMOVEMANUALSLURADJUSTMENTS	"Remove Manual Slur Adjustments" in the "Utilities" menu. A selected measure region is required.
MENUCMD_RESETALLGROUPSANDBRACKETS	"Reset all Groups and Brackets" in the "Utilities" menu. A selected measure region is required.
MENUCMD_STEMDIRECTIONUP	"Stem Direction - Up" in the "Utilities" menu. A selected measure region is required.
MENUCMD_STEMDIRECTIONDOWN	"Stem Direction - Down" in the "Utilities" menu. A selected measure region is required.
MENUCMD_STEMDIRECTIONDEFAULT	"Stem Direction - Default" in the "Utilities" menu. A selected measure region is required.
MENUCMD_CLEARALLITEMS	"Clear all Items" in the "Edit" menu. A selected measure region is required.
MENUCMD_EHSPELLING_DEFAULT	Set the "Enharmonic Spelling" setting to "Default" in the "Edit" menu (or "Finale" menu on the Mac). This setting affects the MENUCMD_RESPELLNOTES menu command.
MENUCMD_EHSPELLING_FAVORSHARPS	Set the "Enharmonic Spelling" setting to "Favor Sharps" in the "Edit" menu (or "Finale" menu on the Mac). This setting affects the MENUCMD_RESPELLNOTES menu command.
MENUCMD_EHSPELLING_FAVORFLATS	Set the "Enharmonic Spelling" setting to "Favor Flats" in the "Edit" menu (or "Finale" menu on the Mac). This setting affects the MENUCMD_RESPELLNOTES menu command.
MENUCMD_EHSPELLING_USESPELLINGTABLES	Set the "Enharmonic Spelling" setting to "Use Spelling Tables" in the "Edit" menu (or "Finale" menu on the Mac). This setting affects the MENUCMD_RESPELLNOTES menu command.
MENUCMD_REBEAM	Rebeam the selected region. More control is available through the FCMusicRegion::RebeamMusic() method.
MENUCMD_VIEWSCROLLVIEW	Switch to Scroll View.
MENUCMD_VIEWPAGEVIEW	Switch to Page View.
MENUCMD_VIEWSTUDIOVIEW	Switch to Studio View.
MENUCMD_REDRAWSCREEN	The Redraw Screen command from the View menu. Normally, the RedrawDocument should be used for refreshing the current document, but this menu command will behave identically to the Finale user interface.
MENUCMD_EDITSCORE	Switch to Score editing mode.
MENUCMD_STAFFSETALLSTAVES	View the full staff set
MENUCMD_STAFFSET1	View Staff Set 1
MENUCMD_STAFFSET2	View Staff Set 2
MENUCMD_STAFFSET3	View Staff Set 3
MENUCMD_STAFFSET4	View Staff Set 4
MENUCMD_STAFFSET5	View Staff Set 5
MENUCMD_STAFFSET6	View Staff Set 6
MENUCMD_STAFFSET7	View Staff Set 7
MENUCMD_STAFFSET8	View Staff Set 8
MENUCMD_RETRANSCRIBE	Retranscribe (in the MIDI/Audio menu). A region selection must exist.
MENUCMD_CREATEMMRESTS	Create multi-measure rest(s) (command available in the Edit/Multimeasure Rests menu). A region selection must exist.
MENUCMD_BREAKMMRESTS	Break multi-measure rest(s) (command available in the Edit/Multimeasure Rests menu). A region selection must exist.
MENUCMD_SELECTIONTOOL	Select the Selection Tool.
MENUCMD_STAFFTOOL	Select the Staff Tool.
MENUCMD_MEASURETOOL	Select the Measure Tool.
MENUCMD_KEYSIGTOOL	Select the Key Signature Tool.
MENUCMD_TIMESIGTOOL	Select the Time Signature Tool.
MENUCMD_CLEFTOOL	Select the Clef Tool.
MENUCMD_REPEATTOOL	Select the Repeat Tool.
MENUCMD_ARTICULATIONTOOL	Select the Articulation Tool.
MENUCMD_CHORDTOOL	Select the Chord Tool.
MENUCMD_EXPRESSIONTOOL	Select the Expression Tool.
MENUCMD_GRAPHICSTOOL	Select the Graphics Tool.
MENUCMD_HANDGRABBERTOOL	Select the Hand Grabber Tool.
MENUCMD_HYPERSCRIBETOOL	Select the HyperScribe Tool.
MENUCMD_LYRICSTOOL	Select the Lyrics Tool.
MENUCMD_MIDITOOL	Select the MIDI Tool.
MENUCMD_MIRRORTOOL	Select the Mirror Tool. Not available on Finale 25 and later.
MENUCMD_NOTEMOVERTOOL	Select the Note Mover Tool.
MENUCMD_OSSIATOOL	Select the Ossia Tool.
MENUCMD_PAGELAYOUTTOOL	Select the Page Layout Tool.
MENUCMD_RESIZETOOL	Select the Resize Tool.
MENUCMD_SPEEDYENTRYTOOL	Select the Speedy Entry Tool.
MENUCMD_TEMPOTOOL	Select the Tempo Tool. Not available on Finale 25 and later.
MENUCMD_TEXTTOOL	Select the Text Tool.
MENUCMD_TUPLETTOOL	Select the Tuplet Tool.
MENUCMD_ZOOMTOOL	Select the Zoom Tool.

Constructor & Destructor Documentation

FCUI::FCUI ( EWND parent )

inline

The constructor.

Parameters

parent The parent Finale window, as passed to FinaleExtensionInvoke.

Member Function Documentation

bool FCUI::ActivateDocumentWindow ( )

Brings the current document window to user focus.

Lua-supported.

Returns: True on success.

void FCUI::AlertError	(	FCString *	pMessage,
		FCString *	pTitle = `NULL`
	)

Displays a error message box / alert, with an OK button. FCString version.

Parameters

pMessage	Message box message.
pTitle	Optional title for the message box (Windows only).

void FCUI::AlertErrorCString	(	const char *	pszMessage,
		const char *	pszTitle = `NULL`
	)

Displays a error message box / alert, with an OK button. C string version.

Parameters

pszMessage	Message box message.
pszTitle	Optional title for the message box (Windows only).

void FCUI::AlertErrorUTF8	(	const char *	pszMessage,
		const char *	pszTitle = `NULL`
	)

Displays a error message box / alert, with an OK button. UTF8 string version.

Lua-supported (as AlertError).

Parameters

pszMessage	Message box message.
pszTitle	Optional title for the message box (Windows only).

void FCUI::AlertInfo	(	FCString *	pMessage,
		FCString *	pTitle = `NULL`
	)

Displays an information message box / alert, with an OK button. FCString version.

Parameters

[in]	pMessage	Message box message.
[in]	pTitle	Optional title for the message box (Windows only).

void FCUI::AlertInfoCString	(	const char *	pszMessage,
		const char *	pszTitle = `NULL`
	)

Displays an information message box / alert, with an OK button. C string version.

Parameters

pszMessage	Message box message.
pszTitle	Optional title for the message box (Windows only).

void FCUI::AlertInfoUTF8	(	const char *	pszMessage,
		const char *	pszTitle = `NULL`
	)

Displays an information message box / alert, with an OK button. UTF8 version.

Lua-supported (as AlertInfo).

Parameters

pszMessage	Message box message.
pszTitle	Optional title for the message box (Windows only).

void FCUI::AlertNeutral	(	FCString *	pMessage,
		FCString *	pTitle = `NULL`
	)

Displays a standard message box / alert, with an OK button. FCString version.

Parameters

[in]	pMessage	Message box message.
[in]	pTitle	Optional title for the message box (Windows only).

void FCUI::AlertNeutralCString	(	const char *	pszMessage,
		const char *	pszTitle = `NULL`
	)

Displays a standard message box / alert, with an OK button. C string verison.

Parameters

pszMessage	Message box message.
pszTitle	Optional title for the message box (Windows only).

void FCUI::AlertNeutralUTF8	(	const char *	pszMessage,
		const char *	pszTitle = `NULL`
	)

Displays a standard message box / alert, with an OK button. UTF8 verison.

Parameters

pszMessage	Message box message.
pszTitle	Optional title for the message box (Windows only).

FCUI::ALERT_RETURNS FCUI::AlertOkCancel	(	FCString *	pMessage,
		FCString *	pTitle = `NULL`
	)

Displays a error message box / alert, with Ok+Cancel buttons. FCString version.

Parameters

pMessage	Message box message.
pTitle	Optional title for the message box (Windows only).

Returns: OKRETURN or CANELRETURN.

FCUI::ALERT_RETURNS FCUI::AlertOkCancelCString	(	const char *	pszMessage,
		const char *	pszTitle = `NULL`
	)

Displays a error message box / alert, with OK+Cancel buttons. C string version.

Parameters

pszMessage	Message box message.
pszTitle	Optional title for the message box (Windows only).

Returns: OKRETURN or CANCELRETURN.

FCUI::ALERT_RETURNS FCUI::AlertOkCancelUTF8	(	const char *	pszMessage,
		const char *	pszTitle = `NULL`
	)

Displays a error message box / alert, with OK+Cancel buttons. UTF8 version.

Lua-support (as AlertOkCancel)

Parameters

pszMessage	Message box message.
pszTitle	Optional title for the message box (Windows only).

Returns: OKRETURN or CANCELRETURN.

FCUI::ALERT_RETURNS FCUI::AlertYesNo	(	FCString *	pMessage,
		FCString *	pTitle = `NULL`
	)

Displays a error message box / alert, with Yes+No buttons. FCString version.

Lua-supported (as AlertYesNoCancel).

Parameters

pMessage	Message box message.
pTitle	Optional title for the message box (Windows only).

Returns: YESRETURN or NORETURN.

FCUI::ALERT_RETURNS FCUI::AlertYesNoCancel	(	FCString *	pMessage,
		FCString *	pTitle = `NULL`
	)

Displays a error message box / alert, with Yes+No+Cancel buttons. FCString version.

Parameters

pMessage	Message box message.
pTitle	Optional title for the message box (Windows only).

Returns: YESRETURN, NORETURN or CANCELRETURN.

FCUI::ALERT_RETURNS FCUI::AlertYesNoCancelUTF8	(	const char *	pszMessage,
		const char *	pszTitle
	)

Displays a error message box / alert, with Yes+No+Cancel buttons. UTF8 version.

Parameters

pszMessage	Message box message.
pszTitle	Optional title for the message box (Windows only).

Returns: YESRETURN, NORETURN or CANCELRETURN.

FCUI::ALERT_RETURNS FCUI::AlertYesNoCString	(	const char *	pszMessage,
		const char *	pszTitle = `NULL`
	)

Displays a error message box / alert, with Yes+No buttons. C string version.

Parameters

pszMessage	Message box message.
pszTitle	Optional title for the message box (Windows only).

Returns: YESRETURN or NORETURN.

FCUI::ALERT_RETURNS FCUI::AlertYesNoUTF8	(	const char *	pszMessage,
		const char *	pszTitle = `NULL`
	)

Displays a error message box / alert, with Yes+No buttons. UTF8 version.

Lua-supported (as AlertYesNo).

Parameters

pszMessage	Message box message.
pszTitle	Optional title for the message box (Windows only).

Returns: YESRETURN or NORETURN.

void FCUI::Beep ( )

Gives a beep from the speaker.

Lua-supported.

const char* FCUI::ClassName ( )

inlinevirtual

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

Lua-supported.

Reimplemented from __FCBase.

virtual void FCUI::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 __FCBase.

CMPER FCUI::DisplayArticulationDialog ( CMPER cmperinit = 0 )

Displays the articulation definition selection dialog.

When the dialog box is closed, the previously active window automatically becomes active again.

Lua-supported.

Returns: 0 if the cancel button was pressed. Otherwise, the selected articulation definition ID.

CMPER FCUI::DisplayShapeDialog ( CMPER cmperinit = 0 )

Displays the shape definition selection dialog box.

When the dialog box is closed, the previously active window automatically becomes active again.

Lua-supported.

Returns: 0 if the cancel button was pressed. Otherwise, the selected shape definition ID.

bool FCUI::DisplayShellFolder ( FCString * pFolderString )

Opens the file or folder in the operating system's workspace.

Lua-supported.

Parameters

pFolderString The pointer to the FCString object containing the full folder path.

Returns: true if successful.

eUniChar32 FCUI::DisplaySymbolDialog	(	FCFontInfo *	pFontInfo,
		eUniChar32	symbolinit = `0`
	)

Displays the symbol selection dialog.

When the dialog box is closed, the previously active window automatically becomes active again.

Lua-supported.

Returns: 0 if the cancel button was pressed. Otherwise, the selected character number.

CMPER FCUI::DisplayTextExpressionDialog ( CMPER cmperinit = 0 )

Displays the text expression definition selection dialog.

When the dialog box is closed, the previously active window automatically becomes active again.

Lua-supported.

Returns: 0 if the cancel button was pressed. Otherwise, the selected text expression definition ID.

bool FCUI::DisplayWebURL ( FCString * pURLString )

Displays an URL in an external web browser.

Lua-supported.

twobyte FCUI::GetCurrentMeasure ( ) const

Returns the currently displayed measure number in Scroll View.

Lua-supported.

Returns: 0 if it's Page View. The currently displayed measure number in Scroll View.

twobyte FCUI::GetCurrentPage ( ) const

Returns the currently displayed page number in Page View.

Lua-supported.

Returns: The currently displayed page number in Page View. 0 if not in Page View.

void FCUI::GetDecimalSeparator ( FCString * pString )

Fills a FCString with the decimal separator used for the current user's locale.

Typically, this will be '.' (American style) or ',' (European style).

Lua-supported.

Parameters

[out] pString The FCString object that should contain the decimal separator.

EWND FCUI::GetDocumentWindow ( )

Return the window handle to the current document window.

Returns: The handle to the current document window. 0 on error.

double FCUI::GetHiResTimer ( )

static

Returns a high-resolution timer value, mainly for use with internal profilers.

This is static method that should be called without any class instance.

int FCUI::GetMaxLayers ( ) const

Returns the maximum number of layers that Finale supports.

If the maximum number of layers is changed in future Finale releases, this method will give the accurate number. It's highly recommended that this return value is used, rather than hard-coding to a fixed number of layers.

Lua-supported.

EWND FCUI::GetParentWindow ( )

inline

Returns the window handle to the main window (that was passed to the constructor.)

Returns: The handle to the main Finale window.

int FCUI::GetScreenHeight ( ) const

Returns the height in pixels of the primary screen.

Lua-supported.

int FCUI::GetScreenWidth ( ) const

Returns the width in pixels of the primary screen.

Lua-supported.

bool FCUI::GetUseIsFontAvailableAPI ( ) const

inline

Returns if Finale's own API for checking font availability should be used for IsFontAvailable().

If set, the Finale API will only be used on Finale 25 and above. On earlier Finale versions, the PDK Framework's own implementation will always be used.

Lua-supported (also as property).

Returns: True if Finale's own API should be used (on Finale 25 and above). False if the PDK Framework's implementation should be used.

twobyte FCUI::GetZoomLevel ( ) const

Returns the current zoom level.

Lua-supported.

bool FCUI::IsFontAvailable ( FCString * pFontName )

Returns true if the font name exists on the running system.

An empty font name will return false.

Lua-supported.

bool FCUI::IsOnMac ( )

inline

Returns true if the user runs on the Mac.

Lua-supported.

bool FCUI::IsOnWindows ( )

inline

Returns true if the user runs on Windows.

Lua-supported.

bool FCUI::IsPageView ( )

Returns true if the current view for the current document is Page View.

Lua-supported.

bool FCUI::IsPartView ( )

inline

Returns true if the current view is in a part (=not in the score).

Lua-supported.

bool FCUI::MenuCommand ( FCUI::MENU_COMMANDS menucmd )

Executes a supported menu command from Finale's menu.

Lua-supported.

Parameters

menucmd The menu command to execute. Any of the MENUCMD_ constants.

Returns: True on success.

bool FCUI::MenuPositionCommand	(	int	mainmenuidx,
		int	dropdownidx,
		int	submenuidx
	)

Executes a menu command from a specific location in Finale's menu. Use this method with care!

NOTE! If possible, the MenuCommand method should be used instead of this method. Use this only when there isn't a suitable solution in MenuCommand. Please be aware that menu item locations may differ between Finale versions, and even between platforms.

On the Mac, some menu items will only work in the Finale document window is in focus. Also, for Mac only Finale 2012 and later vesions are supported.

Lua-supported.

Parameters

[in]	mainmenuidx	The 0-based left-right index of the location for the menu item within the main Finale menu. Index 0 is the "File" menu in Finale. On the Mac, there's also the special value 100, which indicates the "Finale" menu to the left of the "File" menu.
[in]	dropdownidx	The 0-based index within a dropdown menu. Separator lines does not count as a separate item.
[in]	submenuidx	The 0-based index in a submenu to the dropdown menu. This is only used if the dropdown leads to a submenu. If the item is not located in a submenu, this must be -1.

Returns: True on success.

void FCUI::MoveToMeasure	(	int	measure,
		int	staffno = `0`
	)

Moves the view to the indicated 1-based measure.

Finale will only move the document view if the cell is completely out of view.

Lua-supported.

Parameters

[in]	measure	The 1-based measure number in the document
[in]	staffno	(Optional parameter) The 1-based staff number. If it's 0 or omitted, the top staff will be used.

void FCUI::RedrawDocument ( )

Visually redraws the current document.

This method doesn't affect the document's data.

Lua-supported.

void FCUI::SetUseIsFontAvailableAPI ( bool state )

inline

Sets if Finale's own API for checking font availability should be used for IsFontAvailable().

If set, the Finale API will only be used on Finale 25 and above. On earlier Finale versions, the PDK Framework's own implementation will always be used.

Lua-supported (also as property).

Parameters

[in] state True if Finale's own API should be used (on Finale 25 and above). False if the PDK Framework's implementation should be used.

bool FCUI::TextToClipboard ( const char * pszText )

Copies text to the operating system's clipboard.

Parameters

pszText The NULL-terminated text to copy to the OS clipboard.

Returns: true on success.

bool FCUI::TextToClipboardUTF8 ( const char * pszText )

Copies text to the operating system's clipboard from an UTF8 source.

Lua-supported (as TextToClipboard).

Parameters

pszText The NULL-terminated text to copy to the OS clipboard.

Returns: true on success.

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation