cdisplaywindow.cpp

Go to the documentation of this file.

/*********
*
* In the name of the Father, and of the Son, and of the Holy Spirit.
*
* This file is part of BibleTime's source code, https://bibletime.info/
*
* Copyright 1999-2026 by the BibleTime developers.
* The BibleTime source code is licensed under the GNU General Public License
* version 2.0.
*
**********/
 
#include "cdisplaywindow.h"
 
#include <QClipboard>
#include <QCloseEvent>
#include <QDebug>
#include <QFileDialog>
#include <QMdiSubWindow>
#include <QMenu>
#include <QStringList>
#include <QWidget>
#include "../../backend/config/btconfig.h"
#include "../../backend/keys/cswordkey.h"
#include "../../backend/managers/cswordbackend.h"
#include "../../util/cresmgr.h"
#include "../bibletime.h"
#include "../bibletimeapp.h"
#include "../cexportmanager.h"
#include "../cmdiarea.h"
#include "../display/btmodelviewreaddisplay.h"
#include "../display/modelview/btqmlinterface.h"
#include "../display/modelview/btquickwidget.h"
#include "../keychooser/ckeychooser.h"
#include "../keychooser/bthistory.h"
#include "../messagedialog.h"
#include "bttoolbarpopupaction.h"
#include "btmodulechooserbar.h"
#include "btdisplaysettingsbutton.h"
#include "bttextwindowheader.h"
 
 
namespace {
 
inline QWidget * getProfileWindow(QWidget * w) {
    for (; w; w = w->parentWidget())
        if (QMdiSubWindow * const sw = qobject_cast<QMdiSubWindow *>(w))
            return sw;
    return nullptr;
}
 
void prepareToolBar(QToolBar* bar, const QString& title, bool visible) {
    bar->setAllowedAreas(Qt::TopToolBarArea);
    bar->setFloatable(false);
    bar->setWindowTitle(title);
    bar->setVisible(visible);
}
 
 
} // anonymous namespace
 
CDisplayWindow::ActionCollection::ActionCollection(QObject * const parent)
    : BtActionCollection(parent)
{
    auto * actn = new QAction(QIcon(), tr("Copy"), this);
    actn->setShortcut(QKeySequence::Copy);
    addAction(QStringLiteral("copySelectedText"), actn);
 
    actn = new QAction(QIcon(), tr("Copy by references..."), this);
    actn->setShortcut(Qt::CTRL | Qt::Key_R);
    addAction(QStringLiteral("copyByReferences"), actn);
 
    actn = new QAction(QIcon(), tr("Find..."), this);
    actn->setShortcut(QKeySequence::Find);
    addAction(QStringLiteral("findText"), actn);
 
    actn = new QAction(QIcon(), tr("Change location"), this);
    actn->setShortcut(QKeySequence(Qt::CTRL | Qt::Key_L));
    addAction(QStringLiteral("openLocation"), actn);
 
    actn = new QAction(QIcon(), tr("Page down"), this);
    actn->setShortcut(QKeySequence(Qt::Key_PageDown));
    addAction(QStringLiteral("pageDown"), actn);
 
    actn = new QAction(QIcon(), tr("Page up"), this);
    actn->setShortcut(QKeySequence(Qt::Key_PageUp));
    addAction(QStringLiteral("pageUp"), actn);
 
    actn = new QAction(CResMgr::displaywindows::general::search::icon(),
                       tr("Search with works of this window"),
                       this);
    actn->setShortcut(CResMgr::displaywindows::general::search::accel);
    addAction(CResMgr::displaywindows::general::search::actionName, actn);
 
    BtToolBarPopupAction* action = new BtToolBarPopupAction(
                CResMgr::displaywindows::general::backInHistory::icon(),
                tr("Back in history"),
                this);
    action->setEnabled(false);
    action->setShortcut(CResMgr::displaywindows::general::backInHistory::accel);
    addAction(CResMgr::displaywindows::general::backInHistory::actionName,
              action);
 
    action = new BtToolBarPopupAction(
                CResMgr::displaywindows::general::forwardInHistory::icon(),
                tr("Forward in history"),
                this);
    action->setEnabled(false);
    action->setShortcut(
                CResMgr::displaywindows::general::forwardInHistory::accel);
    addAction(CResMgr::displaywindows::general::forwardInHistory::actionName,
              action);
 
    actn = new QAction(tr("Copy reference only"), this);
    addAction(QStringLiteral("copyReferenceOnly"), actn);
 
    actn = new QAction(tr("Save entry as HTML"), this);
    addAction(QStringLiteral("saveHtml"), actn);
 
    actn = new QAction(tr("Print reference only"), this);
    addAction(QStringLiteral("printReferenceOnly"), actn);
 
    actn = new QAction(tr("Entry with text"), this);
    addAction(QStringLiteral("copyEntryWithText"), actn);
 
    actn = new QAction(tr("Entry as plain text"), this);
    addAction(QStringLiteral("saveEntryAsPlain"), actn);
 
    actn = new QAction(tr("Entry with text"), this);
    addAction(QStringLiteral("printEntryWithText"), actn);
 
    actn = new QAction(tr("Strong's Search"), this);
    actn->setShortcut(CResMgr::displaywindows::general::findStrongs::accel);
    addAction(CResMgr::displaywindows::general::findStrongs::actionName, actn);
 
    #ifdef BUILD_TEXT_TO_SPEECH
    actn = new QAction(tr("Speak selected text"), this);
    addAction("speakSelectedText", actn);
    #endif
}
 
CDisplayWindow::CDisplayWindow(BtModuleList const & modules,
                               QString const & key,
                               bool const addTextHeaderToolbar,
                               ActionCollection * actionCollection,
                               CMDIArea * const parent)
    : QMainWindow(parent)
    , m_actionCollection(actionCollection)
    , m_mdi(parent)
    , m_modules(modules)
    , m_swordKey((static_cast<void>(BT_ASSERT(!modules.empty())),
                  m_modules.first()->createKey()))
    , m_history(new BTHistory(this))
{
    m_actionCollection->setParent(this);
 
    m_moduleNames.reserve(m_modules.size());
    for (auto const module : m_modules)
        m_moduleNames.append(module->name());
 
    BT_ASSERT(m_swordKey);
    if (!key.isEmpty())
        m_swordKey->setKey(key);
    m_history->add(m_swordKey.get());
 
    setMinimumSize(100, 100);
    setFocusPolicy(Qt::ClickFocus);
 
    // Cannot delete on close. QMdiSubWindow and this window work
    // as pairs. They must be deleted in a specific order.
    // QMdiSubWindow handles this procedure.
    //setAttribute(Qt::WA_DeleteOnClose);
 
    // Connect this to the backend module list changes
    BT_CONNECT(&CSwordBackend::instance(), &CSwordBackend::sigSwordSetupChanged,
               this,                       &CDisplayWindow::reload);
 
    setWindowIcon(m_modules.first()->moduleIcon());
    updateWindowTitle();
 
    // Create display widget for this window
    m_displayWidget = new BtModelViewReadDisplay(this, this);
    setCentralWidget(m_displayWidget);
    m_displayWidget->setModules(m_moduleNames);
 
    // Create the Navigation toolbar:
    m_mainToolBar = new QToolBar(this);
    prepareToolBar(m_mainToolBar,
                   tr("Navigation"),
                   btConfig().session().value<bool>(
                       QStringLiteral("GUI/showTextWindowNavigator"),
                       true));
    BT_CONNECT(btMainWindow(), &BibleTime::toggledTextWindowNavigator,
               m_mainToolBar, &QToolBar::setVisible);
    addToolBar(m_mainToolBar);
 
    // Create keychooser
    m_keyChooser = CKeyChooser::createInstance(constModules(),
                                               m_swordKey.get(),
                                               m_mainToolBar);
    BT_CONNECT(m_keyChooser, &CKeyChooser::keyChanged,
               m_history,    &BTHistory::add);
    BT_CONNECT(m_history,    &BTHistory::historyMoved,
               m_keyChooser, &CKeyChooser::handleHistoryMoved);
 
    // Create module chooser bar:
    m_moduleChooserBar = new BtModuleChooserBar(this);
    m_moduleChooserBar->setWindowTitle(tr("Work chooser buttons"));
    m_moduleChooserBar->setLayoutDirection(Qt::LeftToRight);
    m_moduleChooserBar->setVisible(
                btConfig().session().value<bool>(
                    QStringLiteral(
                        "GUI/showTextWindowModuleSelectorButtons"),
                    true));
    m_moduleChooserBar->associateWithWindow(this);
    BT_CONNECT(btMainWindow(), &BibleTime::toggledTextWindowModuleChooser,
               m_moduleChooserBar, &BtModuleChooserBar::setVisible);
    addToolBar(m_moduleChooserBar);
 
    // Create the Tools toolbar:
    m_buttonsToolBar = new QToolBar(this);
    prepareToolBar(m_buttonsToolBar,
                   tr("Tool"),
                   btConfig().session().value<bool>(
                       QStringLiteral("GUI/showTextWindowToolButtons"),
                       true));
    BT_CONNECT(btMainWindow(), &BibleTime::toggledTextWindowToolButtons,
               m_buttonsToolBar, &QToolBar::setVisible);
    addToolBar(m_buttonsToolBar);
 
    if (addTextHeaderToolbar) {
        addToolBarBreak();
 
        auto * const headerBar = new QToolBar(this);
        headerBar->setMovable(false);
        headerBar->setWindowTitle(tr("Text area header"));
        headerBar->setVisible(
                    btConfig().session().value<bool>(
                        QStringLiteral("GUI/showTextWindowHeaders"),
                        true));
        BT_CONNECT(btMainWindow(), &BibleTime::toggledTextWindowHeader,
                   headerBar, &QToolBar::setVisible);
 
        auto * const headerWidget =
                new BtTextWindowHeader(m_modules.first()->type(),
                                       m_modules,
                                       headerBar);
        BT_CONNECT(this,         &CDisplayWindow::sigModuleListChanged,
                   headerWidget, &BtTextWindowHeader::setModules);
        BT_CONNECT(headerWidget, &BtTextWindowHeader::moduleAdded,
                   this,         &CDisplayWindow::slotAddModule);
        BT_CONNECT(headerWidget, &BtTextWindowHeader::moduleReplaced,
                   this,         &CDisplayWindow::slotReplaceModule);
        BT_CONNECT(headerWidget, &BtTextWindowHeader::moduleRemoved,
                   this,         &CDisplayWindow::slotRemoveModule);
        headerBar->addWidget(headerWidget);
 
        addToolBar(headerBar);
    }
 
    // Initialize actions:
    namespace DWG = CResMgr::displaywindows::general;
    initAddAction(DWG::search::actionName,
                  [this]
                  { BibleTime::instance()->openSearchDialog(constModules()); });
    initAddAction(
                QStringLiteral("openLocation"),
                [this]{
                    if (btConfig().session().value<bool>(
                            QStringLiteral("GUI/showToolbarsInEachWindow"),
                            true))
                    {
                        m_keyChooser->setFocus();
                    } else if (auto * const kc = btMainWindow()->keyChooser()) {
                        kc->setFocus();
                    }
                });
    initAddAction(QStringLiteral("pageDown"),
                  m_displayWidget,
                  &BtModelViewReadDisplay::pageDown);
    initAddAction(QStringLiteral("pageUp"),
                  m_displayWidget,
                  &BtModelViewReadDisplay::pageUp);
    auto & copySelectedTextAction =
            initAddAction(QStringLiteral("copySelectedText"),
                          m_displayWidget,
                          &BtModelViewReadDisplay::copySelectedText);
    auto hasSelection = m_displayWidget->qmlInterface()->selection().has_value();
    copySelectedTextAction.setEnabled(hasSelection);
    #ifdef BUILD_TEXT_TO_SPEECH
    auto & speakSelectedTextAction =
            initAddAction(QStringLiteral("speakSelectedText"),
                          m_displayWidget,
                          &BtModelViewReadDisplay::speakSelectedText);
    speakSelectedTextAction.setEnabled(hasSelection);
    #define BUILD_TEXT_TO_SPEECH_CAPTURE , &speakSelectedTextAction
    #define BUILD_TEXT_TO_SPEECH_ACTION \
        speakSelectedTextAction.setEnabled(newSelection.has_value());
    #else
    #define BUILD_TEXT_TO_SPEECH_CAPTURE
    #define BUILD_TEXT_TO_SPEECH_ACTION
    #endif
    BT_CONNECT(m_displayWidget->qmlInterface(),
               &BtQmlInterface::selectionChanged,
               this,
               [&copySelectedTextAction BUILD_TEXT_TO_SPEECH_CAPTURE](
                 std::optional<BtQmlInterface::Selection> const & newSelection)
               {
                copySelectedTextAction.setEnabled(newSelection.has_value());
                BUILD_TEXT_TO_SPEECH_ACTION
               });
    #undef BUILD_TEXT_TO_SPEECH_CAPTURE
    #undef BUILD_TEXT_TO_SPEECH_ACTION
    initAddAction(QStringLiteral("copyByReferences"),
                  m_displayWidget,
                  &BtModelViewReadDisplay::copyByReferences);
    initAddAction(QStringLiteral("findText"),
                  btMainWindow(),
                  &BibleTime::openFindWidget);
    initAddAction(DWG::backInHistory::actionName,
                  m_history,
                  &BTHistory::back);
    initAddAction(DWG::forwardInHistory::actionName,
                  m_history,
                  &BTHistory::fw);
    m_actions.backInHistory =
            &m_actionCollection->actionAs<BtToolBarPopupAction>(
                CResMgr::displaywindows::general::backInHistory::actionName);
    addAction(m_actions.backInHistory);
    m_actions.forwardInHistory =
            &m_actionCollection->actionAs<BtToolBarPopupAction>(
                CResMgr::displaywindows::general::forwardInHistory::actionName);
    addAction(m_actions.forwardInHistory);
    m_actions.findText =
            &m_actionCollection->action(QStringLiteral("findText"));
    m_actions.findStrongs =
            &initAddAction(
                CResMgr::displaywindows::general::findStrongs::actionName,
                [this]{
                    QString searchText;
                    for (auto const & strongNumber
                         : m_displayWidget->nodeInfo().split(
                             '|',
                             Qt::SkipEmptyParts))
                        searchText.append(
                                    QStringLiteral("strong:%1 ")
                                    .arg(strongNumber));
                    BibleTime::instance()->openSearchDialog(constModules(),
                                                            searchText);
                });
    BT_CONNECT(m_displayWidget, &BtModelViewReadDisplay::nodeInfoChanged, this,
               [this](QString const & nodeInfo)
               { m_actions.findStrongs->setEnabled(!nodeInfo.isNull()); });
    m_actions.copy.reference =
            &initAddAction(QStringLiteral("copyReferenceOnly"),
                           m_displayWidget,
                           &BtModelViewReadDisplay::copyAnchorOnly);
    m_actions.copy.entry = &initAddAction(QStringLiteral("copyEntryWithText"),
                                          m_displayWidget,
                                          &BtModelViewReadDisplay::copyAll);
    m_actions.copy.selectedText =
            &m_actionCollection->action(QStringLiteral("copySelectedText"));
    m_actions.copy.byReferences =
            &m_actionCollection->action(QStringLiteral("copyByReferences"));
    m_actions.save.entryAsPlain =
            &initAddAction(
                QStringLiteral("saveEntryAsPlain"),
                [this]{
                    CExportManager mgr(true,
                                       tr("Saving"),
                                       filterOptions(),
                                       displayOptions());
                    mgr.saveKey(m_swordKey.get(),
                                CExportManager::Text,
                                true,
                                constModules());
                });
    m_actions.save.entryAsHTML =
            &initAddAction(
                QStringLiteral("saveHtml"),
                [this]{
                    CExportManager mgr(true,
                                       tr("Saving"),
                                       filterOptions(),
                                       displayOptions());
                    mgr.saveKey(m_swordKey.get(),
                                CExportManager::HTML,
                                true,
                                constModules());
                });
    m_actions.print.reference =
            &initAddAction(QStringLiteral("printReferenceOnly"),
                           this,
                           &CDisplayWindow::printAnchorOnly);
    addAction(m_actions.print.reference);
    m_actions.print.entry = &initAddAction(QStringLiteral("printEntryWithText"),
                                           this,
                                           &CDisplayWindow::printAll);
    BT_CONNECT(m_displayWidget, &BtModelViewReadDisplay::activeAnchorChanged,
               this,
               [this](QString const & newActiveAnchor) {
                bool const hasActiveAnchor = !newActiveAnchor.isEmpty();
                m_actions.copy.reference->setEnabled(hasActiveAnchor);
                m_actions.print.reference->setEnabled(hasActiveAnchor);
               });
    #ifdef BUILD_TEXT_TO_SPEECH
    m_actions.speakSelectedText =
            &m_actionCollection->action(QStringLiteral("speakSelectedText"));
    #endif
 
    m_actionCollection->readShortcuts(
                QStringLiteral("Displaywindow shortcuts"));
}
 
CDisplayWindow::~CDisplayWindow() = default;
 
CSwordModuleInfo::ModuleType CDisplayWindow::moduleType() const
{ return CSwordModuleInfo::Lexicon; }
 
BibleTime* CDisplayWindow::btMainWindow() {
    return dynamic_cast<BibleTime*>(m_mdi->parent()->parent());
}
 
void CDisplayWindow::clearMainWindowToolBars() {
    // Clear main window toolbars, except for works toolbar
    btMainWindow()->navToolBar()->clear();
    btMainWindow()->toolsToolBar()->clear();
}
 
void CDisplayWindow::windowActivated() {
    clearMainWindowToolBars();
    setupMainWindowToolBars();
}
 
void CDisplayWindow::updateWindowTitle() {
    if (m_modules.isEmpty()) {
        setWindowTitle(tr("<NO WORKS>"));
    } else {
        setWindowTitle(QStringLiteral("%1 (%2)")
                       .arg(m_swordKey->key(),
                            m_moduleNames.join(QStringLiteral(" | "))));
    }
}
 
/** Store the settings of this window in the given CProfileWindow object. */
void CDisplayWindow::storeProfileSettings(BtConfigCore & conf) const {
    QWidget const * const w = getProfileWindow(parentWidget());
    BT_ASSERT(w);
 
    /**
      \note We don't use saveGeometry/restoreGeometry for MDI subwindows,
            because they give slightly incorrect results with some window
            managers. Might be related to Qt bug QTBUG-7634.
    */
    const QRect rect(w->x(), w->y(), w->width(), w->height());
    conf.setValue<QRect>(QStringLiteral("windowRect"), rect);
    conf.setValue<bool>(QStringLiteral("staysOnTop"),
                        w->windowFlags() & Qt::WindowStaysOnTopHint);
    conf.setValue<bool>(QStringLiteral("staysOnBottom"),
                        w->windowFlags() & Qt::WindowStaysOnBottomHint);
    conf.setValue(QStringLiteral("maximized"), w->isMaximized());
 
    bool const hasFocus =
            (w == dynamic_cast<CDisplayWindow *>(mdi()->activeSubWindow()));
    conf.setValue(QStringLiteral("hasFocus"), hasFocus);
 
    // Save current key:
    conf.setValue(QStringLiteral("key"), m_swordKey->normalizedKey());
 
    // Save list of modules:
    conf.setValue(QStringLiteral("modules"), m_moduleNames);
 
    // Default for "not a write window":
    conf.setValue(QStringLiteral("writeWindowType"), int(0));
}
 
void CDisplayWindow::applyProfileSettings(BtConfigCore const & conf) {
    setUpdatesEnabled(false);
 
    QWidget * const w = getProfileWindow(parentWidget());
    BT_ASSERT(w);
 
    /**
      \note We don't use restoreGeometry/saveGeometry for MDI subwindows,
            because they give slightly incorrect results with some window
            managers. Might be related to Qt bug QTBUG-7634.
    */
    const QRect rect = conf.value<QRect>(QStringLiteral("windowRect"));
    w->resize(rect.width(), rect.height());
    w->move(rect.x(), rect.y());
    if (conf.value<bool>(QStringLiteral("staysOnTop"), false))
        w->setWindowFlags(w->windowFlags() | Qt::WindowStaysOnTopHint);
    if (conf.value<bool>(QStringLiteral("staysOnBottom"), false))
        w->setWindowFlags(w->windowFlags() | Qt::WindowStaysOnBottomHint);
    if (conf.value<bool>(QStringLiteral("maximized")))
        w->showMaximized();
 
    setUpdatesEnabled(true);
}
 
void CDisplayWindow::initConnections() {
    BT_ASSERT(m_keyChooser);
 
    BT_CONNECT(m_keyChooser, &CKeyChooser::keyChanged,
               this,         &CDisplayWindow::lookupSwordKey);
    BT_CONNECT(m_history, &BTHistory::historyChanged,
               [this](bool const backEnabled, bool const fwEnabled) {
                   BT_ASSERT(m_actions.backInHistory);
                   BT_ASSERT(m_keyChooser);
 
                   m_actions.backInHistory->setEnabled(backEnabled);
                   m_actions.forwardInHistory->setEnabled(fwEnabled);
               });
 
    //connect the history actions to the right slots
    BT_CONNECT(m_actions.backInHistory->popupMenu(), &QMenu::aboutToShow,
               this, // Needed
               [this]{
                   QMenu * menu = m_actions.backInHistory->popupMenu();
                   menu->clear();
                   for (auto * const actionPtr
                        : m_history->getBackList())
                       menu->addAction(actionPtr);
               });
    BT_CONNECT(m_actions.backInHistory->popupMenu(), &QMenu::triggered,
               m_history, &BTHistory::move);
    BT_CONNECT(m_actions.forwardInHistory->popupMenu(), &QMenu::aboutToShow,
               this, // Needed
               [this]{
                   QMenu* menu = m_actions.forwardInHistory->popupMenu();
                   menu->clear();
                   for (auto * const actionPtr
                        : m_history->getFwList())
                       menu->addAction(actionPtr);
               });
    BT_CONNECT(m_actions.forwardInHistory->popupMenu(), &QMenu::triggered,
               m_history, &BTHistory::move);
}
 
void CDisplayWindow::initToolbars() {
    //Navigation toolbar
    BT_ASSERT(m_actions.backInHistory);
    m_mainToolBar->addAction(m_actions.backInHistory); //1st button
    m_mainToolBar->addAction(m_actions.forwardInHistory); //2nd button
    m_mainToolBar->addWidget(m_keyChooser);
 
    //Tools toolbar
    m_buttonsToolBar->addAction(
                &m_actionCollection->action(
                    CResMgr::displaywindows::general::search::actionName));
 
    auto * const button = new BtDisplaySettingsButton(m_buttonsToolBar);
    setDisplaySettingsButton(button);
    m_buttonsToolBar->addWidget(button);
}
 
QMenu * CDisplayWindow::newDisplayWidgetPopupMenu() {
    auto * const popupMenu = new QMenu(this);
    popupMenu->addAction(m_actions.findText);
    popupMenu->addAction(m_actions.findStrongs);
    popupMenu->addSeparator();
 
    m_actions.copyMenu = new QMenu(tr("Copy..."), popupMenu);
    m_actions.copyMenu->addAction(m_actions.copy.selectedText);
    m_actions.copyMenu->addAction(m_actions.copy.byReferences);
    m_actions.copyMenu->addSeparator();
    m_actions.copyMenu->addAction(m_actions.copy.reference);
    m_actions.copyMenu->addAction(m_actions.copy.entry);
    popupMenu->addMenu(m_actions.copyMenu);
 
    m_actions.saveMenu = new QMenu(
                tr("Save..."),
                popupMenu
                );
    m_actions.saveMenu->addAction(m_actions.save.entryAsPlain);
    m_actions.saveMenu->addAction(m_actions.save.entryAsHTML);
 
    popupMenu->addMenu(m_actions.saveMenu);
 
    m_actions.printMenu = new QMenu(
                tr("Print..."),
                popupMenu
                );
    m_actions.printMenu->addAction(m_actions.print.reference);
    m_actions.printMenu->addAction(m_actions.print.entry);
    popupMenu->addMenu(m_actions.printMenu);
 
    #ifdef BUILD_TEXT_TO_SPEECH
    popupMenu->addAction((m_actions.speakSelectedText));
    #endif
 
    return addDebugActions(popupMenu);
}
 
QMenu * CDisplayWindow::addDebugActions(QMenu * const menu) {
    if (btApp->debugMode()) {
        auto * const debugAction =
                new QAction(tr("DEBUG: Show raw text"), this);
        debugAction->setProperty("bibletime_show_raw_text", true);
        menu->addSeparator();
        menu->addAction(debugAction);
    }
    return menu;
}
 
void CDisplayWindow::setupMainWindowToolBars() {
    // Navigation toolbar
    QString keyReference = m_swordKey->key();
    auto const constMods = constModules();
    auto * const keyChooser =
            CKeyChooser::createInstance(constMods,
                                        m_swordKey.get(),
                                        btMainWindow()->navToolBar());
    BT_CONNECT(keyChooser, &CKeyChooser::keyChanged,
               m_history, &BTHistory::add);
    BT_CONNECT(m_history, &BTHistory::historyMoved,
               keyChooser, &CKeyChooser::handleHistoryMoved);
    keyChooser->key()->setKey(keyReference);
    btMainWindow()->navToolBar()->addAction(m_actions.backInHistory);
    btMainWindow()->navToolBar()->addAction(m_actions.forwardInHistory);
    btMainWindow()->navToolBar()->addWidget(keyChooser);
    BT_CONNECT(keyChooser, &CKeyChooser::keyChanged,
               this,       &CDisplayWindow::lookupSwordKey);
    BT_CONNECT(this,       &CDisplayWindow::sigKeyChanged,
               keyChooser, &CKeyChooser::updateKey);
 
    // Works toolbar
    btMainWindow()->worksToolBar()->associateWithWindow(this);
 
    // Tools toolbar
    btMainWindow()->toolsToolBar()->addAction(
                &m_actionCollection->action(
                    CResMgr::displaywindows::general::search::actionName));
    auto * const button = new BtDisplaySettingsButton(m_buttonsToolBar);
    setDisplaySettingsButton(button);
    btMainWindow()->toolsToolBar()->addWidget(button);
}
 
void CDisplayWindow::copyDisplayedText()
{ CExportManager().copyKey(m_swordKey.get(), CExportManager::Text, true); }
 
CSwordKey* CDisplayWindow::getMouseClickedKey() const
{ return m_displayWidget->quickWidget()->getMouseClickedKey(); }
 
/** Refresh the settings of this window. */
void CDisplayWindow::reload() {
    // Since all the CSwordModuleInfo pointers are invalidated, we need to
    // rebuild m_modules based on m_moduleNames, and remove all missing modules:
    BT_ASSERT(!m_moduleNames.empty()); // This should otherwise be close()-d
    m_modules.clear();
    {
        auto const & backend = CSwordBackend::instance();
        auto it = m_moduleNames.begin();
        do {
            if (auto * const module = backend.findModuleByName(*it)) {
                m_modules.append(module);
                ++it;
            } else {
                it = m_moduleNames.erase(it);
            }
        } while (it != m_moduleNames.end());
    }
    BT_ASSERT(m_moduleNames.size() == m_modules.size());
 
    if (m_modules.isEmpty()) {
        close();
    } else {
        m_displayWidget->reloadModules();
 
        if (auto * const kc = m_keyChooser)
            kc->setModules(constModules(), false);
 
        lookup();
 
        m_actionCollection->readShortcuts(
                    QStringLiteral("Displaywindow shortcuts"));
        Q_EMIT sigModuleListChanged(m_modules);
    }
 
    m_displayWidget->settingsChanged();
 
    m_actionCollection->readShortcuts(QStringLiteral("Lexicon shortcuts"));
}
 
void CDisplayWindow::slotAddModule(int index, CSwordModuleInfo * module) {
    BT_ASSERT(index <= m_modules.size());
    m_modules.insert(index, module);
    m_moduleNames.insert(index, module->name());
    if (index == 0)
        setWindowIcon(module->moduleIcon());
    m_displayWidget->setModules(m_moduleNames);
    lookup();
    modulesChanged();
    Q_EMIT sigModuleListChanged(m_modules);
}
 
void CDisplayWindow::slotReplaceModule(int index, CSwordModuleInfo * newModule){
    BT_ASSERT(index < m_modules.size());
    m_modules.replace(index, newModule);
    m_moduleNames.replace(index, newModule->name());
    if (index == 0)
        setWindowIcon(newModule->moduleIcon());
    m_displayWidget->setModules(m_moduleNames);
    lookup();
    modulesChanged();
    Q_EMIT sigModuleListChanged(m_modules);
}
 
void CDisplayWindow::slotRemoveModule(int index) {
    BT_ASSERT(index >= 0);
    BT_ASSERT(index < m_modules.size());
    m_modules.removeAt(index);
    m_moduleNames.removeAt(index);
    if (m_modules.empty())
        close();
    if (index == 0)
        setWindowIcon(m_modules.first()->moduleIcon());
    m_displayWidget->setModules(m_moduleNames);
    lookup();
    modulesChanged();
    Q_EMIT sigModuleListChanged(m_modules);
}
 
void CDisplayWindow::setBibleReference(const QString& reference) {
    if (moduleType() == CSwordModuleInfo::Bible) {
        lookupKey(reference);
        return;
    }
    auto * const bibleModule =
            btConfig().getDefaultSwordModuleByType(
                QStringLiteral("standardBible"));
    if (bibleModule) {
        BibleTime *mainWindow = btMainWindow();
        BT_ASSERT(mainWindow);
        mainWindow->createReadDisplayWindow(bibleModule, reference);
        return;
    }
    message::showInformation(this, tr("Choose Standard Bible"),
                             tr("Please choose a Bible in the Settings > "
                                "Configure dialog."));
}
 
void CDisplayWindow::modulesChanged() {
    // this would only set the stringlist again
    //if (moduleChooserBar()) { //necessary for write windows
    //setModules( m_moduleChooserBar->getModuleList() );
    //}
    if (m_modules.isEmpty()) {
        close();
    }
    else {
        auto const constMods = constModules();
        Q_EMIT sigModulesChanged(constMods);
        m_swordKey->setModule(constMods.first());
        m_keyChooser->setModules(constMods);
    }
}
 
void CDisplayWindow::lookupSwordKey(CSwordKey * newKey) {
    BT_ASSERT(newKey);
 
    if (!m_isInitialized || !newKey || m_modules.empty() || !m_modules.first())
        return;
 
    if (m_swordKey.get() != newKey)
        m_swordKey->setKey(newKey->key());
 
    m_displayWidget->setOptions(displayOptions(), filterOptions());
    m_displayWidget->scrollToKey(newKey);
    BibleTime::instance()->autoScrollStop();
 
    updateWindowTitle();
}
 
/** Initialize the window. Call this method from the outside, because calling
     this in the constructor is not possible! */
bool CDisplayWindow::init() {
    initActions();
    initToolbars();
 
    auto const & conf = btConfig();
    if (!conf.session().value<bool>(
            QStringLiteral("GUI/showToolbarsInEachWindow"),
            true))
    {
        m_mainToolBar->setHidden(true);
        m_buttonsToolBar->setHidden(true);
        if (m_moduleChooserBar)
            m_moduleChooserBar->setHidden(true);
    }
    btMainWindow()->clearMdiToolBars();
    clearMainWindowToolBars();
    initConnections();
 
    m_displayWidget->installPopup(newDisplayWidgetPopupMenu());
 
    m_filterOptions = conf.getFilterOptions();
    m_displayOptions = conf.getDisplayOptions();
    Q_EMIT sigDisplayOptionsChanged(m_displayOptions);
    Q_EMIT sigFilterOptionsChanged(m_filterOptions);
    Q_EMIT sigModulesChanged(constModules());
 
    m_isInitialized = true;
    return true;
}
 
/** Sets the display settings button. */
void CDisplayWindow::setDisplaySettingsButton(BtDisplaySettingsButton *button) {
    BT_CONNECT(this,   &CDisplayWindow::sigDisplayOptionsChanged,
               button, &BtDisplaySettingsButton::setDisplayOptions);
    BT_CONNECT(this,   &CDisplayWindow::sigFilterOptionsChanged,
               button, &BtDisplaySettingsButton::setFilterOptions);
    BT_CONNECT(this,   &CDisplayWindow::sigModulesChanged,
               button, &BtDisplaySettingsButton::setModules);
 
    button->setDisplayOptionsNoRepopulate(displayOptions());
    button->setFilterOptionsNoRepopulate(filterOptions());
    button->setModules(constModules());
 
    BT_CONNECT(button, &BtDisplaySettingsButton::sigFilterOptionsChanged,
               this, // Needed
               [this](FilterOptions const & filterOptions) {
                   m_filterOptions = filterOptions;
                   Q_EMIT sigFilterOptionsChanged(m_filterOptions);
               });
    BT_CONNECT(button, &BtDisplaySettingsButton::sigDisplayOptionsChanged,
               this, // Needed
               [this](DisplayOptions const & displayOptions) {
                   m_displayOptions = displayOptions;
                   Q_EMIT sigDisplayOptionsChanged(m_displayOptions);
               });
    BT_CONNECT(button, &BtDisplaySettingsButton::sigChanged,
               this,   &CDisplayWindow::lookup);
}
 
/** Lookup the current key. Used to refresh the display. */
void CDisplayWindow::lookup() { lookupSwordKey(m_swordKey.get()); }
 
void CDisplayWindow::lookupKey( const QString& keyName ) {
    /* This function is called for example after a bookmark was dropped on this
       window. */
    BT_ASSERT(m_modules.first());
 
    if (!m_isInitialized) {
        return;
    }
 
    auto * const m =
            CSwordBackend::instance().findModuleByName(
                m_modules.first()->name());
    if (!m) {
        return; /// \todo check if this is correct behavior
    }
 
    /// \todo check for containsRef compat
    if (m && m_modules.contains(m)) {
        m_swordKey->setKey(keyName);
        // the key chooser does send an update signal
        m_keyChooser->setKey(m_swordKey.get());
        Q_EMIT sigKeyChanged(m_swordKey.get());
    }
    else { // given module not displayed in this window
        // If the module is displayed in another display window we assume a
        // wrong drop. Create a new window for the given module:
        BibleTime * mainWindow = btMainWindow();
        BT_ASSERT(mainWindow);
        mainWindow->createReadDisplayWindow(m, keyName);
    }
}
 
void CDisplayWindow::printAll()
{ m_displayWidget->printAll(m_displayOptions, m_filterOptions); }
 
void CDisplayWindow::printAnchorOnly()
{ m_displayWidget->printAnchorOnly(m_displayOptions, m_filterOptions); }
 
void CDisplayWindow::printAnchorWithText()
{ m_displayWidget->printAnchorWithText(m_displayOptions, m_filterOptions); }