src/gui/text/qtextdocumentfragment.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 QTEXTDOCUMENTFRAGMENT_H
  43 #define QTEXTDOCUMENTFRAGMENT_H
  44
  45 #include <QtCore/qstring.h>
  46
  47 QT_BEGIN_HEADER
  48
  49 QT_BEGIN_NAMESPACE
  50
  51 QT_MODULE(Gui)
  52
  53 class QTextStream;
  54 class QTextDocument;
  55 class QTextDocumentFragmentPrivate;
  56 class QTextCursor;
  57
  58 class Q_GUI_EXPORT QTextDocumentFragment
  59 {
  60 public:
  61     QTextDocumentFragment();
  62     explicit QTextDocumentFragment(const QTextDocument *document);
  63     explicit QTextDocumentFragment(const QTextCursor &range);
  64     QTextDocumentFragment(const QTextDocumentFragment &rhs);
  65     QTextDocumentFragment &operator=(const QTextDocumentFragment &rhs);
  66     ~QTextDocumentFragment();
  67
  68     bool isEmpty() const;
  69
  70     QString toPlainText() const;
  71 #ifndef QT_NO_TEXTHTMLPARSER
  72     QString toHtml() const;
  73     QString toHtml(const QByteArray &encoding) const;
  74 #endif // QT_NO_TEXTHTMLPARSER
  75
  76     static QTextDocumentFragment fromPlainText(const QString &plainText);
  77 #ifndef QT_NO_TEXTHTMLPARSER
  78     static QTextDocumentFragment fromHtml(const QString &html);
  79     static QTextDocumentFragment fromHtml(const QString &html, const QTextDocument *resourceProvider);
  80 #endif // QT_NO_TEXTHTMLPARSER
  81
  82 private:
  83     QTextDocumentFragmentPrivate *d;
  84     friend class QTextCursor;
  85     friend class QTextDocumentWriter;
  86 };
  87
  88 QT_END_NAMESPACE
  89
  90 QT_END_HEADER
  91
  92 #endif // QTEXTDOCUMENTFRAGMENT_H