BibleTime
Classes | Public Slots | Signals | Public Member Functions | Static Public Member Functions | Protected Slots | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | Friends | List of all members
CDisplayWindow Class Reference

The base class for all display windows of BibleTime. More...

#include <cdisplaywindow.h>

Inheritance diagram for CDisplayWindow:

Classes

struct  ActionsStruct
 

Public Slots

void lookupKey (QString const &key)
 
virtual void reload ()
 
void slotAddModule (int index, CSwordModuleInfo *module)
 
void slotRemoveModule (int index)
 
void slotReplaceModule (int index, CSwordModuleInfo *newModule)
 

Signals

void sigDisplayOptionsChanged (const DisplayOptions &displayOptions)
 
void sigFilterOptionsChanged (const FilterOptions &filterOptions)
 
void sigKeyChanged (CSwordKey *key)
 
void sigModuleAdded (int index, QString module)
 
void sigModuleListChanged (BtModuleList newList)
 
void sigModuleRemoved (int index)
 
void sigModuleReplaced (int index, QString newModule)
 
void sigModulesChanged (const BtConstModuleList &modules)
 

Public Member Functions

BtActionCollection * actionCollection () const
 
virtual void applyProfileSettings (BtConfigCore const &windowConf)
 Loads the settings of this window from configuration. More...
 
BibleTime * btMainWindow ()
 
QToolBar * buttonsToolBar ()
 
BtConstModuleList constModules () const
 
virtual void copyDisplayedText ()
 
DisplayOptions const & displayOptions () const
 
BtModelViewReadDisplay * displayWidget () const
 
FilterOptions const & filterOptions () const
 
CSwordModuleInfo const * firstModule () const noexcept
 
CSwordKey * getMouseClickedKey () const
 
bool hasSelectedText ()
 
CSwordKey * key () const
 
CKeyChooser * keyChooser () const
 
QToolBar * mainToolBar ()
 
CMDIArea * mdi () const
 
QStringList const & moduleNames () const noexcept
 
BtModuleList const & modules () const noexcept
 
virtual CSwordModuleInfo::ModuleType moduleType () const
 
void setBibleReference (const QString &reference)
 
void setDisplaySettingsButton (BtDisplaySettingsButton *button)
 
void setDisplayWidget (BtModelViewReadDisplay *newDisplay)
 
virtual void storeProfileSettings (BtConfigCore &windowConf) const
 Stores the settings of this window to configuration. More...
 
virtual bool syncAllowed () const
 
void updateWindowTitle ()
 
void windowActivated ()
 

Static Public Member Functions

static void insertKeyboardActions (BtActionCollection *const a)
 

Protected Slots

void lookup ()
 
virtual void modulesChanged ()
 
void printAll ()
 
void printAnchorWithText ()
 

Protected Member Functions

void addModuleChooserBar ()
 
 CDisplayWindow (BtModuleList const &modules, CMDIArea *const parent)
 
void clearMainWindowToolBars ()
 
BTHistory * history () const noexcept
 
bool init ()
 
virtual void initActions ()
 
template<typename ... Args>
QAction & initAddAction (Args &&... args)
 
virtual void initConnections ()
 
virtual void initToolbars ()
 
virtual void initView ()
 
virtual void lookupSwordKey (CSwordKey *)
 
virtual QMenu * newDisplayWidgetPopupMenu ()
 
void setDisplayOptions (DisplayOptions const &v)
 
void setFilterOptions (FilterOptions const &v)
 
void setKeyChooser (CKeyChooser *ck)
 
virtual void setupMainWindowToolBars ()
 
 ~CDisplayWindow () override
 

Protected Attributes

struct CDisplayWindow::ActionsStruct m_actions
 

Private Member Functions

template<typename Name , typename ... Args>
QAction & initAction (Name &&name, Args &&... args)
 

Private Attributes

BtActionCollection *const m_actionCollection
 
QToolBar * m_buttonsToolBar = nullptr
 
DisplayOptions m_displayOptions
 
BtModelViewReadDisplay * m_displayWidget = nullptr
 
FilterOptions m_filterOptions
 
QToolBar * m_headerBar = nullptr
 
BTHistory *const m_history
 
bool m_isInitialized = false
 Whether init() has been called. More...
 
CKeyChooser * m_keyChooser = nullptr
 
QToolBar * m_mainToolBar = nullptr
 
CMDIArea *const m_mdi
 
BtModuleChooserBar * m_moduleChooserBar = nullptr
 
QStringList m_moduleNames
 
BtModuleList m_modules
 
std::unique_ptr< CSwordKey > const m_swordKey
 

Friends

class CBibleReadWindow
 
class CLexiconReadWindow
 

Detailed Description

The base class for all display windows of BibleTime.

Definition at line 44 of file cdisplaywindow.h.

Constructor & Destructor Documentation

◆ CDisplayWindow()

CDisplayWindow::CDisplayWindow ( BtModuleList const &  modules,
CMDIArea *const  parent 
)
protected

Definition at line 54 of file cdisplaywindow.cpp.

References BT_ASSERT, BT_CONNECT, CSwordBackend::instance(), m_moduleNames, m_modules, m_swordKey, reload(), CSwordBackend::sigSwordSetupChanged(), and updateWindowTitle().

◆ ~CDisplayWindow()

CDisplayWindow::~CDisplayWindow ( )
overrideprotecteddefault

Member Function Documentation

◆ actionCollection()

BtActionCollection* CDisplayWindow::actionCollection ( ) const
inline

Definition at line 131 of file cdisplaywindow.h.

References m_actionCollection.

Referenced by CBibleReadWindow::initActions(), CBookReadWindow::initActions(), CCommentaryReadWindow::initActions(), CLexiconReadWindow::initActions(), CBookReadWindow::initToolbars(), CBibleReadWindow::reload(), CCommentaryReadWindow::reload(), CLexiconReadWindow::reload(), and CBookReadWindow::setupMainWindowToolBars().

◆ addModuleChooserBar()

void CDisplayWindow::addModuleChooserBar ( )
protected

Creates and adds the module chooser bar to the toolbar.

Definition at line 713 of file cdisplaywindow.cpp.

References BtModuleChooserBar::associateWithWindow(), BT_ASSERT, BT_CONNECT, btConfig(), btMainWindow(), m_moduleChooserBar, and BibleTime::toggledTextWindowModuleChooser().

Referenced by initView(), and CBookReadWindow::initView().

◆ applyProfileSettings()

void CDisplayWindow::applyProfileSettings ( BtConfigCore const &  windowConf)
virtual

Loads the settings of this window from configuration.

Parameters
[in]windowConfThe locked configuration group.
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.

Reimplemented in CCommentaryReadWindow, CBookReadWindow, and CBibleReadWindow.

Definition at line 147 of file cdisplaywindow.cpp.

References BT_ASSERT, anonymous_namespace{cdisplaywindow.cpp}::getProfileWindow(), and BtConfigCore::value().

Referenced by CBibleReadWindow::applyProfileSettings(), CBookReadWindow::applyProfileSettings(), and CCommentaryReadWindow::applyProfileSettings().

◆ btMainWindow()

BibleTime * CDisplayWindow::btMainWindow ( )

Return pointer to the BibleTime main window

Definition at line 90 of file cdisplaywindow.cpp.

References m_mdi.

Referenced by addModuleChooserBar(), buttonsToolBar(), clearMainWindowToolBars(), init(), initActions(), initView(), lookupKey(), mainToolBar(), setBibleReference(), setDisplayWidget(), setupMainWindowToolBars(), CBookReadWindow::setupMainWindowToolBars(), and CCommentaryReadWindow::setupMainWindowToolBars().

◆ buttonsToolBar()

QToolBar * CDisplayWindow::buttonsToolBar ( )

Returns the tool buttons toolbar.

Definition at line 788 of file cdisplaywindow.cpp.

References BT_CONNECT, btConfig(), btMainWindow(), m_buttonsToolBar, prepareToolBar(), and BibleTime::toggledTextWindowToolButtons().

Referenced by initToolbars(), CBookReadWindow::initToolbars(), CCommentaryReadWindow::initToolbars(), initView(), CBookReadWindow::initView(), setupMainWindowToolBars(), and CBookReadWindow::setupMainWindowToolBars().

◆ clearMainWindowToolBars()

void CDisplayWindow::clearMainWindowToolBars ( )
protected

Definition at line 94 of file cdisplaywindow.cpp.

References btMainWindow(), BibleTime::navToolBar(), and BibleTime::toolsToolBar().

Referenced by init(), and windowActivated().

◆ constModules()

BtConstModuleList CDisplayWindow::constModules ( ) const
inline

Definition at line 65 of file cdisplaywindow.h.

References m_modules.

Referenced by BtCopyByReferencesDialog::BtCopyByReferencesDialog(), init(), initActions(), initView(), CBookReadWindow::initView(), modulesChanged(), CBookReadWindow::modulesChanged(), reload(), CBibleReadWindow::saveChapter(), setDisplaySettingsButton(), setupMainWindowToolBars(), CBookReadWindow::setupMainWindowToolBars(), and BibleTime::slotSearchModules().

◆ copyDisplayedText()

void CDisplayWindow::copyDisplayedText ( )
virtual

Updates the status of the popup menu entries.

Definition at line 565 of file cdisplaywindow.cpp.

References CExportManager::copyKey(), m_swordKey, and CExportManager::Text.

◆ displayOptions()

DisplayOptions const& CDisplayWindow::displayOptions ( ) const
inline

Returns the display options used by this display window.

Definition at line 85 of file cdisplaywindow.h.

References m_displayOptions.

Referenced by CBibleReadWindow::applyProfileSettings(), CBibleReadWindow::copyDisplayedText(), initActions(), lookupSwordKey(), BtModelViewReadDisplay::print(), CBibleReadWindow::saveChapter(), setDisplaySettingsButton(), and CBibleReadWindow::storeProfileSettings().

◆ displayWidget()

BtModelViewReadDisplay* CDisplayWindow::displayWidget ( ) const
inline

Returns the display widget used by this implementation of CDisplayWindow.

Definition at line 110 of file cdisplaywindow.h.

References BT_ASSERT, and m_displayWidget.

Referenced by CMDIArea::findTextInActiveWindow(), CMDIArea::highlightTextInActiveWindow(), CBibleReadWindow::initActions(), and CBibleReadWindow::newDisplayWidgetPopupMenu().

◆ filterOptions()

FilterOptions const& CDisplayWindow::filterOptions ( ) const
inline

Returns the filter options used by this window.

Definition at line 88 of file cdisplaywindow.h.

References m_filterOptions.

Referenced by CBibleReadWindow::applyProfileSettings(), CBibleReadWindow::copyDisplayedText(), initActions(), lookupSwordKey(), BtModelViewReadDisplay::print(), CBibleReadWindow::saveChapter(), setDisplaySettingsButton(), and CBibleReadWindow::storeProfileSettings().

◆ firstModule()

CSwordModuleInfo const* CDisplayWindow::firstModule ( ) const
inlinenoexcept

Definition at line 60 of file cdisplaywindow.h.

References m_modules.

Referenced by CBibleReadWindow::copyDisplayedText(), and CBibleReadWindow::newDisplayWidgetPopupMenu().

◆ getMouseClickedKey()

CSwordKey * CDisplayWindow::getMouseClickedKey ( ) const

Definition at line 568 of file cdisplaywindow.cpp.

References BtQuickWidget::getMouseClickedKey(), m_displayWidget, and BtModelViewReadDisplay::quickWidget().

Referenced by CBibleReadWindow::saveChapter().

◆ hasSelectedText()

bool CDisplayWindow::hasSelectedText ( )

Definition at line 562 of file cdisplaywindow.cpp.

References BtQmlInterface::hasSelectedText(), m_displayWidget, and BtModelViewReadDisplay::qmlInterface().

Referenced by newDisplayWidgetPopupMenu(), and CBibleReadWindow::newDisplayWidgetPopupMenu().

◆ history()

BTHistory* CDisplayWindow::history ( ) const
inlineprotectednoexcept

Returns history for this window

Definition at line 187 of file cdisplaywindow.h.

References m_history.

Referenced by CBookReadWindow::initView(), and CBookReadWindow::setupMainWindowToolBars().

◆ init()

bool CDisplayWindow::init ( )
protected

Initialize the window. Call this method from the outside, because calling this in the constructor is not possible!

Definition at line 733 of file cdisplaywindow.cpp.

References BT_ASSERT, btConfig(), btMainWindow(), clearMainWindowToolBars(), BibleTime::clearMdiToolBars(), constModules(), initActions(), initConnections(), initToolbars(), initView(), BtModelViewReadDisplay::installPopup(), m_buttonsToolBar, m_displayOptions, m_displayWidget, m_filterOptions, m_isInitialized, m_mainToolBar, m_moduleChooserBar, newDisplayWidgetPopupMenu(), sigDisplayOptionsChanged(), sigFilterOptionsChanged(), and sigModulesChanged().

Referenced by CBibleReadWindow::CBibleReadWindow(), CBookReadWindow::CBookReadWindow(), CCommentaryReadWindow::CCommentaryReadWindow(), and CLexiconReadWindow::CLexiconReadWindow().

◆ initAction()

template<typename Name , typename ... Args>
QAction& CDisplayWindow::initAction ( Name &&  name,
Args &&...  args 
)
inlineprivate

Definition at line 249 of file cdisplaywindow.h.

References BtActionCollection::action(), BT_CONNECT, and m_actionCollection.

Referenced by initActions(), and initAddAction().

◆ initActions()

void CDisplayWindow::initActions ( )
protectedvirtual

Initializes the internel keyboard actions.

Reimplemented in CLexiconReadWindow, CCommentaryReadWindow, CBookReadWindow, and CBibleReadWindow.

Definition at line 244 of file cdisplaywindow.cpp.

References CResMgr::mainMenu::view::showMainIndex::actionName, CResMgr::displaywindows::general::backInHistory::actionName, CResMgr::displaywindows::general::forwardInHistory::actionName, CResMgr::displaywindows::general::findStrongs::actionName, BTHistory::back(), CDisplayWindow::ActionsStruct::backInHistory, btConfig(), btMainWindow(), CDisplayWindow::ActionsStruct::byReferences, constModules(), CDisplayWindow::ActionsStruct::copy, BtModelViewReadDisplay::copyAll(), BtModelViewReadDisplay::copyAnchorOnly(), BtModelViewReadDisplay::copyByReferences(), BtModelViewReadDisplay::copySelectedText(), displayOptions(), CDisplayWindow::ActionsStruct::entry, CDisplayWindow::ActionsStruct::entryAsHTML, CDisplayWindow::ActionsStruct::entryAsPlain, filterOptions(), CDisplayWindow::ActionsStruct::findStrongs, CDisplayWindow::ActionsStruct::findText, CDisplayWindow::ActionsStruct::forwardInHistory, BTHistory::fw(), BtModelViewReadDisplay::getCurrentNodeInfo(), CExportManager::HTML, initAction(), initAddAction(), insertKeyboardActions(), BibleTime::instance(), keyChooser(), m_actionCollection, m_actions, m_displayWidget, m_history, m_keyChooser, m_swordKey, BibleTime::openFindWidget(), BibleTime::openSearchDialog(), BtModelViewReadDisplay::pageDown(), BtModelViewReadDisplay::pageUp(), CDisplayWindow::ActionsStruct::print, printAll(), printAnchorWithText(), BtActionCollection::readShortcuts(), CDisplayWindow::ActionsStruct::reference, CDisplayWindow::ActionsStruct::save, CExportManager::saveKey(), CDisplayWindow::ActionsStruct::selectedText, and CExportManager::Text.

Referenced by init(), CBibleReadWindow::initActions(), CBookReadWindow::initActions(), CCommentaryReadWindow::initActions(), and CLexiconReadWindow::initActions().

◆ initAddAction()

template<typename ... Args>
QAction& CDisplayWindow::initAddAction ( Args &&...  args)
inlineprotected

Definition at line 200 of file cdisplaywindow.h.

References initAction().

Referenced by initActions(), CBibleReadWindow::initActions(), CCommentaryReadWindow::initActions(), and CLexiconReadWindow::initActions().

◆ initConnections()

void CDisplayWindow::initConnections ( )
protectedvirtual

Initializes the signal / slot connections of this display window.

Reimplemented in CBookReadWindow.

Definition at line 373 of file cdisplaywindow.cpp.

References CDisplayWindow::ActionsStruct::backInHistory, BT_ASSERT, BT_CONNECT, CDisplayWindow::ActionsStruct::forwardInHistory, BTHistory::historyChanged(), CKeyChooser::keyChanged(), lookupSwordKey(), m_actions, m_history, m_keyChooser, BTHistory::move(), and BtToolBarPopupAction::popupMenu().

Referenced by init(), and CBookReadWindow::initConnections().

◆ initToolbars()

void CDisplayWindow::initToolbars ( )
protectedvirtual

Initialize the toolbars.

Reimplemented in CCommentaryReadWindow, and CBookReadWindow.

Definition at line 447 of file cdisplaywindow.cpp.

References BtActionCollection::action(), CResMgr::displaywindows::general::search::actionName, CDisplayWindow::ActionsStruct::backInHistory, BT_ASSERT, BT_CONNECT, buttonsToolBar(), CDisplayWindow::ActionsStruct::forwardInHistory, m_actionCollection, m_actions, m_headerBar, m_keyChooser, m_modules, mainToolBar(), BtTextWindowHeader::moduleAdded(), BtTextWindowHeader::moduleRemoved(), BtTextWindowHeader::moduleReplaced(), setDisplaySettingsButton(), BtTextWindowHeader::setModules(), sigModuleListChanged(), slotAddModule(), slotRemoveModule(), and slotReplaceModule().

Referenced by init(), and CCommentaryReadWindow::initToolbars().

◆ initView()

void CDisplayWindow::initView ( )
protectedvirtual

Initialize the view of this display window.

Reimplemented in CBookReadWindow, and CBibleReadWindow.

Definition at line 412 of file cdisplaywindow.cpp.

References addModuleChooserBar(), BT_CONNECT, btConfig(), btMainWindow(), buttonsToolBar(), constModules(), CKeyChooser::createInstance(), m_displayWidget, m_headerBar, m_moduleNames, m_swordKey, mainToolBar(), setDisplayWidget(), setKeyChooser(), and BibleTime::toggledTextWindowHeader().

Referenced by init(), and CBibleReadWindow::initView().

◆ insertKeyboardActions()

void CDisplayWindow::insertKeyboardActions ( BtActionCollection *const  a)
static

Insert the keyboard accelerators of this window into the given actioncollection.

Definition at line 171 of file cdisplaywindow.cpp.

References CResMgr::displaywindows::general::findStrongs::accel, CResMgr::displaywindows::general::search::accel, CResMgr::displaywindows::general::backInHistory::accel, CResMgr::displaywindows::general::forwardInHistory::accel, CResMgr::displaywindows::general::search::actionName, CResMgr::displaywindows::general::backInHistory::actionName, CResMgr::displaywindows::general::forwardInHistory::actionName, CResMgr::displaywindows::general::findStrongs::actionName, and BtActionCollection::addAction().

Referenced by initActions().

◆ key()

CSwordKey* CDisplayWindow::key ( ) const
inline

Returns the key of this display window.

Definition at line 94 of file cdisplaywindow.h.

References BT_ASSERT, and m_swordKey.

Referenced by BtCopyByReferencesDialog::BtCopyByReferencesDialog(), BtModelViewReadDisplay::BtModelViewReadDisplay(), CBookReadWindow::initView(), CBibleReadWindow::nextBook(), CCommentaryReadWindow::nextBook(), CBibleReadWindow::nextChapter(), CCommentaryReadWindow::nextChapter(), CBibleReadWindow::nextVerse(), CCommentaryReadWindow::nextVerse(), CBibleReadWindow::previousBook(), CCommentaryReadWindow::previousBook(), CBibleReadWindow::previousChapter(), CCommentaryReadWindow::previousChapter(), CBibleReadWindow::previousVerse(), CCommentaryReadWindow::previousVerse(), BtModelViewReadDisplay::print(), CBibleReadWindow::saveChapter(), CBookReadWindow::setupMainWindowToolBars(), CBibleReadWindow::syncWindows(), BtModelViewReadDisplay::text(), CBibleReadWindow::verseKey(), and CCommentaryReadWindow::verseKey().

◆ keyChooser()

CKeyChooser* CDisplayWindow::keyChooser ( ) const
inline

Returns the keychooser widget of this display window.

Definition at line 91 of file cdisplaywindow.h.

References m_keyChooser.

Referenced by BtModelViewReadDisplay::BtModelViewReadDisplay(), initActions(), CBookReadWindow::initConnections(), CBookReadWindow::initToolbars(), CBibleReadWindow::nextBook(), CCommentaryReadWindow::nextBook(), CBibleReadWindow::nextChapter(), CCommentaryReadWindow::nextChapter(), CLexiconReadWindow::nextEntry(), CBibleReadWindow::nextVerse(), CCommentaryReadWindow::nextVerse(), CBibleReadWindow::previousBook(), CCommentaryReadWindow::previousBook(), CBibleReadWindow::previousChapter(), CCommentaryReadWindow::previousChapter(), CLexiconReadWindow::previousEntry(), CBibleReadWindow::previousVerse(), CCommentaryReadWindow::previousVerse(), CBibleReadWindow::reload(), CCommentaryReadWindow::reload(), setupMainWindowToolBars(), and CBookReadWindow::setupMainWindowToolBars().

◆ lookup

void CDisplayWindow::lookup ( )
protectedslot

Lookup the current key. Used to refresh the display. This also needs to be called after programmatically changing filter/display options.

Lookup the current key. Used to refresh the display.

Definition at line 833 of file cdisplaywindow.cpp.

References lookupSwordKey(), and m_swordKey.

Referenced by CBibleReadWindow::applyProfileSettings(), reload(), setDisplaySettingsButton(), slotAddModule(), slotRemoveModule(), and slotReplaceModule().

◆ lookupKey

void CDisplayWindow::lookupKey ( QString const &  key)
slot

Lookup the key in the chosen modules.

Todo:
check if this is correct behavior
Todo:
check for containsRef compat

Definition at line 835 of file cdisplaywindow.cpp.

References BT_ASSERT, btMainWindow(), BibleTime::createReadDisplayWindow(), CSwordBackend::findModuleByName(), CSwordBackend::instance(), m_isInitialized, m_keyChooser, m_modules, m_swordKey, CKeyChooser::setKey(), and sigKeyChanged().

Referenced by BtModelViewReadDisplay::BtModelViewReadDisplay(), BibleTime::createReadDisplayWindow(), setBibleReference(), and CBibleReadWindow::syncWindows().

◆ lookupSwordKey()

void CDisplayWindow::lookupSwordKey ( CSwordKey *  newKey)
protectedvirtual

Lookup the given key.

Definition at line 696 of file cdisplaywindow.cpp.

References BibleTime::autoScrollStop(), BT_ASSERT, displayOptions(), filterOptions(), BibleTime::instance(), CSwordKey::key(), m_displayWidget, m_isInitialized, m_modules, m_swordKey, BtModelViewReadDisplay::scrollToKey(), BtModelViewReadDisplay::setDisplayOptions(), BtModelViewReadDisplay::setFilterOptions(), and updateWindowTitle().

Referenced by initConnections(), CBookReadWindow::initConnections(), lookup(), CBibleReadWindow::lookupSwordKey(), setupMainWindowToolBars(), and CBookReadWindow::setupMainWindowToolBars().

◆ mainToolBar()

QToolBar * CDisplayWindow::mainToolBar ( )

Returns the main navigation toolbar.

Definition at line 774 of file cdisplaywindow.cpp.

References BT_CONNECT, btConfig(), btMainWindow(), m_mainToolBar, prepareToolBar(), and BibleTime::toggledTextWindowNavigator().

Referenced by BtModelViewReadDisplay::BtModelViewReadDisplay(), initToolbars(), CBookReadWindow::initToolbars(), initView(), and CBookReadWindow::initView().

◆ mdi()

CMDIArea* CDisplayWindow::mdi ( ) const
inline

Returns pointer to the mdi area object.

Definition at line 56 of file cdisplaywindow.h.

References m_mdi.

Referenced by storeProfileSettings(), and CBibleReadWindow::syncWindows().

◆ moduleNames()

QStringList const& CDisplayWindow::moduleNames ( ) const
inlinenoexcept
Returns
the used modules as a string list.

Definition at line 69 of file cdisplaywindow.h.

References m_moduleNames.

Referenced by CBookReadWindow::initView().

◆ modules()

BtModuleList const& CDisplayWindow::modules ( ) const
inlinenoexcept

Definition at line 63 of file cdisplaywindow.h.

References m_modules.

Referenced by BtModuleChooserBar::associateWithWindow().

◆ modulesChanged

void CDisplayWindow::modulesChanged ( )
protectedvirtualslot

Definition at line 680 of file cdisplaywindow.cpp.

References constModules(), m_keyChooser, m_modules, m_swordKey, CKeyChooser::setModules(), and sigModulesChanged().

Referenced by CBookReadWindow::modulesChanged(), slotAddModule(), slotRemoveModule(), and slotReplaceModule().

◆ moduleType()

CSwordModuleInfo::ModuleType CDisplayWindow::moduleType ( ) const
virtual

Reimplemented in CCommentaryReadWindow, CBookReadWindow, and CBibleReadWindow.

Definition at line 87 of file cdisplaywindow.cpp.

References CSwordModuleInfo::Lexicon.

Referenced by setBibleReference().

◆ newDisplayWidgetPopupMenu()

QMenu * CDisplayWindow::newDisplayWidgetPopupMenu ( )
protectedvirtual

Reimplemented in CBibleReadWindow.

Definition at line 479 of file cdisplaywindow.cpp.

References BT_CONNECT, CDisplayWindow::ActionsStruct::byReferences, CDisplayWindow::ActionsStruct::copy, CDisplayWindow::ActionsStruct::copyMenu, CDisplayWindow::ActionsStruct::entry, CDisplayWindow::ActionsStruct::entryAsHTML, CDisplayWindow::ActionsStruct::entryAsPlain, CDisplayWindow::ActionsStruct::findStrongs, CDisplayWindow::ActionsStruct::findText, BtModelViewReadDisplay::getCurrentNodeInfo(), BtModelViewReadDisplay::hasActiveAnchor(), hasSelectedText(), m_actions, m_displayWidget, m_modules, CDisplayWindow::ActionsStruct::print, CDisplayWindow::ActionsStruct::printMenu, CDisplayWindow::ActionsStruct::reference, CDisplayWindow::ActionsStruct::save, CDisplayWindow::ActionsStruct::saveMenu, and CDisplayWindow::ActionsStruct::selectedText.

Referenced by init().

◆ printAll

void CDisplayWindow::printAll ( )
protectedslot

Definition at line 878 of file cdisplaywindow.cpp.

References m_displayOptions, m_displayWidget, m_filterOptions, and BtModelViewReadDisplay::printAll().

Referenced by initActions(), and CBibleReadWindow::initActions().

◆ printAnchorWithText

void CDisplayWindow::printAnchorWithText ( )
protectedslot

Definition at line 881 of file cdisplaywindow.cpp.

References m_displayOptions, m_displayWidget, m_filterOptions, and BtModelViewReadDisplay::printAnchorWithText().

Referenced by initActions(), and CBibleReadWindow::initActions().

◆ reload

void CDisplayWindow::reload ( )
virtualslot

Refresh the settings of this window.

Definition at line 572 of file cdisplaywindow.cpp.

References BtInstallBackend::backend(), BT_ASSERT, constModules(), CSwordBackend::instance(), lookup(), m_actionCollection, m_displayWidget, m_keyChooser, m_moduleNames, m_modules, BtActionCollection::readShortcuts(), BtModelViewReadDisplay::reloadModules(), BtModelViewReadDisplay::settingsChanged(), and sigModuleListChanged().

Referenced by CDisplayWindow(), CBibleReadWindow::reload(), CCommentaryReadWindow::reload(), and CLexiconReadWindow::reload().

◆ setBibleReference()

void CDisplayWindow::setBibleReference ( const QString &  reference)

Definition at line 652 of file cdisplaywindow.cpp.

References CSwordModuleInfo::Bible, BT_ASSERT, btConfig(), btMainWindow(), BibleTime::createReadDisplayWindow(), BtConfig::getDefaultSwordModuleByType(), lookupKey(), moduleType(), and message::showInformation().

Referenced by BtModelViewReadDisplay::setBibleReference().

◆ setDisplayOptions()

void CDisplayWindow::setDisplayOptions ( DisplayOptions const &  v)
inlineprotected

Definition at line 195 of file cdisplaywindow.h.

References m_displayOptions.

Referenced by CBibleReadWindow::applyProfileSettings().

◆ setDisplaySettingsButton()

void CDisplayWindow::setDisplaySettingsButton ( BtDisplaySettingsButton *  button)

Sets the display settings button.

Definition at line 803 of file cdisplaywindow.cpp.

References BT_CONNECT, constModules(), displayOptions(), filterOptions(), lookup(), m_displayOptions, m_displayWidget, m_filterOptions, BtModelViewReadDisplay::setDisplayOptions(), BtDisplaySettingsButton::setDisplayOptions(), BtDisplaySettingsButton::setDisplayOptionsNoRepopulate(), BtDisplaySettingsButton::setFilterOptions(), BtDisplaySettingsButton::setFilterOptionsNoRepopulate(), BtDisplaySettingsButton::setModules(), BtDisplaySettingsButton::sigChanged(), sigDisplayOptionsChanged(), BtDisplaySettingsButton::sigDisplayOptionsChanged(), sigFilterOptionsChanged(), BtDisplaySettingsButton::sigFilterOptionsChanged(), and sigModulesChanged().

Referenced by initToolbars(), CBookReadWindow::initToolbars(), setupMainWindowToolBars(), and CBookReadWindow::setupMainWindowToolBars().

◆ setDisplayWidget()

void CDisplayWindow::setDisplayWidget ( BtModelViewReadDisplay *  newDisplay)

Sets the display widget used by this display window.

Definition at line 868 of file cdisplaywindow.cpp.

References BT_ASSERT, BT_CONNECT, btMainWindow(), BibleTime::colorThemeChanged(), m_displayWidget, and BtModelViewReadDisplay::qmlInterface().

Referenced by initView(), and CBookReadWindow::initView().

◆ setFilterOptions()

void CDisplayWindow::setFilterOptions ( FilterOptions const &  v)
inlineprotected

Definition at line 197 of file cdisplaywindow.h.

References m_filterOptions.

Referenced by CBibleReadWindow::applyProfileSettings().

◆ setKeyChooser()

void CDisplayWindow::setKeyChooser ( CKeyChooser *  ck)
protected

Sets the keychooser widget for this display window.

Definition at line 672 of file cdisplaywindow.cpp.

References BTHistory::add(), BT_CONNECT, CKeyChooser::handleHistoryMoved(), BTHistory::historyMoved(), CKeyChooser::keyChanged(), m_history, and m_keyChooser.

Referenced by initView(), and CBookReadWindow::initView().

◆ setupMainWindowToolBars()

void CDisplayWindow::setupMainWindowToolBars ( )
protectedvirtual

Called to add actions to mainWindow toolbars

Reimplemented in CCommentaryReadWindow, and CBookReadWindow.

Definition at line 529 of file cdisplaywindow.cpp.

References BtActionCollection::action(), CResMgr::displaywindows::general::search::actionName, BTHistory::add(), BtModuleChooserBar::associateWithWindow(), CDisplayWindow::ActionsStruct::backInHistory, BT_CONNECT, btMainWindow(), buttonsToolBar(), constModules(), CKeyChooser::createInstance(), CDisplayWindow::ActionsStruct::forwardInHistory, CKeyChooser::handleHistoryMoved(), BTHistory::historyMoved(), CKeyChooser::key(), CKeyChooser::keyChanged(), keyChooser(), lookupSwordKey(), m_actionCollection, m_actions, m_history, m_swordKey, BibleTime::navToolBar(), setDisplaySettingsButton(), CSwordKey::setKey(), sigKeyChanged(), BibleTime::toolsToolBar(), CKeyChooser::updateKey(), and BibleTime::worksToolBar().

Referenced by CCommentaryReadWindow::setupMainWindowToolBars(), and windowActivated().

◆ sigDisplayOptionsChanged

void CDisplayWindow::sigDisplayOptionsChanged ( const DisplayOptions &  displayOptions)
signal

Signal emitted when display options are changed.

Referenced by CBibleReadWindow::applyProfileSettings(), init(), and setDisplaySettingsButton().

◆ sigFilterOptionsChanged

void CDisplayWindow::sigFilterOptionsChanged ( const FilterOptions &  filterOptions)
signal

Signal emitted when display options are changed.

Referenced by CBibleReadWindow::applyProfileSettings(), init(), and setDisplaySettingsButton().

◆ sigKeyChanged

void CDisplayWindow::sigKeyChanged ( CSwordKey *  key)
signal

signal for sword key change

Referenced by lookupKey(), setupMainWindowToolBars(), and CBookReadWindow::setupMainWindowToolBars().

◆ sigModuleAdded

void CDisplayWindow::sigModuleAdded ( int  index,
QString  module 
)
signal

A module was added to this window.

◆ sigModuleListChanged

void CDisplayWindow::sigModuleListChanged ( BtModuleList  newList)
signal

The module list of window changed but backend list didn't.

Referenced by BtModuleChooserBar::associateWithWindow(), initToolbars(), reload(), slotAddModule(), slotRemoveModule(), and slotReplaceModule().

◆ sigModuleRemoved

void CDisplayWindow::sigModuleRemoved ( int  index)
signal

◆ sigModuleReplaced

void CDisplayWindow::sigModuleReplaced ( int  index,
QString  newModule 
)
signal

◆ sigModulesChanged

void CDisplayWindow::sigModulesChanged ( const BtConstModuleList &  modules)
signal

signal for change of modules

Referenced by init(), modulesChanged(), and setDisplaySettingsButton().

◆ slotAddModule

void CDisplayWindow::slotAddModule ( int  index,
CSwordModuleInfo *  module 
)
slot

Receives a signal telling that a module should be added.

Definition at line 613 of file cdisplaywindow.cpp.

References BT_ASSERT, lookup(), m_displayWidget, m_moduleNames, m_modules, CSwordModuleInfo::moduleIcon(), modulesChanged(), CSwordModuleInfo::name(), BtModelViewReadDisplay::setModules(), and sigModuleListChanged().

Referenced by BtModuleChooserBar::addButton(), and initToolbars().

◆ slotRemoveModule

void CDisplayWindow::slotRemoveModule ( int  index)
slot

Definition at line 637 of file cdisplaywindow.cpp.

References BT_ASSERT, lookup(), m_displayWidget, m_moduleNames, m_modules, modulesChanged(), BtModelViewReadDisplay::setModules(), and sigModuleListChanged().

Referenced by BtModuleChooserBar::addButton(), and initToolbars().

◆ slotReplaceModule

void CDisplayWindow::slotReplaceModule ( int  index,
CSwordModuleInfo *  newModule 
)
slot

Definition at line 625 of file cdisplaywindow.cpp.

References BT_ASSERT, lookup(), m_displayWidget, m_moduleNames, m_modules, CSwordModuleInfo::moduleIcon(), modulesChanged(), CSwordModuleInfo::name(), BtModelViewReadDisplay::setModules(), and sigModuleListChanged().

Referenced by BtModuleChooserBar::addButton(), and initToolbars().

◆ storeProfileSettings()

void CDisplayWindow::storeProfileSettings ( BtConfigCore &  conf) const
virtual

Stores the settings of this window to configuration.

Parameters
[in]windowConfThe locked configuration group.

Store the settings of this window in the given CProfileWindow object.

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.

Reimplemented in CCommentaryReadWindow, CBookReadWindow, and CBibleReadWindow.

Definition at line 116 of file cdisplaywindow.cpp.

References BT_ASSERT, anonymous_namespace{cdisplaywindow.cpp}::getProfileWindow(), m_moduleNames, m_swordKey, mdi(), and BtConfigCore::setValue().

Referenced by BibleTime::saveProfile(), CBibleReadWindow::storeProfileSettings(), CBookReadWindow::storeProfileSettings(), and CCommentaryReadWindow::storeProfileSettings().

◆ syncAllowed()

virtual bool CDisplayWindow::syncAllowed ( ) const
inlinevirtual
Returns
whether syncs to the active window are allowed for this display window.

Reimplemented in CCommentaryReadWindow.

Definition at line 120 of file cdisplaywindow.h.

Referenced by CBibleReadWindow::syncWindows().

◆ updateWindowTitle()

void CDisplayWindow::updateWindowTitle ( )

Definition at line 105 of file cdisplaywindow.cpp.

References m_moduleNames, m_modules, and m_swordKey.

Referenced by BtModelViewReadDisplay::BtModelViewReadDisplay(), CDisplayWindow(), and lookupSwordKey().

◆ windowActivated()

void CDisplayWindow::windowActivated ( )

Called when this window is activated

Definition at line 100 of file cdisplaywindow.cpp.

References clearMainWindowToolBars(), and setupMainWindowToolBars().

Referenced by CMDIArea::CMDIArea().

Friends And Related Function Documentation

◆ CBibleReadWindow

friend class CBibleReadWindow
friend

Definition at line 181 of file cdisplaywindow.h.

◆ CLexiconReadWindow

friend class CLexiconReadWindow
friend

Definition at line 46 of file cdisplaywindow.h.

Member Data Documentation

◆ m_actionCollection

BtActionCollection* const CDisplayWindow::m_actionCollection
private

Definition at line 283 of file cdisplaywindow.h.

Referenced by actionCollection(), initAction(), initActions(), CLexiconReadWindow::initActions(), initToolbars(), reload(), and setupMainWindowToolBars().

◆ m_actions

struct CDisplayWindow::ActionsStruct CDisplayWindow::m_actions
protected

Referenced by initActions(), initConnections(), initToolbars(), CBookReadWindow::initToolbars(), newDisplayWidgetPopupMenu(), setupMainWindowToolBars(), and CBookReadWindow::setupMainWindowToolBars().

◆ m_buttonsToolBar

QToolBar* CDisplayWindow::m_buttonsToolBar = nullptr
private

Definition at line 300 of file cdisplaywindow.h.

Referenced by buttonsToolBar(), and init().

◆ m_displayOptions

DisplayOptions CDisplayWindow::m_displayOptions
private

Definition at line 293 of file cdisplaywindow.h.

Referenced by displayOptions(), init(), printAll(), printAnchorWithText(), setDisplayOptions(), and setDisplaySettingsButton().

◆ m_displayWidget

BtModelViewReadDisplay* CDisplayWindow::m_displayWidget = nullptr
private

Definition at line 302 of file cdisplaywindow.h.

Referenced by displayWidget(), getMouseClickedKey(), hasSelectedText(), init(), initActions(), initView(), lookupSwordKey(), newDisplayWidgetPopupMenu(), printAll(), printAnchorWithText(), reload(), setDisplaySettingsButton(), setDisplayWidget(), slotAddModule(), slotRemoveModule(), and slotReplaceModule().

◆ m_filterOptions

FilterOptions CDisplayWindow::m_filterOptions
private

Definition at line 292 of file cdisplaywindow.h.

Referenced by filterOptions(), init(), printAll(), printAnchorWithText(), setDisplaySettingsButton(), and setFilterOptions().

◆ m_headerBar

QToolBar* CDisplayWindow::m_headerBar = nullptr
private

Definition at line 301 of file cdisplaywindow.h.

Referenced by initToolbars(), and initView().

◆ m_history

BTHistory* const CDisplayWindow::m_history
private

Definition at line 303 of file cdisplaywindow.h.

Referenced by history(), initActions(), initConnections(), setKeyChooser(), and setupMainWindowToolBars().

◆ m_isInitialized

bool CDisplayWindow::m_isInitialized = false
private

Whether init() has been called.

Definition at line 297 of file cdisplaywindow.h.

Referenced by init(), lookupKey(), and lookupSwordKey().

◆ m_keyChooser

CKeyChooser* CDisplayWindow::m_keyChooser = nullptr
private

Definition at line 295 of file cdisplaywindow.h.

Referenced by initActions(), initConnections(), initToolbars(), keyChooser(), lookupKey(), modulesChanged(), reload(), and setKeyChooser().

◆ m_mainToolBar

QToolBar* CDisplayWindow::m_mainToolBar = nullptr
private

Definition at line 299 of file cdisplaywindow.h.

Referenced by init(), and mainToolBar().

◆ m_mdi

CMDIArea* const CDisplayWindow::m_mdi
private

Definition at line 284 of file cdisplaywindow.h.

Referenced by btMainWindow(), and mdi().

◆ m_moduleChooserBar

BtModuleChooserBar* CDisplayWindow::m_moduleChooserBar = nullptr
private

Definition at line 298 of file cdisplaywindow.h.

Referenced by addModuleChooserBar(), and init().

◆ m_moduleNames

QStringList CDisplayWindow::m_moduleNames
private

Definition at line 290 of file cdisplaywindow.h.

Referenced by CDisplayWindow(), initView(), moduleNames(), reload(), slotAddModule(), slotRemoveModule(), slotReplaceModule(), storeProfileSettings(), and updateWindowTitle().

◆ m_modules

BtModuleList CDisplayWindow::m_modules
private

Definition at line 286 of file cdisplaywindow.h.

Referenced by CDisplayWindow(), constModules(), firstModule(), initToolbars(), lookupKey(), lookupSwordKey(), modules(), modulesChanged(), newDisplayWidgetPopupMenu(), reload(), CBibleReadWindow::reload(), slotAddModule(), slotRemoveModule(), slotReplaceModule(), and updateWindowTitle().

◆ m_swordKey

std::unique_ptr<CSwordKey> const CDisplayWindow::m_swordKey
private

Definition at line 296 of file cdisplaywindow.h.

Referenced by CDisplayWindow(), copyDisplayedText(), initActions(), initView(), key(), CLexiconReadWindow::ldKey(), lookup(), lookupKey(), lookupSwordKey(), modulesChanged(), setupMainWindowToolBars(), storeProfileSettings(), and updateWindowTitle().

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.1