Files
Basalt/docs/objects/Pane.md
Robert Jelic d78bb4d141 Docs - panes
changed panes to make it more clear why they exist
2022-10-21 21:13:09 +02:00

42 lines
1.3 KiB
Markdown

Panes are here to do some visual background modifying, without listening (by default) to any events.
Because panes don't have any unique functionality, there is also no method list for them.
[Object](objects/Object.md) methods also apply for panes.
## Example
```lua
local mainFrame = basalt.createFrame()
local aPane = mainFrame:addPane()
aPane:setSize(30, 10)
aPane:setBackground(colors.yellow)
aPane:show()
```
```xml
<pane width="30" height="10" bg="yellow" />
```
### Other examples
!["pane-example-1"](../_media/pane-example-1.png)
```lua
main:addPane():setSize(15, 8):setPosition(2, 2):setBackground(colors.red)
main:addPane():setSize(15, 8):setPosition(18, 2):setBackground(colors.blue, "#")
main:addPane():setSize(15, 8):setPosition(17 * 2, 2):setBackground(colors.green, "#", colors.orange)
```
You could also create a 1-line height pane with dynamic width:
!["pane-example-2"](../_media/pane-example-2.png)
```lua
main:addPane():setSize("parent.w - 2", 1):setPosition(2, 2):setBackground(false, "\140", colors.blue)
main:addPane():setSize("parent.w - 2", 1):setPosition(2, 4):setBackground(colors.black, "\45", colors.red)
main:addPane():setSize("parent.w - 2", 1):setPosition(2, 6):setBackground(false, "\183", colors.purple)
```
You can also do that in y instead of x direction.