This commit is contained in:
NoryiE
2025-02-15 17:19:16 +00:00
parent 4d99507f4f
commit c6a89e5b35
13 changed files with 155 additions and 9 deletions

View File

@@ -8,6 +8,7 @@
|[Container:addChild](#Container:addChild)|-|
|[Container:blit](#Container:blit)|-|
|[Container:char](#Container:char)|-|
|[Container:clear](#Container:clear)|-|
|[Container:getChild](#Container:getChild)|-|
|[Container:handleEvent](#Container:handleEvent)|-|
|[Container:init](#Container:init)|-|
@@ -15,6 +16,7 @@
|[Container:key](#Container:key)|-|
|[Container:key_up](#Container:key_up)|-|
|[Container:mouse_click](#Container:mouse_click)|-|
|[Container:mouse_up](#Container:mouse_up)|-|
|[Container:multiBlit](#Container:multiBlit)|-|
|[Container:registerChildEvent](#Container:registerChildEvent)|-|
|[Container:registerChildrenEvents](#Container:registerChildrenEvents)|-|
@@ -34,6 +36,8 @@
## Container:char()
## Container:clear()
## Container:getChild()
## Container:handleEvent()
@@ -48,6 +52,8 @@
## Container:mouse_click()
## Container:mouse_up()
## Container:multiBlit()
## Container:registerChildEvent()

View File

@@ -0,0 +1,19 @@
# Dropdown : List
## Functions
|Method|Returns|Description|
|---|---|---|
|[Dropdown.new](#Dropdown.new)|-|
|[Dropdown:init](#Dropdown:init)|-|
|[Dropdown:mouse_click](#Dropdown:mouse_click)|-|
|[Dropdown:render](#Dropdown:render)|-|
## Dropdown.new()
## Dropdown:init()
## Dropdown:mouse_click()
## Dropdown:render()

View File

@@ -20,6 +20,7 @@
|[List:init](#List:init)|-|
|[List:mouse_click](#List:mouse_click)|-|
|[List:mouse_scroll](#List:mouse_scroll)|-|
|[List:onSelect](#List:onSelect)|-|
|[List:removeItem](#List:removeItem)|-|
|[List:render](#List:render)|-|
@@ -35,6 +36,8 @@
## List:mouse_scroll()
## List:onSelect()
## List:removeItem()
## List:render()

22
docs/references/Menu.md Normal file
View File

@@ -0,0 +1,22 @@
# Menu : List
## Functions
|Method|Returns|Description|
|---|---|---|
|[Menu.new](#Menu.new)|-|
|[Menu:init](#Menu:init)|-|
|[Menu:mouse_click](#Menu:mouse_click)|-|
|[Menu:render](#Menu:render)|-|
|[Menu:setItems](#Menu:setItems)|-|
## Menu.new()
## Menu:init()
## Menu:mouse_click()
## Menu:render()
## Menu:setItems()

31
docs/references/Table.md Normal file
View File

@@ -0,0 +1,31 @@
# Table : VisualElement
## Functions
|Method|Returns|Description|
|---|---|---|
|[Table.new](#Table.new)|-|
|[Table:init](#Table:init)|-|
|[Table:mouse_click](#Table:mouse_click)|-|
|[Table:mouse_scroll](#Table:mouse_scroll)|-|
|[Table:render](#Table:render)|-|
|[Table:setColumns](#Table:setColumns)|-|
|[Table:setData](#Table:setData)|-|
|[Table:sortData](#Table:sortData)|-|
## Table.new()
## Table:init()
## Table:mouse_click()
## Table:mouse_scroll()
## Table:render()
## Table:setColumns()
## Table:setData()
## Table:sortData()

37
docs/references/Tree.md Normal file
View File

@@ -0,0 +1,37 @@
# Tree : VisualElement
## Functions
|Method|Returns|Description|
|---|---|---|
|[Tree.new](#Tree.new)|-|
|[Tree:collapseNode](#Tree:collapseNode)|-|
|[Tree:expandNode](#Tree:expandNode)|-|
|[Tree:init](#Tree:init)|-|
|[Tree:mouse_click](#Tree:mouse_click)|-|
|[Tree:mouse_scroll](#Tree:mouse_scroll)|-|
|[Tree:onSelect](#Tree:onSelect)|-|
|[Tree:render](#Tree:render)|-|
|[Tree:setNodes](#Tree:setNodes)|-|
|[Tree:toggleNode](#Tree:toggleNode)|-|
## Tree.new()
## Tree:collapseNode()
## Tree:expandNode()
## Tree:init()
## Tree:mouse_click()
## Tree:mouse_scroll()
## Tree:onSelect()
## Tree:render()
## Tree:setNodes()
## Tree:toggleNode()

View File

@@ -1,7 +1,18 @@
Will temporary exist while developing, maybe i will create a benchmark plugin in future
## Benchmark.start()
## BaseElement:benchmark()
## Benchmark.stop()
## BaseElement:endProfile()
## Benchmark.update()
## BaseElement:getBenchmarkStats()
## BaseElement:logBenchmark()
## BaseElement:startProfile()
## BaseElement:stopBenchmark()
## Container:benchmarkContainer()
## Container:logContainerBenchmarks()
## Container:stopContainerBenchmark()

0
docs/references/debug.md Normal file
View File

View File

@@ -1,3 +1,5 @@
## ElementManager.getAPI()
## ElementManager.getElement()
## ElementManager.getElementList()

View File

@@ -16,6 +16,7 @@ What this code does is it loads basalt into the project, and you can access it b
|---|---|---|
|[basalt.create](#basalt.create)|table|Creates a new UI element
|[basalt.createFrame](#basalt.createFrame)|table|
|[basalt.getAPI](#basalt.getAPI)|-|
|[basalt.getElementManager](#basalt.getElementManager)|table|
|[basalt.getMainFrame](#basalt.getMainFrame)|BaseFrame|
|[basalt.removeSchedule](#basalt.removeSchedule)|-|
@@ -51,6 +52,8 @@ Creates and returns a new frame
local mainFrame = basalt.createFrame()
```
## basalt.getAPI()
## basalt.getElementManager()
Returns the element manager instance

View File

@@ -6,6 +6,7 @@
|---|---|---|
|[PropertySystem.addSetterHook](#PropertySystem.addSetterHook)|-|
|[PropertySystem.blueprint](#PropertySystem.blueprint)|table|
|[PropertySystem.combineProperties](#PropertySystem.combineProperties)|-|
|[PropertySystem.createFromBlueprint](#PropertySystem.createFromBlueprint)|-|
|[PropertySystem.defineProperty](#PropertySystem.defineProperty)|-|
|[PropertySystem:__init](#PropertySystem:__init)|-|
@@ -28,6 +29,8 @@ Creates a blueprint of an element class with all its properties
### Returns
* `table` `blueprint` A table containing all property definitions
## PropertySystem.combineProperties()
## PropertySystem.createFromBlueprint()
## PropertySystem.defineProperty()

14
docs/references/state.md Normal file
View File

@@ -0,0 +1,14 @@
## BaseElement.setup()
## BaseElement:computed()
## BaseElement:getState()
## BaseElement:initializeState()
## BaseElement:onStateChange()
## BaseElement:setState()
## BaseElement:shareState()

View File

@@ -1,7 +1,2 @@
Has to be reworked
## BaseElement:applyTheme()
## Container.setup()
## Theme.registerTheme()