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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
|
/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia. For licensing terms and
** conditions see http://qt.digia.com/licensing. For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights. These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/
#ifndef ILOCATORFILTER_H
#define ILOCATORFILTER_H
#include "locator_global.h"
#include <QVariant>
#include <QFutureInterface>
#include <QIcon>
namespace Locator {
class ILocatorFilter;
struct FilterEntry
{
FilterEntry()
: filter(0)
, resolveFileIcon(false)
{}
FilterEntry(ILocatorFilter *fromFilter, const QString &name, const QVariant &data,
const QIcon &icon = QIcon())
: filter(fromFilter)
, displayName(name)
, internalData(data)
, displayIcon(icon)
, resolveFileIcon(false)
{}
bool operator==(const FilterEntry &other) const {
if (internalData.canConvert(QVariant::String))
return (internalData.toString() == other.internalData.toString());
return internalData.constData() == other.internalData.constData();
}
/* backpointer to creating filter */
ILocatorFilter *filter;
/* displayed string */
QString displayName;
/* extra information displayed in light-gray in a second column (optional) */
QString extraInfo;
/* can be used by the filter to save more information about the entry */
QVariant internalData;
/* icon to display along with the entry */
QIcon displayIcon;
/* internal data is interpreted as file name and icon is retrieved from the file system if true */
bool resolveFileIcon;
};
class LOCATOR_EXPORT ILocatorFilter : public QObject
{
Q_OBJECT
public:
enum Priority {High = 0, Medium = 1, Low = 2};
ILocatorFilter(QObject *parent = 0);
virtual ~ILocatorFilter() {}
/* Visible name. */
virtual QString displayName() const = 0;
/* Internal name. */
virtual QString id() const = 0;
/* Selection list order in case of multiple active filters (high goes on top). */
virtual Priority priority() const = 0;
/* String to type to use this filter exclusively. */
QString shortcutString() const;
/* List of matches for the given user entry. */
virtual QList<FilterEntry> matchesFor(QFutureInterface<Locator::FilterEntry> &future, const QString &entry) = 0;
/* User has selected the given entry that belongs to this filter. */
virtual void accept(FilterEntry selection) const = 0;
/* Implement to update caches on user request, if that's a long operation. */
virtual void refresh(QFutureInterface<void> &future) = 0;
/* Saved state is used to restore the filter at start up. */
virtual QByteArray saveState() const;
/* Used to restore the filter at start up. */
virtual bool restoreState(const QByteArray &state);
/* User wants to configure this filter (if supported). Use it to pop up a dialog.
* needsRefresh is used as a hint to indicate that refresh should be called.
* The default implementation allows changing the shortcut and whether the filter
* is enabled by default.
*/
virtual bool openConfigDialog(QWidget *parent, bool &needsRefresh);
/* If there is a configure dialog available for this filter. The default
* implementation returns true. */
virtual bool isConfigurable() const;
/* Is this filter used also when the shortcutString is not used? */
bool isIncludedByDefault() const;
/* Returns whether the filter should be hidden from configuration and menus. */
bool isHidden() const;
/* Returns whether the filter should be enabled and used in menus. */
bool isEnabled() const;
static QString trimWildcards(const QString &str) {
if (str.isEmpty())
return str;
int first = 0, last = str.size()-1;
const QChar asterisk = QLatin1Char('*');
const QChar question = QLatin1Char('?');
while (first < str.size() && (str.at(first) == asterisk || str.at(first) == question))
++first;
while (last >= 0 && (str.at(last) == asterisk || str.at(last) == question))
--last;
if (first > last)
return QString();
return str.mid(first, last-first+1);
}
public slots:
/* Enable or disable the filter. */
void setEnabled(bool enabled);
protected:
void setShortcutString(const QString &shortcut);
void setIncludedByDefault(bool includedByDefault);
void setHidden(bool hidden);
private:
QString m_shortcut;
bool m_includedByDefault;
bool m_hidden;
bool m_enabled;
};
} // namespace Locator
#endif // ILOCATORFILTER_H
|
