QSyntaxHighlighter Class

成员函数文档

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

使用给定的parent 构建 QSyntaxHighlighter。

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

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

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

[virtual noexcept] QSyntaxHighlighter::~QSyntaxHighlighter()

销毁器从文本文档中卸载语法高亮显示器。

[protected] QTextBlock QSyntaxHighlighter::currentBlock() const

返回当前文本块。

[protected] int QSyntaxHighlighter::currentBlockState() const

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

另请参阅 setCurrentBlockState()。

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

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

另请参阅 QTextBlock::userData() 和setCurrentBlockUserData()。

QTextDocument *QSyntaxHighlighter::document() const

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

另请参阅 setDocument().

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

返回语法高亮显示当前文本块内position 的格式。

另请参阅 setFormat().

[pure virtual protected] 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() 处理跨多个文本块的结构体语法的示例，请参阅Detailed Description 。

另请参阅 previousBlockState(),setFormat() 和setCurrentBlockState()。

[protected] int QSyntaxHighlighter::previousBlockState() const

返回语法高亮显示当前文本块之前文本块的结束状态。如果之前未设置任何值，则返回值为-1。

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

[slot] void QSyntaxHighlighter::rehighlight()

将高亮重新应用于整个文档。

另请参阅 rehighlightBlock()。

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

将高亮重新应用于给定的QTextBlock block 。

另请参阅 rehighlight() 。

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

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

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

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

将给定的data 附加到当前文本块。所有权将传递给底层文本文档，也就是说，如果相应的文本块被删除，所提供的QTextBlockUserData 对象也将被删除。

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

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

struct ParenthesisInfo
{
    QChar character;
    int position;
};

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

在相关编辑器中进行光标导航时，可以询问当前QTextBlock （使用QTextCursor::block() 函数获取）是否设置了用户数据对象，并将其转换为BlockData 对象。然后，您可以检查当前光标位置是否与之前记录的括号位置相匹配，并根据括号的类型（开括号或闭括号），查找同层的下一个开括号或闭括号。

这样，您就可以进行可视化的括号匹配，并突出显示从当前光标位置到匹配括号的位置。这样，在编辑括号密集的代码时，就能更容易地发现代码中缺少的括号，并找到相应的开括号/闭括号。

另请参见 currentBlockUserData() 和QTextBlock::setUserData()。

void QSyntaxHighlighter::setDocument(QTextDocument *doc)

在给定的QTextDocument doc 上安装语法高亮器。QSyntaxHighlighter 一次只能用于一个文档。

另请参阅 document() 。

[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()。