GitHub/Basalt
1
0
Fork 0
Code Issues 28 Pull Requests 3 Actions Packages Projects Releases 9 Wiki Activity

Updated Textfield (markdown)

Robert Jelic
2022-05-02 22:22:19 +02:00
parent cf42f6f506
commit 5317a27cac
1 changed files with 63 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

66
Textfield.md

@@ -2,12 +2,72 @@ Textfields are objects, where the user can write something on multiple lines. it
Here is a example of how to create a default textfield: Here is a example of how to create a default textfield:
````lua ````lua
local mainFrame = CreateFrame("myFirstFrame"):show() local mainFrame = basalt.createFrame("myFirstFrame"):show()
local aTextfield = mainFrame:addTextfield("myFirstTextfield"):show() local aTextfield = mainFrame:addTextfield("myFirstTextfield"):show()
```` ````
This will create a default textfield with the size 10 width and 4 height on position 1 1 (relative to its parent frame), the default background is colors.gray, the default text color is colors.black and the default zIndex is 5. This will create a default textfield with the size 10 width and 4 height on position 1 1 (relative to its parent frame), the default background is colors.gray, the default text color is colors.black and the default zIndex is 5.
Here are all possible functions available for textfields. Remember textfield inherit from [object](https://github.com/NoryiE/NyoUI/wiki/Object): Here are all possible functions available for textfields:<br>
Remember textfield inherits from [object](https://github.com/NoryiE/NyoUI/wiki/Object):
There are currently no customizable functions, maybe i will add some in the future
## getLines
returns all lines
````lua
local mainFrame = basalt.createFrame("myFirstFrame"):show()
local aTextfield = mainFrame:addTextfield("myFirstTextfield"):show()
basalt.debug(aTextfield:getLines())
````
**parameters:** -<br>
**returns:** table lines<br>
## getLine
returns the line on index position
````lua
local mainFrame = basalt.createFrame("myFirstFrame"):show()
local aTextfield = mainFrame:addTextfield("myFirstTextfield"):show()
basalt.debug(aTextfield:getLine(2))
````
**parameters:** number index<br>
**returns:** string line<br>
## editLine
edits line on index position
````lua
local mainFrame = basalt.createFrame("myFirstFrame"):show()
local aTextfield = mainFrame:addTextfield("myFirstTextfield"):show()
aTextfield:editLine(2, "hellow")
````
**parameters:** number index, string text<br>
**returns:** self<br>
## addLine
adds a line on index position (if index is nil it just adds the line on the bottom)
````lua
local mainFrame = basalt.createFrame("myFirstFrame"):show()
local aTextfield = mainFrame:addTextfield("myFirstTextfield"):show()
aTextfield:addLine("hellow")
````
**parameters:** string text, number index<br>
**returns:** self<br>
## removeLine
removes the line on index position
````lua
local mainFrame = basalt.createFrame("myFirstFrame"):show()
local aTextfield = mainFrame:addTextfield("myFirstTextfield"):show()
aTextfield:removeLine(1)
````
**parameters:** number index<br>
**returns:** self<br>
## getTextCursor
returns the cursor position
````lua
local mainFrame = basalt.createFrame("myFirstFrame"):show()
local aTextfield = mainFrame:addTextfield("myFirstTextfield"):show()
basalt.debug(aTextfield:getTextCursor())
````
**parameters:** -<br>
**returns:** number x, number y<br>