diff --git a/Textfield.md b/Textfield.md index ea508b7..5c617ec 100644 --- a/Textfield.md +++ b/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: ````lua -local mainFrame = CreateFrame("myFirstFrame"):show() +local mainFrame = basalt.createFrame("myFirstFrame"):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. -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:
+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:** -
+**returns:** table lines
+ +## 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
+**returns:** string line
+ +## 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
+**returns:** self
+ +## 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
+**returns:** self
+ +## 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
+**returns:** self
+ +## getTextCursor +returns the cursor position +````lua +local mainFrame = basalt.createFrame("myFirstFrame"):show() +local aTextfield = mainFrame:addTextfield("myFirstTextfield"):show() +basalt.debug(aTextfield:getTextCursor()) +```` +**parameters:** -
+**returns:** number x, number y
\ No newline at end of file