src/uisupport/bufferview.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2020 by the Quassel Project                        *
   3  *   devel@quassel-irc.org                                                 *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) version 3.                                           *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
  19  ***************************************************************************/
  20
  21 #pragma once
  22
  23 #include "uisupport-export.h"
  24
  25 #include <QAction>
  26 #include <QDockWidget>
  27 #include <QMenu>
  28 #include <QModelIndex>
  29 #include <QPointer>
  30 #include <QStyledItemDelegate>
  31
  32 #include "actioncollection.h"
  33 #include "bufferviewconfig.h"
  34 #include "networkmodel.h"
  35 #include "treeviewtouch.h"
  36 #include "types.h"
  37
  38 /*****************************************
  39  * The TreeView showing the Buffers
  40  *****************************************/
  41 class UISUPPORT_EXPORT BufferView : public TreeViewTouch
  42 {
  43     Q_OBJECT
  44
  45 public:
  46     enum Direction
  47     {
  48         Forward = 1,
  49         Backward = -1
  50     };
  51
  52     BufferView(QWidget* parent = nullptr);
  53     void init();
  54
  55     void setModel(QAbstractItemModel* model) override;
  56     void setFilteredModel(QAbstractItemModel* model, BufferViewConfig* config);
  57
  58     void setConfig(BufferViewConfig* config);
  59     inline BufferViewConfig* config() { return _config; }
  60
  61     void addActionsToMenu(QMenu* menu, const QModelIndex& index);
  62     void addFilterActions(QMenu* contextMenu, const QModelIndex& index);
  63
  64     void selectFirstBuffer();
  65
  66 public slots:
  67     void setRootIndexForNetworkId(const NetworkId& networkId);
  68     void removeSelectedBuffers(bool permanently = false);
  69     void menuActionTriggered(QAction*);
  70     void nextBuffer();
  71     void previousBuffer();
  72     void hideCurrentBuffer();
  73     void filterTextChanged(const QString& filterString);
  74     void changeHighlight(Direction direction);
  75     void selectHighlighted();
  76     void clearHighlight();
  77
  78 signals:
  79     void removeBuffer(const QModelIndex&);
  80     void removeBufferPermanently(const QModelIndex&);
  81
  82 protected:
  83     void dropEvent(QDropEvent* event) override;
  84     void rowsInserted(const QModelIndex& parent, int start, int end) override;
  85     void wheelEvent(QWheelEvent*) override;
  86     void focusInEvent(QFocusEvent* event) override { QAbstractScrollArea::focusInEvent(event); }
  87     void contextMenuEvent(QContextMenuEvent* event) override;
  88
  89     void dataChanged(const QModelIndex& topLeft, const QModelIndex& bottomRight, const QVector<int>& roles) override;
  90
  91 private slots:
  92     void joinChannel(const QModelIndex& index);
  93     void toggleHeader(bool checked);
  94
  95     /**
  96      * Expand all active networks and collapse inactive ones unless manually changed
  97      *
  98      * Applies to all networks.  Shouldn't need called except during initialization.
  99      */
 100     void setExpandedState();
 101
 102     /**
 103      * Save the current display state of the given network
 104      *
 105      * Tracks expanded or collapsed and active or inactive.
 106      *
 107      * @see setExpandedState()
 108      * @param[in] networkIdx QModelIndex of the root network to store
 109      */
 110     void storeExpandedState(const QModelIndex& networkIdx);
 111
 112     /**
 113      * Set the display state of the given network according to network status and manual changes
 114      *
 115      * Expands if active or previously expanded, collapses if inactive or previously collapsed.
 116      *
 117      * @see storeExpandedState()
 118      * @param[in] networkIdx QModelIndex of the root network to update
 119      */
 120     void setExpandedState(const QModelIndex& networkIdx);
 121
 122     void on_configChanged();
 123     void on_layoutChanged();
 124
 125     void changeBuffer(Direction direction);
 126
 127 private:
 128     QPointer<BufferViewConfig> _config;
 129
 130     enum ExpandedState
 131     {
 132         WasExpanded = 0x01,
 133         WasActive = 0x02
 134     };
 135     QHash<NetworkId, short> _expandedState;
 136     QModelIndex _currentHighlight;
 137 };
 138
 139 // ******************************
 140 //  BufferViewDelegate
 141 // ******************************
 142
 143 class BufferViewDelegate : public QStyledItemDelegate
 144 {
 145     Q_OBJECT
 146
 147 public:
 148     BufferViewDelegate(QObject* parent = nullptr);
 149     bool editorEvent(QEvent* event, QAbstractItemModel* model, const QStyleOptionViewItem& option, const QModelIndex& index) override;
 150
 151     void paint(QPainter* painter, const QStyleOptionViewItem& option, const QModelIndex& index) const override;
 152
 153 public:
 154     QModelIndex currentHighlight;
 155
 156 protected:
 157     void customEvent(QEvent* event) override;
 158 };
 159
 160 // ==============================
 161 //  BufferView Dock
 162 // ==============================
 163 class UISUPPORT_EXPORT BufferViewDock : public QDockWidget
 164 {
 165     Q_OBJECT
 166     Q_PROPERTY(bool active READ isActive WRITE setActive STORED true)
 167
 168 public:
 169     BufferViewDock(BufferViewConfig* config, QWidget* parent);
 170
 171     int bufferViewId() const;
 172     BufferViewConfig* config() const;
 173     inline BufferView* bufferView() const { return qobject_cast<BufferView*>(widget()); }
 174     inline bool isActive() const { return _active; }
 175     void setWidget(QWidget* newWidget);
 176     void setLocked(bool locked);
 177     QWidget* widget() const { return _childWidget; }
 178
 179     void activateFilter();
 180
 181 public slots:
 182     void setActive(bool active = true);
 183
 184 protected slots:
 185     bool eventFilter(QObject* object, QEvent* event) override;
 186     void focusInEvent(QFocusEvent* event) override { qDebug() << event; }
 187
 188 private slots:
 189     void bufferViewRenamed(const QString& newName);
 190     void updateTitle();
 191     void configChanged();
 192     void onFilterReturnPressed();
 193
 194 private:
 195     QWidget* _childWidget;
 196     QWidget* _widget;
 197     QPointer<QWidget> _oldFocusItem;  // QPointer in case the old item gets deleted
 198     QLineEdit* _filterEdit;
 199     bool _active;
 200     QString _title;
 201 };