dcc: Introduce TransferModel for DCC file transfers

[quassel.git] / src / client / transfermodel.h

diff --git a/src/client/transfermodel.h b/src/client/transfermodel.h
new file mode 100644 (file)
index 0000000..1f9821a
--- /dev/null
+++ b/src/client/transfermodel.h
@@ -0,0 +1,89 @@
+/***************************************************************************
+ *   Copyright (C) 2005-2016 by the Quassel Project                        *
+ *   devel@quassel-irc.org                                                 *
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU General Public License as published by  *
+ *   the Free Software Foundation; either version 2 of the License, or     *
+ *   (at your option) version 3.                                           *
+ *                                                                         *
+ *   This program is distributed in the hope that it will be useful,       *
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
+ *   GNU General Public License for more details.                          *
+ *                                                                         *
+ *   You should have received a copy of the GNU General Public License     *
+ *   along with this program; if not, write to the                         *
+ *   Free Software Foundation, Inc.,                                       *
+ *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
+ ***************************************************************************/
+
+#pragma once
+
+#include <QAbstractTableModel>
+#include <QString>
+#include <QVector>
+#include <QUuid>
+
+#include "transfer.h"
+
+class TransferManager;
+
+/**
+ * Model that holds the current list of transfers.
+ */
+class TransferModel : public QAbstractTableModel
+{
+    Q_OBJECT
+
+public:
+    using QAbstractTableModel::QAbstractTableModel;
+
+    // see base class docs
+    int rowCount(const QModelIndex &index = {}) const override;
+    int columnCount(const QModelIndex &index = {}) const override;
+    QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const override;
+    QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const override;
+
+    /**
+     * Access the transfer for the given ID
+     *
+     * @param[in] transferId Transfer ID
+     * @returns A pointer to the transfer with the given ID, or nullptr for an unknown ID
+     */
+    Transfer *transfer(const QUuid &transferId) const;
+
+    /**
+     * Sets the TransferManager associated with this model.
+     *
+     * The model receives data from the given TransferManager instance. If set to nullptr, the model
+     * is cleared.
+     *
+     * @param[in] manager Pointer to the TransferManager instance, or nullptr for clearing the model
+     */
+    void setManager(const TransferManager *manager);
+
+private slots:
+    /**
+     * Slot to be called when a transfer is added.
+     *
+     * @param[in] transferId The transfer's ID
+     */
+    void onTransferAdded(const QUuid &transferId);
+
+    /**
+     * Slot to be called when a transfer is removed.
+     *
+     * @param[in] transferId The transfer's ID
+     */
+    void onTransferRemoved(const QUuid &transferId);
+
+    /**
+     * Slot to be called when a transfer's data changes.
+     */
+    void onTransferDataChanged();
+
+private:
+    const TransferManager *_manager{nullptr}; ///< Pointer to the active TransferManager instance, if any
+    QVector<QUuid> _transferIds;              ///< List of transfer IDs
+};