Gambas Documentation
Application Repository
Code Snippets
Compilation & Installation
Components
gb
gb.args
gb.cairo
gb.chart
gb.clipper
gb.complex
gb.compress
gb.crypt
gb.data
gb.db
gb.db.form
gb.db.mysql
gb.db.odbc
gb.db.postgresql
gb.db.sqlite2
gb.db.sqlite3
gb.dbus
gb.dbus.trayicon
gb.debug
gb.desktop
gb.desktop.gnome.keyring
gb.desktop.x11
gb.eval
gb.eval.highlight
gb.form
gb.form.dialog
gb.form.editor
_TextEditor_Line
_texteditor_styles
_texteditorstyle
TextEditor
_get
_new
added ?
Bookmarks
Border
Breakpoints
Clear
CloseBraces
CloseStrings
Column
Copy
Count
Current
Cut
DiffMode
EndOfLine
FindNextString
FindPreviousString
Font
Goto
GotoCenter
Highlight
Highlight
Length
Line
Load
LowerCase
Mode
Overwrite
ReadOnly
Redo
Scroll
ScrollBar
SelectedText
ShowBraces
ShowIndent
ShowLineNumber
ShowModified
ShowPosition
ShowPreview
ShowSpaces
Styles
Text
ToColumn
ToLine
ToPos
Undo
UpperCase
Wrap
gb.form.htmlview
gb.form.mdi
gb.form.print
gb.form.stock
gb.form.terminal
gb.gmp
gb.gsl
gb.gtk
gb.gtk.opengl
gb.gtk3
gb.gtk3.opengl
gb.gtk3.webview
gb.gui
gb.gui.opengl
gb.gui.qt
gb.gui.qt.ext
gb.gui.qt.opengl
gb.gui.qt.webkit
gb.gui.trayicon
gb.gui.webview
gb.hash
gb.highlight
gb.image
gb.image.effect
gb.image.imlib
gb.image.io
gb.inotify
gb.jit
gb.libxml
gb.logging
gb.map
gb.markdown
gb.media
gb.media.form
gb.memcached
gb.mime
gb.mongodb
gb.mysql
gb.ncurses
gb.net
gb.net.curl
gb.net.pop3
gb.net.smtp
gb.openal
gb.opengl
gb.opengl.glsl
gb.opengl.glu
gb.opengl.sge
gb.openssl
gb.option
gb.pcre
gb.pdf
gb.poppler
gb.qt4
gb.qt4.ext
gb.qt4.opengl
gb.qt4.webkit
gb.qt4.webview
gb.qt5
gb.qt5.ext
gb.qt5.opengl
gb.qt5.webkit
gb.qt5.webview
gb.qt6
gb.qt6.ext
gb.qt6.opengl
gb.qt6.webview
gb.report
gb.report2
gb.scanner
gb.sdl
gb.sdl.sound
gb.sdl2
gb.sdl2.audio
gb.settings
gb.signal
gb.term
gb.test
gb.util
gb.util.web
gb.v4l
gb.vb
gb.web
gb.web.feed
gb.web.form
gb.web.gui
gb.xml
gb.xml.html
gb.xml.rpc
gb.xml.xslt
Controls pictures
Deprecated components
Developer Documentation
Development Environment Documentation
Documents
Error Messages
Gambas Playground
How To's
Language Index
Language Overviews
Last Changes
Lexicon
README
Search the wiki
To Do
Topics
Tutorials
Wiki License
Wiki Manual

Event TextEditor.Highlight (gb.form.editor)

Event Highlight ( Text As String )

This event is raised when a text line must be highlighted.

  • Text if the text to highlight.

This event is only raised when the Highlight property is set to "custom", "none" or a null string.

How to highlight?

Custom highlighting of the give text line is done by using the static methods of the TextHighlighter class of the gb.eval.highlight component.

The State and Tag properties represent the state of the highlighter.

They are initialized with the final state of the highlighter at the previous line, or with zero if we are highlighting the first line.

The highlight itself is done by calling the TextHighlighter.Add method repeatedly to give a style constant to each character of the line until everything is highlighted.

Finally the state properties must be filled with the final state of the highlighter after the current line has been highlighted.

Example

Here is the highlighting of the diff command output.

Public Sub Editor_Highlight(Text As String)
  
  If Text Begins "<<<<<<" Then 
    TextHighlighter.Add(Highlight.Custom, String.Len(Text))
    TextHighlighter.State = Highlight.Custom
  Else If Text Begins "======" Then
    TextHighlighter.Add(Highlight.Comment, String.Len(Text))
    TextHighlighter.State = Highlight.Normal
    TextHighlighter.Tag = 1
  Else If Text Begins ">>>>>>" Then
    TextHighlighter.Add(Highlight.Custom + 1, String.Len(Text))
    TextHighlighter.State = Highlight.Custom + 1
    TextHighlighter.Tag = 2
  Else
    If TextHighlighter.Tag = 1 Then 
      TextHighlighter.State = Highlight.Custom + 1
      TextHighlighter.Tag = 0
    Else If TextHighlighter.Tag = 2 Then 
      TextHighlighter.State = Highlight.Normal
      TextHighlighter.Tag = 0
    Endif
    
    TextHighlighter.Add(TextHighlighter.State, String.Len(Text))
    
  Endif
  
End