diff --git a/docs/objects/Button.md b/docs/objects/Button.md index e9b4c6c..d093a71 100644 --- a/docs/objects/Button.md +++ b/docs/objects/Button.md @@ -1,24 +1,70 @@ -Buttons are objects, which execute function by clicking on them +Buttons are objects, which execute something by clicking on them.
-The following list is only available to buttons:
Remember button also inherits from [Object](objects/Object.md) ## setText Sets the displayed button text -```lua -local mainFrame = basalt.createFrame("myFirstFrame"):show() -local aButton = mainFrame:addButton("myFirstButton"):setText("Click"):show() -- you could also use :setValue() instead of :setText() - no difference -``` -#### Parameters: string text
-#### Returns: self
+#### Parameters: +1. `string` the text the button should show -# Examples -Add a onClick event: +#### Returns: +1. `object` The object in use + +#### Usage: +* Creates a button with "Click me!" as text. ```lua local mainFrame = basalt.createFrame("myFirstFrame"):show() -local aButton = mainFrame:addButton("myFirstButton"):setText("Click"):onClick(function(self,event,button,x,y) -if(event=="mouse_click")and(button==1)then -basalt.debug("Left mousebutton got clicked!") -end -end):show() -``` \ No newline at end of file +local button = mainFrame:addButton("myFirstButton"):setText("Click me!"):show() +``` + +## setHorizontalAlign +Sets the horizontal align of the button text + +#### Parameters: +1. `string` the position as string ("left", "center", "right") - default is center. + +#### Returns: +1. `object` The object in use + +#### Usage: +* Sets the button's horizontal text align to right. +```lua +local mainFrame = basalt.createFrame("myFirstFrame"):show() +local button = mainFrame:addButton("myFirstButton") + :setText("Click me!") + :setHorizontalAlign("right") + :show() +``` + +## setVerticalAlign +Sets the vertical align of the button text + +#### Parameters: +1. `string` the position as string ("top", "center", "bottom") - default is center. + +#### Returns: +1. `object` The object in use + +#### Usage: +* Sets the button's horizontal text align to right and the vertical text align to bottom. +```lua +local mainFrame = basalt.createFrame("myFirstFrame"):show() +local button = mainFrame:addButton("myFirstButton") + :setText("Click me!") + :setHorizontalAlign("right") + :setVerticalAlign("bottom") + :show() +``` + +# Example +This is a example on how you would create a fully working button: +```lua +local mainFrame = basalt.createFrame("myFirstFrame"):show() +local aButton = mainFrame:addButton("myFirstButton"):setText("Click"):show() + +aButton:onClick(function(self,event,button,x,y) + if(event=="mouse_click")and(button==1)then + basalt.debug("Left mousebutton got clicked!") + end +end) +```