Difference between revisions of "TextField:setText"

Latest revision as of 08:18, 18 October 2024

Available since: Gideros 2011.6
Class: TextField

Sets the text to be displayed.

TextField:setText(text)

Gideros accepts special escape sequences within the text to modify rendering, in the form of \e[key1=value1,key2=value2,...].

Value can be omitted (and the equal sign too in this case), in which case the effect specified by the key is reset to its default value.

Accepted keys are:

color: sets the color of the next characters, in the form #rgb, #rgba, #rrggbb or #rrggbbaa
font: specifies the font to use, relevant if the font is a CompositeFont

text: (string) the text to be displayed

@@ Line 1: / Line 1: @@
 __NOTOC__
-'''<translate>Available since</translate>:''' Gideros 2011.6<br/>
+'''Available since:''' Gideros 2011.6<br/>
-=== <translate>Description</translate> ===
+'''Class:''' [[TextField]]<br/>
-<translate><br />
-Sets the text to be displayed.<br />
+=== Description ===
-<br /></translate>
+Sets the text to be displayed.
-<source lang="lua">
+<syntaxhighlight lang="lua">
- TextField:setText(text)
+TextField:setText(text)
-</source>
+</syntaxhighlight>
-=== <translate>Parameters</translate> ===
-'''text''': (string) <translate>The text to be displayed.</translate> <br/>
+Gideros accepts special escape sequences within the text to modify rendering, in the form of \e[key1=value1,key2=value2,...].
+Value can be omitted (and the equal sign too in this case), in which case the effect specified by the key is reset to its default value.
+Accepted keys are:
+* color: sets the color of the next characters, in the form #rgb, #rgba, #rrggbb or #rrggbbaa
+* font: specifies the font to use, relevant if the font is a [[CompositeFont]]
+=== Parameters ===
+'''text''': (string) the text to be displayed<br/>
+{{TextField}}