Difference between revisions of "TextField:setText"

From GiderosMobile
m (Text replacement - "</source>" to "</syntaxhighlight>")
 
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
'''Available since:''' Gideros 2011.6<br/>
 
'''Available since:''' Gideros 2011.6<br/>
 +
'''Class:''' [[TextField]]<br/>
 +
 
=== Description ===
 
=== Description ===
<br />
+
Sets the text to be displayed.
Sets the text to be displayed.<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.<br />
<br />
+
Accepted keys are:
<source lang="lua">
+
* color: Set the color of the next characters, in the form #rgb, #rgba, #rrggbb or #rrggbbaa
TextField:setText(text)
+
* font: Specify the font to use, relevant if the font is a [[CompositeFont]]
</source>
+
 
 +
<syntaxhighlight lang="lua">
 +
TextField:setText(text)
 +
</syntaxhighlight>
 +
 
 
=== Parameters ===
 
=== Parameters ===
'''text''': (string) The text to be displayed. <br/>
+
'''text''': (string) the text to be displayed<br/>
 +
 
 +
{{TextField}}

Latest revision as of 15:33, 13 July 2023

Available since: Gideros 2011.6
Class: TextField

Description

Sets the text to be displayed. 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: Set the color of the next characters, in the form #rgb, #rgba, #rrggbb or #rrggbbaa
  • font: Specify the font to use, relevant if the font is a CompositeFont
TextField:setText(text)

Parameters

text: (string) the text to be displayed