src/gui/transferlistmodel.h

   1 /*
   2  * Bittorrent Client using Qt and libtorrent.
   3  * Copyright (C) 2015  Vladimir Golovnev <glassez@yandex.ru>
   4  * Copyright (C) 2010  Christophe Dumez <chris@qbittorrent.org>
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License
   8  * as published by the Free Software Foundation; either version 2
   9  * of the License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  19  *
  20  * In addition, as a special exception, the copyright holders give permission to
  21  * link this program with the OpenSSL project's "OpenSSL" library (or with
  22  * modified versions of it that use the same license as the "OpenSSL" library),
  23  * and distribute the linked executables. You must obey the GNU General Public
  24  * License in all respects for all of the code used other than "OpenSSL".  If you
  25  * modify file(s), you may extend this exception to your version of the file(s),
  26  * but you are not obligated to do so. If you do not wish to do so, delete this
  27  * exception statement from your version.
  28  */
  29
  30 #pragma once
  31
  32 #include <QAbstractListModel>
  33 #include <QColor>
  34 #include <QHash>
  35 #include <QIcon>
  36 #include <QList>
  37
  38 #include "base/bittorrent/torrent.h"
  39
  40 namespace BitTorrent
  41 {
  42     class InfoHash;
  43 }
  44
  45 class TransferListModel final : public QAbstractListModel
  46 {
  47     Q_OBJECT
  48     Q_DISABLE_COPY_MOVE(TransferListModel)
  49
  50 public:
  51     enum Column
  52     {
  53         TR_QUEUE_POSITION,
  54         TR_NAME,
  55         TR_SIZE,
  56         TR_TOTAL_SIZE,
  57         TR_PROGRESS,
  58         TR_STATUS,
  59         TR_SEEDS,
  60         TR_PEERS,
  61         TR_DLSPEED,
  62         TR_UPSPEED,
  63         TR_ETA,
  64         TR_RATIO,
  65         TR_CATEGORY,
  66         TR_TAGS,
  67         TR_ADD_DATE,
  68         TR_SEED_DATE,
  69         TR_TRACKER,
  70         TR_DLLIMIT,
  71         TR_UPLIMIT,
  72         TR_AMOUNT_DOWNLOADED,
  73         TR_AMOUNT_UPLOADED,
  74         TR_AMOUNT_DOWNLOADED_SESSION,
  75         TR_AMOUNT_UPLOADED_SESSION,
  76         TR_AMOUNT_LEFT,
  77         TR_TIME_ELAPSED,
  78         TR_SAVE_PATH,
  79         TR_COMPLETED,
  80         TR_RATIO_LIMIT,
  81         TR_SEEN_COMPLETE_DATE,
  82         TR_LAST_ACTIVITY,
  83         TR_AVAILABILITY,
  84         TR_DOWNLOAD_PATH,
  85         TR_INFOHASH_V1,
  86         TR_INFOHASH_V2,
  87
  88         NB_COLUMNS
  89     };
  90
  91     enum DataRole
  92     {
  93         UnderlyingDataRole = Qt::UserRole,
  94         AdditionalUnderlyingDataRole
  95     };
  96
  97     explicit TransferListModel(QObject *parent = nullptr);
  98
  99     int rowCount(const QModelIndex &parent = {}) const override;
 100     int columnCount(const QModelIndex &parent = {}) const override;
 101     QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const override;
 102     bool setData(const QModelIndex &index, const QVariant &value, int role) override;
 103     QVariant headerData(int section, Qt::Orientation orientation, int role) const override;
 104     Qt::ItemFlags flags(const QModelIndex &index) const override;
 105
 106     BitTorrent::Torrent *torrentHandle(const QModelIndex &index) const;
 107
 108 private slots:
 109     void addTorrents(const QVector<BitTorrent::Torrent *> &torrents);
 110     void handleTorrentAboutToBeRemoved(BitTorrent::Torrent *torrent);
 111     void handleTorrentStatusUpdated(BitTorrent::Torrent *torrent);
 112     void handleTorrentsUpdated(const QVector<BitTorrent::Torrent *> &torrents);
 113
 114 private:
 115     void configure();
 116     QString displayValue(const BitTorrent::Torrent *torrent, int column) const;
 117     QVariant internalValue(const BitTorrent::Torrent *torrent, int column, bool alt) const;
 118     QIcon getIconByState(BitTorrent::TorrentState state) const;
 119
 120     QList<BitTorrent::Torrent *> m_torrentList;  // maps row number to torrent handle
 121     QHash<BitTorrent::Torrent *, int> m_torrentMap;  // maps torrent handle to row number
 122     const QHash<BitTorrent::TorrentState, QString> m_statusStrings;
 123     // row text colors
 124     const QHash<BitTorrent::TorrentState, QColor> m_stateThemeColors;
 125
 126     enum class HideZeroValuesMode
 127     {
 128         Never,
 129         Paused,
 130         Always
 131     };
 132
 133     HideZeroValuesMode m_hideZeroValuesMode = HideZeroValuesMode::Never;
 134
 135     // cached icons
 136     QIcon m_checkingIcon;
 137     QIcon m_completedIcon;
 138     QIcon m_downloadingIcon;
 139     QIcon m_errorIcon;
 140     QIcon m_pausedIcon;
 141     QIcon m_queuedIcon;
 142     QIcon m_stalledDLIcon;
 143     QIcon m_stalledUPIcon;
 144     QIcon m_uploadingIcon;
 145 };
 146
 147 Q_DECLARE_METATYPE(TransferListModel::Column)