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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
|
// 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 "qhelpsearchresultwidget.h"
#include <QtCore/qcoreevent.h>
#include <QtCore/qlist.h>
#include <QtCore/qpointer.h>
#include <QtCore/qtextstream.h>
#include <QtWidgets/qlabel.h>
#include <QtWidgets/qlayout.h>
#include <QtWidgets/qlayoutitem.h>
#include <QtWidgets/qtoolbutton.h>
#include <QtWidgets/qtextbrowser.h>
QT_BEGIN_NAMESPACE
static constexpr int ResultsRange = 20;
class QResultWidget : public QTextBrowser
{
Q_OBJECT
Q_PROPERTY(QColor linkColor READ linkColor WRITE setLinkColor)
public:
QResultWidget(QWidget *parent = nullptr)
: QTextBrowser(parent)
{
connect(this, &QTextBrowser::anchorClicked, this, &QResultWidget::requestShowLink);
setContextMenuPolicy(Qt::NoContextMenu);
setLinkColor(palette().color(QPalette::Link));
}
QColor linkColor() const { return m_linkColor; }
void setLinkColor(const QColor &color)
{
m_linkColor = color;
const QString sheet = QString::fromLatin1("a { text-decoration: underline; color: %1 }")
.arg(m_linkColor.name());
document()->setDefaultStyleSheet(sheet);
}
void showResultPage(const QList<QHelpSearchResult> &results, bool isIndexing)
{
QString htmlFile;
QTextStream str(&htmlFile);
str << "<html><head><title>" << tr("Search Results") << "</title></head><body>";
const int count = results.size();
if (count != 0) {
if (isIndexing) {
str << "<div style=\"text-align:left;"
" font-weight:bold; color:red\">" << tr("Note:")
<< " <span style=\"font-weight:normal; color:black\">"
<< tr("The search results may not be complete since the "
"documentation is still being indexed.")
<< "</span></div></div><br>";
}
for (const QHelpSearchResult &result : results) {
str << "<div style=\"text-align:left\"><a href=\""
<< result.url().toString() << "\">"
<< result.title() << "</a></div>"
"<div style =\"margin:5px\">" << result.snippet() << "</div>";
}
} else {
str << "<div align=\"center\"><br><br><h2>"
<< tr("Your search did not match any documents.")
<< "</h2><div>";
if (isIndexing) {
str << "<div align=\"center\"><h3>"
<< tr("(The reason for this might be that the documentation "
"is still being indexed.)") << "</h3><div>";
}
}
str << "</body></html>";
setHtml(htmlFile);
}
signals:
void requestShowLink(const QUrl &url);
private slots:
void doSetSource(const QUrl & /*name*/, QTextDocument::ResourceType /*type*/) override {}
private:
QColor m_linkColor;
};
class QHelpSearchResultWidgetPrivate
{
public:
~QHelpSearchResultWidgetPrivate()
{
delete searchEngine; // TODO: This it probably wrong, why the widget owns the engine?
}
QToolButton* setupToolButton(const QString &iconPath)
{
QToolButton *button = new QToolButton;
button->setEnabled(false);
button->setAutoRaise(true);
button->setIcon(QIcon(iconPath));
button->setIconSize({12, 12});
button->setMaximumSize({16, 16});
return button;
}
void updateHitRange()
{
int last = 0;
int first = 0;
int count = 0;
if (!searchEngine.isNull()) {
count = searchEngine->searchResultCount();
if (count > 0) {
last = qMin(resultFirstToShow + ResultsRange, count);
first = resultFirstToShow + 1;
}
resultTextBrowser->showResultPage(searchEngine->searchResults(resultFirstToShow, last),
isIndexing);
}
hitsLabel->setText(QHelpSearchResultWidget::tr("%1 - %2 of %n Hits", nullptr, count)
.arg(first).arg(last));
firstResultPage->setEnabled(resultFirstToShow);
previousResultPage->setEnabled(resultFirstToShow);
lastResultPage->setEnabled(count - last);
nextResultPage->setEnabled(count - last);
}
QHelpSearchResultWidget *q = nullptr;
QPointer<QHelpSearchEngine> searchEngine;
QResultWidget *resultTextBrowser = nullptr;
QToolButton *firstResultPage = nullptr;
QToolButton *previousResultPage = nullptr;
QToolButton *nextResultPage = nullptr;
QToolButton *lastResultPage = nullptr;
QLabel *hitsLabel = nullptr;
int resultFirstToShow = 0;
bool isIndexing = false;
};
/*!
\class QHelpSearchResultWidget
\since 4.4
\inmodule QtHelp
\brief The QHelpSearchResultWidget class provides a text browser to display
search results.
*/
/*!
\fn void QHelpSearchResultWidget::requestShowLink(const QUrl &link)
This signal is emitted when a item is activated and its associated
\a link should be shown.
*/
QHelpSearchResultWidget::QHelpSearchResultWidget(QHelpSearchEngine *engine)
: QWidget(0)
, d(new QHelpSearchResultWidgetPrivate)
{
d->q = this;
d->searchEngine = engine;
connect(engine, &QHelpSearchEngine::indexingStarted, this, [this] { d->isIndexing = true; });
connect(engine, &QHelpSearchEngine::indexingFinished, this, [this] { d->isIndexing = false; });
QVBoxLayout *vLayout = new QVBoxLayout(this);
vLayout->setContentsMargins({});
vLayout->setSpacing(0);
QHBoxLayout *hBoxLayout = new QHBoxLayout();
#ifndef Q_OS_MAC
hBoxLayout->setContentsMargins({});
hBoxLayout->setSpacing(0);
#endif
hBoxLayout->addWidget(d->firstResultPage = d->setupToolButton(
QString::fromUtf8(":/qt-project.org/assistant/images/3leftarrow.png")));
hBoxLayout->addWidget(d->previousResultPage = d->setupToolButton(
QString::fromUtf8(":/qt-project.org/assistant/images/1leftarrow.png")));
d->hitsLabel = new QLabel(tr("0 - 0 of 0 Hits"), this);
hBoxLayout->addWidget(d->hitsLabel);
d->hitsLabel->setAlignment(Qt::AlignCenter);
d->hitsLabel->setMinimumSize(QSize(150, d->hitsLabel->height()));
hBoxLayout->addWidget(d->nextResultPage = d->setupToolButton(
QString::fromUtf8(":/qt-project.org/assistant/images/1rightarrow.png")));
hBoxLayout->addWidget(d->lastResultPage = d->setupToolButton(
QString::fromUtf8(":/qt-project.org/assistant/images/3rightarrow.png")));
QSpacerItem *spacer = new QSpacerItem(40, 20, QSizePolicy::Expanding, QSizePolicy::Minimum);
hBoxLayout->addItem(spacer);
vLayout->addLayout(hBoxLayout);
d->resultTextBrowser = new QResultWidget(this);
vLayout->addWidget(d->resultTextBrowser);
connect(d->resultTextBrowser, &QResultWidget::requestShowLink,
this, &QHelpSearchResultWidget::requestShowLink);
connect(d->nextResultPage, &QAbstractButton::clicked, this, [this] {
if (!d->searchEngine.isNull()
&& d->resultFirstToShow + ResultsRange < d->searchEngine->searchResultCount()) {
d->resultFirstToShow += ResultsRange;
}
d->updateHitRange();
});
connect(d->previousResultPage, &QAbstractButton::clicked, this, [this] {
if (!d->searchEngine.isNull()) {
d->resultFirstToShow -= ResultsRange;
if (d->resultFirstToShow < 0)
d->resultFirstToShow = 0;
}
d->updateHitRange();
});
connect(d->lastResultPage, &QAbstractButton::clicked, this, [this] {
if (!d->searchEngine.isNull())
d->resultFirstToShow = (d->searchEngine->searchResultCount() - 1) / ResultsRange * ResultsRange;
d->updateHitRange();
});
const auto showFirstPage = [this] {
if (!d->searchEngine.isNull())
d->resultFirstToShow = 0;
d->updateHitRange();
};
connect(d->firstResultPage, &QAbstractButton::clicked, this, showFirstPage);
connect(engine, &QHelpSearchEngine::searchingFinished, this, showFirstPage);
}
/*! \reimp
*/
void QHelpSearchResultWidget::changeEvent(QEvent *event)
{
if (event->type() == QEvent::LanguageChange)
d->updateHitRange();
}
/*!
Destroys the search result widget.
*/
QHelpSearchResultWidget::~QHelpSearchResultWidget()
{
delete d;
}
/*!
Returns a reference of the URL that the item at \a point owns, or an
empty URL if no item exists at that point.
*/
QUrl QHelpSearchResultWidget::linkAt(const QPoint &point)
{
if (d->resultTextBrowser)
return d->resultTextBrowser->anchorAt(point);
return {};
}
QT_END_NAMESPACE
#include "qhelpsearchresultwidget.moc"
|
