- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files
- Directories
- Examples

- File List
- File Members

# qsyntaxhighlighter.h

Go to the documentation of this file.

    00001 /****************************************************************************
    00002 **
    00003 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
    00004 ** All rights reserved.
    00005 ** Contact: Nokia Corporation (qt-info@nokia.com)
    00006 **
    00007 ** This file is part of the QtGui module of the Qt Toolkit.
    00008 **
    00009 ** $QT_BEGIN_LICENSE:LGPL$
    00010 ** Commercial Usage
    00011 ** Licensees holding valid Qt Commercial licenses may use this file in
    00012 ** accordance with the Qt Commercial License Agreement provided with the
    00013 ** Software or, alternatively, in accordance with the terms contained in
    00014 ** a written agreement between you and Nokia.
    00015 **
    00016 ** GNU Lesser General Public License Usage
    00017 ** Alternatively, this file may be used under the terms of the GNU Lesser
    00018 ** General Public License version 2.1 as published by the Free Software
    00019 ** Foundation and appearing in the file LICENSE.LGPL included in the
    00020 ** packaging of this file.  Please review the following information to
    00021 ** ensure the GNU Lesser General Public License version 2.1 requirements
    00022 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
    00023 **
    00024 ** In addition, as a special exception, Nokia gives you certain additional
    00025 ** rights.  These rights are described in the Nokia Qt LGPL Exception
    00026 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this module.
    00027 **
    00028 ** GNU General Public License Usage
    00029 ** Alternatively, this file may be used under the terms of the GNU
    00030 ** General Public License version 3.0 as published by the Free Software
    00031 ** Foundation and appearing in the file LICENSE.GPL included in the
    00032 ** packaging of this file.  Please review the following information to
    00033 ** ensure the GNU General Public License version 3.0 requirements will be
    00034 ** met: http://www.gnu.org/copyleft/gpl.html.
    00035 **
    00036 ** If you have questions regarding the use of this file, please contact
    00037 ** Nokia at qt-info@nokia.com.
    00038 ** $QT_END_LICENSE$
    00039 **
    00040 ****************************************************************************/
    00041
    00042 #ifndef QSYNTAXHIGHLIGHTER_H
    00043 #define QSYNTAXHIGHLIGHTER_H
    00044
    00045 #include <QtCore/qglobal.h>
    00046
    00047 #ifndef QT_NO_SYNTAXHIGHLIGHTER
    00048
    00049 #include <QtCore/qobject.h>
    00050 #include <QtGui/qtextobject.h>
    00051
    00052 QT_BEGIN_HEADER
    00053
    00054 QT_BEGIN_NAMESPACE
    00055
    00056 QT_MODULE(Gui)
    00057
    00058 class QTextDocument;
    00059 class QSyntaxHighlighterPrivate;
    00060 class QTextCharFormat;
    00061 class QFont;
    00062 class QColor;
    00063 class QTextBlockUserData;
    00064 class QTextEdit;
    00065
    00066 class Q_GUI_EXPORT QSyntaxHighlighter : public QObject
    00067 {
    00068     Q_OBJECT
    00069     Q_DECLARE_PRIVATE(QSyntaxHighlighter)
    00070 public:
    00071     QSyntaxHighlighter(QObject *parent);
    00072     QSyntaxHighlighter(QTextDocument *parent);
    00073     QSyntaxHighlighter(QTextEdit *parent);
    00074     virtual ~QSyntaxHighlighter();
    00075
    00076     void setDocument(QTextDocument *doc);
    00077     QTextDocument *document() const;
    00078
    00079 public Q_SLOTS:
    00080     void rehighlight();
    00081     void rehighlightBlock(const QTextBlock &block);
    00082
    00083 protected:
    00084     virtual void highlightBlock(const QString &text) = 0;
    00085
    00086     void setFormat(int start, int count, const QTextCharFormat &format);
    00087     void setFormat(int start, int count, const QColor &color);
    00088     void setFormat(int start, int count, const QFont &font);
    00089     QTextCharFormat format(int pos) const;
    00090
    00091     int previousBlockState() const;
    00092     int currentBlockState() const;
    00093     void setCurrentBlockState(int newState);
    00094
    00095     void setCurrentBlockUserData(QTextBlockUserData *data);
    00096     QTextBlockUserData *currentBlockUserData() const;
    00097
    00098     QTextBlock currentBlock() const;
    00099
    00100 private:
    00101     Q_DISABLE_COPY(QSyntaxHighlighter)
    00102     Q_PRIVATE_SLOT(d_func(), void _q_reformatBlocks(int from, int charsRemoved, int charsAdded))
    00103     Q_PRIVATE_SLOT(d_func(), void _q_delayedRehighlight())
    00104 };
    00105
    00106 QT_END_NAMESPACE
    00107
    00108 QT_END_HEADER
    00109
    00110 #endif // QT_NO_SYNTAXHIGHLIGHTER
    00111
    00112 #endif // QSYNTAXHIGHLIGHTER_H