1 /****************************************************************************
2 **
3 ** Copyright (C) 2015 The Qt Company Ltd.
4 ** Contact: http://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 http://www.qt.io/terms-conditions. For further
15 ** information use the contact form at http://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 2.1 or version 3 as published by the Free
20 ** Software Foundation and appearing in the file LICENSE.LGPLv21 and
21 ** LICENSE.LGPLv3 included in the packaging of this file. Please review the
22 ** following information to ensure the GNU Lesser General Public License
23 ** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
24 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25 **
26 ** As a special exception, The Qt Company gives you certain additional
27 ** rights. These rights are described in The Qt Company LGPL Exception
28 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29 **
30 ** GNU General Public License Usage
31 ** Alternatively, this file may be used under the terms of the GNU
32 ** General Public License version 3.0 as published by the Free Software
33 ** Foundation and appearing in the file LICENSE.GPL included in the
34 ** packaging of this file.  Please review the following information to
35 ** ensure the GNU General Public License version 3.0 requirements will be
36 ** met: http://www.gnu.org/copyleft/gpl.html.
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41 
42 #ifndef QSYNTAXHIGHLIGHTER_H
43 #define QSYNTAXHIGHLIGHTER_H
44 
45 #include <QtCore/qglobal.h>
46 
47 #ifndef QT_NO_SYNTAXHIGHLIGHTER
48 
49 #include <QtCore/qobject.h>
50 #include <QtGui/qtextobject.h>
51 
52 QT_BEGIN_HEADER
53 
54 QT_BEGIN_NAMESPACE
55 
56 QT_MODULE(Gui)
57 
58 class QTextDocument;
59 class QSyntaxHighlighterPrivate;
60 class QTextCharFormat;
61 class QFont;
62 class QColor;
63 class QTextBlockUserData;
64 class QTextEdit;
65 
66 class Q_GUI_EXPORT QSyntaxHighlighter : public QObject
67 {
68     Q_OBJECT
69     Q_DECLARE_PRIVATE(QSyntaxHighlighter)
70 public:
71     QSyntaxHighlighter(QObject *parent);
72     QSyntaxHighlighter(QTextDocument *parent);
73     QSyntaxHighlighter(QTextEdit *parent);
74     virtual ~QSyntaxHighlighter();
75 
76     void setDocument(QTextDocument *doc);
77     QTextDocument *document() const;
78 
79 public Q_SLOTS:
80     void rehighlight();
81     void rehighlightBlock(const QTextBlock &block);
82 
83 protected:
84     virtual void highlightBlock(const QString &text) = 0;
85 
86     void setFormat(int start, int count, const QTextCharFormat &format);
87     void setFormat(int start, int count, const QColor &color);
88     void setFormat(int start, int count, const QFont &font);
89     QTextCharFormat format(int pos) const;
90 
91     int previousBlockState() const;
92     int currentBlockState() const;
93     void setCurrentBlockState(int newState);
94 
95     void setCurrentBlockUserData(QTextBlockUserData *data);
96     QTextBlockUserData *currentBlockUserData() const;
97 
98     QTextBlock currentBlock() const;
99 
100 private:
101     Q_DISABLE_COPY(QSyntaxHighlighter)
102     Q_PRIVATE_SLOT(d_func(), void _q_reformatBlocks(int from, int charsRemoved, int charsAdded))
103     Q_PRIVATE_SLOT(d_func(), void _q_delayedRehighlight())
104 };
105 
106 QT_END_NAMESPACE
107 
108 QT_END_HEADER
109 
110 #endif // QT_NO_SYNTAXHIGHLIGHTER
111 
112 #endif // QSYNTAXHIGHLIGHTER_H
113