QSyntaxHighlighter Class

Dokumentation zu Mitgliedsfunktionen

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

Erstellt einen QSyntaxHighlighter mit dem angegebenen „ parent “.

Ist das übergeordnete Element ein ` QTextEdit`, wird der Syntax-Highlighter im Dokument des übergeordneten Elements installiert. Das angegebene ` QTextEdit ` wird zudem zum Eigentümer des `QSyntaxHighlighter`.

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

Erstellt einen QSyntaxHighlighter und fügt ihn unter parent ein. Die angegebene QTextDocument wird zudem zum Eigentümer des QSyntaxHighlighter.

[virtual noexcept] QSyntaxHighlighter::~QSyntaxHighlighter()

Destruktor. Entfernt diesen Syntax-Highlighter aus dem Textdokument.

[protected] QTextBlock QSyntaxHighlighter::currentBlock() const

Gibt den aktuellen Textblock zurück.

[protected] int QSyntaxHighlighter::currentBlockState() const

Gibt den Status des aktuellen Textblocks zurück. Wenn kein Wert festgelegt ist, beträgt der Rückgabewert -1.

Siehe auch „ setCurrentBlockState()“.

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

Gibt das QTextBlockUserData -Objekt 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)

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

Um eine eigene Syntaxhervorhebung bereitzustellen, müssen Sie eine Unterklasse von ` QSyntaxHighlighter ` erstellen und die Methode `highlightBlock()` neu implementieren. In Ihrer Neuimplementierung sollten Sie die ` text ` des Blocks analysieren und die Methode ` setFormat()` so oft wie nötig aufrufen, um die von Ihnen gewünschten Schriftart- und Farbänderungen anzuwenden. 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);
    }
}

Beispiele für die Verwendung von ` setCurrentBlockState()`, ` currentBlockState()` und ` previousBlockState()` zur Verarbeitung von Syntaxen mit Konstrukten, die sich über mehrere Textblöcke erstrecken, finden Sie in der Dokumentation zu ` Detailed Description `.

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

[protected] int QSyntaxHighlighter::previousBlockState() const

Gibt den Endzustand des Textblocks zurück, der dem aktuellen Block des Syntax-Highlighters vorausgeht. Wenn zuvor kein Wert festgelegt wurde, ist der zurückgegebene Wert -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 erneut auf die angegebene URL 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)

Fügt das angegebene ` data ` an den aktuellen Textblock an. Die Eigentumsrechte werden an das zugrunde liegende Textdokument weitergegeben, d. h. das bereitgestellte ` QTextBlockUserData `-Objekt wird gelöscht, wenn der entsprechende Textblock gelöscht wird.

QTextBlockUserData kann zum Speichern benutzerdefinierter Einstellungen verwendet werden. Im Falle der Syntaxhervorhebung ist dies insbesondere als Cache-Speicher für Informationen interessant, die Sie beim Parsen des Absatztextes ermitteln.

Beispielsweise können Sie beim Parsen des Textes Klammerzeichen, auf die Sie stoßen („{[(“ und dergleichen), nachverfolgen und deren relative Position sowie den tatsächlichen „ QChar “ in einer einfachen, von „ QTextBlockUserData “ abgeleiteten Klasse speichern:

struct ParenthesisInfo
{
    QChar character;
    int position;
};

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

Während der Cursornavigation im zugehörigen Editor kannst du beim aktuellen „ QTextBlock “ (abgerufen mit der Funktion „ QTextCursor::block()“) abfragen, ob ein Benutzerdatenobjekt festgelegt ist, und dieses in dein „ BlockData “-Objekt umwandeln. Anschließend können Sie prüfen, ob die aktuelle Cursorposition mit einer zuvor erfassten Klammerposition übereinstimmt, und je nach Klammerart (öffnende oder schließende Klammer) die nächste öffnende oder schließende Klammer auf derselben Ebene ermitteln.

Auf diese Weise können Sie einen visuellen Klammerabgleich durchführen und den Bereich von der aktuellen Cursorposition bis zur passenden Klammer hervorheben. Das erleichtert es, eine fehlende Klammer in Ihrem Code zu erkennen und bei der Bearbeitung von Code mit vielen Klammern zu finden, wo sich eine entsprechende öffnende bzw. schließende Klammer befindet.

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

void QSyntaxHighlighter::setDocument(QTextDocument *doc)

Installiert den Syntax-Highlighter unter der angegebenen Adresse 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 Syntax-Highlighters angewendet (d. h. auf den Text, der an die Funktion ` highlightBlock()` übergeben wird).

Der angegebene ` format ` wird auf den Text ab der Position ` start ` über eine Länge von ` count ` Zeichen angewendet (wenn ` count ` gleich 0 ist, erfolgt keine Aktion). Die in ` format ` festgelegten Formatierungseigenschaften werden zur Anzeigezeit mit den direkt im Dokument gespeicherten Formatierungsinformationen zusammengeführt, die beispielsweise zuvor mit den Funktionen von ` QTextCursor` festgelegt wurden. Beachten Sie, dass das Dokument selbst durch die über diese Funktion festgelegte Formatierung unverändert bleibt.

Siehe auch format() und highlightBlock().

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

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

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

Siehe auch format() und highlightBlock().

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

Die angegebene Formatierung „ font “ wird auf den aktuellen Textblock ab der Position „ start “ über eine Länge von „ count “ Zeichen angewendet.

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

Siehe auch format() und highlightBlock().