1
/****************************************************************************
2
**
3
** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4
** All rights reserved.
5
** Contact: Nokia Corporation (qt-info@nokia.com)
6
**
7
** This file is part of the QtGui module of the Qt Toolkit.
8
**
9
** $QT_BEGIN_LICENSE:LGPL$
10
** GNU Lesser General Public License Usage
11
** This file may be used under the terms of the GNU Lesser General Public
12
** License version 2.1 as published by the Free Software Foundation and
13
** appearing in the file LICENSE.LGPL included in the packaging of this
14
** file. Please review the following information to ensure the GNU Lesser
15
** General Public License version 2.1 requirements will be met:
16
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
17
**
18
** In addition, as a special exception, Nokia gives you certain additional
19
** rights. These rights are described in the Nokia Qt LGPL Exception
20
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
21
**
22
** GNU General Public License Usage
23
** Alternatively, this file may be used under the terms of the GNU General
24
** Public License version 3.0 as published by the Free Software Foundation
25
** and appearing in the file LICENSE.GPL included in the packaging of this
26
** file. Please review the following information to ensure the GNU General
27
** Public License version 3.0 requirements will be met:
28
** http://www.gnu.org/copyleft/gpl.html.
29
**
30
** Other Usage
31
** Alternatively, this file may be used in accordance with the terms and
32
** conditions contained in a signed written agreement between you and Nokia.
33
**
34
**
35
**
36
**
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