qtext/qsyntaxhighlighter.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: Qt Software Information (qt-info@nokia.com)
   5 **
   6 ** This file is part of the QtGui module of the Qt Toolkit.
   7 **
   8 ** Commercial Usage
   9 ** Licensees holding valid Qt Commercial licenses may use this file in
  10 ** accordance with the Qt Commercial License Agreement provided with the
  11 ** Software or, alternatively, in accordance with the terms contained in
  12 ** a written agreement between you and Nokia.
  13 **
  14 **
  15 ** GNU General Public License Usage
  16 ** Alternatively, this file may be used under the terms of the GNU
  17 ** General Public License versions 2.0 or 3.0 as published by the Free
  18 ** Software Foundation and appearing in the file LICENSE.GPL included in
  19 ** the packaging of this file.  Please review the following information
  20 ** to ensure GNU General Public Licensing requirements will be met:
  21 ** http://www.fsf.org/licensing/licenses/info/GPLv2.html and
  22 ** http://www.gnu.org/copyleft/gpl.html.  In addition, as a special
  23 ** exception, Nokia gives you certain additional rights. These rights
  24 ** are described in the Nokia Qt GPL Exception version 1.3, included in
  25 ** the file GPL_EXCEPTION.txt in this package.
  26 **
  27 ** Qt for Windows(R) Licensees
  28 ** As a special exception, Nokia, as the sole copyright holder for Qt
  29 ** Designer, grants users of the Qt/Eclipse Integration plug-in the
  30 ** right for the Qt/Eclipse Integration to link to functionality
  31 ** provided by Qt Designer and its related libraries.
  32 **
  33 ** If you are unsure which license is appropriate for your use, please
  34 ** contact the sales department at qt-sales@nokia.com.
  35 **
  36 ****************************************************************************/
  37
  38 #ifndef QSYNTAXHIGHLIGHTER_H
  39 #define QSYNTAXHIGHLIGHTER_H
  40
  41 #include <QtCore/qglobal.h>
  42
  43 #ifndef QT_NO_SYNTAXHIGHLIGHTER
  44
  45 #include <QtCore/qobject.h>
  46 #include <QtGui/qtextobject.h>
  47
  48 QT_BEGIN_HEADER
  49
  50 QT_BEGIN_NAMESPACE
  51
  52 QT_MODULE(Gui)
  53
  54 class QTextDocument;
  55 class QSyntaxHighlighterPrivate;
  56 class QTextCharFormat;
  57 class QFont;
  58 class QColor;
  59 class QTextBlockUserData;
  60 class QTextEdit;
  61
  62 class Q_GUI_EXPORT QSyntaxHighlighter : public QObject
  63 {
  64     Q_OBJECT
  65     Q_DECLARE_PRIVATE(QSyntaxHighlighter)
  66 public:
  67     QSyntaxHighlighter(QObject *parent);
  68     QSyntaxHighlighter(QTextDocument *parent);
  69     QSyntaxHighlighter(QTextEdit *parent);
  70     virtual ~QSyntaxHighlighter();
  71
  72     void setDocument(QTextDocument *doc);
  73     QTextDocument *document() const;
  74
  75 public Q_SLOTS:
  76     void rehighlight();
  77
  78 protected:
  79     virtual void highlightBlock(const QString &text) = 0;
  80
  81     void setFormat(int start, int count, const QTextCharFormat &format);
  82     void setFormat(int start, int count, const QColor &color);
  83     void setFormat(int start, int count, const QFont &font);
  84     QTextCharFormat format(int pos) const;
  85
  86     int previousBlockState() const;
  87     int currentBlockState() const;
  88     void setCurrentBlockState(int newState);
  89
  90     void setCurrentBlockUserData(QTextBlockUserData *data);
  91     QTextBlockUserData *currentBlockUserData() const;
  92
  93     QTextBlock currentBlock() const;
  94
  95 private:
  96     Q_DISABLE_COPY(QSyntaxHighlighter)
  97     Q_PRIVATE_SLOT(d_func(), void _q_reformatBlocks(int from, int charsRemoved, int charsAdded))
  98     Q_PRIVATE_SLOT(d_func(), void _q_delayedRehighlight())
  99 };
 100
 101 QT_END_NAMESPACE
 102
 103 QT_END_HEADER
 104
 105 #endif // QT_NO_SYNTAXHIGHLIGHTER
 106
 107 #endif // QSYNTAXHIGHLIGHTER_H