keduvoctext.h

Go to the documentation of this file.

/***************************************************************************
    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 KEDUVOCTEXT_H
#define KEDUVOCTEXT_H

#include "libkeduvocdocument_export.h"
#include <QtCore/QDateTime>


#define KV_MAX_GRADE       7
#define KV_MIN_GRADE       0

#define KV_NORM_GRADE      0       // not practiced yet
#define KV_NORM_TEXT       I18N_NOOP("Not Practiced Yet")

#define KV_LEV1_GRADE      1
#define KV_LEV1_TEXT       I18N_NOOP("Level 1")

#define KV_LEV2_GRADE      2
#define KV_LEV2_TEXT       I18N_NOOP("Level 2")

#define KV_LEV3_GRADE      3
#define KV_LEV3_TEXT       I18N_NOOP("Level 3")

#define KV_LEV4_GRADE      4
#define KV_LEV4_TEXT       I18N_NOOP("Level 4")

#define KV_LEV5_GRADE      5
#define KV_LEV5_TEXT       I18N_NOOP("Level 5")

#define KV_LEV6_GRADE      6
#define KV_LEV6_TEXT       I18N_NOOP("Level 6")

#define KV_LEV7_GRADE      7
#define KV_LEV7_TEXT       I18N_NOOP("Level 7")


typedef unsigned short grade_t;
typedef unsigned short count_t;

class QDomElement;

class KEDUVOCDOCUMENT_EXPORT KEduVocText
{
public:
    KEduVocText(const QString& text = QString());

    KEduVocText( const KEduVocText &other );

    ~KEduVocText();

    QString text() const;

    void setText( const QString & expr );

    KEduVocText& operator= ( const KEduVocText &other );
    bool operator== ( const KEduVocText &other ) const;


    count_t practiceCount() const;

    void setPracticeCount( count_t count );

    count_t badCount() const;

    void setBadCount( count_t count );

    void incBadCount();

    void incPracticeCount();

    void resetGrades();

    void setGrade( grade_t grade );

    grade_t grade() const;

    void incGrade();

    void decGrade();

    QDateTime practiceDate() const;

    void setPracticeDate( const QDateTime & date );

    bool isEmpty();

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

private:
    class KEduVocTextPrivate;
    KEduVocTextPrivate * const d;
};

#endif