keduvoctranslation.h

Go to the documentation of this file.

/***************************************************************************
                        Vocabulary Expression Translation for KDE Edu
    -----------------------------------------------------------------------
    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 KEDUVOCTRANSLATION_H
#define KEDUVOCTRANSLATION_H

#include "libkeduvocdocument_export.h"
#include "keduvocconjugation.h"
#include "keduvoctext.h"
#include <KDE/KUrl>
#include <QtCore/QString>

class KEduVocExpression;
class KEduVocString;
class KEduVocWordType;
class KEduVocLeitnerBox;
class KEduVocDeclension;

class KEDUVOCDOCUMENT_EXPORT KEduVocTranslation
    :public KEduVocText
{
public:
    enum Related {
        Synonym,
        Antonym,
        FalseFriend
    };

    KEduVocTranslation(KEduVocExpression* entry);

    KEduVocTranslation(KEduVocExpression* entry, const QString &translation );

    KEduVocTranslation( const KEduVocTranslation &other );

    ~KEduVocTranslation();

    KEduVocExpression* entry();

    void setPronunciation( const QString & expression );

    QString pronunciation() const;

    QString comment() const;

    void setComment( const QString& expr );

    void setExample( const QString & expression );

    QString example() const;

    void setParaphrase( const QString & expression );

    QString paraphrase() const;

    void setAntonym( const QString & expression );

    QString antonym() const;

    void setIrregularPlural( const QString& plural );

    QString irregularPlural() const;

    KEduVocWordType* wordType() const;

    void setWordType( KEduVocWordType* wordType );

    KEduVocLeitnerBox* leitnerBox() const;

    void setLeitnerBox( KEduVocLeitnerBox* leitnerBox );

    KEduVocConjugation& conjugation( const QString& tense );

    void setConjugation( const QString& tense, const KEduVocConjugation & conjugation );

    KEduVocDeclension* declension();

    void setDeclension(KEduVocDeclension* declension);

    void setConjugations( const QMap<QString, KEduVocConjugation>& conjugations );

    QStringList conjugationTenses() const;

    KDE_DEPRECATED QMap <QString, KEduVocConjugation> conjugations() const;

    KDE_DEPRECATED QString comparative() const;
    KDE_DEPRECATED void setComparative(const QString& comparative);
    // TODO rename to comparative and remove the deprecated function
    KEduVocText comparativeForm() const;
    void setComparativeForm(const KEduVocText& comparative);

    KDE_DEPRECATED QString superlative() const;
    KDE_DEPRECATED void setSuperlative(const QString& superlative);
    KEduVocText superlativeForm() const;
    void setSuperlativeForm(const KEduVocText& superlative);

    KEduVocText article() const;
    void setArticle(const KEduVocText& article);

    QStringList & multipleChoice();

//     void setMultipleChoice( const QStringList &mc );

    KUrl soundUrl();

    void setSoundUrl(const KUrl &url);

    KUrl imageUrl();

    void setImageUrl(const KUrl &url);

    void addFalseFriend( KEduVocTranslation* falseFriend );

    void removeFalseFriend( KEduVocTranslation* falseFriend );

    QList<KEduVocTranslation*> falseFriends() const;

    void addSynonym( KEduVocTranslation* synonym );

    void removeSynonym( KEduVocTranslation* synonym );

    QList<KEduVocTranslation*> synonyms() const;

    void addAntonym( KEduVocTranslation* antonym );

    void removeAntonym( KEduVocTranslation* antonym );

    QList<KEduVocTranslation*> antonyms() const;

    KEduVocTranslation& operator= ( const KEduVocTranslation &translation );

    bool operator== ( const KEduVocTranslation &translation ) const;

    void fromKVTML2(QDomElement& parent);
    void toKVTML2(QDomElement& parent);

private:
    class KEduVocTranslationPrivate;
    KEduVocTranslationPrivate* const d;

    // for the copy constructor
    void setEntry(KEduVocExpression* entry);
    friend class KEduVocExpression;
};

#endif