blob: a16a2048342c9c5e7de2a67ba9fe907f367516f9 (
plain)
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
|
// Copyright (C) 2018 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
#ifndef QHELPFILTERENGINE_H
#define QHELPFILTERENGINE_H
#include <QtHelp/qhelp_global.h>
#include <QtCore/qobject.h>
QT_BEGIN_NAMESPACE
class QHelpCollectionHandler;
class QHelpEngineCore;
class QHelpFilterData;
class QHelpFilterEnginePrivate;
template <class K, class T>
class QMap;
class QVersionNumber;
class QHELP_EXPORT QHelpFilterEngine : public QObject
{
Q_OBJECT
public:
QMap<QString, QString> namespaceToComponent() const;
QMap<QString, QVersionNumber> namespaceToVersion() const;
QStringList filters() const;
QString activeFilter() const;
bool setActiveFilter(const QString &filterName);
QStringList availableComponents() const;
QList<QVersionNumber> availableVersions() const;
QHelpFilterData filterData(const QString &filterName) const;
bool setFilterData(const QString &filterName, const QHelpFilterData &filterData);
bool removeFilter(const QString &filterName);
QStringList namespacesForFilter(const QString &filterName) const;
QStringList indices() const;
QStringList indices(const QString &filterName) const;
Q_SIGNALS:
void filterActivated(const QString &newFilter);
protected:
explicit QHelpFilterEngine(QHelpEngineCore *helpEngine);
virtual ~QHelpFilterEngine();
private:
void setCollectionHandler(QHelpCollectionHandler *collectionHandler);
QHelpFilterEnginePrivate *d;
friend class QHelpEngineCorePrivate;
};
QT_END_NAMESPACE
#endif // QHELPFILTERENGINE_H
|
