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
  31 #include <kdemacros.h>
  32
  33 #include <QStringList>
  34 #include <QString>
  35 #include <QList>
  36
  37 class KwDocument;
  38 class KUrl;
  39
  40 /// Export file filter.
  41 class KDE_EXPORT KwExportFilter : public virtual KwFilter
  42 {
  43   public:
  44
  45     /*
  46      * Types
  47      */
  48
  49     /// Abstract description of something that cannot be saved.
  50     class Limitation
  51     {
  52       public:
  53
  54         /*
  55          * Constructors + destructor
  56          */
  57
  58         /// Default constructor.
  59         Limitation();
  60
  61         /// Destructor.
  62         virtual ~Limitation();
  63
  64         /*
  65          * Main interface
  66          */
  67
  68         /// Get a short description of what won't be saved
  69         virtual QString briefDescription() = 0;
  70
  71         /// Get a detailed description of what won't be saved
  72         virtual QString detailedDescription() = 0;
  73     };
  74
  75     /// Container class of limitations.
  76     class Limitations
  77     {
  78       public:
  79
  80         /*
  81          * Constructors + destructor
  82          */
  83
  84         /// Default constructor.
  85         Limitations();
  86
  87         /// Destructor.
  88         virtual ~Limitations();
  89
  90       private:
  91
  92         /*
  93          * Variables
  94          */
  95
  96         /// List of limitations.
  97         QList<Limitation*> m_limitations;
  98     };
  99
 100     /*
 101      * Constructors + destructor
 102      */
 103
 104     /// Primary constructor.
 105     KwExportFilter();
 106
 107     /// Destructor.
 108     virtual ~KwExportFilter();
 109
 110     /*
 111      * Main interface
 112      */
 113
 114     /// Obtain information about any data that can not be saved.
 115     void saveLimitations(KwDocument* doc, Limitations* o_limitations);
 116
 117     /// Save the document to file.
 118     virtual bool save(KwDocument* doc, const KUrl& url) = 0;
 119
 120     /*
 121      * Accessors
 122      */
 123
 124     /// Get a list of export mime types.
 125     QStringList exportMimeTypes() const;
 126
 127   protected:
 128
 129     /*
 130      * Virtual interface
 131      */
 132
 133     /// Obtain information about any data that can not be saved.
 134     virtual void v_saveLimitations(KwDocument* doc, Limitations* o_limitations) = 0;
 135
 136     /*
 137      * Variables
 138      */
 139
 140     /// List of export mime types.
 141     QStringList m_exportMimeTypes;
 142 };
 143
 144 #endif // _KwExportFilter_h_