src/gui/torrentcontentwidget.h

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