kworship/KwExportFilter.h

   1 /***************************************************************************
   2  *   This file is part of KWorship.                                        *
   3  *   Copyright 2008 James Hogan <james@albanarts.com>                      *
   4  *                                                                         *
   5  *   KWorship is free software: you can redistribute it and/or modify      *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation, either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   KWorship is distributed in the hope that it will be useful,           *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with KWorship.  If not, write to the Free Software Foundation,  *
  17  *   Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.   *
  18  ***************************************************************************/
  19
  20 #ifndef _KwExportFilter_h_
  21 #define _KwExportFilter_h_
  22
  23 /**
  24  * @file KwExportFilter.h
  25  * @brief Export file filter.
  26  * @author James Hogan <james@albanarts.com>
  27  */
  28
  29 #include "KwFilter.h"
  30 #include "KwExport.h"
  31
  32 #include <QStringList>
  33 #include <QString>
  34 #include <QList>
  35
  36 class KwDocument;
  37 class KUrl;
  38
  39 /// Export file filter.
  40 class KWMAIN_EXPORT KwExportFilter : public virtual KwFilter
  41 {
  42   public:
  43
  44     /*
  45      * Types
  46      */
  47
  48     /// Abstract description of something that cannot be saved.
  49     class Limitation
  50     {
  51       public:
  52
  53         /*
  54          * Constructors + destructor
  55          */
  56
  57         /// Default constructor.
  58         Limitation();
  59
  60         /// Destructor.
  61         virtual ~Limitation();
  62
  63         /*
  64          * Main interface
  65          */
  66
  67         /// Get a short description of what won't be saved
  68         virtual QString briefDescription() = 0;
  69
  70         /// Get a detailed description of what won't be saved
  71         virtual QString detailedDescription() = 0;
  72     };
  73
  74     /// Container class of limitations.
  75     class Limitations
  76     {
  77       public:
  78
  79         /*
  80          * Constructors + destructor
  81          */
  82
  83         /// Default constructor.
  84         Limitations();
  85
  86         /// Destructor.
  87         virtual ~Limitations();
  88
  89       private:
  90
  91         /*
  92          * Variables
  93          */
  94
  95         /// List of limitations.
  96         QList<Limitation*> m_limitations;
  97     };
  98
  99     /*
 100      * Constructors + destructor
 101      */
 102
 103     /// Primary constructor.
 104     KwExportFilter();
 105
 106     /// Destructor.
 107     virtual ~KwExportFilter();
 108
 109     /*
 110      * Main interface
 111      */
 112
 113     /// Obtain information about any data that can not be saved.
 114     void saveLimitations(KwDocument* doc, const QString& mimeType, Limitations* o_limitations);
 115
 116     /// Save the document to file.
 117     virtual bool save(KwDocument* doc, const KUrl& url, const QString& mimeType) = 0;
 118
 119     /*
 120      * Accessors
 121      */
 122
 123     /// Get a list of export mime types.
 124     QStringList exportMimeTypes() const;
 125
 126   protected:
 127
 128     /*
 129      * Virtual interface
 130      */
 131
 132     /// Obtain information about any data that can not be saved.
 133     virtual void v_saveLimitations(KwDocument* doc, const QString& mimeType, Limitations* o_limitations) = 0;
 134
 135     /*
 136      * Variables
 137      */
 138
 139     /// List of export mime types.
 140     QStringList m_exportMimeTypes;
 141 };
 142
 143 #endif // _KwExportFilter_h_