From c6a89e5b35a1e57a74b6c6f58f34df38279142ad Mon Sep 17 00:00:00 2001 From: NoryiE Date: Sat, 15 Feb 2025 17:19:16 +0000 Subject: [PATCH] deploy: db716636bde6bc90078c72507560ae3dfd3669c4 --- docs/references/Container.md | 6 +++++ docs/references/Dropdown.md | 19 ++++++++++++++++ docs/references/List.md | 3 +++ docs/references/Menu.md | 22 ++++++++++++++++++ docs/references/Table.md | 31 ++++++++++++++++++++++++++ docs/references/Tree.md | 37 +++++++++++++++++++++++++++++++ docs/references/benchmark.md | 19 ++++++++++++---- docs/references/debug.md | 0 docs/references/elementManager.md | 2 ++ docs/references/main.md | 3 +++ docs/references/propertySystem.md | 3 +++ docs/references/state.md | 14 ++++++++++++ docs/references/theme.md | 5 ----- 13 files changed, 155 insertions(+), 9 deletions(-) create mode 100644 docs/references/Dropdown.md create mode 100644 docs/references/Menu.md create mode 100644 docs/references/Table.md create mode 100644 docs/references/Tree.md create mode 100644 docs/references/debug.md create mode 100644 docs/references/state.md diff --git a/docs/references/Container.md b/docs/references/Container.md index 5d952be..dbea03e 100644 --- a/docs/references/Container.md +++ b/docs/references/Container.md @@ -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() diff --git a/docs/references/Dropdown.md b/docs/references/Dropdown.md new file mode 100644 index 0000000..d47b3b0 --- /dev/null +++ b/docs/references/Dropdown.md @@ -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() + diff --git a/docs/references/List.md b/docs/references/List.md index 56ef367..c7ece50 100644 --- a/docs/references/List.md +++ b/docs/references/List.md @@ -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() diff --git a/docs/references/Menu.md b/docs/references/Menu.md new file mode 100644 index 0000000..528ca19 --- /dev/null +++ b/docs/references/Menu.md @@ -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() + diff --git a/docs/references/Table.md b/docs/references/Table.md new file mode 100644 index 0000000..2525be0 --- /dev/null +++ b/docs/references/Table.md @@ -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() + diff --git a/docs/references/Tree.md b/docs/references/Tree.md new file mode 100644 index 0000000..48fee24 --- /dev/null +++ b/docs/references/Tree.md @@ -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() + diff --git a/docs/references/benchmark.md b/docs/references/benchmark.md index 5ddeb0f..41def59 100644 --- a/docs/references/benchmark.md +++ b/docs/references/benchmark.md @@ -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() diff --git a/docs/references/debug.md b/docs/references/debug.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/references/elementManager.md b/docs/references/elementManager.md index cc216d5..2df46b6 100644 --- a/docs/references/elementManager.md +++ b/docs/references/elementManager.md @@ -1,3 +1,5 @@ +## ElementManager.getAPI() + ## ElementManager.getElement() ## ElementManager.getElementList() diff --git a/docs/references/main.md b/docs/references/main.md index 239db74..dc8c985 100644 --- a/docs/references/main.md +++ b/docs/references/main.md @@ -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 diff --git a/docs/references/propertySystem.md b/docs/references/propertySystem.md index eb1c023..616bd0c 100644 --- a/docs/references/propertySystem.md +++ b/docs/references/propertySystem.md @@ -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() diff --git a/docs/references/state.md b/docs/references/state.md new file mode 100644 index 0000000..d14c4ab --- /dev/null +++ b/docs/references/state.md @@ -0,0 +1,14 @@ +## BaseElement.setup() + +## BaseElement:computed() + +## BaseElement:getState() + +## BaseElement:initializeState() + +## BaseElement:onStateChange() + +## BaseElement:setState() + +## BaseElement:shareState() + diff --git a/docs/references/theme.md b/docs/references/theme.md index fea4615..02732b1 100644 --- a/docs/references/theme.md +++ b/docs/references/theme.md @@ -1,7 +1,2 @@ -Has to be reworked ## BaseElement:applyTheme() -## Container.setup() - -## Theme.registerTheme() -