Gambas Documentation
Documents

TextHighlighter (gb.highlight)

This class is the parent class of all syntax highlighters.

It allows to create a custom highlighter based on a definition file.

This class can be used like an object by creating a hidden instance on demand.

This class is creatable.

This class acts like a read-only static array.

Static properties
List   Return the list of all registered syntax highlighters.

Static methods
GetName   Return the display name of an highlighter from its internal name.
Register   Register a custom highlighter based on a definition file.

Properties
CanRewrite   Return or set if the highlighter is allowed to rewrite the text to highlight.
Comment   Return or set if the highlighted text is a comment.
Key   Return the highlighter internal name.
Keywords   Return the list of keywords associated with the highlighter.
LengthAdded   Return or set the number of characters added (or removed) after the text has been rewritten.
Limit   Return or set if the highlighted text is a function limit.
Name   Return the highlighter display name.
States   Return the list of state names used by the highlighter.
TextAfter   Return or set the highlighted text after it has been rewritten.

Methods
Paint   Paint highlighted text on the current painter.
RegisterState   Register a state for that highlighter.
Run   Highlight some piece of text.
ToANSI   Return the result of text highlighting as VT100 ANSI characters that can be printed on a terminal.
ToHTML   Return the result of text highlighting as HTML.
ToRichText   Return the result of text highlighting as rich text.