Class that handles edit controls. More...

#include <ff_dialogs.h>

Inheritance diagram for FCCtrlEdit:

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

	FCCtrlEdit (twobyte id)
	The constructor.

int	GetInteger ()
	Returns the edit field as an integer value. More...

int	GetRangeInteger (int minimum, int maximum)
	Returns the edit field as an integer value, but only within a specific range. More...

double	GetMeasurement (_ENUMCODE(MEASUREMENTUNITS) _LUACODE(twobyte) measurementunit)
	Gets the measurement value from the edit field. More...

double	GetRangeMeasurement (_ENUMCODE(MEASUREMENTUNITS) _LUACODE(twobyte) measurementunit, double min, double max)
	Gets the measurement value from the edit field, within a specific range. More...

float	GetMeasurementEfix (_ENUMCODE(MEASUREMENTUNITS) _LUACODE(twobyte) measurementunit)
	Gets the measurement value in EFIXes from the edit field. More...

float	GetRangeMeasurementEfix (_ENUMCODE(MEASUREMENTUNITS) _LUACODE(twobyte) measurementunit, float min, float max)
	Gets the measurement value in EFIXes from the edit field, within a specific range. More...

void	SetMeasurement (double value, _ENUMCODE(MEASUREMENTUNITS) _LUACODE(twobyte) measurementunit)
	Sets the EVPU value to the edit field, using the indicated measurement unit. More...

void	SetMeasurementEfix (float value, _ENUMCODE(MEASUREMENTUNITS) _LUACODE(twobyte) measurementunit)
	Sets the EFIX value to the edit field, using the indicated measurement unit. More...

double	GetMeasurementInteger (_ENUMCODE(MEASUREMENTUNITS) _LUACODE(twobyte) measurementunit)
	GetMeasurement version without the fractional part. More...

double	GetRangeMeasurementInteger (_ENUMCODE(MEASUREMENTUNITS) _LUACODE(twobyte) measurementunit, int min, int max)
	GetMeasurement version without the fractional part, within a specific range. More...

void	SetMeasurementInteger (double value, _ENUMCODE(MEASUREMENTUNITS) _LUACODE(twobyte) measurementunit)
	A SetMeasurement version without the fractional part. More...

void	SetInteger (int anint)
	Sets the edit control to an integer value. More...

void	SetFloat (float value)
	Sets the edit control to a floating point value.

float	GetFloat (float min, float max)
	Reads a floating point value from the edit control.

void	AdjustIntegerWithin (int min, int max)
	Assures that the edit control displays an integer value within a specific range.

void	SetFocus ()
	Moves the keyboard focus to the control.

void	SelectAll ()
	Selects all text in the edit box.

void	SetMaxLength (twobyte maxlength)
	Sets the maximum length of the edit control.

void	SetReadOnly (bool readonly)
	Sets the edit field to be read-only or editable.

void	ScrollToBottom ()
	Scrolls to the bottom of a multiline control.

Public Member Functions inherited from FCControl
	FCControl (twobyte id)
	The constructor. More...

virtual	~FCControl ()
	Destructor.

bool	GetPointsMeasurement ()
	Returns if the measurements and positioning is in points or in a system-native unit. More...

__FCUserWindow *	GetParent ()
	Returns the parent window object for the control.

bool	WindowExists ()
	Returns true if a valid parent window handle (and control handle) is available.

HWND	_GetWinControlHandle ()
	For internal use only. Returns to handle for the control.

virtual void	Repaint ()
	Force a visual update of the control. More...

int	GetControlID ()
	Returns the control ID for the control. More...

int	GetAssignedID ()
	Gets the connected ID regardless of platform. More...

CONTROL_ACTIONS	GetAction ()
	Returns the dialog acction assigned to the control. More...

void	SetAction (CONTROL_ACTIONS action)
	Sets the dialog acction assigned to the control. More...

virtual void	SetEnable (bool state)
	Sets the enable/grayed state of the control (if user input should be allowed or not). More...

virtual bool	GetEnable ()
	Returns the enable/grayed state of the control (if user input should be allowed or not). More...

virtual void	SetVisible (bool bShow)
	Sets the visibility of the control. More...

virtual void	SetBold (bool state)
	Sets the boldface appearance for the control.

virtual void	SetKeyboardFocus ()
	Sets the keyboard focus to the control. More...

void	SetTextAndResize (FCString *pString)
	Cocoa only: Sets the text and resizes the view inside a NSScrollView.

virtual void	SetText (FCString *pString)
	Sets the text for the control. More...

virtual void	GetText (FCString *pString)
	Gets the text of the control.

void	SetLeft (float pos)
	Sets the left position of the control.

float	GetLeft ()
	Returns the left position of the control.

void	SetTop (float pos)
	Sets the top position of the control.

float	GetTop ()
	Returns the top position of the control.

float	GetHeight ()
	Returns the height of the control.

float	GetWidth ()
	Returns the width of the control.

bool	GetVisible ()
	Returns the visibility state of a control.

void	SetWidth (float width)
	Sets the width of the control.

void	SetHeight (float height)
	Sets the height of the control.

void	MoveRelative (float horizmove, float vertmove)
	Moves the control relatively to the current position. More...

void	MoveAbsolute (float x, float y)
	Moves the control in absolute coordinates. More...

virtual void	ResizeRelative (float horizresize, float vertresize)
	Resizes the control relatively to the current size. Top left corner will stay fixed. 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	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	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
Public Types inherited from FCControl
enum	CONTROL_ACTIONS { ACTION_NONE = 0, ACTION_OK = 1, ACTION_CLOSE = 2, ACTION_CANCEL = 3 }
	Predefined actions for controls. 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...

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

Class that handles edit controls.

Programmatically created controls of this class defaults to a width of 70 points.

Member Function Documentation

virtual const char* FCCtrlEdit::ClassName ( )

inlinevirtual

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

Lua-supported.

Reimplemented from FCControl.

Reimplemented in FCCtrlComboBox.

int FCCtrlEdit::GetInteger ( )

Returns the edit field as an integer value.

Lua-supported.

double FCCtrlEdit::GetMeasurement ( _ENUMCODE(MEASUREMENTUNITS) _LUACODE(twobyte) measurementunit )

Gets the measurement value from the edit field.

PDK_FRAMEWORK_PREFS must be defined when compiling in C++.

Lua-supported.

Parameters

[in] measurementunit Any of the MEASUREMENTUNIT_ constants defined by the PDK, for example MEASUREMENTUNIT_DEFAULT.

Returns: The measurement in EVPUs.

float FCCtrlEdit::GetMeasurementEfix ( _ENUMCODE(MEASUREMENTUNITS) _LUACODE(twobyte) measurementunit )

inline

Gets the measurement value in EFIXes from the edit field.

PDK_FRAMEWORK_PREFS must be defined.

Lua-supported.

Parameters

[in] measurementunit Any of the MEASUREMENTUNIT_ constants defined by the PDK, for example MEASUREMENTUNIT_DEFAULT.

Returns: The measurement in EFIXes.

double FCCtrlEdit::GetMeasurementInteger ( _ENUMCODE(MEASUREMENTUNITS) _LUACODE(twobyte) measurementunit )

GetMeasurement version without the fractional part.

PDK_FRAMEWORK_PREFS must be defined.

Lua-supported.

Parameters

[in] measurementunit Any of the MEASUREMENTUNIT_ constants defined by the PDK, for example MEASUREMENTUNIT_DEFAULT.

Returns: The measurement in EVPUs.

int FCCtrlEdit::GetRangeInteger	(	int	minimum,
		int	maximum
	)

Returns the edit field as an integer value, but only within a specific range.

Lua-supported.

Parameters

[in]	minimum	If it's less than maximum, it's a minimum range value for the allowed returned value.
[in]	maximum	If it's larger than minimum, it's a maximum range value for the allowed returned value.

double FCCtrlEdit::GetRangeMeasurement	(	_ENUMCODE(MEASUREMENTUNITS) _LUACODE(twobyte)	measurementunit,
		double	min,
		double	max
	)

Gets the measurement value from the edit field, within a specific range.

PDK_FRAMEWORK_PREFS must be defined.

Lua-supported.

Parameters

[in]	min	The minimum allowed value, in EVPUs.
[in]	max	The maximum allowed value, in EVPUs.
[in]	measurementunit	Any of the MEASUREMENTUNIT_ constants defined by the PDK, for example MEASUREMENTUNIT_DEFAULT.

Returns: The measurement in EVPUs.

float FCCtrlEdit::GetRangeMeasurementEfix	(	_ENUMCODE(MEASUREMENTUNITS) _LUACODE(twobyte)	measurementunit,
		float	min,
		float	max
	)

inline

Gets the measurement value in EFIXes from the edit field, within a specific range.

PDK_FRAMEWORK_PREFS must be defined when build the C++ project.

Lua-supported.

Parameters

[in]	min	The minimum allowed value, in EFIXes.
[in]	max	The maximum allowed value, in EFIXes.
[in]	measurementunit	Any of the MEASUREMENTUNIT_ constants defined by the PDK, for example MEASUREMENTUNIT_DEFAULT.

Returns: The measurement in EFIXes.

double FCCtrlEdit::GetRangeMeasurementInteger	(	_ENUMCODE(MEASUREMENTUNITS) _LUACODE(twobyte)	measurementunit,
		int	min,
		int	max
	)

GetMeasurement version without the fractional part, within a specific range.

PDK_FRAMEWORK_PREFS must be defined.

Lua-supported.

Parameters

[in]	measurementunit	Any of the MEASUREMENTUNIT_ constants defined by the PDK, for example MEASUREMENTUNIT_DEFAULT.
[in]	min	The minimum allowed value, in EVPUs.
[in]	max	The maximum allowed value, in EVPUs.

Returns: The measurement in EVPUs.

void FCCtrlEdit::SetInteger ( int anint )

Sets the edit control to an integer value.

Lua-supported.

void FCCtrlEdit::SetMeasurement	(	double	value,
		_ENUMCODE(MEASUREMENTUNITS) _LUACODE(twobyte)	measurementunit
	)

Sets the EVPU value to the edit field, using the indicated measurement unit.

PDK_FRAMEWORK_PREFS must be defined.

Lua-supported.

Parameters

[in]	value	The measurement in EVPUs.
[in]	measurementunit	Any of the MEASUREMENTUNIT_ constants defined by the PDK, for example MEASUREMENTUNIT_DEFAULT (which is the default).

Returns: The measurement in EVPUs.

void FCCtrlEdit::SetMeasurementEfix	(	float	value,
		_ENUMCODE(MEASUREMENTUNITS) _LUACODE(twobyte)	measurementunit
	)

inline

Sets the EFIX value to the edit field, using the indicated measurement unit.

PDK_FRAMEWORK_PREFS must be defined.

Lua-supported.

Parameters

[in]	value	The measurement, in EFIXes.
[in]	measurementunit	Any of the MEASUREMENTUNIT_ constants defined by the PDK, for example MEASUREMENTUNIT_DEFAULT.

void FCCtrlEdit::SetMeasurementInteger	(	double	value,
		_ENUMCODE(MEASUREMENTUNITS) _LUACODE(twobyte)	measurementunit
	)

A SetMeasurement version without the fractional part.

PDK_FRAMEWORK_PREFS must be defined.

Lua-supported.

Parameters

[in]	value	The measurement in EVPUs.
[in]	measurementunit	Any of the MEASUREMENTUNIT_ constants defined by the PDK, for example MEASUREMENTUNIT_DEFAULT.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation