1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
|
/*
* SPDX-FileCopyrightText: 2009 Ben Cooksley <bcooksley@kde.org>
* SPDX-FileCopyrightText: 2007 Will Stephenson <wstephenson@kde.org>
*
* SPDX-License-Identifier: GPL-2.0-or-later
*/
#ifndef MENUPROXYMODEL_H
#define MENUPROXYMODEL_H
#include <KCategorizedSortFilterProxyModel>
/**
* @brief Provides a filter model for MenuModel
*
* Provides a standardised model to be used with views to filter a MenuModel.\n
* It automatically sorts the items appropriately depending on if it is categorised
* or not.
* Call setFilterRegExp(QString) with the desired text to filter to perform searching.
* Items that do not match the search parameters will be disabled, not hidden.
*
* @author Will Stephenson <wstephenson@kde.org>
* @author Ben Cooksley <bcooksley@kde.org>
*/
class MenuProxyModel : public KCategorizedSortFilterProxyModel
{
Q_OBJECT
Q_PROPERTY(QString filterRegExp READ filterRegularExpression WRITE setFilterRegularExpression NOTIFY filterRegularExpressionChanged)
public:
/**
* Constructs a MenuProxyModel with the specified parent.
*
* @param parent The QObject to use as a parent.
*/
explicit MenuProxyModel(QObject *parent = nullptr);
QHash<int, QByteArray> roleNames() const override;
/**
* Please see the Qt QSortFilterProxyModel documentation for further information.\n
* Provides information on whether or not the QModelIndex specified by left is below right.
*
* @param left the QModelIndex that is being used for comparing.
* @param right the QModelIndex to compare against.
* @returns true if the left is below the right.
*/
bool lessThan(const QModelIndex &left, const QModelIndex &right) const override;
/**
* Please see the KDE KCategorizedSortFilterProxyModel documentation for further information.\n
* Provides information on whether or not the QModelIndex specified by left is below right.
*
* @param left the QModelIndex that is being used for comparing.
* @param right the QModelIndex to compare against.
* @returns true if the left is below the right.
*/
bool subSortLessThan(const QModelIndex &left, const QModelIndex &right) const override;
/**
* Please see the Qt QSortFilterProxyModel documentation for further information.\n
* Provides additional filtering of the MenuModel to only show categories which contain modules.
*
* @param source_column Please see QSortFilterProxyModel documentation.
* @param source_parent Please see QSortFilterProxyModel documentation.
* @returns true if the row should be displayed, false if it should not.
*/
bool filterAcceptsRow(int source_column, const QModelIndex &source_parent) const override;
/**
* Please see Qt QAbstractItemModel documentation for more details.\n
* Provides the status flags for the QModelIndex specified.
* The item will be selectable and enabled for its status unless invalid or filtered by search terms.
*
* @returns The flags for the QModelIndex provided.
*/
Qt::ItemFlags flags(const QModelIndex &index) const override;
/**
* Please see Qt QAbstractItemModel documentation for more details.\n
* Reimplemented for internal reasons.
*/
void setFilterRegularExpression(const QRegularExpression ®Exp);
/**
* Please see Qt QAbstractItemModel documentation for more details.\n
* Reimplemented for internal reasons.
*/
void setFilterRegularExpression(const QString &pattern);
QString filterRegularExpression() const;
/**
* makes the filter highlight matching entries instead of hiding them
*/
void setFilterHighlightsEntries(bool highlight);
/**
* @returns the filter highlight matching entries instead of hiding them, default true
*/
bool filterHighlightsEntries() const;
/**
* makes the filter show irrelevant modules (KCModuleData::isRelevant), default false
*/
void setShowIrrelevantModules(bool show);
/**
* @returns whether the filter shows irrelevant modules.
*/
bool showIrrelevantModules() const;
Q_SIGNALS:
void filterRegularExpressionChanged();
private:
bool m_filterHighlightsEntries : 1;
bool m_showIrrelevantModules : 1;
};
#endif
|
