File Duplex/Application.lua
Functions
Application:__init (process, mappings, options, cfg_name, palette) | initialize the Application class |
Application:__tostring () | Prints the type of application (class name) |
Application:_add_component (c) | Register a UIComponent so we can automatically remove it when exiting note that the display might not be present, so use with caution |
Application:_add_option_row (t, key, process) | Build a row of option controls |
Application:_apply_mappings (mappings) | Assign matching group-names |
Application:_apply_palette (palette) | Assign matching palette entries |
Application:_build_app () | Create application (build interface) |
Application:_build_options (process) | Create application options dialog |
Application:_check_mappings (mappings) | Check mappings: should be called before application is started |
Application:_set_option (key, val, process) | Set option value |
Application:destroy_app () | Destroy application (remove listeners, set to inactive state) |
Application:on_idle () | Handle idle updates for the application (nothing is done by default) |
Application:on_keypress (key) | Receive keypress events from the Duplex Browser dialog |
Application:on_new_document () | Called when a new document becomes available |
Application:on_release_document () | Called when releasing the active document |
Application:start_app () | Start/resume application |
Application:stop_app () | Stop application |
Functions
- Application:__init (process, mappings, options, cfg_name, palette)
-
initialize the Application class
Parameters:
-
process
: BrowserProcess -
mappings
: (table, imported from the device configuration) -
options
: (table, imported from the application default options) -
cfg_name
: (string, imported from the application default options) -
palette
: (table, imported from the device configuration)
-
- Application:__tostring ()
- Prints the type of application (class name)
- Application:_add_component (c)
-
Register a UIComponent so we can automatically remove it when exiting note that the display might not be present, so use with caution
Parameters:
-
c
:
-
- Application:_add_option_row (t, key, process)
-
Build a row of option controls
Parameters:
-
t
: -
key
: -
process
:
Return value:
- ViewBuilder view
-
- Application:_apply_mappings (mappings)
-
Assign matching group-names
Parameters:
-
mappings
:
-
- Application:_apply_palette (palette)
-
Assign matching palette entries
Parameters:
-
palette
:
-
- Application:_build_app ()
-
Create application (build interface)
Return value:
- (Boolean) true when application was built
- Application:_build_options (process)
-
Create application options dialog
Parameters:
-
process
:
-
- Application:_check_mappings (mappings)
-
Check mappings: should be called before application is started
Parameters:
-
mappings
:
Return value:
- boolean (false if missing group-names were encountered)
-
- Application:_set_option (key, val, process)
-
Set option value
Parameters:
-
key
: (String) the key to change -
val
: (Number) the value to change -
process
: (BrowserProcess) supply this parameter to modify the persistent settings
-
- Application:destroy_app ()
- Destroy application (remove listeners, set to inactive state)
- Application:on_idle ()
- Handle idle updates for the application (nothing is done by default)
- Application:on_keypress (key)
-
Receive keypress events from the Duplex Browser dialog
Parameters:
-
key
: (table) forwarded from the keyhandler
Return value:
- (boolean) if false, key event is not forwarded to Renoise
-
- Application:on_new_document ()
- Called when a new document becomes available
- Application:on_release_document ()
- Called when releasing the active document
- Application:start_app ()
- Start/resume application
- Application:stop_app ()
- Stop application