#include <ccommentaryreadwindow.h>

Inheritance diagram for CCommentaryReadWindow:

Classes
class	ActionCollection

Public Slots
void	nextBook ()

void	nextChapter ()

void	nextVerse ()

void	previousBook ()

void	previousChapter ()

void	previousVerse ()

void	reload () override

Public Slots inherited from CDisplayWindow
void	lookupKey (QString const &key)

virtual void	reload ()

void	slotAddModule (int index, CSwordModuleInfo *module)

void	slotRemoveModule (int index)

void	slotReplaceModule (int index, CSwordModuleInfo *newModule)

Public Member Functions
void	applyProfileSettings (BtConfigCore const &windowConf) override
	Loads the settings of this window from configuration.

	CCommentaryReadWindow (QList< CSwordModuleInfo * > const &modules, QString const &key, CMDIArea *parent)

CSwordModuleInfo::ModuleType	moduleType () const override

void	storeProfileSettings (BtConfigCore &windowConf) const override
	Stores the settings of this window to configuration.

bool	syncAllowed () const noexcept override

Public Member Functions inherited from CDisplayWindow
ActionCollection *	actionCollection () const noexcept

BibleTime *	btMainWindow ()

QToolBar *	buttonsToolBar () const noexcept

BtConstModuleList	constModules () const

virtual void	copyDisplayedText ()

DisplayOptions const &	displayOptions () const noexcept

BtModelViewReadDisplay *	displayWidget () const noexcept

FilterOptions const &	filterOptions () const noexcept

CSwordModuleInfo const *	firstModule () const noexcept

CSwordKey *	getMouseClickedKey () const

CKeyChooser *	keyChooser () const noexcept

QToolBar *	mainToolBar () const noexcept

CMDIArea *	mdi () const

QStringList const &	moduleNames () const noexcept

BtModuleList const &	modules () const noexcept

void	setBibleReference (const QString &reference)

void	setDisplaySettingsButton (BtDisplaySettingsButton *button)

CSwordKey *	swordKey () const noexcept

void	updateWindowTitle ()

void	windowActivated ()

Protected Member Functions
void	initActions () override

void	initToolbars () override

void	setupMainWindowToolBars () override

Protected Member Functions inherited from CDisplayWindow
	CDisplayWindow (BtModuleList const &modules, QString const &key, bool const addTextHeaderToolbar, ActionCollection actionCollection, CMDIArea const parent)

void	clearMainWindowToolBars ()

BTHistory *	history () const noexcept

bool	init ()

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

virtual void	initConnections ()

virtual void	lookupSwordKey (CSwordKey *)

virtual QMenu *	newDisplayWidgetPopupMenu ()

void	setDisplayOptions (DisplayOptions const &v)

void	setFilterOptions (FilterOptions const &v)

	~CDisplayWindow () override

Private Member Functions
CSwordVerseKey *	verseKey ()

Private Attributes
QAction *	m_syncButton

Additional Inherited Members
Signals inherited from CDisplayWindow
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)

Protected Slots inherited from CDisplayWindow
void	lookup ()

virtual void	modulesChanged ()

void	printAll ()

void	printAnchorOnly ()

void	printAnchorWithText ()

Protected Attributes inherited from CDisplayWindow
struct CDisplayWindow::ActionsStruct	m_actions

Detailed Description

Author: The BibleTime team

Definition at line 25 of file ccommentaryreadwindow.h.

Constructor & Destructor Documentation

◆ CCommentaryReadWindow()

CCommentaryReadWindow::CCommentaryReadWindow	(	QList< CSwordModuleInfo * > const &	modules,
		QString const &	key,
		CMDIArea *	parent
	)

Definition at line 64 of file ccommentaryreadwindow.cpp.

References CDisplayWindow::init().

Member Function Documentation

◆ applyProfileSettings()

void CCommentaryReadWindow::applyProfileSettings ( BtConfigCore const & windowConf )

overridevirtual

Loads the settings of this window from configuration.

Parameters

[in] windowConf The 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 from CDisplayWindow.

Definition at line 100 of file ccommentaryreadwindow.cpp.

References CDisplayWindow::applyProfileSettings(), BT_ASSERT, m_syncButton, and BtConfigCore::value().

◆ initActions()

void CCommentaryReadWindow::initActions ( )

overrideprotectedvirtual

Initializes the internel keyboard actions.

Implements CDisplayWindow.

Definition at line 71 of file ccommentaryreadwindow.cpp.

References BtActionCollection::action(), CDisplayWindow::actionCollection(), CResMgr::displaywindows::commentaryWindow::syncWindow::actionName, CDisplayWindow::initAddAction(), m_syncButton, nextBook(), nextChapter(), nextVerse(), previousBook(), previousChapter(), previousVerse(), and BtActionCollection::readShortcuts().

◆ initToolbars()

void CCommentaryReadWindow::initToolbars ( )

overrideprotectedvirtual

Initialize the toolbars.

Reimplemented from CDisplayWindow.

Definition at line 115 of file ccommentaryreadwindow.cpp.

References CDisplayWindow::buttonsToolBar(), CDisplayWindow::initToolbars(), and m_syncButton.

◆ moduleType()

CSwordModuleInfo::ModuleType CCommentaryReadWindow::moduleType ( ) const

inlineoverridevirtual

Reimplemented from CDisplayWindow.

Definition at line 44 of file ccommentaryreadwindow.h.

References CSwordModuleInfo::Commentary.

◆ nextBook

void CCommentaryReadWindow::nextBook ( )

slot

Moves to the next book.

Definition at line 146 of file ccommentaryreadwindow.cpp.

References CDisplayWindow::keyChooser(), CKeyChooser::setKey(), CDisplayWindow::swordKey(), CSwordVerseKey::UseBook, and verseKey().

Referenced by initActions().

◆ nextChapter

void CCommentaryReadWindow::nextChapter ( )

slot

Moves to the next book.

Definition at line 158 of file ccommentaryreadwindow.cpp.

References CDisplayWindow::keyChooser(), CKeyChooser::setKey(), CDisplayWindow::swordKey(), CSwordVerseKey::UseChapter, and verseKey().

Referenced by initActions().

◆ nextVerse

void CCommentaryReadWindow::nextVerse ( )

slot

Moves to the next book.

Definition at line 170 of file ccommentaryreadwindow.cpp.

References CDisplayWindow::keyChooser(), CKeyChooser::setKey(), CDisplayWindow::swordKey(), CSwordVerseKey::UseVerse, and verseKey().

Referenced by initActions().

◆ previousBook

void CCommentaryReadWindow::previousBook ( )

slot

Moves one book behind.

Definition at line 152 of file ccommentaryreadwindow.cpp.

References CDisplayWindow::keyChooser(), CKeyChooser::setKey(), CDisplayWindow::swordKey(), CSwordVerseKey::UseBook, and verseKey().

Referenced by initActions().

◆ previousChapter

void CCommentaryReadWindow::previousChapter ( )

slot

Moves one book behind.

Definition at line 164 of file ccommentaryreadwindow.cpp.

References CDisplayWindow::keyChooser(), CKeyChooser::setKey(), CDisplayWindow::swordKey(), CSwordVerseKey::UseChapter, and verseKey().

Referenced by initActions().

◆ previousVerse

void CCommentaryReadWindow::previousVerse ( )

slot

Moves one book behind.

Definition at line 176 of file ccommentaryreadwindow.cpp.

References CDisplayWindow::keyChooser(), CKeyChooser::setKey(), CDisplayWindow::swordKey(), CSwordVerseKey::UseVerse, and verseKey().

Referenced by initActions().

◆ reload

void CCommentaryReadWindow::reload ( )

overrideslot

Reimplementation to handle the keychooser refresh.

Definition at line 126 of file ccommentaryreadwindow.cpp.

References CDisplayWindow::actionCollection(), CSwordBackend::instance(), CDisplayWindow::keyChooser(), BtActionCollection::readShortcuts(), CKeyChooser::refreshContent(), CDisplayWindow::reload(), CSwordVerseKey::setLocale(), and verseKey().

◆ setupMainWindowToolBars()

void CCommentaryReadWindow::setupMainWindowToolBars ( )

overrideprotectedvirtual

Called to add actions to mainWindow toolbars

Reimplemented from CDisplayWindow.

Definition at line 120 of file ccommentaryreadwindow.cpp.

References CDisplayWindow::btMainWindow(), m_syncButton, CDisplayWindow::setupMainWindowToolBars(), and BibleTime::toolsToolBar().

◆ storeProfileSettings()

void CCommentaryReadWindow::storeProfileSettings ( BtConfigCore & conf ) const

overridevirtual

Stores the settings of this window to configuration.

Parameters

[in] windowConf The 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 from CDisplayWindow.

Definition at line 107 of file ccommentaryreadwindow.cpp.

References BT_ASSERT, m_syncButton, BtConfigCore::setValue(), and CDisplayWindow::storeProfileSettings().

◆ syncAllowed()

bool CCommentaryReadWindow::syncAllowed ( ) const

overridevirtualnoexcept

Returns: whether syncs to the active window are allowed for this display window.

Reimplemented from CDisplayWindow.

Definition at line 181 of file ccommentaryreadwindow.cpp.

References m_syncButton.

◆ verseKey()

CSwordVerseKey * CCommentaryReadWindow::verseKey ( )

private

rapper around key() to return the right type of key.

Definition at line 138 of file ccommentaryreadwindow.cpp.

References BT_ASSERT, and CDisplayWindow::swordKey().

Referenced by nextBook(), nextChapter(), nextVerse(), previousBook(), previousChapter(), previousVerse(), and reload().

Member Data Documentation

◆ m_syncButton

QAction* CCommentaryReadWindow::m_syncButton

private

Definition at line 66 of file ccommentaryreadwindow.h.

Referenced by applyProfileSettings(), initActions(), initToolbars(), setupMainWindowToolBars(), storeProfileSettings(), and syncAllowed().

The documentation for this class was generated from the following files:

Classes

Public Slots

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CCommentaryReadWindow()

Member Function Documentation

◆ applyProfileSettings()

◆ initActions()

◆ initToolbars()

◆ moduleType()

◆ nextBook

◆ nextChapter

◆ nextVerse

◆ previousBook

◆ previousChapter

◆ previousVerse

◆ reload

◆ setupMainWindowToolBars()

◆ storeProfileSettings()

◆ syncAllowed()

◆ verseKey()

Member Data Documentation

◆ m_syncButton