SliderControl
Overview
Slider Control
Discussion
The Slider Inspector Control provides a means of adjusting a value over a range by dragging the slider up or down with the mouse or the mouse wheel.
The mapping property can be used to map slider value to module variable directly (linear), or by converting with db20 or undb20 functions. The range of the slider can be set using the min and max properties.
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 | Name of a variable you want the slider to control |
fixedticks | int | 0 | 0 or 2:32 | If non zero, range 2-32. Default 0 causes automatic tick positions. If a number is specified exactly, that many tick positions are shown |
mapping | string | lin | lin/db20/undb20 | Controls the mapping between slider position and variable controlled |
max | float | 24 | Unrestricted | Maximum slider value |
min | float | -24 | Unrestricted | Minimum slider value |
muteonmin | int | false | 0:1:1 | When true, the controlled value will be zero when the slider is at minimim |
stepsize | int | 0 | 0: | When non-zero, specifies the granularity of adjustment |
ticks | int | 13 | 0: | Max number of automatic ticks to use, ignored if fixedticks is non-zero |
useticks | string | ticks_numbers | ticks_numbers/no ticks/ticks only | Controls display style of tick marks |
value | float | 0 | min:max | The current value of the slider position |
caption | string | slider | Unrestricted | A short text string to display above the slider |
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 |
edit.below | int | 0 | 0:1:1 | If true, the value edit box is shown beneath the slider instead of above |
edit.hide | int | 0 | 0:1:1 | If true, the edit box is not shown |
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 |
color.thumb | enum | blue/gray/red/yellow | red | Color of the thumb control of the slider |
height | int | 250 | 130:1:500 | Height in DPI independent units |
scale | float | 1.0 | 0.5:3.0 | Specifies the magnification of all parts of the inspector |
sliderimage | enum | img1 | img1:img5 | Chooses the style of slider image to use |
width | int | 69 | 60: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 |