Merge pull request #198 - IRCv3 improvements
[quassel.git] / src / uisupport / bufferview.h
1 /***************************************************************************
2  *   Copyright (C) 2005-2016 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 #ifndef BUFFERVIEW_H_
22 #define BUFFERVIEW_H_
23
24 #include <QAction>
25 #include <QMenu>
26 #include <QDockWidget>
27 #include <QModelIndex>
28 #include <QStyledItemDelegate>
29 #include <QPointer>
30
31 #include "actioncollection.h"
32 #include "bufferviewconfig.h"
33 #include "networkmodel.h"
34 #include "treeviewtouch.h"
35 #include "types.h"
36
37 /*****************************************
38  * The TreeView showing the Buffers
39  *****************************************/
40 class BufferView : public TreeViewTouch
41 {
42     Q_OBJECT
43
44 public:
45     enum Direction {
46         Forward = 1,
47         Backward = -1
48     };
49
50     BufferView(QWidget *parent = 0);
51     void init();
52
53     void setModel(QAbstractItemModel *model);
54     void setFilteredModel(QAbstractItemModel *model, BufferViewConfig *config);
55
56     void setConfig(BufferViewConfig *config);
57     inline BufferViewConfig *config() { return _config; }
58
59     void addActionsToMenu(QMenu *menu, const QModelIndex &index);
60     void addFilterActions(QMenu *contextMenu, const QModelIndex &index);
61
62 public slots:
63     void setRootIndexForNetworkId(const NetworkId &networkId);
64     void removeSelectedBuffers(bool permanently = false);
65     void menuActionTriggered(QAction *);
66     void nextBuffer();
67     void previousBuffer();
68     void hideCurrentBuffer();
69
70 signals:
71     void removeBuffer(const QModelIndex &);
72     void removeBufferPermanently(const QModelIndex &);
73
74 protected:
75     virtual void keyPressEvent(QKeyEvent *);
76     virtual void dropEvent(QDropEvent *event);
77     virtual void rowsInserted(const QModelIndex &parent, int start, int end);
78     virtual void wheelEvent(QWheelEvent *);
79     virtual QSize sizeHint() const;
80     virtual void focusInEvent(QFocusEvent *event) { QAbstractScrollArea::focusInEvent(event); }
81     virtual void contextMenuEvent(QContextMenuEvent *event);
82
83 #if QT_VERSION < 0x050000
84     virtual void dataChanged(const QModelIndex &topLeft, const QModelIndex &bottomRight);
85 #else
86     virtual void dataChanged(const QModelIndex &topLeft, const QModelIndex &bottomRight, const QVector<int> &roles);
87 #endif
88
89 private slots:
90     void joinChannel(const QModelIndex &index);
91     void toggleHeader(bool checked);
92
93     void storeExpandedState(const QModelIndex &networkIdx);
94     void setExpandedState(const QModelIndex &networkIdx);
95
96     void on_configChanged();
97     void on_layoutChanged();
98
99     void changeBuffer(Direction direction);
100
101 private:
102     QPointer<BufferViewConfig> _config;
103
104     enum ExpandedState {
105         WasExpanded = 0x01,
106         WasActive = 0x02
107     };
108     QHash<NetworkId, short> _expandedState;
109 };
110
111
112 // ******************************
113 //  BufferViewDelgate
114 // ******************************
115
116 class BufferViewDelegate : public QStyledItemDelegate
117 {
118     Q_OBJECT
119
120 public:
121     BufferViewDelegate(QObject *parent = 0);
122     bool editorEvent(QEvent *event, QAbstractItemModel *model, const QStyleOptionViewItem &option, const QModelIndex &index);
123
124 protected:
125     virtual void customEvent(QEvent *event);
126 };
127
128
129 // ==============================
130 //  BufferView Dock
131 // ==============================
132 class BufferViewDock : public QDockWidget
133 {
134     Q_OBJECT
135     Q_PROPERTY(bool active READ isActive WRITE setActive STORED true)
136
137 public :
138         BufferViewDock(BufferViewConfig *config, QWidget *parent);
139
140     int bufferViewId() const;
141     BufferViewConfig *config() const;
142     inline BufferView *bufferView() const { return qobject_cast<BufferView *>(widget()); }
143     inline bool isActive() const { return _active; }
144
145 public slots:
146     void setActive(bool active = true);
147
148 private slots:
149     void bufferViewRenamed(const QString &newName);
150     void updateTitle();
151
152 private:
153
154     bool _active;
155     QString _title;
156 };
157
158
159 #endif