kjots/knowitimporter.h

   1 /*
   2  * This file is part of KJots
   3  *
   4  * Copyright 2008 Stephen Kelly <steveire@gmail.com>
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2 of the License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19  * 02110-1301  USA
  20  */
  21
  22 #ifndef KNOWITIMPORTER_H
  23 #define KNOWITIMPORTER_H
  24
  25 class QDomElement;
  26
  27 #include <QHash>
  28 #include <QDomDocument>
  29
  30 class KUrl;
  31
  32 struct KnowItNote
  33 {
  34   QString title;
  35   int depth;
  36   QString content;
  37   int id; // Only used to determine parent /child relationships. This is not the KJots Page or Book id.
  38   int parent;
  39
  40   QList< QPair< QString, QString > > links;
  41
  42
  43 };
  44
  45 /**
  46 Class for importing KNowIt notes. KNowIt is not longer maintained.
  47 @since 4.2
  48 */
  49 class KnowItImporter
  50 {
  51 public:
  52   KnowItImporter();
  53
  54   /**
  55   Create a KJotsBook from the knowit file at @p url.
  56   */
  57   void importFromUrl( const KUrl& url );
  58
  59   private:
  60     /**
  61     Builds several trees with roots at m_notes.
  62     @param url The url of the knowit file.
  63     */
  64     void buildNoteTree( const KUrl& url );
  65
  66     /**
  67     Add a representation of note @p n to m_domDoc. If @p n has child notes, it will create a book, otherwise a page.
  68     */
  69     QDomElement addNote( const KnowItNote& n );
  70
  71     /**
  72     Build a domDocument from the notes rooted at m_notes.
  73     */
  74     void buildDomDocument();
  75
  76
  77     QList<KnowItNote> m_notes; // Top level notes.
  78     QList<KnowItNote> m_lastNoteAtLevel;
  79     QDomDocument m_domDoc;
  80     QHash <int, KnowItNote> m_noteHash;
  81     QHash <int, QList< int > > m_childNotes;
  82 };
  83
  84 #endif