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
|
// qhelpenginecore.sip generated by MetaSIP
//
// This file is part of the QtHelp Python extension module.
//
// Copyright (c) 2018 Riverbank Computing Limited <info@riverbankcomputing.com>
//
// This file is part of PyQt5.
//
// 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 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.
//
// If you do not wish to use this file under the terms of the GPL version 3.0
// then you may purchase a commercial license. For more information contact
// info@riverbankcomputing.com.
//
// This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
// WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
class QHelpEngineCore : QObject
{
%TypeHeaderCode
#include <qhelpenginecore.h>
%End
%ConvertToSubClassCode
static struct class_graph {
const char *name;
sipTypeDef **type;
int yes, no;
} graph[] = {
{sipName_QHelpIndexModel, &sipType_QHelpIndexModel, -1, 1},
{sipName_QHelpSearchEngine, &sipType_QHelpSearchEngine, -1, 2},
{sipName_QHelpContentWidget, &sipType_QHelpContentWidget, -1, 3},
{sipName_QHelpEngineCore, &sipType_QHelpEngineCore, 8, 4},
{sipName_QHelpIndexWidget, &sipType_QHelpIndexWidget, -1, 5},
{sipName_QHelpContentModel, &sipType_QHelpContentModel, -1, 6},
{sipName_QHelpSearchQueryWidget, &sipType_QHelpSearchQueryWidget, -1, 7},
{sipName_QHelpSearchResultWidget, &sipType_QHelpSearchResultWidget, -1, -1},
{sipName_QHelpEngine, &sipType_QHelpEngine, -1, -1},
};
int i = 0;
sipType = NULL;
do
{
struct class_graph *cg = &graph[i];
if (cg->name != NULL && sipCpp->inherits(cg->name))
{
sipType = *cg->type;
i = cg->yes;
}
else
i = cg->no;
}
while (i >= 0);
%End
public:
QHelpEngineCore(const QString &collectionFile, QObject *parent /TransferThis/ = 0);
virtual ~QHelpEngineCore();
bool setupData();
QString collectionFile() const;
void setCollectionFile(const QString &fileName);
bool copyCollectionFile(const QString &fileName);
static QString namespaceName(const QString &documentationFileName);
bool registerDocumentation(const QString &documentationFileName);
bool unregisterDocumentation(const QString &namespaceName);
QString documentationFileName(const QString &namespaceName);
QStringList customFilters() const;
bool removeCustomFilter(const QString &filterName);
bool addCustomFilter(const QString &filterName, const QStringList &attributes);
QStringList filterAttributes() const;
QStringList filterAttributes(const QString &filterName) const;
QString currentFilter() const;
void setCurrentFilter(const QString &filterName);
QStringList registeredDocumentations() const;
QList<QStringList> filterAttributeSets(const QString &namespaceName) const;
QList<QUrl> files(const QString namespaceName, const QStringList &filterAttributes, const QString &extensionFilter = QString());
QUrl findFile(const QUrl &url) const;
QByteArray fileData(const QUrl &url) const;
QMap<QString, QUrl> linksForIdentifier(const QString &id) const;
%If (Qt_5_9_0 -)
QMap<QString, QUrl> linksForKeyword(const QString &keyword) const;
%End
bool removeCustomValue(const QString &key);
QVariant customValue(const QString &key, const QVariant &defaultValue = QVariant()) const;
bool setCustomValue(const QString &key, const QVariant &value);
static QVariant metaData(const QString &documentationFileName, const QString &name);
QString error() const;
bool autoSaveFilter() const;
void setAutoSaveFilter(bool save);
signals:
void setupStarted();
void setupFinished();
void currentFilterChanged(const QString &newFilter);
void warning(const QString &msg);
%If (Qt_5_4_0 -)
void readersAboutToBeInvalidated();
%End
};
|
