Updated Scrollbar (markdown)

Robert Jelic
2022-04-02 15:12:16 +02:00
parent d9eb802481
commit 8832929c1e

@@ -1 +1,41 @@
WIP
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:
````lua
local mainFrame = NyoUI.createFrame("myFirstFrame"):show()
local aScrollbar = mainFrame:addScrollbar("myFirstScrollbar"):show()
````
This will create a default label with a size 5 width and 1 height on position 1 1 (relative to its parent frame), the default background is the colors.gray, the default text color is colors.black. the default bar type is vertical, the default symbol is " " and the default symbol color is colors.lightGray. The default zIndex is 5.
Here are all possible functions available for scrollbars. Remember scrollbar inherit from [object](https://github.com/NoryiE/NyoUI/wiki/Object):
## setSymbol
Changes the symbol
````lua
local mainFrame = NyoUI.createFrame("myFirstFrame"):show()
local aScrollbar = mainFrame:addScrollbar("myFirstScrollbar"):setSymbol("X"):show()
````
**args:** char<br>
**returns:** the object<br>
## setSymbolColor
Changes the symbol color
````lua
local mainFrame = NyoUI.createFrame("myFirstFrame"):show()
local aScrollbar = mainFrame:addScrollbar("myFirstScrollbar"):setSymbol("X"):setSymbolColor(colors.green):show()
````
**args:** color<br>
**returns:** the object<br>
## setBarType
If the bar goes vertically or horizontally
````lua
local mainFrame = NyoUI.createFrame("myFirstFrame"):show()
local aScrollbar = mainFrame:addScrollbar("myFirstScrollbar"):setBarType("horizontal"):show()
````
**args:** "vertical" or "horizontal"<br>
**returns:** the object<br>