Classes | Functions
User Interface

classes and functions related to User Interface definition and layout. More...

Classes

class  AudioMeter
 AudioMeter widget. More...
 
class  Button
 stateless transient button. More...
 
class  Image
 Image widget. More...
 
class  Knob
 Knob widget. More...
 
class  Label
 text label widget. More...
 
class  Mapper
 Predefined mapper types. More...
 
class  Menu
 Menu widget. More...
 
class  MultiStateButton
 MultiStateButton widget. More...
 
class  NumBox
 Numeric spinner label. More...
 
class  OnOffButton
 2 states boolean button. More...
 
class  Panel
 Panel widget. More...
 
class  Slider
 horizontal or vertical slider widget. More...
 
class  Table
 Table widget. More...
 
class  Unit
 Predefined unit types. More...
 
class  Widget
 Widget base class. More...
 
class  XY
 XY widget. More...
 

Functions

void makePerformanceView ()
 make this script User Interface visible in performance view.
 
void moveControl (Widget widget, int col, int row)
 move a UI element to a specific place on the grid More...
 
void setBackground (string imagePath)
 set the script background Image. More...
 
function setKeyColour (note, colour)
 customize the keyboard colours. More...
 
function setHeight (h)
 sets the desired height of the user interface. More...
 
function moveControl (widget, xcol, yrow)
 move a UI element to a specific place on the grid More...
 
function setBackground (imgPath)
 set the script background Image. More...
 

Detailed Description

classes and functions related to User Interface definition and layout.

Function Documentation

void moveControl ( Widget  widget,
int  col,
int  row 
)

move a UI element to a specific place on the grid

Parameters
widgetwidget element to move
colgrid column index
rowgrid row index
void setBackground ( string  imagePath)

set the script background Image.

supported image types include jpg and png

Parameters
imagePathfile path to the Image can be absolute or relative
function setKeyColour ( note  ,
colour   
)

customize the keyboard colours.

Parameters
notemidiNote to change
colourstring that defines the desired colour. It can be either a named colour like "blue" or "red" or an hexadecimal string in RGB ("#FF00CC") or ARGB ("#3C00FECD") format You can use custom colors to set the valid key range: #00FFFFFF (transparent white) and #00000000 (transparent black) for a valid and non valid key
Examples:
Keyswitch.lua.
function setHeight ( )

sets the desired height of the user interface.

it is automatically computed when creating widgets but you can adjust it to fit your needs

Parameters
hheight in pixels
function moveControl ( widget  ,
xcol  ,
yrow   
)

move a UI element to a specific place on the grid

Parameters
widget
xcol
yrow
function setBackground ( imgPath  )

set the script background Image.

supported image types include jpg and png

Parameters
imgPathfile path to the Image can be absolute or relative