deploy: fc44bc4d8b

docs/references/elements/Program.md

@@ -1,37 +1,112 @@
-# Program : VisualElement
-This is the program class. It provides a program that runs in a window.
+# Program
+_This is the program class. It provides a program that runs in a window._
+
+Extends: `VisualElement`
 
 ## Properties
 
 |Property|Type|Default|Description|
 |---|---|---|---|
-|program|table|nil|The program instance
-|path|string|""|The path to the program
-|running|boolean|false|Whether the program is running
+|program|table|nil|The program instance|
+|path|string|""|The path to the program|
+|running|boolean|false|Whether the program is running|
+|errorCallback|function|nil|The error callback function|
+|doneCallback|function|nil|The done callback function|
 
 ## Functions
 
 |Method|Returns|Description|
 |---|---|---|
-|[Program:execute](#program-execute)|Program|Executes a program
+|[Program.new](#program-new)|-||
+|[Program:run](#program-run)|-||
+|[Program:resize](#program-resize)|-||
+|[Program:resume](#program-resume)|-||
+|[Program:stop](#program-stop)|-||
+|[Program.new](#program-new)|Program|Creates a new Program instance|
+|[Program:init](#program-init-props-basalt)|Program|Initializes the Program instance|
+|[Program:execute](#program-execute-path-env-addenvironment)|Program|Executes a program|
+|[Program:stop](#program-stop)|Program|Stops the program|
+|[Program:sendEvent](#program-sendevent-event-any)|Program|Sends an event to the program|
+|[Program:onError](#program-onerror-fn)|Program|Registers a callback for the program's error event|
+|[Program:onDone](#program-ondone-fn)|Program|Registers a callback for the program's done event|
+|[Program:dispatchEvent](#program-dispatchevent-event-any)|any|Handles all incomming events|
+|[Program:focus](#program-focus)|-|Gets called when the element gets focused|
+|[Program:render](#program-render)|-|Renders the program|
 
+## Program.new()
+## Program:run()
+## Program:resize()
+## Program:resume()
+## Program:stop()
+## Program.new()
+### Returns
+* `Program` `object` The newly created Program instance
 
-## Protected Functions
+## Program:init(props, basalt)
+### Parameters
+* `props` `table` The properties to initialize the element with
+* `basalt` `table` The basalt instance
 
-|Method|Returns|Description|
-|---|---|---|
-|Program:dispatchEvent|any|Handles all incomming events
-|Program:focus|-|Gets called when the element gets focused
-|Program:init|Program|Initializes the Program instance
-|Program:render|-|Renders the program
+### Returns
+* `Program` `self` The initialized instance
+
+## Program:execute(path, env?, addEnvironment?)
 
-## Program:execute(path)
 Executes a program
 
 ### Parameters
 * `path` `string` The path to the program
+* `env` *(optional)* `table` The environment to run the program in
+* `addEnvironment` *(optional)* `boolean` Whether to add the environment to the program's environment (false = overwrite instead of adding)
 
 ### Returns
 * `Program` `self` The Program instance
 
+## Program:stop()
 
+Stops the program
+
+### Returns
+* `Program` `self` The Program instance
+
+## Program:sendEvent(event, any)
+
+Sends an event to the program
+
+### Parameters
+* `event` `string` The event to send
+* `any` `The` event arguments
+
+### Returns
+* `Program` `self` The Program instance
+
+## Program:onError(fn)
+
+Registers a callback for the program's error event, if the function returns false, the program won't stop
+
+### Parameters
+* `fn` `function` The callback function to register
+
+### Returns
+* `Program` `self` The Program instance
+
+## Program:onDone(fn)
+
+Registers a callback for the program's done event
+
+### Parameters
+* `fn` `function` The callback function to register
+
+### Returns
+* `Program` `self` The Program instance
+
+## Program:dispatchEvent(event, any)
+### Parameters
+* `event` `string` The event to handle
+* `any` `The` event arguments
+
+### Returns
+* `any` `result` The event result
+
+## Program:focus()
+## Program:render()