transfergroup.h

Go to the documentation of this file.

/* This file is part of the KDE project

   Copyright (C) 2005 Dario Massarin <nekkar@libero.it>
   Copyright (C) 2009 Lukas Appelhans <l.appelhans@gmx.de>
   Coypright (C) 2010 Matthias Fuchs <mat69@gmx.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 GROUP_H
#define GROUP_H

#include <QRegExp>

#include <kio/netaccess.h>
#include <KIcon>
#include <KDebug>

#include "jobqueue.h"
#include "../kget_export.h"
#include "transfer.h"

#ifdef HAVE_NEPOMUK
    #include <Nepomuk2/Tag>
#endif

class QDomElement;

class TransferGroupHandler;
class TransferTreeModel;

class KGET_EXPORT TransferGroup : public JobQueue
{
    Q_OBJECT
    public:
        enum GroupChange
        {
            Gc_None                = 0x00000000,
            // These flags respect the Model columns order
            Gc_GroupName           = 0x00000001,
            Gc_Status              = 0x00000002,
            Gc_TotalSize           = 0x00000004,
            Gc_Percent             = 0x00000008,
            Gc_UploadSpeed         = 0x00000010,
            Gc_DownloadSpeed       = 0x00000020,
            // Misc
            Gc_ProcessedSize       = 0x00010000
        };

        typedef int ChangesFlags;

        TransferGroup(TransferTreeModel * model, Scheduler * parent, const QString & name=QString());

        virtual ~TransferGroup();

        void setStatus(Status queueStatus);

        void append(Transfer * transfer);

        void append(const QList<Transfer*> &transfer);

        void prepend(Transfer * transfer);

        void insert(Transfer * transfer, Transfer * after);

        void remove(Transfer * transfer);

        void remove(const QList<Transfer*> &transfers);

        void move(Transfer * transfer, Transfer * after);

        Transfer * findTransfer(const KUrl &src);

         Transfer *findTransferByDestination(const KUrl &dest);

        Transfer * operator[] (int i) const {return (Transfer *)((* (JobQueue *)this)[i]);}

        void  setName(const QString &name)    {m_name=name;}

        const QString & name()    {return m_name;}

        int totalSize() const     {return m_totalSize;}

        int downloadedSize() const {return m_downloadedSize;}

        int uploadedSize() const {return m_uploadedSize;}

        int percent() const       {return m_percent;}

        int downloadSpeed();

        int uploadSpeed();

        void setDefaultFolder(QString folder) {m_defaultFolder = folder;}

        QString defaultFolder() {return m_defaultFolder;}

        void setRegExp(const QRegExp &regExp) {m_regExp = regExp;}

        QRegExp regExp() {return m_regExp;}

#ifdef HAVE_NEPOMUK

        void setTags(const QList<Nepomuk2::Tag> &tags);

        QList<Nepomuk2::Tag> tags() const { return m_tags.values(); }
#endif //HAVE_NEPOMUK

        bool supportsSpeedLimits();

        void setDownloadLimit(int dlLimit, Transfer::SpeedLimit limit);

        int downloadLimit(Transfer::SpeedLimit limit) const;

        void setUploadLimit(int ulLimit, Transfer::SpeedLimit limit);

        int uploadLimit(Transfer::SpeedLimit limit) const;

        void setIconName(const QString &name) {m_iconName = name;}

        QString iconName() const {return m_iconName;}

        QPixmap pixmap() {return KIcon(m_iconName).pixmap(32);}

        TransferGroupHandler * handler() const {return m_handler;}

        TransferTreeModel * model()     {return m_model;}

        void calculateSpeedLimits();

        void calculateDownloadLimit();

        void calculateUploadLimit();

        void save(QDomElement e);

        void load(const QDomElement & e);

    private:
        TransferTreeModel * m_model;
        TransferGroupHandler * m_handler;

        //TransferGroup info
        QString m_name;
        int m_totalSize;
        int m_downloadedSize;
        int m_uploadedSize;
        int m_percent;
        int m_downloadSpeed;
        int m_uploadSpeed;
        int m_downloadLimit;
        int m_uploadLimit;
        int m_visibleDownloadLimit;
        int m_visibleUploadLimit;
        QString m_iconName;
        QString m_defaultFolder;
        QRegExp m_regExp;
#ifdef HAVE_NEPOMUK
        QMap<QUrl, Nepomuk2::Tag> m_tags;
#endif //HAVE_NEPOMUK
};

#endif