docs

docs/objects/Textfield.md

@@ -55,8 +55,8 @@ basalt.debug(aTextfield:editLine(1, "Hello!"))
 Adds a line on index position
 
 #### Parameteres:
-1. `number` index
-2. `string` text
+1. `string` text
+2. `number` index
 
 #### Returns:
 1. `object` The object in use
@@ -66,7 +66,15 @@ Adds a line on index position
 ```lua
 local mainFrame = basalt.createFrame("myFirstFrame"):show()
 local aTextfield = mainFrame:addTextfield("myFirstTextfield"):show()
-basalt.debug(aTextfield:addLine(1, "Hello!"))
+basalt.debug(aTextfield:addLine("Hello!", 1))
+```
+
+```xml
+<textfield>
+    <lines>
+        <line>Hello!</line>
+    </lines>
+</textfield>
 ```
 
 ## removeLine
@@ -93,3 +101,64 @@ Gets text cursor position
 #### Returns:
 1. `number` x position
 2. `number` y position
+
+## addKeywords
+Adds keywords for special coloring
+
+#### Parameteres:
+1. `number|color` color of your choice
+2. `table` a list of keywords which should be colored example: {"if", "else", "then", "while", "do"}
+
+#### Returns:
+1. `object` The object in use
+
+#### Usage:
+* Changes the color of some words to purple
+```lua
+local mainFrame = basalt.createFrame()
+local aTextfield = mainFrame:addTextfield():addKeywords(colors.purple, {"if", "else", "then", "while", "do", "hello"})
+```
+
+```xml
+<textfield>
+    <keywords>
+        <purple>
+            <keyword>if</keyword>
+            <keyword>else</keyword>
+            <keyword>then</keyword>
+            <keyword>while</keyword>
+            <keyword>do</keyword>
+            <keyword>hello</keyword>
+        </purple>
+    </keywords>
+</textfield>
+```
+
+## addRule
+Adds a new rule for special coloring
+
+#### Parameteres:
+1. `string` a pattern - check out this page: (https://riptutorial.com/lua/example/20315/lua-pattern-matching)
+2. `number|color` text color
+3. `number|color` background color - optional
+
+#### Returns:
+1. `object` The object in use
+
+#### Usage:
+* Changes the color of all numbers
+```lua
+local mainFrame = basalt.createFrame()
+local aTextfield = mainFrame:addTextfield():addRule("%d", colors.lightBlue)
+```
+
+```xml
+<textfield>
+    <rules>
+        <rule>
+            <pattern>%d</pattern>
+            <fg>lightBlue</fg>
+        </rule>
+    </rules>
+</textfield>
+```