kget/core/transfergroup.h

   1 /* This file is part of the KDE project
   2
   3    Copyright (C) 2005 Dario Massarin <nekkar@libero.it>
   4
   5    This program is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU General Public
   7    License as published by the Free Software Foundation; version 2
   8    of the License.
   9 */
  10
  11
  12 #ifndef GROUP_H
  13 #define GROUP_H
  14
  15 #include <kio/netaccess.h>
  16
  17 #include "jobqueue.h"
  18 #include "kget_export.h"
  19
  20 class QDomElement;
  21
  22 class Transfer;
  23 class TransferGroupHandler;
  24 class TransferTreeModel;
  25
  26 /**
  27  * class TransferGroup:
  28  *
  29  * This class abstracts the concept of transfer group by means of which
  30  * the user can sort his transfers into categories.
  31  * By definition, we want each TransferGroup (transfer group) to be a JobQueue.
  32  * Moreover this class calculates information such as:
  33  * - the size obtained by the sum of all the transfer's size
  34  * - the size obtained by the sum of all the transfer's processed size
  35  * - the global progress percentage within the group
  36  * - the global speed within the group
  37  */
  38 class KGET_EXPORT TransferGroup : public JobQueue
  39 {
  40     public:
  41         enum GroupChange
  42         {
  43             Gc_None          = 0x00000000,
  44             Gc_Status        = 0x00000001,
  45             Gc_TotalSize     = 0x00000002,
  46             Gc_ProcessedSize = 0x00000004,
  47             Gc_Percent       = 0x00000008,
  48             Gc_Speed         = 0x00000010
  49         };
  50
  51         typedef int ChangesFlags;
  52
  53         TransferGroup(TransferTreeModel * model, Scheduler * scheduler, const QString & name=QString());
  54
  55         virtual ~TransferGroup();
  56
  57         /**
  58          * This function is reimplemented by JobQueue::setStatus
  59          *
  60          * @param queueStatus the new JobQueue status
  61          */
  62         void setStatus(Status queueStatus);
  63
  64         /**
  65          * Appends a new transfer to the list of the transfers
  66          *
  67          * @param transfer the transfer to append
  68          */
  69         void append(Transfer * transfer);
  70
  71         /**
  72          * Prepends a new transfer to the list of the transfers
  73          *
  74          * @param transfer the transfer to prepend
  75          */
  76         void prepend(Transfer * transfer);
  77
  78         /**
  79          * inserts a transfer to the current group after the given transfer
  80          *
  81          * @param transfer The transfer to add in the current Group
  82          * @param after The transfer after which to add the transfer
  83          */
  84         void insert(Transfer * transfer, Transfer * after);
  85
  86         /**
  87          * Removes the given transfer from the list of the transfers
  88          *
  89          * @param transfer the transfer to remove
  90          */
  91         void remove(Transfer * transfer);
  92
  93         /**
  94          * Moves a transfer in the list
  95          *
  96          * @param transfer The transfer to move. Note that this transfer can
  97          *                  belong to other groups. In this situation this
  98          *                  transfer is deleted from the previous group and
  99          *                  moved inside this one.
 100          * @param after The transfer after which we have to move the given one
 101          */
 102         void move(Transfer * transfer, Transfer * after);
 103
 104         /**
 105          * Finds the first transfer with source src
 106          *
 107          * @param src the url of the source location
 108          *
 109          * @return the transfer pointer if the transfer has been found. Otherwise
 110          * it returns 0
 111          */
 112         Transfer * findTransfer(const KUrl &src);
 113
 114         /***
 115          * Finds the first transfer with destination dest
 116          *
 117          * @param dest the url of the destination location
 118          *
 119          * @return the transfer pointer if the transfer has been found, else return 0
 120          */
 121          Transfer *findTransferByDestination(const KUrl &dest);
 122
 123         /**
 124          * @returns the Job in the queue at the given index i
 125          */
 126         Transfer * operator[] (int i) const;
 127
 128         /**Set the group name
 129          * @param name group name
 130          */
 131         void  setName(const QString &name)    {m_name=name;}
 132
 133         /**
 134          * @return the group name
 135          */
 136         const QString & name()    {return m_name;}
 137
 138         /**
 139          * @return the sum of the sizes of the transfers belonging to
 140          * this group
 141          */
 142         int totalSize() const     {return m_totalSize;}
 143
 144         /**
 145          * @return the sum of the processed sizes of the transfers
 146          * belonging to this group
 147          */
 148         int processedSize() const {return m_processedSize;}
 149
 150         /**
 151          * @return the progress percentage
 152          */
 153         int percent() const       {return m_percent;}
 154
 155         /**
 156          * @return the sum of the download speeds of the running transfers
 157          * belonging this group
 158          */
 159         int speed() const         {return m_speed;}
 160
 161         /**
 162          * @return the handler associated with this group
 163          */
 164         TransferGroupHandler * handler();
 165
 166         /**
 167          * @returns the TransferTreeModel that owns this group
 168          */
 169         TransferTreeModel * model()     {return m_model;}
 170
 171         /**
 172          * Notifies that the given transfer has changed
 173          *
 174          * @param transfer The transfer that has changed
 175          */
 176         void transferChangedEvent(Transfer * transfer);
 177
 178         /**
 179          * Saves this group object to the given QDomNode
 180          *
 181          * @param n The QDomNode where the group will be saved
 182          */
 183         void save(QDomElement e);
 184
 185         /**
 186          * Adds all the groups in the given QDomNode * to the group
 187          *
 188          * @param n The QDomNode where the group will look for the transfers to add
 189          */
 190         void load(const QDomElement & e);
 191
 192     private:
 193         TransferTreeModel * m_model;
 194         TransferGroupHandler * m_handler;
 195
 196         //TransferGroup info
 197         QString m_name;
 198         int m_totalSize;
 199         int m_processedSize;
 200         int m_percent;
 201         int m_speed;
 202 };
 203
 204 #endif