Module Duplex.WidgetHooks
Provide hooks for controls in the virtual control surface (native & custom)
process_subparams()
Description: when parsing the controlmap, apply widget-specific attributes
See also Duplex.ControlMap._parse_xml
Parameters:
- param
- subparam
build()
Description create the actual viewbuilder components, including a notifier method
See also Duplex.Display._walk_table
Parameters
- display
- param
Return
- renoise.Views.View
validate()
Description: validate/fix parameters and try to give the control map author some hints of what might be wrong with the control map
See also Duplex.Display._walk_table
Parameters
- display
- param
- cm
set_subparams()
Description: handle outgoing messages for parameters that include subparameters
See also Duplex.Display.set_parameter
Parameters:
- display
- param
- point
- ui_obj
set_widget()
Description: update the widget in the virtual control surface - define this when the widget needs a more complex display-update (for example, a button is more complex than a slider)
See also Duplex.Display.set_parameter
Parameters:
- display
- widget
- param
- ui_obj
- point
- value
on_receive()
Description: do something clever when an incoming message arrives
See also Duplex.OscDevice.receive_osc_message
- device
- param
- msg
- regex
on_send()
Description: perform last-minute changes before transmitting to hardware
Tables
| widget_hooks.fader | function - fader widget |
| widget_hooks.dial | function - dial widget |
| widget_hooks.button | function - button widget |
| widget_hooks.xypad | function - xypad widget |
| widget_hooks.label | function - label widget |
| widget_hooks.key | function - key widget |
| widget_hooks.keyboard | function - keyboard widget |
Tables
- widget_hooks.fader
-
function - fader widget
Fields:
- build
- param
- adj_width
- adj_height
- tooltip
- min
- max
- tooltip
- width
- height
- notifier
- widget_hooks.dial
-
function - dial widget
Fields:
- build
- param
- adj_width
- adj_height
- tooltip
- min
- max
- tooltip
- width
- height
- notifier
- widget_hooks.button
-
function - button widget
Fields:
- build
- param
- adj_width
- adj_height
- tooltip
- width
- height
- text
- tooltip
- pressed
- released
- widget_hooks.xypad
-
function - xypad widget
Fields:
- process_subparams
- subparam
- set_subparams
- param
- point
- ui_obj
- subparam
- build
- param
- adj_width
- adj_height
- tooltip
- axis_y
- nil
- subparam
- min
- y
- widget_hooks.label
-
function - label widget
Fields:
- build
- param
- adj_width
- adj_height
- tooltip
- text
- font
- width
- height
- tooltip
- widget_hooks.key
-
function - key widget [[
Fields:
- build
- param
- adj_width
- adj_height
- tooltip
- width
- height
- tooltip
- pressed
- released
- widget_hooks.keyboard
-
function - keyboard widget
Fields:
- build
- validate
- param
- cm [[
- set_widget
- widget
- xarg
- ui_obj
- point
- value
- ]
- param
- msg
- regex
- v