kget/core/transfergrouphandler.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 #ifndef TRANSFERGROUPHANDLER_H
  12 #define TRANSFERGROUPHANDLER_H
  13
  14 #include <QVariant>
  15
  16 #include "transfergroup.h"
  17 #include "kget_export.h"
  18
  19 class QAction;
  20 class KMenu;
  21
  22 class QObjectInterface;
  23 class TransferGroupObserver;
  24 class TransferHandler;
  25 class Scheduler;
  26
  27 class KGET_EXPORT TransferGroupHandler
  28 {
  29     friend class TransferGroup;
  30     friend class TransferTreeModel;
  31
  32     public:
  33
  34         typedef TransferGroup::ChangesFlags ChangesFlags;
  35
  36         TransferGroupHandler(TransferGroup * group, Scheduler * scheduler);
  37
  38         ~TransferGroupHandler();
  39
  40         /**
  41          * Adds an observer to this TransferGroup
  42          *
  43          * @param observer The new observer that should be added
  44          */
  45         void addObserver(TransferGroupObserver * observer);
  46
  47         /**
  48          * Removes an observer from this TransferGroup
  49          *
  50          * @param observer The observer that should be removed
  51          */
  52         void delObserver(TransferGroupObserver * observer);
  53
  54         /**
  55          * These are all JobQueue-related functions
  56          */
  57         void start();
  58         void stop();
  59         JobQueue::Status status() const {return m_group->status();}
  60
  61         /**
  62          * Moves a list of transfers belonging to this group to a new position,
  63          * after the transfer named "after". All the transfers must belong to
  64          * this group
  65          *
  66          * @param transfers The transfers to be be moved
  67          * @param after The transfer after which the given transfers should be moved
  68          */
  69         void move(QList<TransferHandler *> transfers, TransferHandler * after);
  70
  71         /**
  72          * Sets the maximum number of jobs belonging to this queue that
  73          * should executed simultaneously by the scheduler
  74          *
  75          * @param n The maximum number of jobs
  76          */
  77         void setMaxSimultaneousJobs(int n);
  78
  79         /**
  80          * @returns the Job in the queue at the given index i
  81          */
  82         TransferHandler * operator[] (int i);
  83
  84         /**
  85          * @returns the number of Transfers owned by this object
  86          */
  87         int size()     {return m_group->size();}
  88
  89         /**Set the group name
  90          * @param name group name
  91          */
  92         void  setName(const QString &name);
  93
  94         /**
  95          * @return the group name
  96          */
  97         const QString & name()    {return m_group->name();}
  98
  99         /**
 100          * @return the sum of the sizes of the transfers belonging to
 101          * this group
 102          */
 103         int totalSize() const     {return m_group->totalSize();}
 104
 105         /**
 106          * @return the sum of the processed sizes of the transfers
 107          * belonging to this group
 108          */
 109         int processedSize() const {return m_group->processedSize();}
 110
 111         /**
 112          * @return the progress percentage
 113          */
 114         int percent() const       {return m_group->percent();}
 115
 116         /**
 117          * @return the sum of the download speeds of the running transfers
 118          * belonging this group
 119          */
 120         int speed() const         {return m_group->speed();}
 121
 122         /**
 123          * @returns the data associated to this TransferGroup item. This is
 124          * necessary to make the interview model/view work
 125          */
 126         QVariant data(int column);
 127
 128         /**
 129          * @returns the number of columns associated to the group's data
 130          */
 131         int columnCount() const     {return 5;}
 132
 133         /**
 134          * Returns the changes flags
 135          *
 136          * @param observer The observer that makes this request
 137          */
 138         ChangesFlags changesFlags(TransferGroupObserver * observer);
 139
 140         /**
 141          * Resets the changes flags for a given TransferObserver
 142          *
 143          * @param observer The observer that makes this request
 144          */
 145         void resetChangesFlags(TransferGroupObserver * observer);
 146
 147         /**
 148          * @returns the index for the given transfer. If the transfer can't
 149          *          be found, it returns -1
 150          */
 151         int indexOf(TransferHandler * transfer);
 152
 153         /**
 154          * @returns a list containing all the transfers belonging to this group.
 155          */
 156         const QList<TransferHandler *> transfers();
 157
 158         /**
 159          * @returns a pointer to a QObjectInterface object which is a QObject
 160          * by means of which you can connect signals and slots for this
 161          * transfer group.
 162          */
 163         const QList<QAction *> & actions();
 164
 165         /**
 166          * @returns a KMenu for this transfer group.
 167          */
 168         KMenu * popupMenu();
 169
 170         /**
 171          * @returns a pointer to a QObjectInterface object which is a QObject
 172          * by means of which you can connect signals and slots for this
 173          * transfer group.
 174          */
 175         QObjectInterface * qObject();
 176
 177     private:
 178         /**
 179          * Sets a change flag in the ChangesFlags variable.
 180          *
 181          * @param change The TransferChange flag to be set
 182          * @param postEvent if false the handler will not post an event to the
 183          * observers, if true the handler will post an event to the observers
 184          */
 185         void setGroupChange(ChangesFlags change, bool postEvent=false);
 186
 187         /**
 188          * Posts a TransferGroupChangedEvent to all the observers
 189          */
 190         void postGroupChangedEvent();
 191
 192         /**
 193          * Posts an addedTransferEvent to all the observers
 194          *
 195          * @param transfer the transfer that has been added to the group
 196          * @param after the transfer after which it has been added
 197          */
 198         void postAddedTransferEvent(Transfer * transfer, Transfer * after);
 199
 200         /**
 201          * Posts an removedTransferEvent to all the observers
 202          *
 203          * @param transfer the transfer that has been removed from the group
 204          */
 205         void postRemovedTransferEvent(Transfer * transfer);
 206
 207         /**
 208          * Posts an movedTransferEvent to all the observers
 209          *
 210          * @param transfer the transfer that has been removed from the group
 211          * @param after the transfer after which the it has been moved
 212          */
 213         void postMovedTransferEvent(Transfer * transfer, Transfer * after);
 214
 215         /**
 216          * Posts a deleteEvent to all the observers
 217          */
 218         void postDeleteEvent();
 219
 220         /**
 221          * Creates all the QActions
 222          */
 223         void createActions();
 224
 225         TransferGroup * m_group;
 226         Scheduler * m_scheduler;
 227
 228         QObjectInterface * m_qobject;
 229         QList<QAction *> m_actions;
 230
 231         QList<TransferGroupObserver *> m_observers;
 232         QMap<TransferGroupObserver *, ChangesFlags> m_changesFlags;
 233 };
 234
 235
 236 class QObjectInterface : public QObject
 237 {
 238     Q_OBJECT
 239     public:
 240         QObjectInterface(TransferGroupHandler * handler);
 241
 242     public slots:
 243         void slotStart();        //Starts the download process
 244         void slotStop();         //Stops the download process
 245
 246     signals:
 247
 248     private:
 249         TransferGroupHandler * m_handler;
 250 };
 251
 252 #endif