entryinternal.h

Go to the documentation of this file.

/*
    knewstuff3/entry.h.
    Copyright (c) 2002 Cornelius Schumacher <schumacher@kde.org>
    Copyright (c) 2003 - 2007 Josef Spillner <spillner@kde.org>
    Copyright (c) 2009 Jeremy Whiting <jpwhiting@kde.org>
    Copyright (C) 2009 Frederik Gladhorn <gladhorn@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 KNEWSTUFF3_ENTRY_H
#define KNEWSTUFF3_ENTRY_H

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

#include <kurl.h>

#include <knewstuff3/core/author.h>
#include <knewstuff3/entry.h>

namespace KNS3
{
    static const int PreviewWidth = 96;
    static const int PreviewHeight = 72;

    QString replaceBBCode(const QString& unformattedText);

class EntryInternal
{
public:
    typedef QList<EntryInternal> List;

    enum Source {
        Cache,
        Online,
        Registry
    };

    enum PreviewType {
        PreviewSmall1,
        PreviewSmall2,
        PreviewSmall3,
        PreviewBig1,
        PreviewBig2,
        PreviewBig3
    };

    struct DownloadLinkInformation {
        QString name;
        QString priceAmount;
        QString distributionType;
        QString descriptionLink;
        int id;
        bool isDownloadtypeLink;
    };

    EntryInternal();

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

    bool operator==(const EntryInternal& other) const;
    bool operator<(const EntryInternal& other) const;

    ~EntryInternal();

    bool isValid() const;

    void setName(const QString& name);

    QString name() const;

    void setUniqueId(const QString& id);
    QString uniqueId() const;

    void setCategory(const QString& category);

    QString category() const;

    void setHomepage(const KUrl& page);
    KUrl homepage() const;

    void setAuthor(const Author& author);

    Author author() const;

    void setLicense(const QString& license);

    QString license() const;

    void setSummary(const QString& summary);

    QString summary() const;

    void setChangelog(const QString& changelog);
    QString changelog() const;

    void setVersion(const QString& version);

    QString version() const;

    void setReleaseDate(const QDate& releasedate);

    QDate releaseDate() const;

    void setUpdateVersion(const QString& version);

    QString updateVersion() const;

    void setUpdateReleaseDate(const QDate& releasedate);

    QDate updateReleaseDate() const;

    void setPayload(const QString& url);

    QString payload() const;

    void setPreviewUrl(const QString& url, PreviewType type = PreviewSmall1);

    QString previewUrl(PreviewType type = PreviewSmall1) const;

    QImage previewImage(PreviewType type = PreviewSmall1) const;
    void setPreviewImage(const QImage& image, PreviewType type = PreviewSmall1);

    void setInstalledFiles(const QStringList& files);

    QStringList installedFiles() const;

    void setUnInstalledFiles(const QStringList& files);

    QStringList uninstalledFiles() const;

    void setRating(int rating);

    int rating() const;

    void setDownloadCount(int downloads);

    int downloadCount() const;

    int numberFans() const;
    void setNumberFans(int fans);
    
    int numberKnowledgebaseEntries() const;
    void setNumberKnowledgebaseEntries(int num);
    QString knowledgebaseLink() const;
    void setKnowledgebaseLink(const QString& link);

    int downloadLinkCount() const;
    QList<DownloadLinkInformation> downloadLinkInformationList() const;
    void appendDownloadLinkInformation(const DownloadLinkInformation& info);
    void clearDownloadLinkInformation();

    QString donationLink() const;
    void setDonationLink(const QString& link);
    
    QString providerId() const;
    void setProviderId(const QString& id);

    void setSource(Source source);
    Source source() const;

    bool setEntryXML(const QDomElement & xmldata);

    QDomElement entryXML() const;

    //QString checksum() const;

    //void setChecksum(const QString& checksum);

    //QString signature() const;

    //void setSignature(const QString& signature);

    void setStatus(Entry::Status status);

    Entry::Status status() const;

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

    Entry toEntry() const;
    
    static KNS3::EntryInternal fromEntry(const KNS3::Entry& entry);
private:
    class Private;
    QExplicitlySharedDataPointer<Private> d;
};

inline uint qHash(const KNS3::EntryInternal& entry) {
    return qHash(entry.uniqueId());
}

}

#endif