QSyntaxHighlighter 类

成员函数文档

[显式构造函数] QSyntaxHighlighter::QSyntaxHighlighter(QObject *parent)

使用指定的 parent 构建 QSyntaxHighlighter。

如果父控件是QTextEdit，它会在父控件的文档上安装语法高亮器。指定的QTextEdit也将成为QSyntaxHighlighter的所有者。

[显式] QSyntaxHighlighter::QSyntaxHighlighter(QTextDocument *parent)

构造一个QSyntaxHighlighter并将其安装到parent上。指定的QTextDocument也将成为QSyntaxHighlighter的所有者。

[虚函数 noexcept] QSyntaxHighlighter::~QSyntaxHighlighter()

析构函数。从文本文档中卸载此语法高亮器。

[受保护] QTextBlock QSyntaxHighlighter::currentBlock() const

返回当前文本块。

[受保护] int QSyntaxHighlighter::currentBlockState() const

返回当前文本块的状态。如果没有设置值，则返回的值是-1。

另见setCurrentBlockState。

[受保护] QTextBlockUserData *QSyntaxHighlighter::currentBlockUserData() const

返回先前附加到当前文本块的QTextBlockUserData对象。

另见QTextBlock::userData和setCurrentBlockUserData。

QTextDocument *QSyntaxHighlighter::document() const

返回此语法高亮器安装的QTextDocument。

另见setDocument。

[受保护] QTextCharFormat QSyntaxHighlighter::format(int position) const

返回语法高亮器当前文本块中position处的格式。

另见setFormat。

[纯虚函数受保护] void QSyntaxHighlighter::highlightBlock(const QString &text)

高亮显示给定的文本块。在富文本引擎必要时调用此函数，即在文本块更改时。

要提供自己的语法高亮显示，您必须创建QSyntaxHighlighter的子类并重新实现highlightBlock()函数。在您的实现中，您应该解析块的text并调用setFormat()，如需多次应用任何字体和颜色更改。例如

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);
    }
}

请参阅详细描述，了解使用setCurrentBlockState、currentBlockState和previousBlockState的示例来处理跨越多个文本块的语法

另见previousBlockState、setFormat和setCurrentBlockState。

[受保护] `int` QSyntaxHighlighter::previousBlockState() const

返回语法高亮器当前文本块之前文本块的结束状态。如果没有先前设置值，则返回值为-1。

另请参阅 highlightBlock() 和 setCurrentBlockState().

[槽函数] `void` QSyntaxHighlighter::rehighlight()

重新对整个文档应用高亮。

另请参阅 rehighlightBlock().

[槽函数] `void` QSyntaxHighlighter::rehighlightBlock(const `QTextBlock` &``block``)

重新对所给的 `QTextBlock ``block`` 应用高亮。

另请参阅 rehighlight().

[受保护] `void` QSyntaxHighlighter::setCurrentBlockState(`int ``newState`)

设置当前文本块的状态为 ``newState`。

另请参阅 currentBlockState() 和 highlightBlock().

[受保护] `void` QSyntaxHighlighter::setCurrentBlockUserData(`QTextBlockUserData *``data`)

将所给的 ``data` 附带到当前文本块。所有权传递给底层文本文档，即当相应的文本块被删除时，提供的 `QTextBlockUserData` 对象将被删除。

`QTextBlockUserData` 可以用来存储自定义设置。在语法高亮的情况下，用作在解析段落的文本时可能发现问题信息的缓存存储。

例如，在解析文本时，您可以跟踪遇到的括号字符（如 '{[(' 等），并将它们的相对位置和实际的 `QChar` 保存在从 `QTextBlockUserData` 派生的简单类中。

struct ParenthesisInfo
{
    QChar character;
    int position;
};

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

在关联编辑器的光标导航期间，您可以使用 `QTextCursor::block()` 函数检索当前的 `QTextBlock`，并将其强制转换为您的 `BlockData` 对象。然后，您可以检查当前光标位置是否与之前记录的括号位置匹配，并根据括号类型（开括号或闭括号）找到同一级别的下一个开括号或闭括号。

通过这种方式，您可以进行视觉上的括号匹配，并从当前光标位置到匹配的括号进行高亮显示。这使得在代码中查找缺失的括号以及编辑带有大量括号的代码时查找相应的开闭括号变得更容易。

另请参阅 currentBlockUserData() 和 QTextBlock::setUserData().

`void` QSyntaxHighlighter::setDocument(`QTextDocument *``doc`)

在给定的 QTextDocument doc 上安装语法高亮显示器。同一个时间只能使用一个 QSyntaxHighlighter。

另请参阅 文档。

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

此函数应用于语法高亮显示器的当前文本块（即在 highlightBlock() 函数中传递的文本）。

指定的 format 将应用于从 start 位置开始的文本，长度为 count 个字符（如果 count 为 0，则不做任何事情）。在显示时将 format 中设置的格式属性与文档中直接存储的格式信息合并，例如先前使用 QTextCursor 的函数设置。请注意，通过此函数设置的格式不会修改文档本身。

另请参阅 format() 和 highlightBlock。

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

这是一个覆盖函数。

将指定的 color 应用于从 start 位置开始的当前文本块，长度为 count 个字符。

将当前文本块的其它属性重置为默认值，例如字体和背景颜色。

另请参阅 format() 和 highlightBlock。

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

这是一个覆盖函数。

将指定的 font 应用于从 start 位置开始的当前文本块，长度为 count 个字符。

将当前文本块的其它属性重置为默认值，例如字体和背景颜色。

另请参阅 format() 和 highlightBlock。