1 /****************************************************************************
3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/
6 ** This file is part of the QtGui module of the Qt Toolkit.
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** GNU Lesser General Public License Usage
10 ** This file may be used under the terms of the GNU Lesser General Public
11 ** License version 2.1 as published by the Free Software Foundation and
12 ** appearing in the file LICENSE.LGPL included in the packaging of this
13 ** file. Please review the following information to ensure the GNU Lesser
14 ** General Public License version 2.1 requirements will be met:
15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
17 ** In addition, as a special exception, Nokia gives you certain additional
18 ** rights. These rights are described in the Nokia Qt LGPL Exception
19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
21 ** GNU General Public License Usage
22 ** Alternatively, this file may be used under the terms of the GNU General
23 ** Public License version 3.0 as published by the Free Software Foundation
24 ** and appearing in the file LICENSE.GPL included in the packaging of this
25 ** file. Please review the following information to ensure the GNU General
26 ** Public License version 3.0 requirements will be met:
27 ** http://www.gnu.org/copyleft/gpl.html.
30 ** Alternatively, this file may be used in accordance with the terms and
31 ** conditions contained in a signed written agreement between you and Nokia.
40 ****************************************************************************/
42 #ifndef QSYNTAXHIGHLIGHTER_H
43 #define QSYNTAXHIGHLIGHTER_H
45 #include <QtCore/qglobal.h>
47 #ifndef QT_NO_SYNTAXHIGHLIGHTER
49 #include <QtCore/qobject.h>
50 #include <QtGui/qtextobject.h>
58 class QSyntaxHighlighterPrivate;
59 class QTextCharFormat;
62 class QTextBlockUserData;
64 class Q_GUI_EXPORT QSyntaxHighlighter : public QObject
67 Q_DECLARE_PRIVATE(QSyntaxHighlighter)
69 explicit QSyntaxHighlighter(QObject *parent);
70 explicit QSyntaxHighlighter(QTextDocument *parent);
71 virtual ~QSyntaxHighlighter();
73 void setDocument(QTextDocument *doc);
74 QTextDocument *document() const;
78 void rehighlightBlock(const QTextBlock &block);
81 virtual void highlightBlock(const QString &text) = 0;
83 void setFormat(int start, int count, const QTextCharFormat &format);
84 void setFormat(int start, int count, const QColor &color);
85 void setFormat(int start, int count, const QFont &font);
86 QTextCharFormat format(int pos) const;
88 int previousBlockState() const;
89 int currentBlockState() const;
90 void setCurrentBlockState(int newState);
92 void setCurrentBlockUserData(QTextBlockUserData *data);
93 QTextBlockUserData *currentBlockUserData() const;
95 QTextBlock currentBlock() const;
98 Q_DISABLE_COPY(QSyntaxHighlighter)
99 Q_PRIVATE_SLOT(d_func(), void _q_reformatBlocks(int from, int charsRemoved, int charsAdded))
100 Q_PRIVATE_SLOT(d_func(), void _q_delayedRehighlight())
107 #endif // QT_NO_SYNTAXHIGHLIGHTER
109 #endif // QSYNTAXHIGHLIGHTER_H