deploy: e10d3c1ae8
This commit is contained in:
@@ -20,35 +20,12 @@ Extends: `VisualElement`
|
||||
|
||||
|Method|Returns|Description|
|
||||
|---|---|---|
|
||||
|[TextBox.new](#textbox-new)|TextBox|Creates a new TextBox instance|
|
||||
|[TextBox:init](#textbox-init-props-basalt)|TextBox|Initializes the TextBox instance|
|
||||
|[TextBox:addSyntaxPattern](#textbox-addsyntaxpattern-pattern-color)|TextBox|Adds a new syntax highlighting pattern|
|
||||
|[TextBox:removeSyntaxPattern](#textbox-removesyntaxpattern-index)|TextBox|Removes a syntax pattern by index (1-based)|
|
||||
|[TextBox:clearSyntaxPatterns](#textbox-clearsyntaxpatterns)|TextBox|Clears all syntax highlighting patterns|
|
||||
|[TextBox:updateViewport](#textbox-updateviewport)|TextBox|Updates the viewport to keep the cursor in view|
|
||||
|[TextBox:char](#textbox-char-char)|boolean|Handles character input|
|
||||
|[TextBox:key](#textbox-key-key)|boolean|Handles key events|
|
||||
|[TextBox:mouse_scroll](#textbox-mouse-scroll-direction-x-y)|boolean|Handles mouse scroll events|
|
||||
|[TextBox:mouse_click](#textbox-mouse-click-button-x-y)|boolean|Handles mouse click events|
|
||||
|[TextBox:paste](#textbox-paste)|-|Handles paste events|
|
||||
|[TextBox:setText](#textbox-settext-text)|TextBox|Sets the text of the TextBox|
|
||||
|[TextBox:getText](#textbox-gettext)|string|Gets the text of the TextBox|
|
||||
|[TextBox:render](#textbox-render)|-|Renders the TextBox with syntax highlighting|
|
||||
|
||||
## TextBox.new()
|
||||
|
||||
Creates a new TextBox instance
|
||||
|
||||
### Returns
|
||||
* `TextBox` `self` The newly created TextBox instance
|
||||
|
||||
## TextBox:init(props, basalt)
|
||||
### Parameters
|
||||
* `props` `table` The properties to initialize the element with
|
||||
* `basalt` `table` The basalt instance
|
||||
|
||||
### Returns
|
||||
* `TextBox` `self` The initialized instance
|
||||
|
||||
## TextBox:addSyntaxPattern(pattern, color)
|
||||
|
||||
@@ -85,39 +62,6 @@ Updates the viewport to keep the cursor in view
|
||||
### Returns
|
||||
* `TextBox` `self` The TextBox instance
|
||||
|
||||
## TextBox:char(char)
|
||||
### Parameters
|
||||
* `char` `string` The character that was typed
|
||||
|
||||
### Returns
|
||||
* `boolean` `handled` Whether the event was handled
|
||||
|
||||
## TextBox:key(key)
|
||||
### Parameters
|
||||
* `key` `number` The key that was pressed
|
||||
|
||||
### Returns
|
||||
* `boolean` `handled` Whether the event was handled
|
||||
|
||||
## TextBox:mouse_scroll(direction, x, y)
|
||||
### Parameters
|
||||
* `direction` `number` The scroll direction
|
||||
* `x` `number` The x position of the scroll
|
||||
* `y` `number` The y position of the scroll
|
||||
|
||||
### Returns
|
||||
* `boolean` `handled` Whether the event was handled
|
||||
|
||||
## TextBox:mouse_click(button, x, y)
|
||||
### Parameters
|
||||
* `button` `number` The button that was clicked
|
||||
* `x` `number` The x position of the click
|
||||
* `y` `number` The y position of the click
|
||||
|
||||
### Returns
|
||||
* `boolean` `handled` Whether the event was handled
|
||||
|
||||
## TextBox:paste()
|
||||
## TextBox:setText(text)
|
||||
|
||||
Sets the text of the TextBox
|
||||
@@ -134,5 +78,3 @@ Gets the text of the TextBox
|
||||
|
||||
### Returns
|
||||
* `string` `text` The text of the TextBox
|
||||
|
||||
## TextBox:render()
|
||||
Reference in New Issue
Block a user