AttributedText
Text with styles.
| Module | require("gui") |
| Type | Class |
On Windows, due to the limitations of GdiPlus, it is only supported to change
the whole text's color and font, i.e. the SetFontFor and SetColorFor APIs
are unsupported.
Class methods
create(text, attributes)
Create an AttributedText.
Parameters
StringtextTextAttributesattributes
Return
AttributedTextMethods
setFormat(format)
Overwrite styles with format.
Parameters
TextFormatformat
getFormat()
Return current styles.
Return
TextFormatsetFont(font)
Set the whole text's font.
Parameters
Fontfont
setFontFor(font, start, end) macOS Linux
Set the font of text between character range [start, end). Passing
-1 as end means the rest of the text.
Parameters
FontfontIntegerstartIntegerend
setColor(color)
Set the whole text's color.
Parameters
Colorcolor
setColorFor(font, start, end) macOS Linux
Set the color of text between character range [start, end). Passing
-1 as end means the rest of the text.
Parameters
ColorfontIntegerstartIntegerend
clear()
Reset font and color to system default.
getBoundsFor(size)
Return the bounds required to draw the text within size.
Parameters
SizeFsize
Return
RectFsetText(text)
Change the text content.
Parameters
Stringtext
getText()
Return the plain text.
Return
String