SyntaxHighlighter QML Type

(BETA) Controls automatic color and font formatting in a TextEdit component. More...

• List of all members, including inherited members

Properties

• commentFormat : TextCharFormat
• currentBlockState : int
• identifierFormat : TextCharFormat
• keywordFormat : TextCharFormat
• language : url
• numberFormat : TextCharFormat
• previousBlockState : int
• stringFormat : TextCharFormat
• textDocument : object

Signals

• highlightBlockText(string text)

Methods

• rehighlight()
• setFormat(int start, int count, object format)

Detailed Description

The SyntaxHighlighter component allows color and style of text displayed to be automatically formatted in a TextEdit object. This component supports colorizing C++, JavaScript, Python, SQL, Windows INI and Shell. The syntax highlight is configured by a TextMate grammar file in JSON format.

This component is reponsible for colorizing keywords like 'if' or 'for' in JavaScript differently than strings, numbers, comments and variable names.

The following code sample illustrates a potential way to apply JavaScript syntax highlighting rules to a TextEdit component. In this example, the TextMate grammar file JavaScript.tmLanguage.json must also be included with the app:

Item {
    TextEdit {
        id: textEdit
        text: [
            "// JavaScript code snippet",
            "function sum(a, b) {",
            "    return a + b;",
            "}"
        ].join("\n")
    }

    SyntaxHighlighter {
        textDocument: textEdit.textDocument
        language: "JavaScript.tmLanguage.json"
    }
}

This component is in beta, and implementation is subject to change in future releases.

Property Documentation

Signal Documentation

Method Documentation