blob: 2d80ed1e19f8f8356a1a244fde49d95614abf333 (
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
|
/****************************************************************************
**
** Copyright (C) 2021 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:COMM$
**
** 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.
**
** $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 <QtCore/QSharedData>
#include <QtCore/QStringList>
#include <QtCore/QVariant>
QT_BEGIN_NAMESPACE
class 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 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 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 QHelpDataCustomFilter {
QStringList filterAttributes;
QString name;
};
QT_END_NAMESPACE
#endif // QHELPDATAINTERFACE_H
|
