src/gui/text/qsyntaxhighlighter.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2011 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
  65 class Q_GUI_EXPORT QSyntaxHighlighter : public QObject
  66 {
  67     Q_OBJECT
  68     Q_DECLARE_PRIVATE(QSyntaxHighlighter)
  69 public:
  70     QSyntaxHighlighter(QObject *parent);
  71     QSyntaxHighlighter(QTextDocument *parent);
  72     virtual ~QSyntaxHighlighter();
  73
  74     void setDocument(QTextDocument *doc);
  75     QTextDocument *document() const;
  76
  77 public Q_SLOTS:
  78     void rehighlight();
  79     void rehighlightBlock(const QTextBlock &block);
  80
  81 protected:
  82     virtual void highlightBlock(const QString &text) = 0;
  83
  84     void setFormat(int start, int count, const QTextCharFormat &format);
  85     void setFormat(int start, int count, const QColor &color);
  86     void setFormat(int start, int count, const QFont &font);
  87     QTextCharFormat format(int pos) const;
  88
  89     int previousBlockState() const;
  90     int currentBlockState() const;
  91     void setCurrentBlockState(int newState);
  92
  93     void setCurrentBlockUserData(QTextBlockUserData *data);
  94     QTextBlockUserData *currentBlockUserData() const;
  95
  96     QTextBlock currentBlock() const;
  97
  98 private:
  99     Q_DISABLE_COPY(QSyntaxHighlighter)
 100     Q_PRIVATE_SLOT(d_func(), void _q_reformatBlocks(int from, int charsRemoved, int charsAdded))
 101     Q_PRIVATE_SLOT(d_func(), void _q_delayedRehighlight())
 102 };
 103
 104 QT_END_NAMESPACE
 105
 106 QT_END_HEADER
 107
 108 #endif // QT_NO_SYNTAXHIGHLIGHTER
 109
 110 #endif // QSYNTAXHIGHLIGHTER_H