FCMCtrlEdit

Summary of Modifications

• Added Change custom control event.
• Added hooks into control state preservation.
• GetMeasurement* and SetMeasurement* methods have been overridden to use the FCMString versions of those methods internally. For more details on any changes, see the documentation for FCMString.

Functions

• SetText(self, str)
• GetInteger(self)
• SetInteger(self, anint)
• GetFloat(self)
• SetFloat(self, value)
• GetMeasurement(self, measurementunit)
• GetRangeMeasurement(self, measurementunit, minimum, maximum)
• SetMeasurement(self, value, measurementunit)
• GetMeasurementEfix(self, measurementunit)
• GetRangeMeasurementEfix(self, measurementunit, minimum, maximum)
• SetMeasurementEfix(self, value, measurementunit)
• GetMeasurementInteger(self, measurementunit)
• GetRangeMeasurementInteger(self, measurementunit, minimum, maximum)
• SetMeasurementInteger(self, value, measurementunit)
• GetMeasurement10000th(self, measurementunit)
• GetRangeMeasurement10000th(self, measurementunit, minimum, maximum)
• SetMeasurement10000th(self, value, measurementunit)
• GetRangeInteger(self, minimum, maximum)
• HandleChange(control, last_value)
• AddHandleChange(self, callback)
• RemoveHandleChange(self, callback)

SetText

fcmctrledit.SetText(self, str)

View source

[Fluid] [Override]

Override Changes:

• Ensures that Change event is triggered.

Input	Type	Description
self	FCMCtrlEdit
str	`FCString	string

GetInteger

fcmctrledit.GetInteger(self)

View source

[Override]

Override Changes:

• Hooks into control state preservation.

Input	Type	Description
self	FCMCtrlEdit

Return type	Description
number

SetInteger

fcmctrledit.SetInteger(self, anint)

View source

[Fluid] [Override]

Override Changes:

• Ensures that Change event is triggered.
• Hooks into control state preservation.

Input	Type	Description
self	FCMCtrlEdit
anint	number

GetFloat

fcmctrledit.GetFloat(self)

View source

[Override]

Override Changes:

• Hooks into control state preservation.

Input	Type	Description
self	FCMCtrlEdit

Return type	Description
number

SetFloat

fcmctrledit.SetFloat(self, value)

View source

[Fluid] [Override]

Override Changes:

• Ensures that Change event is triggered.
• Hooks into control state preservation.

Input	Type	Description
self	FCMCtrlEdit
value	number

GetMeasurement

fcmctrledit.GetMeasurement(self, measurementunit)

View source

[Override]

• Hooks into control state preservation.

Input	Type	Description
self	FCMCtrlEdit
measurementunit	number	Any of the finale.MEASUREMENTUNIT_* constants.

Return type	Description
number

GetRangeMeasurement

fcmctrledit.GetRangeMeasurement(self, measurementunit, minimum, maximum)

View source

[Override]

Override Changes:

• Hooks into control state preservation.

Input	Type	Description
self	FCMCtrlEdit
measurementunit	number	Any of the finale.MEASUREMENTUNIT_* constants.
minimum	number
maximum	number

Return type	Description
number

SetMeasurement

fcmctrledit.SetMeasurement(self, value, measurementunit)

View source

[Fluid] [Override]

Override Changes:

• Ensures that Change event is triggered.
• Hooks into control state preservation.

Input	Type	Description
self	FCMCtrlEdit
value	number
measurementunit	number

GetMeasurementEfix

fcmctrledit.GetMeasurementEfix(self, measurementunit)

View source

[Override]

Override Changes:

• Hooks into control state preservation.

Input	Type	Description
self	FCMCtrlEdit
measurementunit	number	Any of the finale.MEASUREMENTUNIT_* constants.

Return type	Description
number

GetRangeMeasurementEfix

fcmctrledit.GetRangeMeasurementEfix(self, measurementunit, minimum, maximum)

View source

[Override]

Override Changes:

• Hooks into control state preservation.

Input	Type	Description
self	FCMCtrlEdit
measurementunit	number	Any of the finale.MEASUREMENTUNIT_* constants.
minimum	number
maximum	number

Return type	Description
number

SetMeasurementEfix

fcmctrledit.SetMeasurementEfix(self, value, measurementunit)

View source

[Fluid] [Override]

Override Changes:

• Ensures that Change event is triggered.
• Hooks into control state preservation.

Input	Type	Description
self	FCMCtrlEdit
value	number
measurementunit	number

GetMeasurementInteger

fcmctrledit.GetMeasurementInteger(self, measurementunit)

View source

[Override]

Override Changes:

• Hooks into control state preservation.

Input	Type	Description
self	FCMCtrlEdit
measurementunit	number	Any of the finale.MEASUREMENTUNIT_* constants.

Return type	Description
number

GetRangeMeasurementInteger

fcmctrledit.GetRangeMeasurementInteger(self, measurementunit, minimum, maximum)

View source

[Override]

Override Changes:

• Hooks into control state preservation.
• Fixes issue with decimal places in minimum being discarded instead of being correctly taken into account (see FCMString.GetRangeMeasurementInteger).

Input	Type	Description
self	FCMCtrlEdit
measurementunit	number	Any of the finale.MEASUREMENTUNIT_* constants.
minimum	number
maximum	number

Return type	Description
number

SetMeasurementInteger

fcmctrledit.SetMeasurementInteger(self, value, measurementunit)

View source

[Fluid] [Override]

Override Changes:

• Ensures that Change event is triggered.
• Hooks into control state preservation.

Input	Type	Description
self	FCMCtrlEdit
value	number
measurementunit	number

GetMeasurement10000th

fcmctrledit.GetMeasurement10000th(self, measurementunit)

View source

Returns the measurement in 10000ths of an EVPU.

Input	Type	Description
self	FCMCtrlEdit
measurementunit	number	Any of the finale.MEASUREMENTUNIT_* constants.

Return type	Description
number

GetRangeMeasurement10000th

fcmctrledit.GetRangeMeasurement10000th(self, measurementunit, minimum, maximum)

View source

Returns the measurement in 10000ths of an EVPU, clamped between two values.

Input	Type	Description
self	FCMCtrlEdit
measurementunit	number	Any of the finale.MEASUREMENTUNIT_* constants.
minimum	number
maximum	number

Return type	Description
number

SetMeasurement10000th

fcmctrledit.SetMeasurement10000th(self, value, measurementunit)

View source

[Fluid] Sets a measurement in 10000ths of an EVPU.

Input	Type	Description
self	FCMCtrlEdit
value	number
measurementunit	number

GetRangeInteger

fcmctrledit.GetRangeInteger(self, minimum, maximum)

View source

[Override]

Override Changes:

• Hooks into control state preservation.
• Fixes issue with decimal places in minimum being discarded instead of being correctly taken into account.

Input	Type	Description
self	FCMCtrlEdit
minimum	number
maximum	number

Return type	Description
number

HandleChange

fcmctrledit.HandleChange(control, last_value)

View source

[Callback Template]

Input	Type	Description
control	FCMCtrlEdit	The control that was changed.
last_value	string	The previous value of the control.

AddHandleChange

fcmctrledit.AddHandleChange(self, callback)

View source

[Fluid]

Adds a handler for when the value of the control changes. The even will fire when:

• The window is created (if the value of the control is not an empty string)
• The value of the control is changed by the user
• The value of the control is changed programmatically (if the value of the control is changed within a handler, that same handler will not be called again for that change.)

Input	Type	Description
self	FCMCtrlEdit
callback	function	See HandleChange for callback signature.

RemoveHandleChange

fcmctrledit.RemoveHandleChange(self, callback)

View source

[Fluid]

Removes a handler added with AddHandleChange.

Input	Type	Description
self	FCMCtrlEdit
callback	function