keduvocdocument.h

Go to the documentation of this file.

/***************************************************************************
                   Vocabulary Document for KDE Edu
    -----------------------------------------------------------------------
    copyright     : (C) 1999-2001 Ewald Arnold <kvoctrain@ewald-arnold.de>

                    (C) 2005, 2007 Peter Hedlund <peter.hedlund@kdemail.net>
                    (C) 2007 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 KEDUVOCDOCUMENT_H
#define KEDUVOCDOCUMENT_H

#include "libkeduvocdocument_export.h"

#include "keduvocidentifier.h"
#include "keduvocarticle.h"
#include "keduvocconjugation.h"

#include <QtCore/QObject>
#include <QtCore/QList>
#include <QtCore/QMap>

#include <KDE/KUrl>

class QStringList;
class KEduVocExpression;
class KEduVocLesson;
class KEduVocWordType;
class KEduVocLeitnerBox;

class KEDUVOCDOCUMENT_EXPORT KEduVocDocument : public QObject
{
    Q_OBJECT
public:

    enum FileType {
        KvdNone,
        Automatic,
        Kvtml,
        Wql,
        Pauker,
        Vokabeln,
        Xdxf,
        Csv,
        Kvtml1
    };

    enum ErrorCode {
        NoError = 0,
        Unknown,
        InvalidXml,
        FileTypeUnknown,
        FileCannotWrite,
        FileWriterFailed,
        FileCannotRead,
        FileReaderFailed,
        FileDoesNotExist
    };

    enum FileDialogMode
    {
        Reading,
        Writing
    };

    enum LessonDeletion
    {
        DeleteEmptyLesson,
        DeleteEntriesAndLesson
    };

    explicit KEduVocDocument( QObject* parent = 0 );

    ~KEduVocDocument();

    // *** whole document methods ***

    int open( const KUrl& url );

    int saveAs( const KUrl & url, FileType ft, const QString & generator );

    QByteArray toByteArray(const QString &generator);

    void merge( KEduVocDocument *docToMerge, bool matchIdentifiers );

    void setModified( bool dirty = true );

    bool isModified() const;

    void setUrl( const KUrl& url );

    KUrl url() const;


    void setTitle( const QString & title );

    QString title() const;

    void setAuthor( const QString & author );

    QString author() const;

    void setAuthorContact( const QString & authorContact );

    QString authorContact() const;

    void setLicense( const QString & license );

    QString license() const;

    void setDocumentComment( const QString & comment );

    QString documentComment() const;

    void setCategory( const QString & category );

    QString category() const;

    void setGenerator( const QString & generator );

    QString generator() const;

    void setVersion( const QString & ver );

    QString version() const;

    // *** identifier methods ***

    int identifierCount() const;

    int appendIdentifier( const KEduVocIdentifier & identifier = KEduVocIdentifier());

    void setIdentifier( int index, const KEduVocIdentifier& lang );

    KEduVocIdentifier& identifier( int index );

    const KEduVocIdentifier& identifier( int index ) const;

    void removeIdentifier( int index );

    int indexOfIdentifier( const QString &name ) const;

    // *** grade methods ***

    KDE_DEPRECATED void queryIdentifier( QString &org, QString &trans ) const;

    KDE_DEPRECATED void setQueryIdentifier( const QString &org, const QString &trans );

    // *** lesson methods ***

    KEduVocLesson * lesson();

    KEduVocWordType * wordTypeContainer();

    KEduVocLeitnerBox * leitnerContainer();

    // *** file format specific methods ***

    QString csvDelimiter() const;

    void setCsvDelimiter( const QString &delimiter );

    static FileType detectFileType( const QString &fileName );

    static QString pattern( FileDialogMode mode );

    static QString errorDescription( int errorCode );

Q_SIGNALS:
    void progressChanged( KEduVocDocument *, int curr_percent );

    void docModified( bool mod );

private:
    // The private data of this - see KEduVocDocument::Private, implemented in keduvocdocument.cpp
    class KEduVocDocumentPrivate;
    KEduVocDocumentPrivate* const d;

    Q_DISABLE_COPY( KEduVocDocument )
};


#endif // KEDUVOCDOCUMENT_H