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 HELPDOCSETTINGS_H
41#define HELPDOCSETTINGS_H
42
43#include <QtCore/QSharedDataPointer>
44
45QT_BEGIN_NAMESPACE
46
47class QVersionNumber;
48class QHelpEngineCore;
49class HelpDocSettingsPrivate;
50
51class HelpDocSettings final
52{
53public:
54 HelpDocSettings();
55 HelpDocSettings(const HelpDocSettings &other);
56 HelpDocSettings(HelpDocSettings &&other);
57 ~HelpDocSettings();
58
59 HelpDocSettings &operator=(const HelpDocSettings &other);
60 HelpDocSettings &operator=(HelpDocSettings &&other);
61
62 void swap(HelpDocSettings &other) noexcept
63 { d.swap(other&: other.d); }
64
65 bool addDocumentation(const QString &fileName);
66 bool removeDocumentation(const QString &namespaceName);
67 QString namespaceName(const QString &fileName) const;
68 QStringList components() const;
69 QList<QVersionNumber> versions() const;
70 QStringList namespaces() const;
71 QMap<QString, QString> namespaceToFileName() const;
72
73 static HelpDocSettings readSettings(QHelpEngineCore *helpEngine);
74 static bool applySettings(QHelpEngineCore *helpEngine, const HelpDocSettings &settings);
75
76private:
77 QSharedDataPointer<HelpDocSettingsPrivate> d;
78};
79
80QT_END_NAMESPACE
81
82#endif // HELPDOCSETTINGS_H
83

source code of qttools/src/assistant/assistant/helpdocsettings.h