blob: fade438e119f043d0f346524d2cd9e23906b89ad (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
|
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Assistant of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qhelpdatainterface_p.h"
QT_BEGIN_NAMESPACE
/*!
\internal
\class QHelpDataContentItem
\since 4.4
\brief The QHelpDataContentItem class provides an item which represents
a topic or section of the contents.
Every item holds several pieces of information, most notably the title
which can later be displayed in a contents overview. The reference is used
to store a relative file link to the corresponding section in the
documentation.
*/
/*!
Constructs a new content item with \a parent as parent item.
The constucted item has the title \a title and links to the
location specified by \a reference.
*/
QHelpDataContentItem::QHelpDataContentItem(QHelpDataContentItem *parent,
const QString &title, const QString &reference)
: m_title(title), m_reference(reference)
{
if (parent)
parent->m_children.append(this);
}
/*!
Destructs the item and its children.
*/
QHelpDataContentItem::~QHelpDataContentItem()
{
qDeleteAll(m_children);
}
/*!
Returns the title of the item.
*/
QString QHelpDataContentItem::title() const
{
return m_title;
}
/*!
Returns the file reference of the item.
*/
QString QHelpDataContentItem::reference() const
{
return m_reference;
}
/*!
Returns a list of all its child items.
*/
QList<QHelpDataContentItem*> QHelpDataContentItem::children() const
{
return m_children;
}
bool QHelpDataIndexItem::operator==(const QHelpDataIndexItem &other) const
{
return (other.name == name) && (other.reference == reference);
}
/*!
\internal
\class QHelpDataFilterSection
\since 4.4
*/
/*!
Constructs a help data filter section.
*/
QHelpDataFilterSection::QHelpDataFilterSection()
{
d = new QHelpDataFilterSectionData();
}
/*!
Adds the filter attribute \a filter to the filter attributes of
this section.
*/
void QHelpDataFilterSection::addFilterAttribute(const QString &filter)
{
d->filterAttributes.append(filter);
}
/*!
Returns a list of all filter attributes defined for this section.
*/
QStringList QHelpDataFilterSection::filterAttributes() const
{
return d->filterAttributes;
}
/*!
Adds the index item \a index to the list of indices.
*/
void QHelpDataFilterSection::addIndex(const QHelpDataIndexItem &index)
{
d->indices.append(index);
}
/*!
Sets the filter sections list of indices to \a indices.
*/
void QHelpDataFilterSection::setIndices(const QList<QHelpDataIndexItem> &indices)
{
d->indices = indices;
}
/*!
Returns the list of indices.
*/
QList<QHelpDataIndexItem> QHelpDataFilterSection::indices() const
{
return d->indices;
}
/*!
Adds the top level content item \a content to the filter section.
*/
void QHelpDataFilterSection::addContent(QHelpDataContentItem *content)
{
d->contents.append(content);
}
/*!
Sets the list of top level content items of the filter section to
\a contents.
*/
void QHelpDataFilterSection::setContents(const QList<QHelpDataContentItem*> &contents)
{
qDeleteAll(d->contents);
d->contents = contents;
}
/*!
Returns a list of top level content items.
*/
QList<QHelpDataContentItem*> QHelpDataFilterSection::contents() const
{
return d->contents;
}
/*!
Adds the file \a file to the filter section.
*/
void QHelpDataFilterSection::addFile(const QString &file)
{
d->files.append(file);
}
/*!
Set the list of files to \a files.
*/
void QHelpDataFilterSection::setFiles(const QStringList &files)
{
d->files = files;
}
/*!
Returns the list of files.
*/
QStringList QHelpDataFilterSection::files() const
{
return d->files;
}
/*!
\internal
\class QHelpDataInterface
\since 4.4
*/
/*!
\fn QHelpDataInterface::QHelpDataInterface()
Constructs a new help data interface.
*/
/*!
\fn QHelpDataInterface::~QHelpDataInterface()
Destroys the help data interface.
*/
/*!
\fn QString QHelpDataInterface::namespaceName() const = 0
Returns the namespace name of the help data set.
*/
/*!
\fn QString QHelpDataInterface::virtualFolder() const = 0
Returns the virtual folder of the help data set.
*/
/*!
\fn QList<QHelpDataCustomFilter> QHelpDataInterface::customFilters () const = 0
Returns a list of custom filters. Defining custom filters is optional.
*/
/*!
\fn QList<QHelpDataFilterSection> QHelpDataInterface::filterSections() const = 0
Returns a list of filter sections.
*/
/*!
\fn QMap<QString, QVariant> QHelpDataInterface::metaData() const = 0
Returns a map of meta data. A meta data item can hold almost any data
and is identified by its name.
*/
/*!
\fn QString QHelpDataInterface::rootPath() const = 0
Returns the root file path of the documentation data. All referenced file
path or links of content items are relative to this path.
*/
QT_END_NAMESPACE
|
