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 () const noexcept
 
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 () const noexcept
 
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)
 
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

 CDisplayWindow (BtModuleList const &modules, bool const addTextHeaderToolbar, 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 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
 
DisplayOptions m_displayOptions
 
BtModelViewReadDisplay * m_displayWidget
 
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
 
CMDIArea *const m_mdi
 
BtModuleChooserBar * m_moduleChooserBar
 
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,
bool const  addTextHeaderToolbar,
CMDIArea *const  parent 
)
protected

Definition at line 61 of file cdisplaywindow.cpp.

References BtModuleChooserBar::associateWithWindow(), BT_ASSERT, BT_CONNECT, btConfig(), btMainWindow(), constModules(), CKeyChooser::createInstance(), CSwordBackend::instance(), m_buttonsToolBar, m_displayWidget, m_headerBar, m_mainToolBar, m_moduleChooserBar, m_moduleNames, m_modules, m_swordKey, anonymous_namespace{cdisplaywindow.cpp}::prepareToolBar(), reload(), setKeyChooser(), BtModelViewReadDisplay::setModules(), CSwordBackend::sigSwordSetupChanged(), BibleTime::toggledTextWindowHeader(), BibleTime::toggledTextWindowModuleChooser(), BibleTime::toggledTextWindowNavigator(), BibleTime::toggledTextWindowToolButtons(), and updateWindowTitle().

◆ ~CDisplayWindow()

CDisplayWindow::~CDisplayWindow ( )
overrideprotecteddefault

Member Function Documentation

◆ actionCollection()

BtActionCollection* CDisplayWindow::actionCollection ( ) const
inline

Definition at line 128 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().

◆ 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 216 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 159 of file cdisplaywindow.cpp.

References m_mdi.

Referenced by CDisplayWindow(), clearMainWindowToolBars(), init(), initActions(), lookupKey(), setBibleReference(), setupMainWindowToolBars(), CBookReadWindow::setupMainWindowToolBars(), and CCommentaryReadWindow::setupMainWindowToolBars().

◆ buttonsToolBar()

QToolBar* CDisplayWindow::buttonsToolBar ( ) const
inlinenoexcept

Returns the tool buttons toolbar.

Definition at line 103 of file cdisplaywindow.h.

References m_buttonsToolBar.

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

◆ clearMainWindowToolBars()

void CDisplayWindow::clearMainWindowToolBars ( )
protected

Definition at line 163 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(), CBookReadWindow::CBookReadWindow(), CDisplayWindow(), init(), initActions(), 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 599 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 602 of file cdisplaywindow.cpp.

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

Referenced by CBibleReadWindow::saveChapter().

◆ hasSelectedText()

bool CDisplayWindow::hasSelectedText ( )

Definition at line 596 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 186 of file cdisplaywindow.h.

References m_history.

Referenced by CBookReadWindow::CBookReadWindow(), 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 749 of file cdisplaywindow.cpp.

References btConfig(), btMainWindow(), clearMainWindowToolBars(), BibleTime::clearMdiToolBars(), constModules(), initActions(), initConnections(), initToolbars(), 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 242 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 313 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 199 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 442 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 481 of file cdisplaywindow.cpp.

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

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

◆ insertKeyboardActions()

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

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

Definition at line 240 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::CBookReadWindow(), 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 810 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 812 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 730 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 ( ) const
inlinenoexcept

Returns the main navigation toolbar.

Definition at line 100 of file cdisplaywindow.h.

References m_mainToolBar.

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

◆ 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.

◆ 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 714 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 156 of file cdisplaywindow.cpp.

References CSwordModuleInfo::Lexicon.

Referenced by setBibleReference().

◆ newDisplayWidgetPopupMenu()

QMenu * CDisplayWindow::newDisplayWidgetPopupMenu ( )
protectedvirtual

Reimplemented in CBibleReadWindow.

Definition at line 513 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 844 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 847 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 606 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 686 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 194 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 780 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().

◆ setFilterOptions()

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

Definition at line 196 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 706 of file cdisplaywindow.cpp.

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

Referenced by CDisplayWindow().

◆ setupMainWindowToolBars()

void CDisplayWindow::setupMainWindowToolBars ( )
protectedvirtual

Called to add actions to mainWindow toolbars

Reimplemented in CCommentaryReadWindow, and CBookReadWindow.

Definition at line 563 of file cdisplaywindow.cpp.

References BtActionCollection::action(), CResMgr::displaywindows::general::search::actionName, BTHistory::add(), BtModuleChooserBar::associateWithWindow(), CDisplayWindow::ActionsStruct::backInHistory, BT_CONNECT, btMainWindow(), constModules(), CKeyChooser::createInstance(), CDisplayWindow::ActionsStruct::forwardInHistory, CKeyChooser::handleHistoryMoved(), BTHistory::historyMoved(), CKeyChooser::key(), CKeyChooser::keyChanged(), keyChooser(), lookupSwordKey(), m_actionCollection, m_actions, m_buttonsToolBar, 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 647 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 671 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 659 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 185 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 117 of file cdisplaywindow.h.

Referenced by CBibleReadWindow::syncWindows().

◆ updateWindowTitle()

void CDisplayWindow::updateWindowTitle ( )

Definition at line 174 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 169 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 178 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 276 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
private

Definition at line 293 of file cdisplaywindow.h.

Referenced by buttonsToolBar(), CDisplayWindow(), init(), initToolbars(), and setupMainWindowToolBars().

◆ m_displayOptions

DisplayOptions CDisplayWindow::m_displayOptions
private

Definition at line 286 of file cdisplaywindow.h.

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

◆ m_displayWidget

BtModelViewReadDisplay* CDisplayWindow::m_displayWidget
private

Definition at line 295 of file cdisplaywindow.h.

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

◆ m_filterOptions

FilterOptions CDisplayWindow::m_filterOptions
private

Definition at line 285 of file cdisplaywindow.h.

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

◆ m_headerBar

QToolBar* CDisplayWindow::m_headerBar = nullptr
private

Definition at line 294 of file cdisplaywindow.h.

Referenced by CDisplayWindow(), and initToolbars().

◆ m_history

BTHistory* const CDisplayWindow::m_history
private

Definition at line 296 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 290 of file cdisplaywindow.h.

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

◆ m_keyChooser

CKeyChooser* CDisplayWindow::m_keyChooser = nullptr
private

Definition at line 288 of file cdisplaywindow.h.

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

◆ m_mainToolBar

QToolBar* CDisplayWindow::m_mainToolBar
private

Definition at line 291 of file cdisplaywindow.h.

Referenced by CDisplayWindow(), init(), initToolbars(), and mainToolBar().

◆ m_mdi

CMDIArea* const CDisplayWindow::m_mdi
private

Definition at line 277 of file cdisplaywindow.h.

Referenced by btMainWindow(), and mdi().

◆ m_moduleChooserBar

BtModuleChooserBar* CDisplayWindow::m_moduleChooserBar
private

Definition at line 292 of file cdisplaywindow.h.

Referenced by CDisplayWindow(), and init().

◆ m_moduleNames

QStringList CDisplayWindow::m_moduleNames
private

Definition at line 283 of file cdisplaywindow.h.

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

◆ m_modules

BtModuleList CDisplayWindow::m_modules
private

Definition at line 279 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 289 of file cdisplaywindow.h.

Referenced by CDisplayWindow(), copyDisplayedText(), initActions(), 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