1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtGui module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QSYNTAXHIGHLIGHTER_H
41#define QSYNTAXHIGHLIGHTER_H
42
43#include <QtGui/qtguiglobal.h>
44
45#ifndef QT_NO_SYNTAXHIGHLIGHTER
46
47#include <QtCore/qobject.h>
48#include <QtGui/qtextobject.h>
49
50QT_BEGIN_NAMESPACE
51
52
53class QTextDocument;
54class QSyntaxHighlighterPrivate;
55class QTextCharFormat;
56class QFont;
57class QColor;
58class QTextBlockUserData;
59
60class Q_GUI_EXPORT QSyntaxHighlighter : public QObject
61{
62 Q_OBJECT
63 Q_DECLARE_PRIVATE(QSyntaxHighlighter)
64public:
65 explicit QSyntaxHighlighter(QObject *parent);
66 explicit QSyntaxHighlighter(QTextDocument *parent);
67 ~QSyntaxHighlighter();
68
69 void setDocument(QTextDocument *doc);
70 QTextDocument *document() const;
71
72public Q_SLOTS:
73 void rehighlight();
74 void rehighlightBlock(const QTextBlock &block);
75
76protected:
77 virtual void highlightBlock(const QString &text) = 0;
78
79 void setFormat(int start, int count, const QTextCharFormat &format);
80 void setFormat(int start, int count, const QColor &color);
81 void setFormat(int start, int count, const QFont &font);
82 QTextCharFormat format(int pos) const;
83
84 int previousBlockState() const;
85 int currentBlockState() const;
86 void setCurrentBlockState(int newState);
87
88 void setCurrentBlockUserData(QTextBlockUserData *data);
89 QTextBlockUserData *currentBlockUserData() const;
90
91 QTextBlock currentBlock() const;
92
93private:
94 Q_DISABLE_COPY(QSyntaxHighlighter)
95 Q_PRIVATE_SLOT(d_func(), void _q_reformatBlocks(int from, int charsRemoved, int charsAdded))
96 Q_PRIVATE_SLOT(d_func(), void _q_delayedRehighlight())
97};
98
99QT_END_NAMESPACE
100
101#endif // QT_NO_SYNTAXHIGHLIGHTER
102
103#endif // QSYNTAXHIGHLIGHTER_H
104