| 1 | // Copyright (C) 2016 The Qt Company Ltd. |
|---|
| 2 | // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0 |
|---|
| 3 | |
|---|
| 4 | #ifndef QHELPPROJECTDATA_H |
|---|
| 5 | #define QHELPPROJECTDATA_H |
|---|
| 6 | |
|---|
| 7 | // |
|---|
| 8 | // W A R N I N G |
|---|
| 9 | // ------------- |
|---|
| 10 | // |
|---|
| 11 | // This file is not part of the Qt API. It exists for the convenience |
|---|
| 12 | // of the help generator tools. This header file may change from version |
|---|
| 13 | // to version without notice, or even be removed. |
|---|
| 14 | // |
|---|
| 15 | // We mean it. |
|---|
| 16 | // |
|---|
| 17 | |
|---|
| 18 | #include "qhelpdatainterface_p.h" |
|---|
| 19 | |
|---|
| 20 | QT_BEGIN_NAMESPACE |
|---|
| 21 | |
|---|
| 22 | class QHelpProjectDataPrivate; |
|---|
| 23 | |
|---|
| 24 | class QHelpProjectData |
|---|
| 25 | { |
|---|
| 26 | public: |
|---|
| 27 | QHelpProjectData(); |
|---|
| 28 | ~QHelpProjectData(); |
|---|
| 29 | |
|---|
| 30 | bool readData(const QString &fileName); |
|---|
| 31 | QString errorMessage() const; |
|---|
| 32 | |
|---|
| 33 | QString namespaceName() const; |
|---|
| 34 | QString virtualFolder() const; |
|---|
| 35 | QList<QHelpDataCustomFilter> customFilters() const; |
|---|
| 36 | QList<QHelpDataFilterSection> filterSections() const; |
|---|
| 37 | QMap<QString, QVariant> metaData() const; |
|---|
| 38 | QString rootPath() const; |
|---|
| 39 | |
|---|
| 40 | private: |
|---|
| 41 | QHelpProjectDataPrivate *d; |
|---|
| 42 | }; |
|---|
| 43 | |
|---|
| 44 | QT_END_NAMESPACE |
|---|
| 45 | |
|---|
| 46 | #endif |
|---|
| 47 | |
|---|
