src/uisupport/bufferview.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2018 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     QSize sizeHint() const override;
  87     void focusInEvent(QFocusEvent* event) override { QAbstractScrollArea::focusInEvent(event); }
  88     void contextMenuEvent(QContextMenuEvent* event) override;
  89
  90     void dataChanged(const QModelIndex& topLeft, const QModelIndex& bottomRight, const QVector<int>& roles) override;
  91
  92 private slots:
  93     void joinChannel(const QModelIndex& index);
  94     void toggleHeader(bool checked);
  95
  96     /**
  97      * Expand all active networks and collapse inactive ones unless manually changed
  98      *
  99      * Applies to all networks.  Shouldn't need called except during initialization.
 100      */
 101     void setExpandedState();
 102
 103     /**
 104      * Save the current display state of the given network
 105      *
 106      * Tracks expanded or collapsed and active or inactive.
 107      *
 108      * @see setExpandedState()
 109      * @param[in] networkIdx QModelIndex of the root network to store
 110      */
 111     void storeExpandedState(const QModelIndex& networkIdx);
 112
 113     /**
 114      * Set the display state of the given network according to network status and manual changes
 115      *
 116      * Expands if active or previously expanded, collapses if inactive or previously collapsed.
 117      *
 118      * @see storeExpandedState()
 119      * @param[in] networkIdx QModelIndex of the root network to update
 120      */
 121     void setExpandedState(const QModelIndex& networkIdx);
 122
 123     void on_configChanged();
 124     void on_layoutChanged();
 125
 126     void changeBuffer(Direction direction);
 127
 128 private:
 129     QPointer<BufferViewConfig> _config;
 130
 131     enum ExpandedState
 132     {
 133         WasExpanded = 0x01,
 134         WasActive = 0x02
 135     };
 136     QHash<NetworkId, short> _expandedState;
 137     QModelIndex _currentHighlight;
 138 };
 139
 140 // ******************************
 141 //  BufferViewDelegate
 142 // ******************************
 143
 144 class BufferViewDelegate : public QStyledItemDelegate
 145 {
 146     Q_OBJECT
 147
 148 public:
 149     BufferViewDelegate(QObject* parent = nullptr);
 150     bool editorEvent(QEvent* event, QAbstractItemModel* model, const QStyleOptionViewItem& option, const QModelIndex& index) override;
 151
 152     void paint(QPainter* painter, const QStyleOptionViewItem& option, const QModelIndex& index) const override;
 153
 154 public:
 155     QModelIndex currentHighlight;
 156
 157 protected:
 158     void customEvent(QEvent* event) override;
 159 };
 160
 161 // ==============================
 162 //  BufferView Dock
 163 // ==============================
 164 class UISUPPORT_EXPORT BufferViewDock : public QDockWidget
 165 {
 166     Q_OBJECT
 167     Q_PROPERTY(bool active READ isActive WRITE setActive STORED true)
 168
 169 public:
 170     BufferViewDock(BufferViewConfig* config, QWidget* parent);
 171
 172     int bufferViewId() const;
 173     BufferViewConfig* config() const;
 174     inline BufferView* bufferView() const { return qobject_cast<BufferView*>(widget()); }
 175     inline bool isActive() const { return _active; }
 176     void setWidget(QWidget* newWidget);
 177     void setLocked(bool locked);
 178     QWidget* widget() const { return _childWidget; }
 179
 180     void activateFilter();
 181
 182 public slots:
 183     void setActive(bool active = true);
 184
 185 protected slots:
 186     bool eventFilter(QObject* object, QEvent* event) override;
 187     void focusInEvent(QFocusEvent* event) override { qDebug() << event; }
 188
 189 private slots:
 190     void bufferViewRenamed(const QString& newName);
 191     void updateTitle();
 192     void configChanged();
 193     void onFilterReturnPressed();
 194
 195 private:
 196     QWidget* _childWidget;
 197     QWidget* _widget;
 198     QPointer<QWidget> _oldFocusItem;  // QPointer in case the old item gets deleted
 199     QLineEdit* _filterEdit;
 200     bool _active;
 201     QString _title;
 202 };