kworship/KwFilter.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 _KwFilter_h_
  21 #define _KwFilter_h_
  22
  23 /**
  24  * @file KwFilter.h
  25  * @brief Abstract file filter.
  26  * @author James Hogan <james@albanarts.com>
  27  */
  28
  29 #include "KwExport.h"
  30
  31 #include <QString>
  32
  33 /// Export file filter.
  34 class KWMAIN_EXPORT KwFilter
  35 {
  36   public:
  37
  38     /*
  39      * Constructors + destructor
  40      */
  41
  42     /// Primary constructor.
  43     KwFilter();
  44
  45     /// Destructor.
  46     virtual ~KwFilter();
  47
  48     /*
  49      * Main interface
  50      */
  51
  52     /// Get the name of the file format.
  53     const QString& formatName() const;
  54
  55   private:
  56
  57     /*
  58      * Variables
  59      */
  60
  61     /// Name of the file format.
  62     QString m_formatName;
  63 };
  64
  65 #endif // _KwFilter_h_