docs

docs/objects/Scrollbar.md

@@ -1,48 +1,108 @@
-Scrollbars are objects, the user can scroll vertically or horizontally, this can change the value.<br>
-Here is a example of how to create a standard scrollbar:
+Scrollbars are objects, the user can scroll vertically or horizontally, this will change a value, which you can access by :getValue().<br>
 
-```lua
-local mainFrame = basalt.createFrame("myFirstFrame"):show()
-local aScrollbar = mainFrame:addScrollbar("myFirstScrollbar"):show()
-```
-Here are all possible functions available for scrollbars. Remember Scrollbar inherits from [Object](objects/Object.md)
+Remember scrollbar also inherits from [Object](objects/Object.md)
 
 ## setSymbol
-Changes the symbol
+Changes the scrollbar symbol, default is " "
 
+#### Parameters: 
+1. `string` symbol
+
+#### Returns:
+1. `object` The object in use
+
+#### Usage:
+* Creates a new scrollbar and changes the symbol to X
 ```lua
-local mainFrame = basalt.createFrame("myFirstFrame"):show()
-local aScrollbar = mainFrame:addScrollbar("myFirstScrollbar"):setSymbol("X"):show()
+local mainFrame = basalt.createFrame()
+local scrollbar = mainFrame:addScrollbar():setSymbol("X")
+```
+```xml
+<scrollbar symbol="X" />
 ```
-#### Parameters: char symbol<br>
-#### Returns: self<br>
 
 ## setBackgroundSymbol
-Changes the background symbol color
+Changes the symbol in the background, default is "\127"
 
+#### Parameters: 
+1. `string` symbol
+
+#### Returns:
+1. `object` The object in use
+
+#### Usage:
+* Creates a new scrollbar and changes the background symbol to X
 ```lua
-local mainFrame = basalt.createFrame("myFirstFrame"):show()
-local aScrollbar = mainFrame:addScrollbar("myFirstScrollbar"):setSymbol("X"):setBackgroundSymbol(colors.green):show()
+local mainFrame = basalt.createFrame()
+local scrollbar = mainFrame:addScrollbar():setBackgroundSymbol("X")
+```
+```xml
+<scrollbar backgroundSymbol="X" />
 ```
-#### Parameters: number symbolcolor<br>
-#### Returns: self<br>
 
 ## setBarType
-If the bar goes vertically or horizontally
+Changes the scrollbar to be vertical or horizontal, default is vertical
 
+#### Parameters: 
+1. `string` vertical or horizontal
+
+#### Returns:
+1. `object` The object in use
+
+#### Usage:
+* Creates a new scrollbar and changes the bar type to horizontal
 ```lua
-local mainFrame = basalt.createFrame("myFirstFrame"):show()
-local aScrollbar = mainFrame:addScrollbar("myFirstScrollbar"):setBarType("horizontal"):show()
+local mainFrame = basalt.createFrame()
+local scrollbar = mainFrame:addScrollbar():setBarType("horizontal")
+```
+```xml
+<scrollbar barType="horizontal" />
 ```
-#### Parameters: string value ("vertical" or "horizontal")<br>
-#### Returns: self<br>
 
 ## setMaxValue
 the default max value is always the width (if horizontal) or height (if vertical), if you change the max value the bar will always calculate the value based on its width or height - example: you set the max value to 100, the height is 10 and it is a vertical bar, this means if the bar is on top, the value is 10, if the bar goes one below, it is 20 and so on.
 
+#### Parameters: 
+1. `number` maximum
+
+#### Returns:
+1. `object` The object in use
+
+#### Usage:
+* Creates a new scrollbar and changes the max value to 20
 ```lua
-local mainFrame = basalt.createFrame("myFirstFrame"):show()
-local aScrollbar = mainFrame:addScrollbar("myFirstScrollbar"):setMaxValue(123):show()
+local mainFrame = basalt.createFrame()
+local scrollbar = mainFrame:addScrollbar():setMaxValue(20)
 ```
-#### Parameters: any number<br>
-#### Returns: self<br>
+```xml
+<scrollbar maxValue="20" />
+```
+
+## setIndex
+Changes the current index to your choice, for example you could create a button which scrolls up to 1 by using :setIndex(1)
+
+#### Parameters: 
+1. `number` the index
+
+#### Returns:
+1. `object` The object in use
+
+#### Usage:
+* Creates a new scrollbar and changes the index to 1 as soon as the button got clicked
+```lua
+local mainFrame = basalt.createFrame()
+local scrollbar = mainFrame:addScrollbar():setMaxValue(20)
+local button = mainFrame:addButton(function()
+    scrollbar:setIndex(1)
+end)
+```
+```xml
+<scrollbar index="2" />
+```
+
+## getIndex
+Returns the current index
+
+#### Returns:
+1. `number` index
+