deploy: c2507b5486

docs/references/elements/BaseFrame.md

@@ -7,17 +7,19 @@ This is the base frame class. It is the root element of all elements and the onl
 |---|---|---|
 |_render|`Render`|The render object|
 |_renderUpdate|`boolean`|Whether the render object needs to be updated|
+|_peripheralName|`string`|The name of a peripheral|
 
 ## Properties
 
 |Property|Type|Default|Description|
 |---|---|---|---|
-|text|term|nil|The terminal object to render to
+|term|term|peripheral|term.current()|The terminal or (monitor) peripheral object to render to
 
 ## Functions
 
 |Method|Returns|Description|
 |---|---|---|
+|[BaseFrame:dispatchEvent](#baseframe-dispatchevent)|-|
 |[BaseFrame:setCursor](#baseframe-setcursor)|-|Sets the cursor position
 
 
@@ -30,6 +32,8 @@ This is the base frame class. It is the root element of all elements and the onl
 |BaseFrame:init|table|Initializes the Frame instance
 |BaseFrame:key|-|Handles key events
 |BaseFrame:key_up|-|Handles key up events
+|BaseFrame:monitor_touch|-|Handles monitor touch events
+|BaseFrame:mouse_click|-|Handles mouse click events
 |BaseFrame:mouse_up|-|Handles mouse up events
 |BaseFrame:multiBlit|-|Renders a multiBlit to the render Object
 |BaseFrame:render|-|Renders the Frame
@@ -37,6 +41,8 @@ This is the base frame class. It is the root element of all elements and the onl
 |BaseFrame:textBg|-|Renders a text with a background color to the render Object
 |BaseFrame:textFg|-|Renders a text with a foreground color to the render Object
 
+## BaseFrame:dispatchEvent()
+
 ## BaseFrame:setCursor(x, y, blink)
 Sets the cursor position
 

docs/references/elements/Display.md

@@ -6,6 +6,7 @@ The Display is a special element where you can use the window (term) API to draw
 |Method|Returns|Description|
 |---|---|---|
 |[Display:getWindow](#display-getwindow)|table|Returns the current window object
+|[Display:write](#display-write)|Display|Writes text to the display
 
 
 ## Protected Functions
@@ -21,4 +22,17 @@ Returns the current window object
 ### Returns
 * `table` `window` The current window object
 
+## Display:write(x, y, text, fg?, bg?)
+Writes text to the display at the given position with the given foreground and background colors
+
+### Parameters
+* `x` `number` The x position to write to
+* `y` `number` The y position to write to
+* `text` `string` The text to write
+* `fg` *(optional)* `colors` The foreground color (optional)
+* `bg` *(optional)* `colors` The background color (optional)
+
+### Returns
+* `Display` `self` The display instance
+
 

docs/references/main.md

@@ -32,11 +32,14 @@ What this code does is it loads basalt into the project, and you can access it b
 |[basalt.getActiveFrame](#basalt-getactiveframe)|BaseFrame?|Returns the active frame
 |[basalt.getElementClass](#basalt-getelementclass)|table|Returns an element class
 |[basalt.getElementManager](#basalt-getelementmanager)|table|Returns the element manager
+|[basalt.getErrorManager](#basalt-geterrormanager)|table|Returns the error manager
+|[basalt.getFocus](#basalt-getfocus)|BaseFrame?|Returns the focused frame
 |[basalt.getMainFrame](#basalt-getmainframe)|BaseFrame|Gets or creates the main frame
 |[basalt.removeSchedule](#basalt-removeschedule)|boolean|Removes a scheduled update
 |[basalt.run](#basalt-run)|-|Starts the Basalt runtime
 |[basalt.schedule](#basalt-schedule)|thread|Schedules a function to run in a coroutine
 |[basalt.setActiveFrame](#basalt-setactiveframe)|-|Sets the active frame
+|[basalt.setFocus](#basalt-setfocus)|-|Sets a frame as focused
 |[basalt.stop](#basalt-stop)|-|Stops the Basalt runtime
 |[basalt.update](#basalt-update)|-|Runs basalt once
 
@@ -62,11 +65,6 @@ Creates and returns a new BaseFrame
 ### Returns
 * `BaseFrame` `BaseFrame` The created frame instance
 
-### Usage
- ```lua
-local mainFrame = basalt.createFrame()
-```
-
 ## basalt.getAPI(name)
 Returns a Plugin API
 
@@ -76,17 +74,15 @@ Returns a Plugin API
 ### Returns
 * `table` `Plugin` The plugin API
 
-## basalt.getActiveFrame()
+## basalt.getActiveFrame(t?)
 Returns the active frame
 
+### Parameters
+* `t` *(optional)* `term` The term to get the active frame for (default: current term)
+
 ### Returns
 * `BaseFrame?` `BaseFrame` The frame to set as active
 
-### Usage
- ```lua
-local frame = basalt.getActiveFrame()
-```
-
 ## basalt.getElementClass(name)
 Returns an element's class without creating a instance
 
@@ -102,10 +98,17 @@ Returns the element manager instance
 ### Returns
 * `table` `ElementManager` The element manager
 
-### Usage
+## basalt.getErrorManager()
- ```lua
+Returns the error manager instance
-local manager = basalt.getElementManager()
+
-```
+### Returns
+* `table` `ErrorManager` The error manager
+
+## basalt.getFocus()
+Returns the focused frame
+
+### Returns
+* `BaseFrame?` `BaseFrame` The focused frame
 
 ## basalt.getMainFrame()
 Gets or creates the main frame
@@ -113,11 +116,6 @@ Gets or creates the main frame
 ### Returns
 * `BaseFrame` `BaseFrame` The main frame instance
 
-### Usage
- ```lua
-local frame = basalt.getMainFrame()
-```
-
 ## basalt.removeSchedule(func)
 Removes a scheduled update
 
@@ -127,23 +125,12 @@ Removes a scheduled update
 ### Returns
 * `boolean` `success` Whether the scheduled function was removed
 
-### Usage
- ```lua
-basalt.removeSchedule(scheduleId)
-```
-
 ## basalt.run(isActive?)
 Starts the Basalt runtime
 
 ### Parameters
 * `isActive` *(optional)* `boolean` Whether to start active (default: true)
 
-### Usage
- ```lua
-basalt.run()
-basalt.run(false)
-```
-
 ## basalt.schedule(func)
 Schedules a function to run in a coroutine
 
@@ -153,39 +140,26 @@ Schedules a function to run in a coroutine
 ### Returns
 * `thread` `func` The scheduled function
 
-### Usage
+## basalt.setActiveFrame(frame, setActive?)
- ```lua
-local id = basalt.scheduleUpdate(myFunction)
-```
-
-## basalt.setActiveFrame(frame)
 Sets the active frame
 
 ### Parameters
 * `frame` `BaseFrame` The frame to set as active
+* `setActive` *(optional)* `boolean` Whether to set the frame as active (default: true)
 
-### Usage
+## basalt.setFocus(frame)
- ```lua
+Sets a frame as focused
-basalt.setActiveFrame(myFrame)
+
-```
+### Parameters
+* `frame` `BaseFrame` The frame to set as focused
 
 ## basalt.stop()
 Stops the Basalt runtime
 
-### Usage
- ```lua
-basalt.stop()
-```
-
 ## basalt.update(...)
 Runs basalt once, can be used to update the UI manually, but you have to feed it the events
 
 ### Parameters
 * `...` *(vararg)* `any` The event to run with
 
-### Usage
- ```lua
-basalt.update()
-```
-