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 QHELPDATAINTERFACE_H
41#define QHELPDATAINTERFACE_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/QSharedData>
55#include <QtCore/QStringList>
56#include <QtCore/QVariant>
57
58QT_BEGIN_NAMESPACE
59
60class QHelpDataContentItem
61{
62public:
63 QHelpDataContentItem(QHelpDataContentItem *parent, const QString &title,
64 const QString &reference);
65 ~QHelpDataContentItem();
66
67 QString title() const;
68 QString reference() const;
69 QList<QHelpDataContentItem*> children() const;
70
71private:
72 QString m_title;
73 QString m_reference;
74 QList<QHelpDataContentItem*> m_children;
75};
76
77struct QHelpDataIndexItem {
78 QHelpDataIndexItem() {}
79 QHelpDataIndexItem(const QString &n, const QString &id, const QString &r)
80 : name(n), identifier(id), reference(r) {}
81
82 QString name;
83 QString identifier;
84 QString reference;
85
86 bool operator==(const QHelpDataIndexItem & other) const;
87};
88
89class QHelpDataFilterSectionData : public QSharedData
90{
91public:
92 ~QHelpDataFilterSectionData()
93 {
94 qDeleteAll(c: contents);
95 }
96
97 QStringList filterAttributes;
98 QList<QHelpDataIndexItem> indices;
99 QList<QHelpDataContentItem*> contents;
100 QStringList files;
101};
102
103class QHelpDataFilterSection
104{
105public:
106 QHelpDataFilterSection();
107
108 void addFilterAttribute(const QString &filter);
109 QStringList filterAttributes() const;
110
111 void addIndex(const QHelpDataIndexItem &index);
112 void setIndices(const QList<QHelpDataIndexItem> &indices);
113 QList<QHelpDataIndexItem> indices() const;
114
115 void addContent(QHelpDataContentItem *content);
116 void setContents(const QList<QHelpDataContentItem*> &contents);
117 QList<QHelpDataContentItem*> contents() const;
118
119 void addFile(const QString &file);
120 void setFiles(const QStringList &files);
121 QStringList files() const;
122
123private:
124 QSharedDataPointer<QHelpDataFilterSectionData> d;
125};
126
127struct QHelpDataCustomFilter {
128 QStringList filterAttributes;
129 QString name;
130};
131
132QT_END_NAMESPACE
133
134#endif // QHELPDATAINTERFACE_H
135

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