uvi-script
Musical event scripting with Lua
ParamNumBox Class Reference

A numeric box bound to an existing Element parameter. More...

Inheritance diagram for ParamNumBox:
Widget

Public Member Functions

 ParamNumBox (Element elementOrPath, string paramName)
 creates a numeric box bound to an existing Element parameter.
 
 ParamNumBox (string name)
 creates an unbound number box, to be targeted later with bind.
 
void bind (Element elementOrPath, string paramName)
 bind the widget to another parameter, or bind an unbound widget for the first time.
 

Public Attributes

number value
 the widget's value (read-only; reflects the bound parameter)
 
string align
 text alignment
 
number fontSize
 text font size
 
string font
 path to a custom TrueType font
 
number minimumHorizontalScale
 minimum horizontal font squash before ellipsis
 
bool hitTestOnlyOnText
 only react to clicks on the text itself
 
string backgroundImage
 path to background image
 
string backgroundColour
 background colour
 
string textColour
 text colour
 
- Public Attributes inherited from Widget
string name
 widget name, given at construction (read-only)
 
string displayName
 widget display name
 
string displayText
 custom text to display in place of the standard value display, on widgets that show one.
 
string tooltip
 widget tooltip, default is name
 
int x
 x position in pixels
 
int y
 y position in pixels
 
int width
 widget width in pixels
 
int height
 widget height in pixels
 
int w
 alias of width
 
int h
 alias of height
 
table size
 widget size {width, height}
 
table position
 widget position {x,y}
 
table pos
 alias of position
 
table bounds
 widget bounding rect {x,y,width,height}
 
number alpha
 transparency value between 0.0 and 1.0
 
bool enabled
 boolean flag to enable / disable the widget
 
bool visible
 boolean flag to toggle widget visibility
 
bool interceptsMouseClicks
 boolean flag to toggle mouse handling on widget.
 
bool showLabel
 show widgets label if any
 
bool persistent
 flag to tell if the widget values should be serialized when saving.
 
function changed
 callback function used by child widgets to be notified of changes.
 

Detailed Description

A numeric box bound to an existing Element parameter.

Displays and edits the parameter as a number. It is a Widget (not a NumBox).

Constructor & Destructor Documentation

◆ ParamNumBox() [1/2]

ParamNumBox::ParamNumBox ( Element elementOrPath,
string paramName )

creates a numeric box bound to an existing Element parameter.

Parameters
elementOrPathan Element reference, or a path string identifying one
paramNamethe parameter name (as used by setParameter)

◆ ParamNumBox() [2/2]

ParamNumBox::ParamNumBox ( string name)

creates an unbound number box, to be targeted later with bind.

Until then it shows a placeholder and its value is nil.

Parameters
namethe widget name

Member Function Documentation

◆ bind()

void ParamNumBox::bind ( Element elementOrPath,
string paramName )

bind the widget to another parameter, or bind an unbound widget for the first time.

The control is rebuilt with the new parameter's range, unit, mapper and value; rebinding to the same element and parameter does nothing. Typically called when the element the UI edits changes, e.g. the insert effect selected in an effect rack. Raises an error when the element no longer exists or has no such parameter.

Parameters
elementOrPathan Element reference, or a path string identifying one
paramNamethe parameter name (as used by setParameter)