Qt 4.8
qsyntaxhighlighter.h
Go to the documentation of this file.
1 /****************************************************************************
2 **
3 ** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
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 Digia. For licensing terms and
14 ** conditions see http://qt.digia.com/licensing. For further information
15 ** use the contact form at http://qt.digia.com/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 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 2.1 requirements
23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24 **
25 ** In addition, as a special exception, Digia gives you certain additional
26 ** rights. These rights are described in the Digia Qt LGPL Exception
27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
28 **
29 ** GNU General Public License Usage
30 ** Alternatively, this file may be used under the terms of the GNU
31 ** General Public License version 3.0 as published by the Free Software
32 ** Foundation and appearing in the file LICENSE.GPL included in the
33 ** packaging of this file. Please review the following information to
34 ** ensure the GNU General Public License version 3.0 requirements will be
35 ** met: http://www.gnu.org/copyleft/gpl.html.
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 
53 
55 
56 QT_MODULE(Gui)
57 
58 class QTextDocument;
60 class QTextCharFormat;
61 class QFont;
62 class QColor;
63 class QTextBlockUserData;
64 class QTextEdit;
65 
67 {
68  Q_OBJECT
70 public:
71  QSyntaxHighlighter(QObject *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:
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 
107 
109 
110 #endif // QT_NO_SYNTAXHIGHLIGHTER
111 
112 #endif // QSYNTAXHIGHLIGHTER_H
The QColor class provides colors based on RGB, HSV or CMYK values.
Definition: qcolor.h:67
The QTextCharFormat class provides formatting information for characters in a QTextDocument.
Definition: qtextformat.h:372
#define QT_END_NAMESPACE
This macro expands to.
Definition: qglobal.h:90
#define QT_MODULE(x)
Definition: qglobal.h:2783
#define QT_BEGIN_HEADER
Definition: qglobal.h:136
#define Q_GUI_EXPORT
Definition: qglobal.h:1450
#define Q_DISABLE_COPY(Class)
Disables the use of copy constructors and assignment operators for the given Class.
Definition: qglobal.h:2523
#define Q_PRIVATE_SLOT(d, signature)
Definition: qobjectdefs.h:73
#define Q_SLOTS
Definition: qobjectdefs.h:71
The QString class provides a Unicode character string.
Definition: qstring.h:83
The QObject class is the base class of all Qt objects.
Definition: qobject.h:111
#define QT_BEGIN_NAMESPACE
This macro expands to.
Definition: qglobal.h:89
The QTextBlock class provides a container for text fragments in a QTextDocument.
Definition: qtextobject.h:199
static const char * data(const QByteArray &arr)
#define Q_OBJECT
Definition: qobjectdefs.h:157
The QTextBlockUserData class is used to associate custom data with blocks of text.
Definition: qtextobject.h:194
The QFont class specifies a font used for drawing text.
Definition: qfont.h:64
The QSyntaxHighlighter class allows you to define syntax highlighting rules, and in addition you can ...
The QTextDocument class holds formatted text that can be viewed and edited using a QTextEdit...
#define Q_DECLARE_PRIVATE(Class)
Definition: qglobal.h:2467
#define QT_END_HEADER
Definition: qglobal.h:137
The QTextEdit class provides a widget that is used to edit and display both plain and rich text...
Definition: qtextedit.h:70
#define text
Definition: qobjectdefs.h:80