FCXCtrlUpDown

Extends FCMCtrlUpDown

An up down control that is created by FCXCustomLuaWindow.

Summary of Modifications

• The ability to set the step size on a per-measurement unit basis.
• Step size for integers can also be changed.
• Added a setting for forcing alignment to the next step when moving up or down.
• Connected edit must be an instance of FCXCtrlEdit
• Measurement edits can be connected in two additional ways which affect the underlying methods used in GetValue and SetValue
• Measurement EFIX edits have a different set of default step sizes.

Functions

• Init(self)
• GetConnectedEdit(self)
• ConnectIntegerEdit(self, control, minimum, maximum)
• ConnectMeasurementEdit(self, control, minimum, maximum)
• SetIntegerStepSize(self, value)
• SetEVPUsStepSize(self, value)
• SetInchesStepSize(self, value, is_evpus)
• SetCentimetersStepSize(self, value, is_evpus)
• SetPointsStepSize(self, value, is_evpus)
• SetPicasStepSize(self, value, is_evpus)
• SetSpacesStepSize(self, value, is_evpus)
• AlignWSetAlignWhenMovinghenMoving(self, on)
• GetValue(self)
• SetValue(self, value)
• GetMinimum(self)
• GetMaximum(self)
• SetRange(self, minimum, maximum)

Init

fcxctrlupdown.Init(self)

View source

[Internal]

Input	Type	Description
self	FCXCtrlUpDown

GetConnectedEdit

fcxctrlupdown.GetConnectedEdit(self)

View source

[Override]

Override Changes:

• Ensures that original edit control is returned.

Input	Type	Description
self	FCXCtrlUpDown

Return type	Description
FCMCtrlEdit | nil	nil if there is no edit connected.

ConnectIntegerEdit

fcxctrlupdown.ConnectIntegerEdit(self, control, minimum, maximum)

View source

[Fluid] [Override]

Connects an integer edit. The underlying methods used in GetValue and SetValue will be GetRangeInteger and SetInteger respectively.

Input	Type	Description
self	FCXCtrlUpDown
control	FCMCtrlEdit
minimum	number
maximum	maximum

ConnectMeasurementEdit

fcxctrlupdown.ConnectMeasurementEdit(self, control, minimum, maximum)

View source

[Fluid] [Override] Connects a measurement edit. The control will be automatically registered as a measurement edit if it isn’t already. The underlying methods used in GetValue and SetValue will depend on the measurement edit’s type.

Input	Type	Description
self	FCXCtrlUpDown
control	FCXCtrlMeasurementEdit
minimum	number
maximum	maximum

SetIntegerStepSize

fcxctrlupdown.SetIntegerStepSize(self, value)

View source

[Fluid]

Sets the step size for integer edits.

Input	Type	Description
self	FCXCtrlUpDown
value	number

SetEVPUsStepSize

fcxctrlupdown.SetEVPUsStepSize(self, value)

View source

[Fluid]

Sets the step size for measurement edits that are currently displaying in EVPUs.

Input	Type	Description
self	FCXCtrlUpDown
value	number

SetInchesStepSize

fcxctrlupdown.SetInchesStepSize(self, value, is_evpus)

View source

[Fluid]

Sets the step size for measurement edits that are currently displaying in Inches.

Input	Type	Description
self	FCXCtrlUpDown
value	number
is_evpus (optional)	boolean	If true, the value will be treated as an EVPU value. If false or omitted, the value will be treated in Inches.

SetCentimetersStepSize

fcxctrlupdown.SetCentimetersStepSize(self, value, is_evpus)

View source

[Fluid]

Sets the step size for measurement edits that are currently displaying in Centimeters.

Input	Type	Description
self	FCXCtrlUpDown
value	number
is_evpus (optional)	boolean	If true, the value will be treated as an EVPU value. If false or omitted, the value will be treated in Centimeters.

SetPointsStepSize

fcxctrlupdown.SetPointsStepSize(self, value, is_evpus)

View source

[Fluid]

Sets the step size for measurement edits that are currently displaying in Points.

Input	Type	Description
self	FCXCtrlUpDown
value	number
is_evpus (optional)	boolean	If true, the value will be treated as an EVPU value. If false or omitted, the value will be treated in Points.

SetPicasStepSize

fcxctrlupdown.SetPicasStepSize(self, value, is_evpus)

View source

[Fluid]

Sets the step size for measurement edits that are currently displaying in Picas.

Input	Type	Description
self	FCXCtrlUpDown
value	`number	string`
is_evpus (optional)	boolean	If true, the value will be treated as an EVPU value. If false or omitted, the value will be treated in Picas.

SetSpacesStepSize

fcxctrlupdown.SetSpacesStepSize(self, value, is_evpus)

View source

[Fluid]

Sets the step size for measurement edits that are currently displaying in Spaces.

Input	Type	Description
self	FCXCtrlUpDown
value	number
is_evpus (optional)	boolean	If true, the value will be treated as an EVPU value. If false or omitted, the value will be treated in Spaces.

AlignWSetAlignWhenMovinghenMoving

fcxctrlupdown.AlignWSetAlignWhenMovinghenMoving(self, on)

View source

[Fluid]

Sets whether to align to the next multiple of a step when moving.

Input	Type	Description
self	FCXCtrlUpDown
on	boolean

GetValue

fcxctrlupdown.GetValue(self)

View source

[Override]

Returns the value of the connected edit, clamped according to the set minimum and maximum.

Different types of connected edits will return different types and use different methods to access the value of the edit. The methods are:

• Integer edit => GetRangeInteger
• Measurement edit (“Measurement”) => GetRangeMeasurement
• Measurement edit (“MeasurementInteger”) => GetRangeMeasurementInteger
• Measurement edit (“MeasurementEfix”) => GetRangeMeasurementEfix

Input	Type	Description
self	FCXCtrlUpDown

Return type	Description
number	An integer for an integer edit, EVPUs for a measurement edit, whole EVPUs for a measurement integer edit, or EFIXes for a measurement EFIX edit.

SetValue

fcxctrlupdown.SetValue(self, value)

View source

[Fluid] [Override]

Sets the value of the attached control, clamped according to the set minimum and maximum.

Different types of connected edits will accept different types and use different methods to set the value of the edit. The methods are:

• Integer edit => SetRangeInteger
• Measurement edit (“Measurement”) => SetRangeMeasurement
• Measurement edit (“MeasurementInteger”) => SetRangeMeasurementInteger
• Measurement edit (“MeasurementEfix”) => SetRangeMeasurementEfix

Input	Type	Description
self	FCXCtrlUpDown
value	number	An integer for an integer edit, EVPUs for a measurement edit, whole EVPUs for a measurement integer edit, or EFIXes for a measurement EFIX edit.

GetMinimum

fcxctrlupdown.GetMinimum(self)

View source

[Override]

Input	Type	Description
self	FCMCtrlUpDown

Return type	Description
number	An integer for integer edits or EVPUs for measurement edits.

GetMaximum

fcxctrlupdown.GetMaximum(self)

View source

[Override]

Input	Type	Description
self	FCMCtrlUpDown

Return type	Description
number	An integer for integer edits or EVPUs for measurement edits.

SetRange

fcxctrlupdown.SetRange(self, minimum, maximum)

View source

[Fluid] [Override]

Input	Type	Description
self	FCMCtrlUpDown
minimum	number	An integer for integer edits or EVPUs for measurement edits.
maximum	number	An integer for integer edits or EVPUs for measurement edits.