kworship/KwImportFilter.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 _KwImportFilter_h_
  21 #define _KwImportFilter_h_
  22
  23 /**
  24  * @file KwImportFilter.h
  25  * @brief Import file filter.
  26  * @author James Hogan <james@albanarts.com>
  27  */
  28
  29 #include "KwFilter.h"
  30 #include "KwExport.h"
  31
  32 #include <QStringList>
  33
  34 class KwDocument;
  35 class KUrl;
  36
  37 /// Import file filter.
  38 class KWMAIN_EXPORT KwImportFilter : public virtual KwFilter
  39 {
  40   public:
  41
  42     /*
  43      * Constructors + destructor
  44      */
  45
  46     /// Primary constructor.
  47     KwImportFilter();
  48
  49     /// Destructor.
  50     virtual ~KwImportFilter();
  51
  52     /*
  53      * Main interface
  54      */
  55
  56     /// Load the document from a file.
  57     virtual KwDocument* load(const KUrl& url, const QString& mimeType) = 0;
  58
  59     /*
  60      * Accessors
  61      */
  62
  63     /// Get a list of importable mime types.
  64     QStringList importMimeTypes() const;
  65
  66   protected:
  67
  68     /*
  69      * Variables
  70      */
  71
  72     /// List of import mime types.
  73     QStringList m_importMimeTypes;
  74 };
  75
  76 #endif // _KwImportFilter_h_