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
|
/****************************************************************************
**
** 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$
**
****************************************************************************/
#ifndef QHELPDBREADER_H
#define QHELPDBREADER_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/QObject>
#include <QtCore/QStringList>
#include <QtCore/QUrl>
#include <QtCore/QByteArray>
#include <QtCore/QSet>
QT_BEGIN_NAMESPACE
class QSqlQuery;
class QHelpDBReader : public QObject
{
Q_OBJECT
public:
QHelpDBReader(const QString &dbName);
QHelpDBReader(const QString &dbName, const QString &uniqueId,
QObject *parent);
~QHelpDBReader();
bool init();
QString errorMessage() const;
QString databaseName() const;
QString namespaceName() const;
QString virtualFolder() const;
QList<QStringList> filterAttributeSets() const;
QStringList files(const QStringList &filterAttributes,
const QString &extensionFilter = QString()) const;
bool fileExists(const QString &virtualFolder, const QString &filePath,
const QStringList &filterAttributes = QStringList()) const;
QByteArray fileData(const QString &virtualFolder,
const QString &filePath) const;
QStringList customFilters() const;
QStringList filterAttributes(const QString &filterName = QString()) const;
QStringList indicesForFilter(const QStringList &filterAttributes) const;
void linksForKeyword(const QString &keyword, const QStringList &filterAttributes,
QMap<QString, QUrl> *linkMap) const;
void linksForIdentifier(const QString &id, const QStringList &filterAttributes,
QMap<QString, QUrl> *linkMap) const;
QList<QByteArray> contentsForFilter(const QStringList &filterAttributes) const;
QUrl urlOfPath(const QString &relativePath) const;
QSet<int> indexIds(const QStringList &attributes) const;
bool createAttributesCache(const QStringList &attributes,
const QSet<int> &indexIds);
QVariant metaData(const QString &name) const;
private:
QUrl buildQUrl(const QString &ns, const QString &folder,
const QString &relFileName, const QString &anchor) const;
QString mergeList(const QStringList &list) const;
QString quote(const QString &string) const;
bool m_initDone = false;
QString m_dbName;
QString m_uniqueId;
QString m_error;
QSqlQuery *m_query = nullptr;
mutable QString m_namespace;
QSet<QString> m_viewAttributes;
bool m_useAttributesCache = false;
QSet<int> m_indicesCache;
};
QT_END_NAMESPACE
#endif
|
