CKeyChooser Class Reference

#include <ckeychooser.h>

Inheritance diagram for CKeyChooser:

Public Slots
void	handleHistoryMoved (QString const &newKey)
virtual void	updateKey (CSwordKey *key)=0

Signals
void	keyChanged (CSwordKey *newKey)

Public Member Functions
virtual CSwordKey *	key ()=0
virtual void	refreshContent ()=0
virtual void	setKey (CSwordKey *key)=0
virtual void	setModules (const BtConstModuleList &modules, bool refresh=true)=0

Static Public Member Functions
static CKeyChooser *	createInstance (const BtConstModuleList &modules, CSwordKey *key, QWidget *parent)

Protected Member Functions
	CKeyChooser (QWidget *parent=nullptr)

Detailed Description

The base class for the KeyChooser. Do not use directly, create a KeyChooser with createInstance , this will create the proper one of the classes that inherit from CKeyChooser

Definition at line 29 of file ckeychooser.h.

Constructor & Destructor Documentation

CKeyChooser()

CKeyChooser::CKeyChooser ( QWidget *  parent = nullptr )

protected

Definition at line 24 of file ckeychooser.cpp.

Member Function Documentation

createInstance()

CKeyChooser * CKeyChooser::createInstance ( const BtConstModuleList &  modules, CSwordKey *  key, QWidget *  parent  )

static

Creates a proper Instance, either CLexiconKeyChooser or CBibleKeyChooser

Parameters

info	the CModuleInfo to be represented by the KeyChooser
key	if not NULL, the CKey the KeyChooser should be set to
parent	the parent of the widget to create

Definition at line 26 of file ckeychooser.cpp.

References CSwordModuleInfo::Bible, BT_ASSERT, CSwordModuleInfo::Commentary, CSwordModuleInfo::GenericBook, key(), and CSwordModuleInfo::Lexicon.

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

handleHistoryMoved

void CKeyChooser::handleHistoryMoved ( QString const &  newKey )

slot

Definition at line 56 of file ckeychooser.cpp.

References key(), and setKey().

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

key()

virtual CSwordKey* CKeyChooser::key ( )

pure virtual

Returns

the current CKey.

Implemented in CBibleKeyChooser, CLexiconKeyChooser, CBookTreeChooser, and CBookKeyChooser.

Referenced by BtCopyByReferencesDialog::BtCopyByReferencesDialog(), createInstance(), handleHistoryMoved(), and CDisplayWindow::setupMainWindowToolBars().

keyChanged

void CKeyChooser::keyChanged ( CSwordKey *  newKey )

signal

is emitted if the CKey was changed by the user

Referenced by BtCopyByReferencesDialog::BtCopyByReferencesDialog(), CBibleKeyChooser::CBibleKeyChooser(), CDisplayWindow::initConnections(), CBookReadWindow::initConnections(), CBookReadWindow::initView(), CBookTreeChooser::itemActivated(), CLexiconKeyChooser::setKey(), CBibleKeyChooser::setKey(), CBookKeyChooser::setKey(), CDisplayWindow::setKeyChooser(), CDisplayWindow::setupMainWindowToolBars(), and CBookReadWindow::setupMainWindowToolBars().

refreshContent()

virtual void CKeyChooser::refreshContent ( )

pure virtual

Refreshes the content of the different key chooser parts.

Implemented in CBibleKeyChooser, CLexiconKeyChooser, CBookTreeChooser, and CBookKeyChooser.

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

setKey()

virtual void CKeyChooser::setKey ( CSwordKey *  key )

pure virtual

Sets the CKey

Parameters

key	the key which the widget should be set to.

Implemented in CBibleKeyChooser, CLexiconKeyChooser, CBookTreeChooser, and CBookKeyChooser.

Referenced by BtCopyByReferencesDialog::BtCopyByReferencesDialog(), handleHistoryMoved(), CDisplayWindow::lookupKey(), 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(), and CCommentaryReadWindow::previousVerse().

setModules()

virtual void CKeyChooser::setModules ( const BtConstModuleList &  modules, bool  refresh = true  )

pure virtual

Sets the module of this keychooser and refreshes the comboboxes

Implemented in CBibleKeyChooser, CLexiconKeyChooser, CBookTreeChooser, and CBookKeyChooser.

Referenced by CDisplayWindow::modulesChanged().

updateKey

virtual void CKeyChooser::updateKey ( CSwordKey *  key )

pure virtualslot

Updates the CKey.

Parameters

key	the key which the widget should be set to.

Referenced by CBookReadWindow::initConnections(), CDisplayWindow::setupMainWindowToolBars(), and CBookReadWindow::setupMainWindowToolBars().

---

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

• ckeychooser.h
• ckeychooser.cpp