1/****************************************************************************
2**
3** Copyright (C) 2020 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 QHELPFILTERSETTINGS_H
41#define QHELPFILTERSETTINGS_H
42
43//
44// W A R N I N G
45// -------------
46//
47// This file is not part of the Qt API. It exists for the convenience
48// of the help generator tools. This header file may change from version
49// to version without notice, or even be removed.
50//
51// We mean it.
52//
53
54#include <QtCore/QSharedDataPointer>
55
56QT_BEGIN_NAMESPACE
57
58template <class K, class T>
59class QMap;
60class QHelpFilterData;
61class QHelpFilterEngine;
62class QHelpFilterSettingsPrivate;
63
64class QHelpFilterSettings final
65{
66public:
67 QHelpFilterSettings();
68 QHelpFilterSettings(const QHelpFilterSettings &other);
69 QHelpFilterSettings(QHelpFilterSettings &&other);
70 ~QHelpFilterSettings();
71
72 QHelpFilterSettings &operator=(const QHelpFilterSettings &other);
73 QHelpFilterSettings &operator=(QHelpFilterSettings &&other);
74
75 void swap(QHelpFilterSettings &other) noexcept
76 { d.swap(other&: other.d); }
77
78 void setFilter(const QString &filterName, const QHelpFilterData &filterData);
79 void removeFilter(const QString &filterName);
80 QStringList filterNames() const;
81 QHelpFilterData filterData(const QString &filterName) const;
82 QMap<QString, QHelpFilterData> filters() const;
83
84 void setCurrentFilter(const QString &filterName);
85 QString currentFilter() const;
86
87 static QHelpFilterSettings readSettings(const QHelpFilterEngine *filterEngine);
88 static bool applySettings(QHelpFilterEngine *filterEngine, const QHelpFilterSettings &settings);
89
90private:
91 QSharedDataPointer<QHelpFilterSettingsPrivate> d;
92};
93
94QT_END_NAMESPACE
95
96#endif // QHELPFILTERSETTINGS_H
97

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