adapt qmvockvtml2writer.h for querymee

diff --git a/qmvockvtml2writer.h b/qmvockvtml2writer.h
index aa8b97fad29ea95cfee902dae22df3883e0a2ac0..026fcbd247ead733fba2ee687689dceb1fbc3c89 100644 (file)
--- a/qmvockvtml2writer.h
+++ b/qmvockvtml2writer.h
@@ -1,8 +1,13 @@
 /***************************************************************************
-                     export a KEduVocDocument to a KVTML file
+*   this file is from kdeedu project. Filename: keduvockvtml2writer.h
+***************************************************************************/
+
+/***************************************************************************
+                     export a QmVocDocument to a KVTML file
     -----------------------------------------------------------------------
     copyright       : (C) 2007 Jeremy Whiting <jpwhiting@kde.org>
                       (C) 2007-2008 Frederik Gladhorn <frederik.gladhorn@kdemail.net>
+                      (C) 2010, 2012 Reto Zingg <g.d0b3rm4n@gmail.com>
  ***************************************************************************/
 
 /***************************************************************************
@@ -14,35 +19,35 @@
  *                                                                         *
  ***************************************************************************/
 
-#ifndef KEDUVOCKVTML2WRITER_H
-#define KEDUVOCKVTML2WRITER_H
+#ifndef QMVOCKVTML2WRITER_H
+#define QMVOCKVTML2WRITER_H
 
 #include <QtXml/QDomDocument>
 #include <QtCore/QList>
 #include <QtCore/QFile>
 
-#include "keduvocarticle.h"
-#include "keduvocmultiplechoice.h"
-#include "keduvoctranslation.h"
-#include "keduvocpersonalpronoun.h"
+#include "qmvocarticle.h"
+#include "qmvocmultiplechoice.h"
+#include "qmvoctranslation.h"
+#include "qmvocpersonalpronoun.h"
 
-class KEduVocDocument;
-class KEduVocExpression;
-class KEduVocLesson;
-class KEduVocLeitnerBox;
+class QmVocDocument;
+class QmVocExpression;
+class QmVocLesson;
+class QmVocLeitnerBox;
 
 /**
-* @brief Class to write kvtml2 data files from KEduVocDocument
+* @brief Class to write kvtml2 data files from QmVocDocument
 * @author Jeremy Whiting
 */
-class KEduVocKvtml2Writer
+class QmVocKvtml2Writer
 {
 public:
-    KEduVocKvtml2Writer( QFile *file );
+    QmVocKvtml2Writer( QFile *file );
 
-    bool writeDoc( KEduVocDocument *doc, const QString &generator );
+    bool writeDoc( QmVocDocument *doc, const QString &generator );
 
-    QByteArray toByteArray( KEduVocDocument *doc, const QString &generator );
+    QByteArray toByteArray( QmVocDocument *doc, const QString &generator );
 
     /**
      * Helper function, appends a new element AND a text child to @p parent
@@ -55,7 +60,7 @@ public:
 
 private:
 
-    bool createXmlDocument( KEduVocDocument *doc, const QString &generator );
+    bool createXmlDocument( QmVocDocument *doc, const QString &generator );
 
     /** write information entries
      * @param informationElement QDomElement information to write to
@@ -74,19 +79,19 @@ private:
      */
     bool writeArticle( QDomElement &articleElement, int article );
 
-    bool writePersonalPronoun( QDomElement &pronounElement, const KEduVocPersonalPronoun &pronoun);
+    bool writePersonalPronoun( QDomElement &pronounElement, const QmVocPersonalPronoun &pronoun);
     /** write types
      * @param typesElement QDomElement types to write to
      */
-    bool writeWordTypes( QDomElement &typesElement, KEduVocWordType* parentContainer );
+    bool writeWordTypes( QDomElement &typesElement, QmVocWordType* parentContainer );
 
     /**
-     * write the leitner boxes @see KEduVocLeitnerBox
+     * write the leitner boxes @see QmVocLeitnerBox
      * @param leitnerParentElement parent dom element
-     * @param parentContainer parent of the KEduVocLeitnerBoxes to write
+     * @param parentContainer parent of the QmVocLeitnerBoxes to write
      * @return success
      */
-    bool writeLeitnerBoxes( QDomElement &leitnerParentElement, KEduVocLeitnerBox* parentContainer );
+    bool writeLeitnerBoxes( QDomElement &leitnerParentElement, QmVocLeitnerBox* parentContainer );
 
     /** write entries
      * @param entriesElement QDomElement entries to write to
@@ -97,7 +102,7 @@ private:
      * @param translationElement QDomElement translation to write to, with id pre-set
      * @param translation object to write
      */
-    bool writeTranslation( QDomElement &translationElement, KEduVocTranslation* translation );
+    bool writeTranslation( QDomElement &translationElement, QmVocTranslation* translation );
 
     /**
      * Used to write synonym, antonym and false friend lists
@@ -105,13 +110,13 @@ private:
      * @param parentContainer 
      * @return 
      */
-    bool writeRelated( QDomElement &parentElement, QList<KEduVocTranslation*> relatedList );
+    bool writeRelated( QDomElement &parentElement, QList<QmVocTranslation*> relatedList );
 
     /** write the lesson group
      * @param parentLesson the parent lesson of the current lesson
      * @param lessonsElement QDomElement lessons to write to
      */
-    bool writeLessons( KEduVocLesson *parentLesson, QDomElement &lessonsElement );
+    bool writeLessons( QmVocLesson *parentLesson, QDomElement &lessonsElement );
 
     void writeSynonymAntonymFalseFriend(QDomElement & parentElement);
 
@@ -119,17 +124,17 @@ private:
      * @param multipleChoiceElement QDomElement multiplechoice to write to
      * @returns success
      */
-    bool writeMultipleChoice( QDomElement &multipleChoiceElement, KEduVocTranslation* translation );
+    bool writeMultipleChoice( QDomElement &multipleChoiceElement, QmVocTranslation* translation );
 
     QDomElement newTextElement( const QString &elementName, const QString &text );
 
     QFile *m_outputFile;
-    KEduVocDocument *m_doc;
+    QmVocDocument *m_doc;
 
-    QList<KEduVocExpression*>  m_allEntries;
-    QList<KEduVocTranslation*> m_synonyms;
-    QList<KEduVocTranslation*> m_antonyms;
-    QList<KEduVocTranslation*> m_falseFriends;
+    QList<QmVocExpression*>  m_allEntries;
+    QList<QmVocTranslation*> m_synonyms;
+    QList<QmVocTranslation*> m_antonyms;
+    QList<QmVocTranslation*> m_falseFriends;
 
     QDomDocument m_domDoc;
 };