src/gui/text/qtextdocumentwriter.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 #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 QT_MODULE(Gui)
  51
  52 class QTextDocumentWriterPrivate;
  53 class QIODevice;
  54 class QByteArray;
  55 class QTextDocument;
  56 class QTextDocumentFragment;
  57
  58 class Q_GUI_EXPORT QTextDocumentWriter
  59 {
  60 public:
  61     QTextDocumentWriter();
  62     QTextDocumentWriter(QIODevice *device, const QByteArray &format);
  63     QTextDocumentWriter(const QString &fileName, const QByteArray &format = QByteArray());
  64     ~QTextDocumentWriter();
  65
  66     void setFormat (const QByteArray &format);
  67     QByteArray format () const;
  68
  69     void setDevice (QIODevice *device);
  70     QIODevice *device () const;
  71     void setFileName (const QString &fileName);
  72     QString fileName () const;
  73
  74     bool write(const QTextDocument *document);
  75     bool write(const QTextDocumentFragment &fragment);
  76
  77 #ifndef QT_NO_TEXTCODEC
  78     void setCodec(QTextCodec *codec);
  79     QTextCodec *codec() const;
  80 #endif
  81
  82     static QList<QByteArray> supportedDocumentFormats();
  83
  84 private:
  85     Q_DISABLE_COPY(QTextDocumentWriter)
  86     QTextDocumentWriterPrivate *d;
  87 };
  88
  89 QT_END_NAMESPACE
  90
  91 QT_END_HEADER
  92
  93 #endif