uisupport: Provide helpers for dealing with widget changes
[quassel.git] / src / uisupport / bufferviewfilter.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 <QDropEvent>
27 #include <QFlags>
28 #include <QPointer>
29 #include <QSet>
30 #include <QSortFilterProxyModel>
31
32 #include "types.h"
33 #include "bufferviewconfig.h"
34
35 /*****************************************
36  * Buffer View Filter
37  *****************************************/
38 class UISUPPORT_EXPORT BufferViewFilter : public QSortFilterProxyModel
39 {
40     Q_OBJECT
41
42 public:
43     enum Mode {
44         NoActive = 0x01,
45         NoInactive = 0x02,
46         SomeNets = 0x04,
47         AllNets = 0x08,
48         NoChannels = 0x10,
49         NoQueries = 0x20,
50         NoServers = 0x40,
51         FullCustom = 0x80
52     };
53     Q_DECLARE_FLAGS(Modes, Mode)
54
55     BufferViewFilter(QAbstractItemModel *model, BufferViewConfig *config = nullptr);
56
57     Qt::ItemFlags flags(const QModelIndex &index) const override;
58     bool dropMimeData(const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) override;
59
60     QVariant data(const QModelIndex &index, int role) const override;
61     QVariant checkedState(const QModelIndex &index) const;
62
63     bool setData(const QModelIndex &index, const QVariant &value, int role = Qt::EditRole) override;
64     bool setCheckedState(const QModelIndex &index, Qt::CheckState state);
65
66     void setConfig(BufferViewConfig *config);
67     inline BufferViewConfig *config() const { return _config; }
68
69     void sort(int column, Qt::SortOrder order = Qt::AscendingOrder) override;
70
71     QList<QAction *> actions(const QModelIndex &index);
72
73     void setFilterString(const QString string);
74
75 protected:
76     bool filterAcceptsRow(int source_row, const QModelIndex &source_parent) const override;
77     bool lessThan(const QModelIndex &source_left, const QModelIndex &source_right) const override;
78     bool bufferLessThan(const QModelIndex &source_left, const QModelIndex &source_right) const;
79     bool networkLessThan(const QModelIndex &source_left, const QModelIndex &source_right) const;
80
81 signals:
82     void configChanged();
83
84 private slots:
85     void configInitialized();
86     void enableEditMode(bool enable);
87     void showServerQueriesChanged();
88
89 private:
90     QPointer<BufferViewConfig> _config;
91     Qt::SortOrder _sortOrder;
92
93     bool _showServerQueries;
94     bool _editMode;
95     QAction _enableEditMode;
96     QSet<BufferId> _toAdd;
97     QSet<BufferId> _toTempRemove;
98     QSet<BufferId> _toRemove;
99     QString _filterString;
100
101     bool filterAcceptBuffer(const QModelIndex &) const;
102     bool filterAcceptNetwork(const QModelIndex &) const;
103     void addBuffer(const BufferId &bufferId) const;
104     void addBuffers(const QList<BufferId> &bufferIds) const;
105     static bool bufferIdLessThan(const BufferId &, const BufferId &);
106 };
107
108
109 Q_DECLARE_OPERATORS_FOR_FLAGS(BufferViewFilter::Modes)