okular/part/findbar.cpp

/*
    SPDX-FileCopyrightText: 2007 Pino Toscano <pino@kde.org>

    SPDX-License-Identifier: GPL-2.0-or-later
*/

#include "findbar.h"

// qt/kde includes
#include <KLocalizedString>
#include <QEvent>
#include <QIcon>
#include <QKeyEvent>
#include <QLabel>
#include <QLayout>
#include <QMenu>
#include <QPushButton>
#include <QToolButton>

// local includes
#include "core/document.h"
#include "searchlineedit.h"
#include "settings.h"

FindBar::FindBar(Okular::Document *document, QWidget *parent)
    : QWidget(parent)
    , m_active(false)
{
    QHBoxLayout *lay = new QHBoxLayout(this);
    lay->setContentsMargins(2, 2, 2, 2);

    QToolButton *closeBtn = new QToolButton(this);
    closeBtn->setIcon(QIcon::fromTheme(QStringLiteral("dialog-close")));
    closeBtn->setToolTip(i18n("Close"));
    closeBtn->setAutoRaise(true);
    lay->addWidget(closeBtn);

    QLabel *label = new QLabel(i18nc("Find text", "F&ind:"), this);
    lay->addWidget(label);

    m_search = new SearchLineWidget(this, document);
    m_search->lineEdit()->setSearchCaseSensitivity(Qt::CaseInsensitive);
    m_search->lineEdit()->setSearchMinimumLength(0);
    m_search->lineEdit()->setSearchType(Okular::Document::NextMatch);
    m_search->lineEdit()->setSearchId(PART_SEARCH_ID);
    m_search->lineEdit()->setSearchColor(qRgb(255, 255, 64));
    m_search->lineEdit()->setSearchMoveViewport(true);
    m_search->lineEdit()->setFindAsYouType(false);
    m_search->lineEdit()->setToolTip(i18n("Text to search for"));
    m_search->installEventFilter(this);
    label->setBuddy(m_search->lineEdit());
    lay->addWidget(m_search);

    QPushButton *findNextBtn = new QPushButton(QIcon::fromTheme(QStringLiteral("go-down-search")), i18nc("Find and go to the next search match", "Next"), this);
    findNextBtn->setToolTip(i18n("Jump to next match"));
    lay->addWidget(findNextBtn);

    QPushButton *findPrevBtn = new QPushButton(QIcon::fromTheme(QStringLiteral("go-up-search")), i18nc("Find and go to the previous search match", "Previous"), this);
    findPrevBtn->setToolTip(i18n("Jump to previous match"));
    lay->addWidget(findPrevBtn);

    QPushButton *optionsBtn = new QPushButton(this);
    optionsBtn->setText(i18n("Options"));
    optionsBtn->setToolTip(i18n("Modify search behavior"));
    QMenu *optionsMenu = new QMenu(optionsBtn);
    m_caseSensitiveAct = optionsMenu->addAction(i18n("Case sensitive"));
    m_caseSensitiveAct->setCheckable(true);
    m_fromCurrentPageAct = optionsMenu->addAction(i18n("From current page"));
    m_fromCurrentPageAct->setCheckable(true);
    m_findAsYouTypeAct = optionsMenu->addAction(i18n("Find as you type"));
    m_findAsYouTypeAct->setCheckable(true);
    optionsBtn->setMenu(optionsMenu);
    lay->addWidget(optionsBtn);

    connect(closeBtn, &QAbstractButton::clicked, this, &FindBar::closeAndStopSearch);
    connect(findNextBtn, &QAbstractButton::clicked, this, &FindBar::findNext);
    connect(findPrevBtn, &QAbstractButton::clicked, this, &FindBar::findPrev);
    connect(m_caseSensitiveAct, &QAction::toggled, this, &FindBar::caseSensitivityChanged);
    connect(m_fromCurrentPageAct, &QAction::toggled, this, &FindBar::fromCurrentPageChanged);
    connect(m_findAsYouTypeAct, &QAction::toggled, this, &FindBar::findAsYouTypeChanged);

    m_caseSensitiveAct->setChecked(Okular::Settings::searchCaseSensitive());
    m_fromCurrentPageAct->setChecked(Okular::Settings::searchFromCurrentPage());
    m_findAsYouTypeAct->setChecked(Okular::Settings::findAsYouType());

    hide();

    // "activate" it only at th very end
    m_active = true;
}

FindBar::~FindBar()
{
}

bool FindBar::eventFilter(QObject *target, QEvent *event)
{
    if (target == m_search) {
        if (event->type() == QEvent::KeyPress) {
            QKeyEvent *keyEvent = static_cast<QKeyEvent *>(event);
            if (keyEvent->key() == Qt::Key_PageUp || keyEvent->key() == Qt::Key_PageDown) {
                emit forwardKeyPressEvent(keyEvent);
                return true;
            }
        }
    }
    return false;
}

QString FindBar::text() const
{
    return m_search->lineEdit()->text();
}

Qt::CaseSensitivity FindBar::caseSensitivity() const
{
    return m_caseSensitiveAct->isChecked() ? Qt::CaseSensitive : Qt::CaseInsensitive;
}

void FindBar::focusAndSetCursor()
{
    setFocus();
    m_search->lineEdit()->selectAll();
    m_search->lineEdit()->setFocus();
}

bool FindBar::maybeHide()
{
    if (m_search->lineEdit()->isSearchRunning()) {
        m_search->lineEdit()->stopSearch();
        return false;
    } else {
        hide();
        return true;
    }
}

void FindBar::findNext()
{
    m_search->lineEdit()->setSearchType(Okular::Document::NextMatch);
    m_search->lineEdit()->findNext();
}

void FindBar::findPrev()
{
    m_search->lineEdit()->setSearchType(Okular::Document::PreviousMatch);
    m_search->lineEdit()->findPrev();
}

void FindBar::resetSearch()
{
    m_search->lineEdit()->resetSearch();
}

void FindBar::caseSensitivityChanged()
{
    m_search->lineEdit()->setSearchCaseSensitivity(m_caseSensitiveAct->isChecked() ? Qt::CaseSensitive : Qt::CaseInsensitive);
    if (!m_active)
        return;
    Okular::Settings::setSearchCaseSensitive(m_caseSensitiveAct->isChecked());
    Okular::Settings::self()->save();
    m_search->lineEdit()->restartSearch();
}

void FindBar::fromCurrentPageChanged()
{
    m_search->lineEdit()->setSearchFromStart(!m_fromCurrentPageAct->isChecked());
    if (!m_active)
        return;
    Okular::Settings::setSearchFromCurrentPage(m_fromCurrentPageAct->isChecked());
    Okular::Settings::self()->save();
}

void FindBar::findAsYouTypeChanged()
{
    m_search->lineEdit()->setFindAsYouType(m_findAsYouTypeAct->isChecked());
    if (!m_active)
        return;
    Okular::Settings::setFindAsYouType(m_findAsYouTypeAct->isChecked());
    Okular::Settings::self()->save();
}

void FindBar::closeAndStopSearch()
{
    if (m_search->lineEdit()->isSearchRunning()) {
        m_search->lineEdit()->stopSearch();
    }
    emit onCloseButtonPressed();
    close();
}

void FindBar::startSearch(const QString &findText)
{
    m_search->lineEdit()->setText(findText);
    show();
}

#include "moc_findbar.cpp"