SyntaxHighlighter QML Type

Add syntax highlighting to QML text fields. More...

• List of all members, including inherited members

Properties

• definition : variant
• repository : Repository
• textEdit : QtObject
• theme : variant

Detailed Description

Syntax highlighting may be added to a text field by specifying a textEdit id and a definition.

The list of available definitions can be seen on the Kate website.

You can learn more about syntax highlighting definitions on the syntax-highlighting repository.

A custom repository containing syntax highlighting definitions may be set. See KSyntaxHighlighting::Repository for details.

A custom theme for the highlighting definitions may be set. The list of available themes can be seen on the repository's data/themes/ folder. The name to be used should match the name specified in the JSON metadata, and is case sensitive. For example:

{
  "metadata": {
    "name": "GitHub Dark"
  }
}

Basic usage:

import org.kde.syntaxhighlighting

// ...

SyntaxHighlighter {
    textEdit: sourceTextArea
    definition: "INI Files"
    theme: Repository.theme("GitHub Dark")
}

For more complex uses, the syntax definition might not be fixed but depend on input data (for example, derived from its mimetype or file name), or a user selection. In the C++ API this is enabled by the KSyntaxHighlighting::Repository class, which is available in QML as a singleton object.

The following example shows how to use this for a simple syntax selection combobox:

ComboBox {
   model: Repository.definitions
   displayText: currentValue.translatedName + " (" + currentValue.translatedSection + ")"
   textRole: "translatedName"
   onCurrentIndexChanged: myHighlighter.definition = currentValue
}

Handling color themes is also possible, similarly to syntax definitions. Themes can be listed, their properties can be accessed and they can be set by theme object or name on the highlighter. Like in the C++ API it's also possible to just ask for the light or dark default theme.

More examples can be seen in the repository's examples/ folder.

Property Documentation