kget/core/observer.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; either
   8    version 2 of the License, or (at your option) any later version.
   9 */
  10
  11
  12 #ifndef OBSERVER_H
  13 #define OBSERVER_H
  14
  15 class TransferHandler;
  16 class TransferGroupHandler;
  17
  18 /**
  19  * @brief ModelObserver class
  20  *
  21  * A view should reimplement this class in order to receive notification about
  22  * changes happened to the model
  23  */
  24 class ModelObserver
  25 {
  26     public:
  27         virtual ~ModelObserver(){}
  28
  29         /**
  30          * Notifies that a new "transfer group" has been added to the model
  31          *
  32          * @param group The "transfer group" that has just been added
  33          */
  34         virtual void addedTransferGroupEvent(TransferGroupHandler * group){ Q_UNUSED(group); }
  35
  36         /**
  37          * Notifies that a new "transfer group" has been removed from the model
  38          *
  39          * @param group The "transfer group" that has just been removed
  40          */
  41         virtual void removedTransferGroupEvent(TransferGroupHandler * group){ Q_UNUSED(group); }
  42
  43         // In the future we will have also notifications about new searches..
  44 };
  45
  46 class TransferGroupObserver
  47 {
  48     public:
  49         virtual ~TransferGroupObserver(){}
  50
  51         /**
  52          * Notifies that a transfer has changed (status, progress, etc...)
  53          *
  54          * @param group The group that has changed
  55          */
  56         virtual void groupChangedEvent(TransferGroupHandler * group){ Q_UNUSED(group); }
  57
  58         /**
  59          * Notifies that a new transfer has been added to this group
  60          *
  61          * @param transfer The transfer that has just been added
  62          * @param after The transfer after which it has been added
  63          */
  64         virtual void addedTransferEvent(TransferHandler * transfer, TransferHandler * after){ Q_UNUSED(transfer); Q_UNUSED(after); }
  65
  66         /**
  67          * Notifies that a new transfer has been removed from this group.
  68          * Note that from the moment the view receives this signal on, the
  69          * pointer to the transferHandler becomes invalid.
  70          *
  71          * @param transfer The transfer that has just been removed
  72          */
  73         virtual void removedTransferEvent(TransferHandler * transfer){ Q_UNUSED(transfer); }
  74
  75         /**
  76          * Notifies that a transfer previously belonging to this group
  77          * has been moved whithin the group.
  78          *
  79          * @param transfer The transfer that has just been moved
  80          * @param after The transfer after which it has been moved
  81          */
  82         virtual void movedTransferEvent(TransferHandler * transfer, TransferHandler * after){ Q_UNUSED(transfer); Q_UNUSED(after); }
  83
  84         /**
  85          * Notifies that this group has been deleted
  86          *
  87          * @param group This group's handler
  88          */
  89         virtual void deleteEvent(TransferGroupHandler * group){ Q_UNUSED(group); }
  90 };
  91
  92 class TransferObserver
  93 {
  94     public:
  95         virtual ~TransferObserver(){}
  96
  97         /**
  98          * Notifies that a transfer has changed (status, progress, ...)
  99          *
 100          * @param transfer The transfer that has changed
 101          */
 102         virtual void transferChangedEvent(TransferHandler * transfer){ Q_UNUSED(transfer); }
 103
 104         /**
 105          * Notifies that this transfer has been deleted
 106          *
 107          * @param transfer This transfer's handler
 108          */
 109         virtual void deleteEvent(TransferHandler * transfer){ Q_UNUSED(transfer); }
 110 };
 111
 112
 113 // Here we should add also other observers (SearchObserver)
 114
 115 #endif