File indexing completed on 2024-06-16 05:01:27

 /* ============================================================
 *
 * This file is a part of the rekonq project
 *
 * Copyright (C) 2008-2012 by Andrea Diamantini <adjam7 at gmail dot com>
 * Copyright (C) 2009-2011 by Lionel Chauvin <megabigbug@yahoo.fr>
 *
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of
 * the License or (at your option) version 3 or any later version
 * accepted by the membership of KDE e.V. (or its successor approved
 * by the membership of KDE e.V.), which shall act as a proxy
 * defined in Section 14 of version 3 of the license.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * ============================================================ */
 
 
 #include "FindBar.h"
 #include <QAbstractScrollArea>
 #include <QCheckBox>
 #include <QHBoxLayout>
 #include <QKeyEvent>
 #include <QLabel>
 #include <QPushButton>
 #include <QScrollBar>
 #include <QToolButton>
 #include <QWebFrame>
 #include <QWebView>
 #include "LineEdit.h"
 #include "Gui/EmbeddedWebView.h"
 #include "UiUtils/Color.h"
 #include "UiUtils/IconLoader.h"
 
 namespace Gui {
 
 FindBar::FindBar(QWidget *parent)
     : QWidget(parent)
     , m_lineEdit(new LineEdit(this))
     , m_matchCase(new QCheckBox(tr("&Match case"), this))
     , m_highlightAll(new QCheckBox(tr("&Highlight all"), this)),
       m_associatedWebView(nullptr)
 {
     QHBoxLayout *layout = new QHBoxLayout;
 
     // cosmetic
     layout->setContentsMargins(2, 0, 2, 0);
 
     // hide button
     QToolButton *hideButton = new QToolButton(this);
     hideButton->setAutoRaise(true);
     hideButton->setIcon(UiUtils::loadIcon(QStringLiteral("dialog-close")));
     hideButton->setShortcut(tr("Esc"));
     connect(hideButton, &QAbstractButton::clicked, this, &QWidget::hide);
     layout->addWidget(hideButton);
     layout->setAlignment(hideButton, Qt::AlignLeft | Qt::AlignTop);
 
     // label
     QLabel *label = new QLabel(tr("Find:"));
     layout->addWidget(label);
 
     // Find Bar signal
     connect(this, &FindBar::searchString, this, &FindBar::findText);
 
     // lineEdit, focusProxy
     setFocusProxy(m_lineEdit);
     m_lineEdit->setMaximumWidth(250);
     connect(m_lineEdit, &QLineEdit::textChanged, this, &FindBar::findText);
     layout->addWidget(m_lineEdit);
 
     // buttons
     QPushButton *findNext = new QPushButton(UiUtils::loadIcon(QStringLiteral("go-down")), tr("&Next"), this);
     findNext->setShortcut(tr("F3"));
     QPushButton *findPrev = new QPushButton(UiUtils::loadIcon(QStringLiteral("go-up")), tr("&Previous"), this);
     //: Translators: You can change this shortcut, but button names like Shift should not be localized here.
     //: That will break setting the shortcut. Button names will still appear localized in the UI.
     findPrev->setShortcut(tr("Shift+F3"));
     connect(findNext, &QAbstractButton::clicked, this, &FindBar::findNext);
     connect(findPrev, &QAbstractButton::clicked, this, &FindBar::findPrevious);
     layout->addWidget(findNext);
     layout->addWidget(findPrev);
 
     // Case sensitivity. Deliberately set so this is off by default.
     m_matchCase->setCheckState(Qt::Unchecked);
     m_matchCase->setTristate(false);
     connect(m_matchCase, &QAbstractButton::toggled, this, &FindBar::matchCaseUpdate);
     layout->addWidget(m_matchCase);
 
     // Hightlight All. On by default
     m_highlightAll->setCheckState(Qt::Checked);
     m_highlightAll->setTristate(false);
     connect(m_highlightAll, &QAbstractButton::toggled, this, &FindBar::updateHighlight);
     layout->addWidget(m_highlightAll);
 
     // stretching widget on the left
     layout->addStretch();
 
     setLayout(layout);
 
     // we start off hidden
     hide();
 }
 
 
 void FindBar::keyPressEvent(QKeyEvent *event)
 {
     if (event->key() == Qt::Key_Return || event->key() == Qt::Key_Enter) {
         if (event->modifiers() == Qt::ShiftModifier) {
             findPrevious();
         } else {
             findNext();
         }
     }
 
     QWidget::keyPressEvent(event);
 }
 
 
 bool FindBar::matchCase() const
 {
     return m_matchCase->isChecked();
 }
 
 
 bool FindBar::highlightAllState() const
 {
     return m_highlightAll->isChecked();
 }
 
 void FindBar::resetAssociatedWebView()
 {
     m_associatedWebView = nullptr;
     m_lineEdit->clear();
     QWidget::hide();
 }
 
 void FindBar::setVisible(bool visible)
 {
     QWidget::setVisible(visible);
 
     if (!m_associatedWebView)
         return;
 
     if (visible) {
         const QString selectedText = m_associatedWebView->page()->selectedText();
         if (!hasFocus() && !selectedText.isEmpty()) {
             const QString previousText = m_lineEdit->text();
             m_lineEdit->setText(selectedText);
 
             if (m_lineEdit->text() != previousText) {
                 findPrevious();
             } else {
                 updateHighlight();
             }
         } else if (selectedText.isEmpty()) {
             emit searchString(m_lineEdit->text());
         }
 
         m_lineEdit->setFocus();
         m_lineEdit->selectAll();
     } else {
         updateHighlight();
 
         // Clear the selection
         m_associatedWebView->page()->findText(QString());
     }
 }
 
 
 void FindBar::notifyMatch(bool match)
 {
     if (m_lineEdit->text().isEmpty()) {
         m_lineEdit->setPalette(QPalette());
     } else {
         QColor backgroundTint = match ? QColor(0, 0xff, 0, 0x20) : QColor(0xff, 0, 0, 0x20);
         QPalette p;
         p.setColor(QPalette::Base, UiUtils::tintColor(p.color(QPalette::Base), backgroundTint));
         m_lineEdit->setPalette(p);
     }
 }
 
 void FindBar::findText(const QString &search)
 {
     if (!m_associatedWebView)
         return;
     _lastStringSearched = search;
     updateHighlight();
     findNext();
 }
 
 
 void FindBar::find(FindBar::FindDirection dir)
 {
     Q_ASSERT(m_associatedWebView);
 
     if (isHidden()) {
         QPoint previous_position = m_associatedWebView->page()->currentFrame()->scrollPosition();
         m_associatedWebView->page()->focusNextPrevChild(true);
         m_associatedWebView->page()->currentFrame()->setScrollPosition(previous_position);
         return;
     }
 
     QWebPage::FindFlags options = QWebPage::FindWrapsAroundDocument;
     if (dir == Backward)
         options |= QWebPage::FindBackward;
     if (matchCase())
         options |= QWebPage::FindCaseSensitively;
 
     // HACK Because we're using the QWebView inside a QScrollArea container, the attempts
     // to scroll the QWebView itself have no direct effect.
     // Therefore we temporarily shrink the page viewport to the message viewport (ie. the size it
     // can cover at max), then perform the search, store the scrollPosition, restore the page viewport
     // and finally scroll the messageview to the gathered scrollPosition, mapped to the message (ie.
     // usually offset by the mail header)
 
     auto emb = qobject_cast<EmbeddedWebView *>(m_associatedWebView);
 
     QAbstractScrollArea *container = emb ? static_cast<QAbstractScrollArea*>(emb->scrollParent()) : nullptr;
     const QSize oldVpS = m_associatedWebView->page()->viewportSize();
     const bool useResizeTrick = container ? !!container->verticalScrollBar() : false;
     // first shrink the page viewport
     if (useResizeTrick) {
         m_associatedWebView->setUpdatesEnabled(false); // don't let the user see the flicker we might produce
         QSize newVpS = oldVpS.boundedTo(container->size());
         m_associatedWebView->page()->setViewportSize(newVpS);
     }
 
     // now perform the search (pot. in the shrinked viewport)
     bool found = m_associatedWebView->page()->findText(_lastStringSearched, options);
     notifyMatch(found);
 
     // scroll and reset the page viewport if necessary
     if (useResizeTrick) {
         Q_ASSERT(container->verticalScrollBar());
         // the page has now a usable scroll position ...
         int scrollPosition = m_associatedWebView->page()->currentFrame()->scrollPosition().y();
         // ... which needs to be extended by the pages offset (usually the header widget)
         // NOTICE: QWidget::mapTo() fails as the viewport child position can be negative, so we run ourself
         QWidget *runner = m_associatedWebView;
         while (runner->parentWidget() != container->viewport()) {
             scrollPosition += runner->y();
             runner = runner->parentWidget();
         }
         // reset viewport to original size ...
         m_associatedWebView->page()->setViewportSize(oldVpS);
         // ... let the user see the change ...
         m_associatedWebView->setUpdatesEnabled(true);
 
         // ... and finally scroll to the desired position
         if (found)
             container->verticalScrollBar()->setValue(scrollPosition);
     }
 
     if (!found) {
         QPoint previous_position = m_associatedWebView->page()->currentFrame()->scrollPosition();
         m_associatedWebView->page()->focusNextPrevChild(true);
         m_associatedWebView->page()->currentFrame()->setScrollPosition(previous_position);
     }
 }
 
 void FindBar::findNext()
 {
     find(FindBar::Forward);
 }
 
 void FindBar::findPrevious()
 {
     find(FindBar::Backward);
 }
 
 
 void FindBar::matchCaseUpdate()
 {
     Q_ASSERT(m_associatedWebView);
 
     m_associatedWebView->page()->findText(_lastStringSearched, QWebPage::FindBackward);
     findNext();
     updateHighlight();
 }
 
 
 void FindBar::updateHighlight()
 {
     Q_ASSERT(m_associatedWebView);
 
     QWebPage::FindFlags options = QWebPage::HighlightAllOccurrences;
 
     m_associatedWebView->page()->findText(QString(), options); //Clear an existing highlight
 
     if (!isHidden() && highlightAllState())
     {
         if (matchCase())
             options |= QWebPage::FindCaseSensitively;
         m_associatedWebView->page()->findText(_lastStringSearched, options);
     }
 }
 
 void FindBar::setAssociatedWebView(QWebView *webView)
 {
     if (m_associatedWebView)
         disconnect(m_associatedWebView, nullptr, this, nullptr);
 
     m_associatedWebView = webView;
 
     if (m_associatedWebView) {
         // highlighting is fancy, but terribly expensive - disable by default for fat messages
         if (auto emb = qobject_cast<EmbeddedWebView*>(m_associatedWebView)) {
             m_highlightAll->setChecked(!emb->staticWidth());
         }
         // Automatically hide this FindBar widget when the underlying webview goes away
         connect(m_associatedWebView.data(), &QObject::destroyed,
                 this, &FindBar::resetAssociatedWebView);
     }
 }
 
 }