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
|
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
#include "qhelpengine.h"
#include "qhelpcontentwidget.h"
#include "qhelpfilterengine.h"
#include "qhelpindexwidget.h"
#include "qhelpsearchengine.h"
#include <QtCore/qtimer.h>
QT_BEGIN_NAMESPACE
class QHelpEnginePrivate
{
public:
QHelpEnginePrivate(QHelpEngineCore *helpEngineCore);
QHelpContentModel *contentModel = nullptr;
QHelpContentWidget *contentWidget = nullptr;
QHelpIndexModel *indexModel = nullptr;
QHelpIndexWidget *indexWidget = nullptr;
QHelpSearchEngine *searchEngine = nullptr;
bool m_isApplyCurrentFilterScheduled = false;
QHelpEngineCore *m_helpEngineCore = nullptr;
};
QHelpEnginePrivate::QHelpEnginePrivate(QHelpEngineCore *helpEngineCore)
: m_helpEngineCore(helpEngineCore)
{
if (!contentModel)
contentModel = new QHelpContentModel(helpEngineCore);
if (!indexModel)
indexModel = new QHelpIndexModel(m_helpEngineCore);
const auto applyCurrentFilter = [this] {
m_isApplyCurrentFilterScheduled = false;
contentModel->createContentsForCurrentFilter();
indexModel->createIndexForCurrentFilter();
};
const auto scheduleApplyCurrentFilter = [this, applyCurrentFilter] {
if (!m_helpEngineCore->error().isEmpty())
return;
if (m_isApplyCurrentFilterScheduled)
return;
m_isApplyCurrentFilterScheduled = true;
QTimer::singleShot(0, m_helpEngineCore, applyCurrentFilter);
};
QObject::connect(m_helpEngineCore, &QHelpEngineCore::setupFinished,
m_helpEngineCore, scheduleApplyCurrentFilter);
QObject::connect(m_helpEngineCore, &QHelpEngineCore::currentFilterChanged,
m_helpEngineCore, scheduleApplyCurrentFilter);
QObject::connect(m_helpEngineCore->filterEngine(), &QHelpFilterEngine::filterActivated,
m_helpEngineCore, scheduleApplyCurrentFilter);
}
/*!
\class QHelpEngine
\since 4.4
\inmodule QtHelp
\brief The QHelpEngine class provides access to contents and
indices of the help engine.
*/
/*!
Constructs a new help engine with the given \a parent. The help
engine uses the information stored in the \a collectionFile for
providing help. If the collection file does not already exist,
it will be created.
*/
QHelpEngine::QHelpEngine(const QString &collectionFile, QObject *parent)
: QHelpEngineCore(collectionFile, parent)
, d(new QHelpEnginePrivate(this))
{}
/*!
Destroys the help engine object.
*/
QHelpEngine::~QHelpEngine()
{
delete d;
}
/*!
Returns the content model.
*/
QHelpContentModel *QHelpEngine::contentModel() const
{
return d->contentModel;
}
/*!
Returns the index model.
*/
QHelpIndexModel *QHelpEngine::indexModel() const
{
return d->indexModel;
}
/*!
Returns the content widget.
*/
QHelpContentWidget *QHelpEngine::contentWidget()
{
if (!d->contentWidget) {
d->contentWidget = new QHelpContentWidget;
d->contentWidget->setModel(d->contentModel);
#if QT_CONFIG(cursor)
connect(d->contentModel, &QHelpContentModel::contentsCreationStarted, this, [this] {
d->contentWidget->setCursor(Qt::WaitCursor);
});
connect(d->contentModel, &QHelpContentModel::contentsCreated, this, [this] {
d->contentWidget->unsetCursor();
});
#endif
}
return d->contentWidget;
}
/*!
Returns the index widget.
*/
QHelpIndexWidget *QHelpEngine::indexWidget()
{
if (!d->indexWidget) {
d->indexWidget = new QHelpIndexWidget;
d->indexWidget->setModel(d->indexModel);
#if QT_CONFIG(cursor)
connect(d->indexModel, &QHelpIndexModel::indexCreationStarted, this, [this] {
d->indexWidget->setCursor(Qt::WaitCursor);
});
connect(d->indexModel, &QHelpIndexModel::indexCreated, this, [this] {
d->indexWidget->unsetCursor();
});
#endif
}
return d->indexWidget;
}
/*!
Returns the default search engine.
*/
QHelpSearchEngine* QHelpEngine::searchEngine()
{
if (!d->searchEngine)
d->searchEngine = new QHelpSearchEngine(this, this);
return d->searchEngine;
}
QT_END_NAMESPACE
|
