diff --git a/docs/_media/pane-example-1.png b/docs/_media/pane-example-1.png new file mode 100644 index 0000000..f4412bf Binary files /dev/null and b/docs/_media/pane-example-1.png differ diff --git a/docs/_media/pane-example-2.png b/docs/_media/pane-example-2.png new file mode 100644 index 0000000..99e5c70 Binary files /dev/null and b/docs/_media/pane-example-2.png differ diff --git a/docs/objects/Pane.md b/docs/objects/Pane.md index f0d9c23..c500169 100644 --- a/docs/objects/Pane.md +++ b/docs/objects/Pane.md @@ -1,10 +1,10 @@ -With panes you are able to create background without any functionality +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. +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: +## Example ```lua local mainFrame = basalt.createFrame() @@ -13,6 +13,29 @@ aPane:setSize(30, 10) aPane:setBackground(colors.yellow) aPane:show() ``` + ```xml -``` \ No newline at end of file +``` + +### 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.