knewstuff2/core/entry.h

Go to the documentation of this file.

/*
    This file is part of KNewStuff2.
    Copyright (c) 2002 Cornelius Schumacher <schumacher@kde.org>
    Copyright (c) 2003 - 2007 Josef Spillner <spillner@kde.org>

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

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with this library.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef KNEWSTUFF2_ENTRY_H
#define KNEWSTUFF2_ENTRY_H

#include <knewstuff2/core/author.h>
#include <knewstuff2/core/ktranslatable.h>

#include <kurl.h>

#include <QtCore/QDate>
#include <QtCore/QString>

namespace KNS
{

struct EntryPrivate;

class KNEWSTUFF_EXPORT Entry
{
public:
    typedef QList<Entry*> List;

    Entry();

    Entry(const Entry& other);
    Entry& operator=(const Entry& other);

    ~Entry();

    void setName(const KTranslatable& name);

    KTranslatable name() const;

    void setCategory(const QString& category);

    QString category() const;

    void setAuthor(const Author& author);

    Author author() const;

    void setLicense(const QString& license);

    QString license() const;

    void setSummary(const KTranslatable& summary);

    KTranslatable summary() const;

    void setVersion(const QString& version);

    QString version() const;

    void setRelease(int release);

    int release() const;

    void setReleaseDate(const QDate& releasedate);

    QDate releaseDate() const;

    void setPayload(const KTranslatable& url);

    KTranslatable payload() const;

    void setPreview(const KTranslatable& url);

    KTranslatable preview() const;

    void setInstalledFiles(const QStringList& files);

    void setUnInstalledFiles(const QStringList& files);


    QStringList installedFiles() const;

    QStringList uninstalledFiles() const;



    void setRating(int rating);

    int rating() const;

    void setDownloads(int downloads);

    int downloads() const;

    // FIXME: below here, everything under consideration

    void setChecksum(const QString& checksum);

    void setSignature(const QString& signature);

    QString checksum() const;

    QString signature() const;

    enum Status {
        Invalid,
        Downloadable,
        Installed,
        Updateable,
        Deleted
    };

    void setStatus(Status status);

    // FIXME KDE5 make it const
    Status status();

    enum Source {
        Cache,
        Online,
        Registry
    };

    void setSource(Source source);
    // FIXME KDE5 make it const
    Source source();

    void setIdNumber(int number);
    int idNumber() const;

private:
    EntryPrivate * const d;
};

}

#endif