Qt官方示例-语法高亮器

发表于

语法高亮显示示例展示了如何执行简单的语法高亮显示(对C ++文件语法高亮)。

demo

  该示例主要使用QTextEdit和QSyntaxHighlighter实现。

  要提供自定义的语法突出显示，您必须子类QSyntaxHighlighter和重新实现highlightBlock函数，并定义自己的突出显示规则。

  使用QVector<HighlightingRule>存储高亮显示规则：规则由QRegularExpression模式和QTextCharFormat实例组成，然后配置好的highlightingRules，用于当文本块更新时自动调用highlightBlock函数刷新高亮显示文本。

1
2
3
4
5
6
struct HighlightingRule
{
    QRegularExpression pattern;
    QTextCharFormat format;
};
QVector<HighlightingRule> highlightingRules;

1
2
3
4
5
6
7
8
9
10
11
void Highlighter::highlightBlock(const QString &text)
{
    foreach (const HighlightingRule &rule, highlightingRules) {
        QRegularExpressionMatchIterator matchIterator = rule.pattern.globalMatch(text);
        while (matchIterator.hasNext()) {
            QRegularExpressionMatch match = matchIterator.next();
            setFormat(match.capturedStart(), match.capturedLength(), rule.format);
        }
    }
    ...
}

  高亮显示文本格式有：

1
2
3
4
5
6
QTextCharFormat keywordFormat; // 关键词
QTextCharFormat classFormat; // 类名
QTextCharFormat singleLineCommentFormat; // 单行注释
QTextCharFormat multiLineCommentFormat; // 多行注释
QTextCharFormat quotationFormat; // 头文件引用
QTextCharFormat functionFormat; // 函数

  以添加类名高亮语法为例：

1
2
3
4
5
6
7
HighlightingRule rule;

classFormat.setFontWeight(QFont::Bold);
classFormat.setForeground(Qt::darkMagenta);
rule.pattern = QRegularExpression("\\bQ[A-Za-z]+\\b"); // 配置"类名"正则模式
rule.format = classFormat; // 配置"类名"的文本格式
highlightingRules.append(rule); // 添加到高亮显示规则容器,用于文本刷新

关于更多

  • 在QtCreator软件可以找到：

what_find

  • 或在以下Qt安装目录找到

    1
    C:\Qt\{你的Qt版本}\Examples\{你的Qt版本}\widgets\richtext\syntaxhighlighter

  • 相关链接

    1
    https://doc.qt.io/qt-5/qtwidgets-richtext-syntaxhighlighter-example.html

  • Qt君公众号回复『Qt示例』获取更多内容。