1/****************************************************************************
2**
3** Copyright (C) 2018 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the Qt Assistant of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QHELPFILTERENGINE_H
41#define QHELPFILTERENGINE_H
42
43#include <QtHelp/qhelp_global.h>
44
45#include <QtCore/QObject>
46
47QT_BEGIN_NAMESPACE
48
49template <class K, class T>
50class QMap;
51class QVersionNumber;
52
53class QHelpCollectionHandler;
54class QHelpEngineCore;
55class QHelpFilterData;
56class QHelpFilterEnginePrivate;
57
58class QHELP_EXPORT QHelpFilterEngine : public QObject
59{
60 Q_OBJECT
61public:
62 QMap<QString, QString> namespaceToComponent() const;
63 QMap<QString, QVersionNumber> namespaceToVersion() const;
64
65 QStringList filters() const;
66
67 QString activeFilter() const;
68 bool setActiveFilter(const QString &filterName);
69
70 QStringList availableComponents() const;
71 QList<QVersionNumber> availableVersions() const;
72
73 QHelpFilterData filterData(const QString &filterName) const;
74 bool setFilterData(const QString &filterName, const QHelpFilterData &filterData);
75
76 bool removeFilter(const QString &filterName);
77
78 QStringList namespacesForFilter(const QString &filterName) const;
79
80 QStringList indices() const;
81 QStringList indices(const QString &filterName) const;
82
83Q_SIGNALS:
84 void filterActivated(const QString &newFilter);
85
86protected:
87 explicit QHelpFilterEngine(QHelpEngineCore *helpEngine);
88 virtual ~QHelpFilterEngine();
89
90private:
91 void setCollectionHandler(QHelpCollectionHandler *collectionHandler);
92
93 QHelpFilterEnginePrivate *d;
94 friend class QHelpEngineCore;
95 friend class QHelpEngineCorePrivate;
96};
97
98QT_END_NAMESPACE
99
100#endif // QHELPFILTERENGINE_H
101

source code of qttools/src/assistant/help/qhelpfilterengine.h