src/gui/torrentcontentwidget.h

   1 /*
   2  * Bittorrent Client using Qt and libtorrent.
   3  * Copyright (C) 2022  Vladimir Golovnev <glassez@yandex.ru>
   4  * Copyright (C) 2014  Ivan Sorokin <vanyacpp@gmail.com>
   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 <QTreeView>
  33
  34 #include "base/bittorrent/downloadpriority.h"
  35 #include "base/pathfwd.h"
  36
  37 class QShortcut;
  38
  39 namespace BitTorrent
  40 {
  41     class Torrent;
  42     class TorrentContentHandler;
  43     class TorrentInfo;
  44 }
  45
  46 class TorrentContentFilterModel;
  47 class TorrentContentModel;
  48
  49 class TorrentContentWidget final : public QTreeView
  50 {
  51     Q_OBJECT
  52     Q_DISABLE_COPY_MOVE(TorrentContentWidget)
  53
  54 public:
  55     enum Column
  56     {
  57         Name,
  58         Size,
  59         Progress,
  60         Priority,
  61         Remaining,
  62         Availability
  63     };
  64
  65     enum class DoubleClickAction
  66     {
  67         Open,
  68         Rename
  69     };
  70
  71     enum class ColumnsVisibilityMode
  72     {
  73         Editable,
  74         Locked
  75     };
  76
  77     explicit TorrentContentWidget(QWidget *parent = nullptr);
  78
  79     void setContentHandler(BitTorrent::TorrentContentHandler *contentHandler);
  80     BitTorrent::TorrentContentHandler *contentHandler() const;
  81     void refresh();
  82
  83     bool openByEnterKey() const;
  84     void setOpenByEnterKey(bool value);
  85
  86     DoubleClickAction doubleClickAction() const;
  87     void setDoubleClickAction(DoubleClickAction action);
  88
  89     ColumnsVisibilityMode columnsVisibilityMode() const;
  90     void setColumnsVisibilityMode(ColumnsVisibilityMode mode);
  91
  92     int getFileIndex(const QModelIndex &index) const;
  93     Path getItemPath(const QModelIndex &index) const;
  94
  95     void setFilterPattern(const QString &patternText);
  96
  97     void checkAll();
  98     void checkNone();
  99
 100 signals:
 101     void stateChanged();
 102
 103 private:
 104     void setModel(QAbstractItemModel *model) override;
 105     void keyPressEvent(QKeyEvent *event) override;
 106     void wheelEvent(QWheelEvent *event) override;
 107     QModelIndex currentNameCell() const;
 108     void displayColumnHeaderMenu();
 109     void displayContextMenu();
 110     void openItem(const QModelIndex &index) const;
 111     void openParentFolder(const QModelIndex &index) const;
 112     void openSelectedFile();
 113     void renameSelectedFile();
 114     void applyPriorities(BitTorrent::DownloadPriority priority);
 115     void applyPrioritiesByOrder();
 116     Path getFullPath(const QModelIndex &index) const;
 117     void onItemDoubleClicked(const QModelIndex &index);
 118     // Expand single-item folders recursively.
 119     // This will trigger sorting and filtering so do it after all relevant data is loaded.
 120     void expandRecursively();
 121
 122     TorrentContentModel *m_model;
 123     TorrentContentFilterModel *m_filterModel;
 124     DoubleClickAction m_doubleClickAction = DoubleClickAction::Rename;
 125     ColumnsVisibilityMode m_columnsVisibilityMode = ColumnsVisibilityMode::Editable;
 126     QShortcut *m_openFileHotkeyEnter = nullptr;
 127     QShortcut *m_openFileHotkeyReturn = nullptr;
 128 };