| /**************************************************************************** |
| ** |
| ** 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$ |
| ** |
| ****************************************************************************/ |
| |
| #include "qhelpsearchresultwidget.h" |
| |
| #include <QtCore/QList> |
| #include <QtCore/QString> |
| #include <QtCore/QPointer> |
| #include <QtCore/QStringList> |
| #include <QtCore/QTextStream> |
| |
| #include <QtWidgets/QLabel> |
| #include <QtWidgets/QLayout> |
| #include <QtGui/QMouseEvent> |
| #include <QtWidgets/QHeaderView> |
| #include <QtWidgets/QSpacerItem> |
| #include <QtWidgets/QToolButton> |
| #include <QtWidgets/QTreeWidget> |
| #include <QtWidgets/QTextBrowser> |
| #include <QtWidgets/QTreeWidgetItem> |
| |
| QT_BEGIN_NAMESPACE |
| |
| class QResultWidget : public QTextBrowser |
| { |
| Q_OBJECT |
| |
| public: |
| QResultWidget(QWidget *parent = nullptr) |
| : QTextBrowser(parent) |
| { |
| connect(this, &QTextBrowser::anchorClicked, |
| this, &QResultWidget::requestShowLink); |
| setContextMenuPolicy(Qt::NoContextMenu); |
| } |
| |
| void showResultPage(const QVector<QHelpSearchResult> results, bool isIndexing) |
| { |
| QString htmlFile; |
| QTextStream str(&htmlFile); |
| str << "<html><head><title>" << tr("Search Results") << "</title></head><body>"; |
| |
| const int count = results.count(); |
| 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; font-weight:bold\"><a href=\"" |
| << result.url().toString() << "\">" << result.title() << "</a>" |
| "<div style=\"color:green; font-weight:normal;" |
| " margin:5px\">" << result.snippet() << "</div></div><p></p>"; |
| } |
| } 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 setSource(const QUrl & /* name */) override {} |
| }; |
| |
| |
| class QHelpSearchResultWidgetPrivate : public QObject |
| { |
| Q_OBJECT |
| |
| private slots: |
| void showFirstResultPage() |
| { |
| if (!searchEngine.isNull()) |
| resultFirstToShow = 0; |
| updateHitRange(); |
| } |
| |
| void showLastResultPage() |
| { |
| if (!searchEngine.isNull()) |
| resultFirstToShow = (searchEngine->searchResultCount() - 1) / ResultsRange * ResultsRange; |
| updateHitRange(); |
| } |
| |
| void showPreviousResultPage() |
| { |
| if (!searchEngine.isNull()) { |
| resultFirstToShow -= ResultsRange; |
| if (resultFirstToShow < 0) |
| resultFirstToShow = 0; |
| } |
| updateHitRange(); |
| } |
| |
| void showNextResultPage() |
| { |
| if (!searchEngine.isNull() |
| && resultFirstToShow + ResultsRange < searchEngine->searchResultCount()) { |
| resultFirstToShow += ResultsRange; |
| } |
| updateHitRange(); |
| } |
| |
| void indexingStarted() |
| { |
| isIndexing = true; |
| } |
| |
| void indexingFinished() |
| { |
| isIndexing = false; |
| } |
| |
| private: |
| QHelpSearchResultWidgetPrivate(QHelpSearchEngine *engine) |
| : QObject() |
| , searchEngine(engine) |
| { |
| connect(searchEngine.data(), &QHelpSearchEngine::indexingStarted, |
| this, &QHelpSearchResultWidgetPrivate::indexingStarted); |
| connect(searchEngine.data(), &QHelpSearchEngine::indexingFinished, |
| this, &QHelpSearchResultWidgetPrivate::indexingFinished); |
| } |
| |
| ~QHelpSearchResultWidgetPrivate() |
| { |
| delete searchEngine; |
| } |
| |
| QToolButton* setupToolButton(const QString &iconPath) |
| { |
| QToolButton *button = new QToolButton(); |
| button->setEnabled(false); |
| button->setAutoRaise(true); |
| button->setIcon(QIcon(iconPath)); |
| button->setIconSize(QSize(12, 12)); |
| button->setMaximumSize(QSize(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); |
| } |
| |
| private: |
| friend class QHelpSearchResultWidget; |
| |
| QPointer<QHelpSearchEngine> searchEngine; |
| |
| QResultWidget *resultTextBrowser = nullptr; |
| |
| static const int ResultsRange = 20; |
| |
| 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(engine)) |
| { |
| QVBoxLayout *vLayout = new QVBoxLayout(this); |
| vLayout->setContentsMargins(QMargins()); |
| vLayout->setSpacing(0); |
| |
| QHBoxLayout *hBoxLayout = new QHBoxLayout(); |
| #ifndef Q_OS_MAC |
| hBoxLayout->setContentsMargins(QMargins()); |
| 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, |
| d, &QHelpSearchResultWidgetPrivate::showNextResultPage); |
| connect(d->lastResultPage, &QAbstractButton::clicked, |
| d, &QHelpSearchResultWidgetPrivate::showLastResultPage); |
| connect(d->firstResultPage, &QAbstractButton::clicked, |
| d, &QHelpSearchResultWidgetPrivate::showFirstResultPage); |
| connect(d->previousResultPage, &QAbstractButton::clicked, |
| d, &QHelpSearchResultWidgetPrivate::showPreviousResultPage); |
| |
| connect(engine, &QHelpSearchEngine::searchingFinished, |
| d, &QHelpSearchResultWidgetPrivate::showFirstResultPage); |
| } |
| |
| /*! \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 QUrl(); |
| } |
| |
| QT_END_NAMESPACE |
| |
| #include "qhelpsearchresultwidget.moc" |