docs updates

NoryiE · NoryiE · commit 51f6ebe7cece · 2022-09-06T17:43:03.000+02:00
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -29,3 +29,4 @@
     - [Button coloring](tips/buttonColoring.md)
     - [Designing/Animating](tips/design.md)
     - [Dynamic Values](tips/dynamicvalues.md)
+    - [XML](tips/xml.md)
diff --git a/docs/installer.lua b/docs/installer.lua
diff --git a/docs/objects/Animation/changeBackground.md b/docs/objects/Animation/changeBackground.md
@@ -14,7 +14,7 @@ Changes the background color while the animation is running
 ```lua
 local mainFrame = basalt.createFrame()
 local testButton = mainFrame:addButton("buttonToAnimate")
-local aAnimation = mainFrame:addAnimation():setObject(testButton):changeBackground({colors.red, colors.yellow, colors.green}, 2):play()
+local aAnimation = mainFrame:addAnimation():setObject(testButton):changeTextColor(2, 0, colors.red, colors.yellow, colors.green):play()
 ```
 ```xml
 <animation object="buttonToAnimate" play="true">
@@ -25,4 +25,4 @@ local aAnimation = mainFrame:addAnimation():setObject(testButton):changeBackgrou
         <duration>2</duration>
     </background>
 </animation>
-```
+```
diff --git a/docs/objects/Animation/changeText.md b/docs/objects/Animation/changeText.md
@@ -14,7 +14,7 @@ Changes the text while animation is running
 ```lua
 local mainFrame = basalt.createFrame()
 local testButton = mainFrame:addButton("buttonToAnimate")
-local aAnimation = mainFrame:addAnimation():setObject(testButton):changeText({"i", "am", "groot"}, 2):play()
+local aAnimation = mainFrame:addAnimation():setObject(testButton):changeText(2, 0, "i", "am", "groot"):play()
 ```
 ```xml
 <animation object="buttonToAnimate" play="true">
diff --git a/docs/objects/Animation/changeTextColor.md b/docs/objects/Animation/changeTextColor.md
@@ -14,7 +14,7 @@ Changes the text color while the animation is running
 ```lua
 local mainFrame = basalt.createFrame()
 local testButton = mainFrame:addButton("buttonToAnimate")
-local aAnimation = mainFrame:addAnimation():setObject(testButton):changeTextColor({colors.red, colors.yellow, colors.green}, 2):play()
+local aAnimation = mainFrame:addAnimation():setObject(testButton):changeTextColor(2, 0, colors.red, colors.yellow, colors.green):play()
 ```
 ```xml
 <animation object="buttonToAnimate" play="true">
diff --git a/docs/objects/Button.md b/docs/objects/Button.md
@@ -24,13 +24,13 @@ end)
 
 and this would be the xml way:
 ```lua
-local main = basalt.createFrame():addLayout("example.xml")
-
 basalt.setVariable("buttonClick", function(self,event,button,x,y)
   if(event=="mouse_click")and(button==1)then
     basalt.debug("Left mousebutton got clicked!")
   end
 end)
+
+local main = basalt.createFrame():addLayout("example.xml")
 ```
 ```xml
 <button onClick="buttonClick" text="Click" />
diff --git a/docs/objects/Checkbox/setSymbol.md b/docs/objects/Checkbox/setSymbol.md
@@ -0,0 +1,18 @@
+## setSymbol
+Changes the checkbox symbol, default is "\42"
+
+#### Parameters: 
+1. `string` symbol
+
+#### Returns:
+1. `object` The object in use
+
+#### Usage:
+* Creates a new checkbox and changes the symbol to o
+```lua
+local main = basalt.createFrame()
+local checkbox = main:addCheckbox():setSymbol("o")
+```
+```xml
+<checkbox symbol="o" />
+```
diff --git a/docs/objects/Frame/removeFocusedObject.md b/docs/objects/Frame/removeFocusedObject.md
@@ -1,16 +1,15 @@
 ## removeFocusedObject 
-Removes the focus of the supplied object
-
-#### Parameters: 
-1. `object` The child object to remove focus from
+Removes the currently focused object of that frame
 
 #### Returns: 
 1. `frame` The frame being used
 
 #### Usage:
 * Creates a new button then removes the focus from that button when clicking on it
 ```lua
-local aButton = myFrame:addButton():setFocus():onClick(function() 
-    myFrame:removeFocusedObject(aButton)
+local main = basalt.createFrame()
+local input = main:addInput():setFocus()
+local aButton = main:addButton():onClick(function() 
+    main:removeFocusedObject()
 end)
 ```
diff --git a/docs/objects/Frame/removeObject.md b/docs/objects/Frame/removeObject.md
@@ -2,14 +2,17 @@
 Removes a child object from the frame
 
 #### Parameters:
-1. `string` The name of the child object
+1. `string|object` The name of the child object or the object itself
 
 #### Returns: 
 1. `boolean` Whether the object with the given name was properly removed
 
 #### Usage:
 * Adds a button with the id "myFirstButton", then removes it with the aforementioned id
 ```lua
-myFrame:addButton("myFirstButton")
-myFrame:removeObject("myFirstButton")
+local main = basalt.createFrame()
+main:addButton("myFirstButton"):setText("Close")
+    :onClick(function(self)
+        main:removeObject("myFirstButton") -- or main:removeObject(self) 
+    end)
 ```
diff --git a/docs/objects/Image/loadImage.md b/docs/objects/Image/loadImage.md
@@ -10,7 +10,7 @@ loads a default .nfp file into the object.
 #### Usage:
 * Creates a default image and loads a test.nfp file
 ```lua
-local mainFrame = basalt.createFrame():show()
+local mainFrame = basalt.createFrame()
 local aImage = mainFrame:addImage():loadImage("test.nfp")
 ```
 ```xml
diff --git a/docs/objects/Object/getBackground.md b/docs/objects/Object/getBackground.md
@@ -0,0 +1,5 @@
+## getBackground
+Returns the current background color
+
+#### Returns: 
+1. `number` color
diff --git a/docs/objects/Object/getForeground.md b/docs/objects/Object/getForeground.md
@@ -0,0 +1,5 @@
+## getForeground
+Returns the current foreground color
+
+#### Returns: 
+1. `number` color
diff --git a/docs/objects/Object/remove.md b/docs/objects/Object/remove.md
@@ -0,0 +1,11 @@
+## remove
+Removes the object from it's parent frame. This won't 'destroy' the object, It will continue to exist as long as you still have pointers to it.
+
+Here is a example on how a button will be fully removed from the memory:
+```lua
+local main = basalt.createFrame()
+local button = main:addButton():setPosition(2,2):setText("Close")
+
+button:remove()
+button = nil
+```
diff --git a/docs/objects/Scrollbar.md b/docs/objects/Scrollbar.md
@@ -4,9 +4,9 @@ Scrollbars are objects, the user can scroll vertically or horizontally, this wil
 
 |   |   |
 |---|---|
-|[setSymbol](objects/Scrollbar/setSymbol.md)|Sets the scrollbar symbol
-|[setBackgroundSymbol](objects/Scrollbar/setBackgroundSymbol.md)|Sets the background symbol
-|[setBarType](objects/Scrollbar/setBarType.md)|Sets the bar type (vertical or horizontal)
-|[setMaxValue](objects/Scrollbar/setMaxValue.md)|Sets the maximum value
-|[setIndex](objects/Scrollbar/setIndex.md)|Sets the current index
-|[getIndex](objects/Scrollbar/getIndex.md)|Returns the index
+|[setSymbol](objects/Slider/setSymbol.md)|Sets the slider symbol
+|[setBackgroundSymbol](objects/Slider/setBackgroundSymbol.md)|Sets the background symbol
+|[setBarType](objects/Slider/setBarType.md)|Sets the bar type (vertical or horizontal)
+|[setMaxValue](objects/Slider/setMaxValue.md)|Sets the maximum value
+|[setIndex](objects/Slider/setIndex.md)|Sets the current index
+|[getIndex](objects/Slider/getIndex.md)|Returns the index
diff --git a/docs/tips/xml.md b/docs/tips/xml.md
@@ -0,0 +1,79 @@
+This is a basic guide on how to create a UI with XML.
+
+In XML you are not able to create logic, but you could refer to logic - i will show you how.
+But first i will show you how you are able to create some basic XML design.
+
+First we will need a .lua file - we need to process the XML stuff, and this is only possible in lua.
+So let's create a lua file:
+
+```lua
+local basalt = require("basalt") -- as always we will need basalt
+
+local main = basalt.createFrame() -- and atleast 1 base frame is needed
+
+basalt.autoUpdate() -- starting the event and draw handler is also needed
+```
+
+The code above you are just not able to do in XML, you are not able to create base frames and you are also not able to start the event/draw handlers.
+This can only be done in Lua.
+
+In Basalt XML Code will always be loaded into frames. Which means all the objects created in XML are always childrens of that particular frame. Here is a example to show what i mean:
+
+Lua:
+```lua
+local basalt = require("basalt")
+local main = basalt.createFrame():addLayout("example.xml")
+basalt.autoUpdate()
+```
+
+XML:
+```xml
+<button x="5" y="3" text="Hello" />
+```
+
+This would be exactly the same like if you would use the following lua code:
+```lua
+local basalt = require("basalt")
+local main = basalt.createFrame()
+main:addButton():setPosition(5, 3):setText("Hello")
+basalt.autoUpdate()
+```
+
+You can also add a layout multiple times, or create multiple frames and always use the same layout. For example a design layout for more frames and then you could also use
+a unique layout for each frame. I wont show you a example, you just have to use :addLayout multiple times on different frames.
+
+Another thing is, you could add/load XML files IN XML:
+example.xml:
+```xml
+<frame layout="anotherExample.xml" />
+```
+
+anotherExample.xml:
+```xml
+<button x="2" y="3" width="parent.w - 2" text="Greetings" />
+```
+
+# Events
+
+Using events in XML is also pretty simple. For that basalt has a function called basalt.setVariable. This is to store functions or other things which you can access via
+XML. Obviously the logic you want to add has to be done in lua, here:
+
+Lua:
+```lua
+local basalt = require("basalt")
+
+basalt.setVariable("buttonClick", function()
+    basalt.debug("i got clicked!")
+end)
+
+local main = basalt.createFrame():addLayout("example.xml")
+basalt.autoUpdate()
+```
+
+And then you just have to link your function in your XML file:
+```xml
+<button x="2" y="3" width="parent.w - 2" text="Greetings" onClick="buttonClick" />
+```
+
+This is pretty simple! BUT there is one thing you shouldn't forget: In Lua you always have to create the function's before you want to access it, which means
+always use basalt.setVariable before you use frame:addLayout() - otherwise basalt is not able to find the function
