src/gui/text/qtextdocumentwriter.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the QtGui module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** GNU Lesser General Public License Usage
  10 ** This file may be used under the terms of the GNU Lesser General Public
  11 ** License version 2.1 as published by the Free Software Foundation and
  12 ** appearing in the file LICENSE.LGPL included in the packaging of this
  13 ** file. Please review the following information to ensure the GNU Lesser
  14 ** General Public License version 2.1 requirements will be met:
  15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  16 **
  17 ** In addition, as a special exception, Nokia gives you certain additional
  18 ** rights. These rights are described in the Nokia Qt LGPL Exception
  19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  20 **
  21 ** GNU General Public License Usage
  22 ** Alternatively, this file may be used under the terms of the GNU General
  23 ** Public License version 3.0 as published by the Free Software Foundation
  24 ** and appearing in the file LICENSE.GPL included in the packaging of this
  25 ** file. Please review the following information to ensure the GNU General
  26 ** Public License version 3.0 requirements will be met:
  27 ** http://www.gnu.org/copyleft/gpl.html.
  28 **
  29 ** Other Usage
  30 ** Alternatively, this file may be used in accordance with the terms and
  31 ** conditions contained in a signed written agreement between you and Nokia.
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41 #ifndef QTEXTDOCUMENTWRITER_H
  42 #define QTEXTDOCUMENTWRITER_H
  43
  44 #include <QtCore/qstring.h>
  45
  46 QT_BEGIN_HEADER
  47
  48 QT_BEGIN_NAMESPACE
  49
  50
  51 class QTextDocumentWriterPrivate;
  52 class QIODevice;
  53 class QByteArray;
  54 class QTextDocument;
  55 class QTextDocumentFragment;
  56
  57 class Q_GUI_EXPORT QTextDocumentWriter
  58 {
  59 public:
  60     QTextDocumentWriter();
  61     QTextDocumentWriter(QIODevice *device, const QByteArray &format);
  62     explicit QTextDocumentWriter(const QString &fileName, const QByteArray &format = QByteArray());
  63     ~QTextDocumentWriter();
  64
  65     void setFormat (const QByteArray &format);
  66     QByteArray format () const;
  67
  68     void setDevice (QIODevice *device);
  69     QIODevice *device () const;
  70     void setFileName (const QString &fileName);
  71     QString fileName () const;
  72
  73     bool write(const QTextDocument *document);
  74     bool write(const QTextDocumentFragment &fragment);
  75
  76 #ifndef QT_NO_TEXTCODEC
  77     void setCodec(QTextCodec *codec);
  78     QTextCodec *codec() const;
  79 #endif
  80
  81     static QList<QByteArray> supportedDocumentFormats();
  82
  83 private:
  84     Q_DISABLE_COPY(QTextDocumentWriter)
  85     QTextDocumentWriterPrivate *d;
  86 };
  87
  88 QT_END_NAMESPACE
  89
  90 QT_END_HEADER
  91
  92 #endif