QSyntaxHighlighter Class

Dokumentation der Mitgliedsfunktionen

[explicit] QSyntaxHighlighter::QSyntaxHighlighter(QObject *parent)

Konstruiert einen QSyntaxHighlighter mit dem angegebenen parent.

Wenn der Elternteil ein QTextEdit ist, wird der Syntax-Highlighter auf dem Elterndokument installiert. Die angegebene QTextEdit wird auch der Besitzer des QSyntaxHighlighters.

[explicit] QSyntaxHighlighter::QSyntaxHighlighter(QTextDocument *parent)

Konstruiert einen QSyntaxHighlighter und installiert ihn auf parent. Der angegebene QTextDocument wird auch Eigentümer des QSyntaxHighlighters.

[virtual noexcept] QSyntaxHighlighter::~QSyntaxHighlighter()

Destruktor. Deinstalliert diesen Syntax-Highlighter aus dem Textdokument.

[protected] QTextBlock QSyntaxHighlighter::currentBlock() const

Gibt den aktuellen Textblock zurück.

[protected] int QSyntaxHighlighter::currentBlockState() const

Gibt den Zustand des aktuellen Textblocks zurück. Wird kein Wert gesetzt, ist der Rückgabewert -1.

Siehe auch setCurrentBlockState().

[protected] QTextBlockUserData *QSyntaxHighlighter::currentBlockUserData() const

Gibt das Objekt QTextBlockUserData zurück, das zuvor an den aktuellen Textblock angehängt war.

Siehe auch QTextBlock::userData() und setCurrentBlockUserData().

QTextDocument *QSyntaxHighlighter::document() const

Gibt die QTextDocument zurück, auf der dieser Syntax-Highlighter installiert ist.

Siehe auch setDocument().

[protected] QTextCharFormat QSyntaxHighlighter::format(int position) const

Gibt das Format unter position innerhalb des aktuellen Textblocks des Syntax-Highlighters zurück.

Siehe auch setFormat().

[pure virtual protected] void QSyntaxHighlighter::highlightBlock(const QString &text)

Hebt den angegebenen Textblock hervor. Diese Funktion wird bei Bedarf von der Rich-Text-Engine aufgerufen, d.h. bei Textblöcken, die sich geändert haben.

Um Ihre eigene Syntaxhervorhebung bereitzustellen, müssen Sie die Unterklasse QSyntaxHighlighter verwenden und highlightBlock() neu implementieren. In Ihrer Neuimplementierung sollten Sie die text des Blocks analysieren und setFormat() so oft wie nötig aufrufen, um die von Ihnen benötigten Schrift- und Farbänderungen vorzunehmen. Zum Beispiel:

void MyHighlighter::highlightBlock(const QString &text)
{
    QTextCharFormat myClassFormat;
    myClassFormat.setFontWeight(QFont::Bold);
    myClassFormat.setForeground(Qt::darkMagenta);

    QRegularExpression expression("\\bMy[A-Za-z]+\\b");
    QRegularExpressionMatchIterator i = expression.globalMatch(text);
    while (i.hasNext()) {
        QRegularExpressionMatch match = i.next();
        setFormat(match.capturedStart(), match.capturedLength(), myClassFormat);
    }
}

Siehe Detailed Description für Beispiele zur Verwendung von setCurrentBlockState(), currentBlockState() und previousBlockState(), um Syntaxen mit Konstrukten zu behandeln, die sich über mehrere Textblöcke erstrecken.

Siehe auch previousBlockState(), setFormat(), und setCurrentBlockState().

[protected] int QSyntaxHighlighter::previousBlockState() const

Gibt den Endzustand des Textblocks zurück, der vor dem aktuellen Block des Syntax-Highlighters liegt. Wurde zuvor kein Wert gesetzt, ist der Rückgabewert -1.

Siehe auch highlightBlock() und setCurrentBlockState().

[slot] void QSyntaxHighlighter::rehighlight()

Wendet die Hervorhebung erneut auf das gesamte Dokument an.

Siehe auch rehighlightBlock().

[slot] void QSyntaxHighlighter::rehighlightBlock(const QTextBlock &block)

Wendet die Hervorhebung auf die angegebene QTextBlock block an.

Siehe auch rehighlight().

[protected] void QSyntaxHighlighter::setCurrentBlockState(int newState)

Setzt den Status des aktuellen Textblocks auf newState.

Siehe auch currentBlockState() und highlightBlock().

[protected] void QSyntaxHighlighter::setCurrentBlockUserData(QTextBlockUserData *data)

Hängt das angegebene data an den aktuellen Textblock an. Der Besitz wird an das zugrundeliegende Textdokument übergeben, d.h. das angegebene QTextBlockUserData Objekt wird gelöscht, wenn der entsprechende Textblock gelöscht wird.

QTextBlockUserData kann verwendet werden, um eigene Einstellungen zu speichern. Im Falle der Syntaxhervorhebung ist es insbesondere als Zwischenspeicher für Informationen interessant, die man beim Parsen des Absatzes herausfinden kann.

Beispielsweise können Sie während des Parsens des Textes die Klammerzeichen, auf die Sie stoßen ('{[(' und dergleichen), im Auge behalten und ihre relative Position und die tatsächliche QChar in einer einfachen Klasse speichern, die von QTextBlockUserData abgeleitet ist:

struct ParenthesisInfo
{
    QChar character;
    int position;
};

struct BlockData : public QTextBlockUserData
{
    QList<ParenthesisInfo> parentheses;
};

Während der Cursornavigation im zugehörigen Editor können Sie das aktuelle QTextBlock (das mit der Funktion QTextCursor::block() abgerufen wird) fragen, ob es ein Benutzerdatenobjekt enthält, und es in Ihr BlockData -Objekt umwandeln. Dann können Sie prüfen, ob die aktuelle Cursorposition mit einer zuvor aufgezeichneten Klammerposition übereinstimmt, und je nach Art der Klammer (öffnend oder schließend) die nächste öffnende oder schließende Klammer auf derselben Ebene finden.

Auf diese Weise können Sie einen visuellen Klammerabgleich durchführen und von der aktuellen Cursorposition bis zur passenden Klammer markieren. Das macht es einfacher, eine fehlende Klammer in Ihrem Code zu erkennen und die entsprechende öffnende/schließende Klammer zu finden, wenn Sie klammerintensiven Code bearbeiten.

Siehe auch currentBlockUserData() und QTextBlock::setUserData().

void QSyntaxHighlighter::setDocument(QTextDocument *doc)

Installiert den Syntax-Highlighter auf dem angegebenen QTextDocument doc . Ein QSyntaxHighlighter kann jeweils nur für ein Dokument verwendet werden.

Siehe auch document().

[protected] void QSyntaxHighlighter::setFormat(int start, int count, const QTextCharFormat &format)

Diese Funktion wird auf den aktuellen Textblock des Syntaxhervorhebers angewendet (d.h. den Text, der an die Funktion highlightBlock() übergeben wird).

Der angegebene format wird auf den Text ab der Position start für eine Länge von count Zeichen angewandt (wenn count gleich 0 ist, wird nichts getan). Die in format eingestellten Formatierungseigenschaften werden bei der Anzeige mit den direkt im Dokument gespeicherten Formatierungsinformationen zusammengeführt, wie sie z. B. zuvor mit den Funktionen von QTextCursor eingestellt wurden. Beachten Sie, dass das Dokument selbst durch das mit dieser Funktion gesetzte Format nicht verändert wird.

Siehe auch format() und highlightBlock().

[protected] void QSyntaxHighlighter::setFormat(int start, int count, const QColor &color)

Dies ist eine überladene Funktion.

Die angegebene color wird auf den aktuellen Textblock ab der Position start für eine Länge von count Zeichen angewendet.

Die anderen Attribute des aktuellen Textblocks, z. B. die Schriftart und die Hintergrundfarbe, werden auf die Standardwerte zurückgesetzt.

Siehe auch format() und highlightBlock().

[protected] void QSyntaxHighlighter::setFormat(int start, int count, const QFont &font)

Dies ist eine überladene Funktion.

Die angegebene font wird auf den aktuellen Textblock ab der Position start für eine Länge von count Zeichen angewendet.

Die anderen Attribute des aktuellen Textblocks, z. B. die Schriftart und die Hintergrundfarbe, werden auf die Standardwerte zurückgesetzt.

Siehe auch format() und highlightBlock().