keduvockvtml2reader.h

Go to the documentation of this file.

/***************************************************************************
                     read a KEduVocDocument from a KVTML2 file
    -----------------------------------------------------------------------
    copyright      : (C) 2007 Jeremy Whiting <jpwhiting@kde.org>
    Copyright 2007-2008 Frederik Gladhorn <frederik.gladhorn@kdemail.net>
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef KEDUVOCKVTML2READER_H
#define KEDUVOCKVTML2READER_H

#include <QtXml/QDomDocument>
#include <QList>

#include "keduvocexpression.h"
#include "keduvocpersonalpronoun.h"
#include "keduvocarticle.h"
#include "keduvocmultiplechoice.h"

class QIODevice;
class KEduVocDocument;
class KEduVocWordType;

class KEduVocKvtml2Reader : public QObject
{
    Q_OBJECT
public:
    KEduVocKvtml2Reader( QIODevice *file );

    bool readDoc( KEduVocDocument *doc );

    QString errorMessage() const
    {
        return m_errorMessage;
    }

private:
    bool readInformation( QDomElement &informationElement );

    bool readGroups( QDomElement &domElementParent );

    bool readIdentifier( QDomElement &identifierElement );

    bool readArticle( QDomElement &articleElement, int identifierNum );

    bool readPersonalPronoun( QDomElement &conjugElement, KEduVocPersonalPronoun &pronoun );

    bool readPersonalPronounChild(QDomElement & personElement, KEduVocPersonalPronoun &pronoun, KEduVocWordFlags flags);

    bool readWordType( KEduVocWordType* parentContainer, QDomElement &typesElement );

    bool readLeitner( KEduVocLeitnerBox* parentContainer, QDomElement &leitnerElement );

    bool readChildWordTypes( KEduVocWordType* parentContainer, QDomElement &lessonElement );

    QStringList readTenses( QDomElement &tensesElement );

    bool readUsages( QDomElement &usagesElement );

    bool readEntry( QDomElement &entryElement );

    bool readTranslation( QDomElement &translationElement, KEduVocExpression *expr, int index );

    bool readComparison( QDomElement &comparisonElement, KEduVocTranslation *translation );

    bool readMultipleChoice( QDomElement &multipleChoiceElement, KEduVocTranslation* translation );

    bool readChildLessons( KEduVocLesson* parentLesson, QDomElement &lessonElement );

    bool readLesson( KEduVocLesson* parentLesson, QDomElement &lessonElement );

    bool readSynonymsAntonymsFalseFriends( QDomElement &rootElement );

    QIODevice *m_inputFile;

    KEduVocDocument *m_doc;

    QMap<int, KEduVocExpression*> m_allEntries;

    QString m_errorMessage;
};

#endif