diff --git a/config.ld b/config.ld index 97fe8c3..4795e9b 100644 --- a/config.ld +++ b/config.ld @@ -1,12 +1,14 @@ project = "Basalt 2" title = "Basalt documentation" description = "A Basalt UI Framework Documentation" -format = "discount" -backtick_references = false -file = "ldoc.lua" +format = "markdown" dir = "docs" +file = "src" -- Ändere von "ldoc.lua" zu "src" +style = "!pale" -- Ändere zu einem einfacheren Stil +sort = true +all = true -- Dokumentiere auch private Funktionen +backtick_references = false readme = "manual.md" -style = "!new" kind_names = { topic = "Manual", script = "Programs" diff --git a/docs/index.html b/docs/index.html deleted file mode 100644 index 859a134..0000000 --- a/docs/index.html +++ /dev/null @@ -1,389 +0,0 @@ - - - - - Basalt2 Documentation - - - - -
- -
- -
-
-
- - -
- - - - - - -
- -

Module basalt

-

Basalt UI Framework main module.

-

This is the main entry point for the Basalt UI Framework. - It provides functions for creating and managing UI elements and handling events.

-

See also:

-
    -
-

Usage:

-
    - 
    local basalt = require("basalt")
-local mainFrame = basalt.createFrame()
-mainFrame:show()
-basalt.run()
-
    -
-

Info:

-
    -
  • Copyright: 2025
    • -
  • Release: 2.0
    • -
  • License: MIT
    • -
  • Author: NyoriE
    • -
- - -

Class Basalt

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
basalt:create(type[, id])Creates a new UI element - Creates and returns a new UI element of the specified type
basalt:createFrame()Creates and returns a new frame
basalt:getElementManager()Returns the element manager instance
basalt:getMainFrame()Gets or creates the main frame
basalt:removeSchedule(id)Removes a scheduled update
basalt:run([isActive])Starts the Basalt runtime
basalt:scheduleUpdate(func)Schedules a function to be updated
basalt:setActiveFrame(frame)Sets the active frame
basalt:stop()Stops the Basalt runtime
basalt:update()Updates all scheduled functions
- -
-
- - -

Class Basalt

- -
- The main Basalt instance - Contains all core functionality and management functions -
-
-
- - basalt:create(type[, id]) -
-
- Creates a new UI element - Creates and returns a new UI element of the specified type - - -

Parameters:

-
    -
  • type - string The type of element to create (e.g. "Button", "Label", "BaseFrame") -
    • -
  • id - string Optional unique identifier for the element - (optional) -
    • -
- -

Returns:

-
    - - table - The created element instance -
- - -

See also:

-
    -
- -

Usage:

-
    - 
    local button = basalt.create("Button", "myButton")
-button:setPosition(5, 5)
    -
- -
-
- - basalt:createFrame() -
-
- Creates and returns a new frame - - - -

Returns:

-
    - - table The created frame instance -
- - - -

Usage:

-
    - 
    local mainFrame = basalt.createFrame()
    -
- -
-
- - basalt:getElementManager() -
-
- Returns the element manager instance - - - -

Returns:

-
    - - table The element manager -
- - - -

Usage:

-
    - 
    local manager = basalt.getElementManager()
    -
- -
-
- - basalt:getMainFrame() -
-
- Gets or creates the main frame - - - -

Returns:

-
    - - table The main frame instance -
- - - -

Usage:

-
    - 
    local frame = basalt.getMainFrame()
    -
- -
-
- - basalt:removeSchedule(id) -
-
- Removes a scheduled update - - -

Parameters:

-
    -
  • id - number The schedule ID to remove -
    • -
- - - - -

Usage:

-
    - 
    basalt.removeSchedule(scheduleId)
    -
- -
-
- - basalt:run([isActive]) -
-
- Starts the Basalt runtime - - -

Parameters:

-
    -
  • isActive - boolean Whether to start active (default: true) - (optional) -
    • -
- - - - -

Usage:

-
    - 
  • basalt.run()
    • - 
  • basalt.run(false)
    • -
- -
-
- - basalt:scheduleUpdate(func) -
-
- Schedules a function to be updated - - -

Parameters:

-
    -
  • func - function The function to schedule -
    • -
- -

Returns:

-
    - - number The schedule ID -
- - - -

Usage:

-
    - 
    local id = basalt.scheduleUpdate(myFunction)
    -
- -
-
- - basalt:setActiveFrame(frame) -
-
- Sets the active frame - - -

Parameters:

-
    -
  • frame - table The frame to set as active -
    • -
- -

Returns:

-
    - - boolean Always returns false -
- - - -

Usage:

-
    - 
    basalt.setActiveFrame(myFrame)
    -
- -
-
- - basalt:stop() -
-
- Stops the Basalt runtime - - - - - - -

Usage:

-
    - 
    basalt.stop()
    -
- -
-
- - basalt:update() -
-
- Updates all scheduled functions - - - - - - -

Usage:

-
    - 
    basalt.update()
    -
- -
-
- - -
-
-
-generated by LDoc 1.5.0 -Last updated 2025-02-09 15:27:10 -
-
- - diff --git a/docs/ldoc_pale.css b/docs/ldoc_pale.css deleted file mode 100644 index 77544b8..0000000 --- a/docs/ldoc_pale.css +++ /dev/null @@ -1,304 +0,0 @@ -/* BEGIN RESET - -Copyright (c) 2010, Yahoo! Inc. All rights reserved. -Code licensed under the BSD License: -http://developer.yahoo.com/yui/license.html -version: 2.8.2r1 -*/ -html { - color: #000; - background: #FFF; -} -body,div,dl,dt,dd,ul,ol,li,h1,h2,h3,h4,h5,h6,pre,code,form,fieldset,legend,input,button,textarea,p,blockquote,th,td { - margin: 0; - padding: 0; -} -table { - border-collapse: collapse; - border-spacing: 0; -} -fieldset,img { - border: 0; -} -address,caption,cite,code,dfn,em,strong,th,var,optgroup { - font-style: inherit; - font-weight: inherit; -} -del,ins { - text-decoration: none; -} -li { - margin-left: 20px; -} -caption,th { - text-align: left; -} -h1,h2,h3,h4,h5,h6 { - font-size: 100%; - font-weight: bold; -} -q:before,q:after { - content: ''; -} -abbr,acronym { - border: 0; - font-variant: normal; -} -sup { - vertical-align: baseline; -} -sub { - vertical-align: baseline; -} -legend { - color: #000; -} -input,button,textarea,select,optgroup,option { - font-family: inherit; - font-size: inherit; - font-style: inherit; - font-weight: inherit; -} -input,button,textarea,select {*font-size:100%; -} -/* END RESET */ - -body { - margin-left: 1em; - margin-right: 1em; - font-family: arial, helvetica, geneva, sans-serif; - background-color: #ffffff; margin: 0px; -} - -code, tt { font-family: monospace; font-size: 1.1em; } -span.parameter { font-family:monospace; } -span.parameter:after { content:":"; } -span.types:before { content:"("; } -span.types:after { content:")"; } -.type { font-weight: bold; font-style:italic } - -body, p, td, th { font-size: .95em; line-height: 1.2em;} - -p, ul { margin: 10px 0 0 0px;} - -strong { font-weight: bold;} - -em { font-style: italic;} - -h1 { - font-size: 1.5em; - margin: 0 0 20px 0; -} -h2, h3, h4 { margin: 15px 0 10px 0; } -h2 { font-size: 1.25em; } -h3 { font-size: 1.15em; } -h4 { font-size: 1.06em; } - -a:link { font-weight: bold; color: #004080; text-decoration: none; } -a:visited { font-weight: bold; color: #006699; text-decoration: none; } -a:link:hover { text-decoration: underline; } - -hr { - color:#cccccc; - background: #00007f; - height: 1px; -} - -blockquote { margin-left: 3em; } - -ul { list-style-type: disc; } - -p.name { - font-family: "Andale Mono", monospace; - padding-top: 1em; -} - -pre { - background-color: rgb(245, 245, 245); - border: 1px solid #C0C0C0; /* silver */ - padding: 10px; - margin: 10px 0 10px 0; - overflow: auto; - font-family: "Andale Mono", monospace; -} - -pre.example { - font-size: .85em; -} - -table.index { border: 1px #00007f; } -table.index td { text-align: left; vertical-align: top; } - -#container { - margin-left: 1em; - margin-right: 1em; - background-color: #ffffff; -} - -#product { - text-align: center; - border-bottom: 1px solid #cccccc; - background-color: #ffffff; -} - -#product big { - font-size: 2em; -} - -#main { - background-color:#FFFFFF; // #f0f0f0; - //border-left: 2px solid #cccccc; -} - -#navigation { - float: left; - width: 14em; - vertical-align: top; - background-color:#FFFFFF; // #f0f0f0; - border-right: 2px solid #cccccc; - overflow: visible; -} - -#navigation h2 { - background-color:#FFFFFF;//:#e7e7e7; - font-size:1.1em; - color:#000000; - text-align: left; - padding:0.2em; - //border-top:1px solid #dddddd; - border-bottom:1px solid #dddddd; -} - -#navigation ul -{ - font-size:1em; - list-style-type: none; - margin: 1px 1px 10px 1px; -} - -#navigation li { - text-indent: -1em; - display: block; - margin: 3px 0px 0px 22px; -} - -#navigation li li a { - margin: 0px 3px 0px -1em; -} - -#content { - margin-left: 14em; - padding: 1em; - width: 700px; - border-left: 2px solid #cccccc; - // border-right: 2px solid #cccccc; - background-color: #ffffff; -} - -#about { - clear: both; - padding: 5px; - border-top: 2px solid #cccccc; - background-color: #ffffff; -} - -@media print { - body { - font: 12pt "Times New Roman", "TimeNR", Times, serif; - } - a { font-weight: bold; color: #004080; text-decoration: underline; } - - #main { - background-color: #ffffff; - border-left: 0px; - } - - #container { - margin-left: 2%; - margin-right: 2%; - background-color: #ffffff; - } - - #content { - padding: 1em; - background-color: #ffffff; - } - - #navigation { - display: none; - } - pre.example { - font-family: "Andale Mono", monospace; - font-size: 10pt; - page-break-inside: avoid; - } -} - -table.module_list { - border-width: 1px; - border-style: solid; - border-color: #cccccc; - border-collapse: collapse; -} -table.module_list td { - border-width: 1px; - padding: 3px; - border-style: solid; - border-color: #cccccc; -} -table.module_list td.name { background-color: #f0f0f0; ; min-width: 200px; } -table.module_list td.summary { width: 100%; } - -table.function_list { - border-width: 1px; - border-style: solid; - border-color: #cccccc; - border-collapse: collapse; -} -table.function_list td { - border-width: 1px; - padding: 3px; - border-style: solid; - border-color: #cccccc; -} -table.function_list td.name { background-color: #f6f6ff; ; min-width: 200px; } -table.function_list td.summary { width: 100%; } - -dl.table dt, dl.function dt {border-top: 1px solid #ccc; padding-top: 1em;} -dl.table dd, dl.function dd {padding-bottom: 1em; margin: 10px 0 0 20px;} -dl.table h3, dl.function h3 {font-size: .95em;} - -ul.nowrap { - overflow:auto; - whitespace:nowrap; -} - -/* stop sublists from having initial vertical space */ -ul ul { margin-top: 0px; } -ol ul { margin-top: 0px; } -ol ol { margin-top: 0px; } -ul ol { margin-top: 0px; } - -/* make the target distinct; helps when we're navigating to a function */ -a:target + * { - background-color: #FF9; -} - - -/* styles for prettification of source */ -pre .comment { color: #558817; } -pre .constant { color: #a8660d; } -pre .escape { color: #844631; } -pre .keyword { color: #aa5050; font-weight: bold; } -pre .library { color: #0e7c6b; } -pre .marker { color: #512b1e; background: #fedc56; font-weight: bold; } -pre .string { color: #8080ff; } -pre .number { color: #f8660d; } -pre .function-name { color: #60447f; } -pre .operator { color: #2239a8; font-weight: bold; } -pre .preprocessor, pre .prepro { color: #a33243; } -pre .global { color: #800080; } -pre .user-keyword { color: #800080; } -pre .prompt { color: #558817; } -pre .url { color: #272fc2; text-decoration: underline; } - diff --git a/docs/topics/README.md.html b/docs/topics/README.md.html deleted file mode 100644 index c9c3f35..0000000 --- a/docs/topics/README.md.html +++ /dev/null @@ -1,55 +0,0 @@ - - - - - Basalt2 Documentation - - - - -
- -
- -
-
-
- - -
- - - - - - -
- - Basalt v2 Dev - -
-
-
-generated by LDoc 1.5.0 -Last updated 2025-02-09 14:47:04 -
-
- -