blob: d06d18b045cdd5724eee4e7b2b6791c56b161fd0 (
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
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
|
/****************************************************************************
**
** Copyright (C) 2018 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Assistant of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** 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 The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/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 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef QHELPFILTERENGINE_H
#define QHELPFILTERENGINE_H
#include <QtHelp/qhelp_global.h>
#include <QtCore/QObject>
QT_BEGIN_NAMESPACE
template <class K, class T>
class QMap;
class QVersionNumber;
class QHelpCollectionHandler;
class QHelpEngineCore;
class QHelpFilterData;
class QHelpFilterEnginePrivate;
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 QHelpEngineCore;
friend class QHelpEngineCorePrivate;
};
QT_END_NAMESPACE
#endif // QHELPFILTERENGINE_H
|
