EditboxControl
Overview
Editbox Control
Discussion
An Editbox Inspector Control sets a variable to the real or complex value typed in the text box. The variable is set when the user hits enter.
The mapping property can be used to map the editbox value to module variable directly (linear), or by converting with db20 or undb20 functions.
The modVar property must be set to point to a module variable. See the ParamSet module for more detail on modVar formatting.
Variables
Properties
Name | Type | Default value | Range | Description |
modVar | string | none | Unrestricted | The module variable to control, in . format |
isComplex | int | 0 | 0:1:1 | When true, complex numeric input is supported with a + bi formatting |
mapping | string | lin | lin/db20/undb20 | Controls the mapping between the edit box value and variable controlled |
max | float | 24 | Unrestricted | Maximum value |
min | float | -24 | Unrestricted | Minimum value |
readonly | int | 0 | 0:1:1 | When true, the value can not be edited |
stepsize | int | 0 | 0: | When non-zero, specifies the granularity of adjustment |
value | float | 0 | min:max | Value of variable controlled |
caption | string | editbox | Unrestricted | A short text string to display above the inspector |
format | string | %g | Unrestricted | printf() style format string used to display numbers – see man printf(1) |
units | string | none | Unrestricted | When not empty, displays units string below the caption |
color.text | int | 000000 | 0:1:ffffff | Color of the text |
font.name | string | 'MS Shell Dlg 2' | Unrestricted | Any available Windows font may be used. All text in the inspector uses the same font |
font.size | int | 8 | 6:1:72 | Size in points to use for the font. If the font is too large for the space available, the text will be clipped |
font.style | string | normal | normal/bold/italic | Available styles are normal italic and bold |
scaletext | int | false | 0:1:1 | When true, text font size scales with inspector size |
border | int | 1 | 0:1:1 | When false, the surrounding border is turned off |
caption.height | int | 3 | 0:1:3 | The number of vertical lines to reserve for the caption and units strings. When zero, caption is not displayed |
color.bgnd | int | f0f0f0 | 0:1:ffffff | Color of the inspector background |
color.border | int | b4b4b4 | 0:1:ffffff | Color of the inspector border, if shown |
scale | float | 1.0 | 0.5:3.0 | Specifies the magnification of all parts of the inspector |
width | int | 69 | 59:1:500 | Width in DPI independent units |
x | int | none | Unrestricted | Horizontal position of top left in DPI independent units |
y | int | none | Unrestricted | Vertical position of top left in DPI independent units |