Documentation
¶
Overview ¶
Base class for syntax highlighters. Provides syntax highlighting data to a graphics.gd/classdb/TextEdit. The associated graphics.gd/classdb/TextEdit will call into the graphics.gd/classdb/SyntaxHighlighter on an as-needed basis.
Note: A graphics.gd/classdb/SyntaxHighlighter instance should not be used across multiple graphics.gd/classdb/TextEdit nodes.
Index ¶
- type Advanced
- type Any
- type Entry
- type Extension
- type ID
- type Implementation
- type Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsRefCounted() [1]gd.RefCounted
- func (self Instance) AsResource() Resource.Instance
- func (self Instance) AsSyntaxHighlighter() Instance
- func (self Instance) ClearHighlightingCache()
- func (self Instance) GetLineSyntaxHighlighting(line int) map[int]Entry
- func (self Instance) GetTextEdit() TextEdit.Instance
- func (self Instance) ID() ID
- func (self Instance) Set(peer TextEdit.Instance)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) UpdateCache()
- func (self Instance) Virtual(name string) reflect.Value
- type Interface
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Advanced ¶
type Advanced = class
Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.
type Extension ¶
Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this [Extension]See Interface for methods that can be overridden by T.
func (*Extension[T]) AsRefCounted ¶
func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted
func (*Extension[T]) AsResource ¶
func (*Extension[T]) AsSyntaxHighlighter ¶
type ID ¶
ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.
type Implementation ¶
type Implementation = implementation
Implementation implements Interface with empty methods.
type Instance ¶
type Instance [1]gdclass.SyntaxHighlighter
Instance of the class with convieniently typed arguments and results.
var Nil Instance
Nil is a nil/null instance of the class. Equivalent to the zero value.
func (Instance) AsRefCounted ¶
func (self Instance) AsRefCounted() [1]gd.RefCounted
func (Instance) AsResource ¶
func (Instance) AsSyntaxHighlighter ¶
func (Instance) ClearHighlightingCache ¶
func (self Instance) ClearHighlightingCache()
Clears all cached syntax highlighting data.
Then calls overridable method [Interface.ClearHighlightingCache].
func (Instance) GetLineSyntaxHighlighting ¶
Returns the syntax highlighting data for the line at index 'line'. If the line is not cached, calls [Interface.GetLineSyntaxHighlighting] first to calculate the data.
Each entry is a column number containing a nested data structure. The column number denotes the start of a region, the region will end if another region is found, or at the end of the line. The nested data structure contains the data for that region. Currently only the key "color" is supported.
Example: Possible return value. This means columns 0 to 4 should be red, and columns 5 to the end of the line should be green:
func (Instance) GetTextEdit ¶
Returns the associated graphics.gd/classdb/TextEdit node.
func (Instance) UpdateCache ¶
func (self Instance) UpdateCache()
Clears then updates the graphics.gd/classdb/SyntaxHighlighter caches. Override [Interface.UpdateCache] for a callback.
Note: This is called automatically when the associated graphics.gd/classdb/TextEdit node, updates its own cache.
type Interface ¶
type Interface interface {
// Virtual method which can be overridden to return syntax highlighting data.
//
// See [Instance.GetLineSyntaxHighlighting] for more details.
GetLineSyntaxHighlighting(line int) map[int]Entry
// Virtual method which can be overridden to clear any local caches.
ClearHighlightingCache()
// Virtual method which can be overridden to update any local caches.
UpdateCache()
}
Source Files