kworship/KwKWorshipFilterData.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 _KwKWorshipFilterData_h_
  21 #define _KwKWorshipFilterData_h_
  22
  23 /**
  24  * @file KwKWorshipFilterData.h
  25  * @brief Additional KWorship import data.
  26  * @author James Hogan <james@albanarts.com>
  27  */
  28
  29 #include "KwFilterData.h"
  30
  31 #include <QDomDocumentFragment>
  32 #include <QString>
  33
  34 /// Additional KWorship import data.
  35 class KwKWorshipFilterData : public KwFilterData
  36 {
  37   public:
  38
  39     /*
  40      * Constructors + destructor
  41      */
  42
  43     /// Primary constructor.
  44     KwKWorshipFilterData();
  45
  46     /// Destructor.
  47     virtual ~KwKWorshipFilterData();
  48
  49     /*
  50      * Import filter interface
  51      */
  52
  53     /** Indicate that elements of a particular tag name have been handled.
  54      * This clears the specified elements from the DOM preserve.
  55      */
  56     void elementsHandled(const QString& tagName);
  57
  58     /** Indicate that the first elements of a particular tag name have been handled.
  59      * This clears the specified element from the DOM preserve.
  60      */
  61     void elementHandled(const QString& tagName);
  62
  63   private:
  64
  65     /*
  66      * Variables
  67      */
  68
  69     /// Fragment of DOM from save file which needs preserving.
  70     QDomDocumentFragment m_domPreserve;
  71 };
  72
  73 #endif // _KwKWorshipFilterData_h_