1/****************************************************************************
2**
3** Copyright (C) 2016 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 QHELPPROJECTDATA_H
41#define QHELPPROJECTDATA_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 "qhelpdatainterface_p.h"
55
56QT_BEGIN_NAMESPACE
57
58class QHelpProjectDataPrivate;
59
60class QHelpProjectData
61{
62public:
63 QHelpProjectData();
64 ~QHelpProjectData();
65
66 bool readData(const QString &fileName);
67 QString errorMessage() const;
68
69 QString namespaceName() const;
70 QString virtualFolder() const;
71 QList<QHelpDataCustomFilter> customFilters() const;
72 QList<QHelpDataFilterSection> filterSections() const;
73 QMap<QString, QVariant> metaData() const;
74 QString rootPath() const;
75
76private:
77 QHelpProjectDataPrivate *d;
78};
79
80QT_END_NAMESPACE
81
82#endif
83

source code of qttools/src/assistant/qhelpgenerator/qhelpprojectdata_p.h