Updated docs

There is still stuff to do

docs/objects/Object/getAbsolutePosition.md

@@ -0,0 +1,16 @@
+## getAbsolutePosition
+Converts the relative coordinates into absolute coordinates
+#### Parameters: 
+1. `number|nil` x
+2. `number|nil` y
+
+#### Returns:
+1. `object` The object in use
+
+#### Usage:
+* Creates a frame and a button and prints the button's absolute position to the debug console
+```lua
+local mainFrame = basalt.createFrame():setPosition(3,3)
+local aButton = mainFrame:addButton():setSize(8,1):setPosition(4,2)
+basalt.debug(aButton:getAbsolutePosition()) -- returns 7,5 (frame coords + own coords) instead of 4,2
+```

docs/objects/Object/getAnchorPosition.md

@@ -0,0 +1,21 @@
+## getAnchorPosition
+Converts the x and y coordinates into the anchor coordinates of the object
+
+#### Parameters: 
+1. `number|nil` x
+2. `number|nil` y, if nothing it uses the object's x, y
+
+#### Returns: 
+1. `number` x
+2. `number` y
+
+#### Usage:
+* Prints the anchor position to the debug console
+```lua
+local mainFrame = basalt.createFrame():setSize(15,15)
+local aButton = mainFrame:addButton()
+        :setAnchor("bottomRight")
+        :setSize(8,1)
+        :setPosition(1,1)
+basalt.debug(aButton:getAnchorPosition()) -- returns 7,14 (framesize - own size) instead of 1,1
+```

docs/objects/Object/getName.md

@@ -0,0 +1,17 @@
+## getName
+Returns the given name of the object
+
+#### Returns: 
+1. `string` name
+
+#### Usage:
+* Prints name of object to debug window
+```lua
+local main = basalt.createFrame()
+basalt.debug(main:getName()) -- returns the uuid
+```
+
+```lua
+local main = basalt.createFrame("myFirstMainFrame")
+basalt.debug(main:getName()) -- returns myFirstMainFrame
+```

docs/objects/Object/getValue.md

@@ -0,0 +1,12 @@
+## getValue
+Returns the currently saved value
+#### Returns: 
+1. `any` Object's value
+
+#### Usage:
+* Prints the value of the checkbox to the debug console
+```lua
+local mainFrame = basalt.createFrame()
+local aCheckbox = mainFrame:addCheckbox():setValue(true)
+basalt.debug(aCheckbox:getValue()) -- returns true
+```

docs/objects/Object/hide.md

@@ -0,0 +1,15 @@
+## hide
+Hides the object
+
+#### Returns:
+1. `object` The object in use
+
+#### Usage:
+* Hides a frame
+```lua
+local mainFrame = basalt.createFrame()
+local button = mainFrame:addButton():setText("Close"):onClick(function() mainFrame:hide() end)
+```
+```xml
+<button visible="false" />
+```

docs/objects/Object/isFocused.md

@@ -0,0 +1,13 @@
+## isFocused
+Returns if the object is currently the focused object of the parent frame
+
+#### Returns: 
+1. `boolean` Whether the object is focused
+
+#### Usage:
+* Prints whether the button is focused to the debug console
+```lua
+local mainFrame = basalt.createFrame()
+local aButton = mainFrame:addButton()
+basalt.debug(aButton:isFocused()) -- shows true or false as a debug message
+```

docs/objects/Object/isVisible.md

@@ -0,0 +1,12 @@
+## isVisible
+Returns if the object is currently visible
+#### Returns: 
+1. `boolean`
+
+#### Usage:
+* Prints boolean visibility of object to debug console
+```lua
+local mainFrame = basalt.createFrame()
+local aButton = mainFrame:addButton():setSize(5,8)
+basalt.debug(aButton:isVisible()) -- returns true
+```

docs/objects/Object/onChange.md

@@ -0,0 +1,28 @@
+# onChange
+`onChange(self)`<br>
+This is a custom event which gets triggered as soon as the function :setValue() is called. This function is also called by basalt, for example if you change the input, textfield or checkbox (or all the different types of lists) objects.
+
+Here is a example on how to add a onChange event to your input, and also another example for your checkbox:
+
+```lua
+local basalt = require("basalt")
+
+local main = basalt.createFrame()
+local aInput = main:addInput():setPosition(3,3)
+local aCheckbox = main:addCheckbox():setPosition(3,5)
+
+local function checkInput(input)
+    if(string.lower(input:getValue())=="hello")then
+        basalt.debug("Hello back!")
+    end
+end
+
+local function checkCheckbox(checkbox)
+    if(checkbox:getValue()==true)then -- or if(checkbox:getValue())then
+        basalt.debug("Checkbox is active, let's do something!")
+    end
+end
+
+aInput:onChange(checkInput)
+aCheckbox:onChange(checkCheckbox)
+```

docs/objects/Object/onClick.md

@@ -0,0 +1,20 @@
+# onClick
+`onClick(self, event, button, x, y)`<br>
+The computercraft event which triggers this method is `mouse_click` and `monitor_touch`.
+
+Here is a example on how to add a onClick event to your button:
+
+```lua
+local basalt = require("basalt")
+
+local main = basalt.createFrame()
+local button = main:addButton()
+  :setPosition(3,3)
+  :setSize(12,3)
+  :setText("Click")
+
+function buttonOnClick()
+  basalt.debug("Button got clicked!")
+end
+button:onClick(buttonOnClick)
+```

docs/objects/Object/onClickUp.md

@@ -0,0 +1,25 @@
+# onClickUp
+`onClickUp(self, event, button, x, y)`<br>
+The computercraft event which triggers this method is `mouse_up`.
+
+Here is a example on how to add a onClickUp event to your button:
+
+```lua
+local basalt = require("basalt")
+
+local main = basalt.createFrame()
+local button = main:addButton()
+  :setPosition(3,3)
+  :setSize(12,3)
+  :setText("Click")
+
+function buttonOnClick(self, button, x, y)
+  basalt.debug("Button got clicked!")
+end
+button:onClick(buttonOnClick)
+
+function buttonOnRelease(self, button, x, y)
+  basalt.debug("Button got released!")
+end
+button:onClickUp(buttonOnRelease)
+```

docs/objects/Object/onDrag.md

@@ -0,0 +1,20 @@
+# onDrag
+`onDrag(self, event, button, x, y, xOffset, yOffset)`<br>
+The computercraft event which triggers this method is `mouse_drag`.
+
+Here is a example on how to add a onDrag event to your button:
+
+```lua
+local basalt = require("basalt")
+
+local main = basalt.createFrame()
+local button = main:addButton()
+  :setPosition(3,3)
+  :setSize(12,3)
+  :setText("Click")
+
+function buttonOnDrag(self, button, x, y, xOffset, yOffset)
+  basalt.debug("Someone drags me (i know i wont reposition myself)!")
+end
+button:onDrag(buttonOnDrag)
+```

docs/objects/Object/onGetFocus.md

@@ -0,0 +1,16 @@
+# onGetFocus
+`onGetFocus(self)`<br>
+This event gets triggered as soon as the object is the currently focused object.
+
+```lua
+local basalt = require("basalt")
+
+local main = basalt.createFrame()
+local aButton = main:addButton()
+    :setPosition(3,3)
+    :onGetFocus(
+        function(self) 
+            basalt.debug("Welcome back!") 
+        end
+    )
+```

docs/objects/Object/onKey.md

@@ -0,0 +1,21 @@
+# onKey
+`onKey(self, event, key)`<br>
+The computercraft event which triggers this method is `key` and `char`.
+
+Here is a example on how to add a onKey event to your frame:
+
+```lua
+local basalt = require("basalt")
+
+local main = basalt.createFrame()
+local subFrame = main:addFrame()
+  :setPosition(3,3)
+  :setSize(18,6)
+
+function openSubFrame(self, event, key)
+  if(key==keys.c)then
+    subFrame:show()
+  end
+end
+main:onKey(openSubFrame)
+```

docs/objects/Object/onKeyUp.md

@@ -0,0 +1,21 @@
+# onKeyUp
+`onKeyUp(self, event, key)`<br>
+The computercraft event which triggers this method is `key_up`.
+
+Here is a example on how to add a onKeyUp event to your frame:
+
+```lua
+local basalt = require("basalt")
+
+local main = basalt.createFrame()
+local subFrame = main:addFrame()
+  :setPosition(3,3)
+  :setSize(18,6)
+
+function openSubFrame(self, event, key)
+  if(key==keys.c)then
+    subFrame:show()
+  end
+end
+main:onKeyUp(openSubFrame)
+```

docs/objects/Object/onLoseFocus.md

@@ -0,0 +1,16 @@
+# onLoseFocus
+`onLoseFocus(self)`<br>
+This event gets triggered as soon as the object loses its focus.
+
+```lua
+local basalt = require("basalt")
+
+local main = basalt.createFrame()
+local aButton = main:addButton()
+    :setPosition(3,3)
+    :onLoseFocus(
+        function(self) 
+            basalt.debug("Please come back...") 
+        end
+    )
+```

docs/objects/Object/onResize.md

@@ -0,0 +1,19 @@
+# onResize
+`onResize(self)`<br>
+This is a custom event which gets triggered as soon as the parent frame gets resized.
+
+Here is a example on how to add a onResize event to your button:
+
+```lua
+local basalt = require("basalt")
+
+local main = basalt.createFrame()
+local aButton = main:addButton():setPosition(3,3)
+
+local function onButtonResize(self)
+    local width = main:getWidth()
+    self:setSize(width, 3)
+end
+
+aButton:onResize(onButtonResize)
+```

docs/objects/Object/onScroll.md

@@ -0,0 +1,20 @@
+# onScroll
+`onScroll(self, event, direction, x, y)`<br>
+The computercraft event which triggers this method is `mouse_scroll`.
+
+Here is a example on how to add a onScroll event to your button:
+
+```lua
+local basalt = require("basalt")
+
+local main = basalt.createFrame()
+local button = main:addButton()
+  :setPosition(3,3)
+  :setSize(12,3)
+  :setText("Click")
+
+function buttonOnScroll(self, direction, x, y)
+  basalt.debug("Someone scrolls on me!")
+end
+button:onScroll(buttonOnScroll)
+```

docs/objects/Object/setAnchor.md

@@ -0,0 +1,21 @@
+## setAnchor
+Sets the anchor of the object
+
+#### Parameters: 
+1. `string` Anchor sides `("topLeft" "top", "topRight", "right", "bottomRight", "bottom", "bottomLeft", "left", "center")`
+
+#### Returns:
+1. `object` The object in use
+
+#### Usage:
+* Sets the button to have an anchor of `bottomRight`
+```lua
+local mainFrame = basalt.createFrame():show()
+local aButton = mainFrame:addButton()
+        :setAnchor("bottomRight")
+        :setSize(8,1)
+        :setPosition(-8,1)
+```
+```xml
+<button anchor="bottomRight" />
+```

docs/objects/Object/setBackground.md

@@ -0,0 +1,16 @@
+## setBackground
+Changes the object background color, if you set the value to false the background wont be visible. For example you could see trough a frame.
+#### Parameters: 
+1. `number|color` Background color
+
+#### Returns:
+1. `object` The object in use
+
+#### Usage:
+* Creates a frame, and sets its background color to `colors.gray`
+```lua
+local mainFrame = basalt.createFrame():setBackground(colors.gray)
+```
+```xml
+<button bg="gray" />
+```

docs/objects/Object/setBorder.md

@@ -0,0 +1,23 @@
+## setBorder
+Sets the border of that objects, if false the border will be removed<br>
+Default: false
+
+#### Parameters: 
+1. `number|color` Border color
+2. `string` optional - sides. If you don't set sides, all 4 sides will have a border
+
+#### Returns: 
+1. `object` The object in use
+
+#### Usage:
+* Sets the border to green and shows it:
+```lua
+local mainFrame = basalt.createFrame()
+local subFrame = mainFrame:addFrame()
+        :setMovable()
+        :setSize(18,6)
+        :setBorder(colors.green, "left", "right", "bottom")
+```
+```xml
+<frame width="18" height="6" borderColor="green" movable="true" />
+```

docs/objects/Object/setFocus.md

@@ -0,0 +1,13 @@
+## setFocus    
+Sets the object to be the focused object.
+If you click on an object, it's normally automatically the focused object. For example, if you call :show() on a frame, and you want this particular frame to be in
+the foreground, you should also use :setFocus()
+#### Returns:
+1. `object` The object in use
+
+#### Usage:
+* Sets the button to the focused object
+```lua
+local mainFrame = basalt.createFrame()
+local aButton = mainFrame:addButton():setFocus()
+```

docs/objects/Object/setForeground.md

@@ -0,0 +1,16 @@
+## setForeground
+Changes the object text color
+#### Parameters: 
+1. `number|color` Foreground color
+
+#### Returns:
+1. `object` The object in use
+
+#### Usage:
+* Creates a frame, and sets its foreground color to `colors.green`
+```lua
+local mainFrame = basalt.createFrame():setForeground(colors.green)
+```
+```xml
+<button fg="green" />
+```

docs/objects/Object/setParent.md

@@ -0,0 +1,19 @@
+## setParent
+Sets the parent frame of the object
+#### Parameters: 
+1. `frame` The to-be parent frame
+
+#### Returns:
+1. `object` The object in use
+
+#### Usage:
+* Sets the parent frame of the random frame, adding it to the main frame when the button is clicked"
+```lua
+local mainFrame = basalt.createFrame()
+local aRandomFrame = basalt.createFrame()
+local aButton = mainFrame:addButton():onClick(
+        function() 
+            aRandomFrame:setParent(mainFrame) 
+        end
+)
+```

docs/objects/Object/setPosition.md

@@ -0,0 +1,19 @@
+## setPosition
+Changes the position relative to its parent frame
+#### Parameters: 
+1. `number` x coordinate
+2. `number` y coordinate
+3. `boolean` Whether it will add/remove to the current coordinates instead of setting them
+
+#### Returns:
+1. `object` The object in use
+
+#### Usage:
+* Sets the Buttons position to an x coordinate of 2 with a y coordinate of 3
+```lua
+local mainFrame = basalt.createFrame()
+mainFrame:addButton():setPosition(2,3)
+```
+```xml
+<button x="2" y="3" />
+```

docs/objects/Object/setShadow.md

@@ -0,0 +1,22 @@
+## setShadow
+Sets the shadow color - default: false
+
+#### Parameters: 
+1. `number|color` Shadow color
+
+#### Returns: 
+1. `object` The object in use
+
+#### Usage:
+* Sets the shadow to green and shows it:
+```lua
+local mainFrame = basalt.createFrame()
+local subFrame = mainFrame:addFrame()
+        :setMovable()
+        :setSize(18,6)
+        :setShadow(colors.green)
+```
+Or: 
+```xml
+<frame width="18" height="6" shadowColor="green" movable="true" />
+```

docs/objects/Object/setSize.md

@@ -0,0 +1,18 @@
+## setSize
+Changes the object size
+#### Parameters: 
+1. `number` width
+2. `number` height
+
+#### Returns:
+1. `object` The object in use
+
+#### Usage:
+* Sets the frame to have a width of 15 and a height of 12
+```lua
+local mainFrame = basalt.createFrame()
+local subFrame = mainFrame:addFrame():setSize(15,12)
+```
+```xml
+<frame width="15" height="12" />
+```

docs/objects/Object/setValue.md

@@ -0,0 +1,17 @@
+## setValue
+Sets the value of that object (input, label, checkbox, textfield, scrollbar,...)
+#### Parameters: 
+1. `any` Value to set the object to
+
+#### Returns:
+1. `object` The object in use
+
+#### Usage:
+* Creates a checkbox and ticks it
+```lua
+local mainFrame = basalt.createFrame()
+local aCheckbox = mainFrame:addCheckbox():setValue(true)
+```
+```xml
+<checkbox value="true" />
+```

docs/objects/Object/setZIndex.md

@@ -0,0 +1,19 @@
+## setZIndex
+Sets the z-index. Higher value means higher draw/event priority. You can also add multiple objects to the same z-index, if so the last added object will have the highest priority.
+#### Parameters: 
+1. `number` z-index
+
+#### Returns:
+1. `object` The object in use
+
+#### Usage:
+* Sets the buttons z-index to `1` and the labels z-index to `2`
+```lua
+local mainFrame = basalt.createFrame()
+local aButton = mainFrame:addButton():setZIndex(1):setPosition(2,2)
+local aLabel = mainFrame:addButton():setZIndex(2):setPosition(2,2):setText("I am a label!")
+```
+```xml
+<button x="2" y="2" zIndex="1" />
+<label x="2" y="2" text="I am a label!" zIndex="2" />
+```

docs/objects/Object/show.md

@@ -0,0 +1,15 @@
+## show
+Shows the object (only if the parent frame is already visible)
+#### Returns:
+1. `object` The object in use
+
+#### Usage:
+* Shows a frame
+```lua
+local mainFrame = basalt.createFrame()
+local button = mainFrame:addButton()
+button:show()
+```
+```xml
+<button visible="true" />
+```