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
|
/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** 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 Digia. For licensing terms and
** conditions see http://qt.digia.com/licensing. For further information
** use the contact form at http://qt.digia.com/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 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights. These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef QHELPDATAINTERFACE_H
#define QHELPDATAINTERFACE_H
//
// W A R N I N G
// -------------
//
// This file is not part of the Qt API. It exists for the convenience
// of the help generator tools. This header file may change from version
// to version without notice, or even be removed.
//
// We mean it.
//
#include "qhelp_global.h"
#include <QtCore/QStringList>
#include <QtCore/QSharedData>
QT_BEGIN_HEADER
QT_BEGIN_NAMESPACE
class QHELP_EXPORT QHelpDataContentItem
{
public:
QHelpDataContentItem(QHelpDataContentItem *parent, const QString &title,
const QString &reference);
~QHelpDataContentItem();
QString title() const;
QString reference() const;
QList<QHelpDataContentItem*> children() const;
private:
QString m_title;
QString m_reference;
QList<QHelpDataContentItem*> m_children;
};
struct QHELP_EXPORT QHelpDataIndexItem {
QHelpDataIndexItem() {}
QHelpDataIndexItem(const QString &n, const QString &id, const QString &r)
: name(n), identifier(id), reference(r) {}
QString name;
QString identifier;
QString reference;
bool operator==(const QHelpDataIndexItem & other) const;
};
class QHelpDataFilterSectionData : public QSharedData
{
public:
~QHelpDataFilterSectionData()
{
qDeleteAll(contents);
}
QStringList filterAttributes;
QList<QHelpDataIndexItem> indices;
QList<QHelpDataContentItem*> contents;
QStringList files;
};
class QHELP_EXPORT QHelpDataFilterSection
{
public:
QHelpDataFilterSection();
void addFilterAttribute(const QString &filter);
QStringList filterAttributes() const;
void addIndex(const QHelpDataIndexItem &index);
void setIndices(const QList<QHelpDataIndexItem> &indices);
QList<QHelpDataIndexItem> indices() const;
void addContent(QHelpDataContentItem *content);
void setContents(const QList<QHelpDataContentItem*> &contents);
QList<QHelpDataContentItem*> contents() const;
void addFile(const QString &file);
void setFiles(const QStringList &files);
QStringList files() const;
private:
QSharedDataPointer<QHelpDataFilterSectionData> d;
};
struct QHELP_EXPORT QHelpDataCustomFilter {
QStringList filterAttributes;
QString name;
};
class QHELP_EXPORT QHelpDataInterface
{
public:
QHelpDataInterface() {}
virtual ~QHelpDataInterface() {}
virtual QString namespaceName() const = 0;
virtual QString virtualFolder() const = 0;
virtual QList<QHelpDataCustomFilter> customFilters() const = 0;
virtual QList<QHelpDataFilterSection> filterSections() const = 0;
virtual QMap<QString, QVariant> metaData() const = 0;
virtual QString rootPath() const = 0;
};
QT_END_NAMESPACE
QT_END_HEADER
#endif // QHELPDATAINTERFACE_H
|
