BibleTime
Public Types | Public Member Functions | Private Slots | Private Member Functions | Private Attributes | List of all members
BtModelViewReadDisplay Class Reference

#include <btmodelviewreaddisplay.h>

Inheritance diagram for BtModelViewReadDisplay:

Public Types

enum  TextPart {
  Document , SelectedText , AnchorOnly , AnchorTextOnly ,
  AnchorWithText
}
 

Public Member Functions

 BtModelViewReadDisplay (CDisplayWindow *displayWindow, QWidget *parent=nullptr)
 
void copyAll ()
 
void copyAnchorOnly ()
 
void copyAnchorTextOnly ()
 
void copyAnchorWithText ()
 
void copyByReferences ()
 Copies the given text specified by asking user for first and last references. More...
 
void copySelectedText ()
 Copies the currently selected text. More...
 
void findText (bool const backward)
 
QString getCurrentNodeInfo () const
 
bool hasActiveAnchor () const
 
void highlightText (const QString &text, bool caseSensitive)
 
void installPopup (QMenu *const popup)
 Installs the popup which should be opened when the right mouse button was pressed. More...
 
void pageDown ()
 
void pageUp ()
 
void print (TextPart const, DisplayOptions const &displayOptions, FilterOptions const &filterOptions)
 
void printAll (DisplayOptions const &displayOptions, FilterOptions const &filterOptions)
 
void printAnchorWithText (DisplayOptions const &displayOptions, FilterOptions const &filterOptions)
 
BtQmlInterface * qmlInterface () const noexcept
 
BtQuickWidget * quickWidget () const noexcept
 
void reloadModules ()
 
void save (TextPart const part)
 Saves the given text with the specified format into the applications clipboard. More...
 
void saveAnchorWithText ()
 
void scroll (int pixels)
 
void scrollToKey (CSwordKey *key)
 
void setDisplayFocus ()
 
void setDisplayOptions (const DisplayOptions &displayOptions)
 
void setFilterOptions (FilterOptions filterOptions)
 
void setLemma (const QString &lemma)
 
void setModules (QStringList const &modules)
 
void settingsChanged ()
 
QString text (TextPart const part=Document)
 
void updateReferenceText ()
 
 ~BtModelViewReadDisplay () override
 

Private Slots

void setBibleReference (const QString &reference)
 
void slotSliderMoved (int value)
 
void slotSliderPressed ()
 
void slotSliderReleased ()
 

Private Member Functions

void contextMenuEvent (QContextMenuEvent *event) final override
 
void copyAsPlainText (TextPart const part)
 

Private Attributes

QString m_activeAnchor
 
QString m_nodeInfo
 
CDisplayWindow * m_parentWindow
 
QMenu * m_popup = nullptr
 
BtQmlInterface *const m_qmlInterface
 
BtQuickWidget *const m_quickWidget
 
QScrollBar *const m_scrollBar
 
int m_scrollBarPosition = 0
 

Detailed Description

The view implementation for the Model/View read display.

Definition at line 62 of file btmodelviewreaddisplay.h.

Member Enumeration Documentation

◆ TextPart

enum BtModelViewReadDisplay::TextPart
Enumerator
Document 
SelectedText 
AnchorOnly 
AnchorTextOnly 
AnchorWithText 

Definition at line 67 of file btmodelviewreaddisplay.h.

Constructor & Destructor Documentation

◆ BtModelViewReadDisplay()

BtModelViewReadDisplay::BtModelViewReadDisplay ( CDisplayWindow *  displayWindow,
QWidget *  parent = nullptr 
)
Todo:
Fix me

Definition at line 45 of file btmodelviewreaddisplay.cpp.

References BT_CONNECT, BtQmlInterface::changeColorTheme(), BibleTime::colorThemeChanged(), BtQmlInterface::dragOccuring(), CSwordBackend::instance(), BibleTime::instance(), CDisplayWindow::key(), CDisplayWindow::keyChooser(), CDisplayWindow::lookupKey(), m_parentWindow, m_qmlInterface, m_quickWidget, m_scrollBar, CDisplayWindow::mainToolBar(), BtQuickWidget::referenceDropped(), setBibleReference(), BtQmlInterface::setBibleReference(), CSwordKey::setKey(), slotSliderMoved(), slotSliderPressed(), slotSliderReleased(), BtQmlInterface::updateReference(), and CDisplayWindow::updateWindowTitle().

◆ ~BtModelViewReadDisplay()

BtModelViewReadDisplay::~BtModelViewReadDisplay ( )
overridedefault

Member Function Documentation

◆ contextMenuEvent()

void BtModelViewReadDisplay::contextMenuEvent ( QContextMenuEvent *  event)
finaloverrideprivate

Definition at line 139 of file btmodelviewreaddisplay.cpp.

References BtQmlInterface::activeLink(), BtQmlInterface::getBibleUrlFromLink(), BtQmlInterface::getLemmaFromLink(), m_activeAnchor, m_popup, m_qmlInterface, and setLemma().

◆ copyAll()

void BtModelViewReadDisplay::copyAll ( )
inline

Definition at line 86 of file btmodelviewreaddisplay.h.

References copyAsPlainText(), and Document.

Referenced by CDisplayWindow::initActions().

◆ copyAnchorOnly()

void BtModelViewReadDisplay::copyAnchorOnly ( )
inline

Definition at line 82 of file btmodelviewreaddisplay.h.

References AnchorOnly, and copyAsPlainText().

Referenced by CDisplayWindow::initActions().

◆ copyAnchorTextOnly()

void BtModelViewReadDisplay::copyAnchorTextOnly ( )
inline

Definition at line 83 of file btmodelviewreaddisplay.h.

References AnchorTextOnly, and copyAsPlainText().

Referenced by CBibleReadWindow::initActions().

◆ copyAnchorWithText()

void BtModelViewReadDisplay::copyAnchorWithText ( )
inline

Definition at line 84 of file btmodelviewreaddisplay.h.

References AnchorWithText, and copyAsPlainText().

Referenced by CBibleReadWindow::initActions().

◆ copyAsPlainText()

void BtModelViewReadDisplay::copyAsPlainText ( TextPart const  part)
private

Definition at line 136 of file btmodelviewreaddisplay.cpp.

References text().

Referenced by copyAll(), copyAnchorOnly(), copyAnchorTextOnly(), and copyAnchorWithText().

◆ copyByReferences()

void BtModelViewReadDisplay::copyByReferences ( )

Copies the given text specified by asking user for first and last references.

Definition at line 151 of file btmodelviewreaddisplay.cpp.

References CSwordModuleInfo::Bible, BT_ASSERT, CSwordModuleInfo::Commentary, m_parentWindow, qmlInterface(), and BtCopyByReferencesDialog::result().

Referenced by CDisplayWindow::initActions().

◆ copySelectedText()

void BtModelViewReadDisplay::copySelectedText ( )

Copies the currently selected text.

Definition at line 148 of file btmodelviewreaddisplay.cpp.

References qmlInterface().

Referenced by CDisplayWindow::initActions().

◆ findText()

void BtModelViewReadDisplay::findText ( bool const  backward)

Definition at line 347 of file btmodelviewreaddisplay.cpp.

References BtQmlInterface::findText(), and m_qmlInterface.

Referenced by CMDIArea::findTextInActiveWindow().

◆ getCurrentNodeInfo()

QString BtModelViewReadDisplay::getCurrentNodeInfo ( ) const
inline

Definition at line 138 of file btmodelviewreaddisplay.h.

References m_nodeInfo.

Referenced by CDisplayWindow::initActions(), and CDisplayWindow::newDisplayWidgetPopupMenu().

◆ hasActiveAnchor()

bool BtModelViewReadDisplay::hasActiveAnchor ( ) const
inline
Returns
whether the display has an active anchor.

Definition at line 163 of file btmodelviewreaddisplay.h.

References m_activeAnchor.

Referenced by CDisplayWindow::newDisplayWidgetPopupMenu(), and print().

◆ highlightText()

void BtModelViewReadDisplay::highlightText ( const QString &  text,
bool  caseSensitive 
)

Definition at line 343 of file btmodelviewreaddisplay.cpp.

References m_qmlInterface, BtQmlInterface::setHighlightWords(), and text().

Referenced by CMDIArea::highlightTextInActiveWindow().

◆ installPopup()

void BtModelViewReadDisplay::installPopup ( QMenu *const  popup)
inline

Installs the popup which should be opened when the right mouse button was pressed.

Definition at line 119 of file btmodelviewreaddisplay.h.

References m_popup.

Referenced by CDisplayWindow::init().

◆ pageDown()

void BtModelViewReadDisplay::pageDown ( )

Definition at line 339 of file btmodelviewreaddisplay.cpp.

References m_quickWidget, and BtQuickWidget::pageDown().

Referenced by CDisplayWindow::initActions().

◆ pageUp()

void BtModelViewReadDisplay::pageUp ( )

Definition at line 341 of file btmodelviewreaddisplay.cpp.

References m_quickWidget, and BtQuickWidget::pageUp().

Referenced by CDisplayWindow::initActions().

◆ print()

void BtModelViewReadDisplay::print ( TextPart const  type,
DisplayOptions const &  displayOptions,
FilterOptions const &  filterOptions 
)

Definition at line 184 of file btmodelviewreaddisplay.cpp.

References AnchorWithText, CSwordModuleInfo::Bible, CSwordVerseKey::bookName(), CSwordVerseKey::chapter(), CSwordModuleInfo::Commentary, CDisplayWindow::displayOptions(), Document, CDisplayWindow::filterOptions(), CSwordModuleInfo::GenericBook, hasActiveAnchor(), CDisplayWindow::key(), CSwordKey::key(), CSwordTreeKey::key(), CSwordVerseKey::key(), CSwordModuleInfo::Lexicon, m_activeAnchor, m_parentWindow, CSwordKey::module(), CExportManager::printByHyperlink(), CExportManager::printKey(), CSwordVerseKey::setVerse(), and CSwordModuleInfo::type().

Referenced by printAll(), and printAnchorWithText().

◆ printAll()

void BtModelViewReadDisplay::printAll ( DisplayOptions const &  displayOptions,
FilterOptions const &  filterOptions 
)
inline

Definition at line 107 of file btmodelviewreaddisplay.h.

References Document, and print().

Referenced by CDisplayWindow::printAll().

◆ printAnchorWithText()

void BtModelViewReadDisplay::printAnchorWithText ( DisplayOptions const &  displayOptions,
FilterOptions const &  filterOptions 
)
inline

Definition at line 111 of file btmodelviewreaddisplay.h.

References AnchorWithText, and print().

Referenced by CDisplayWindow::printAnchorWithText().

◆ qmlInterface()

BtQmlInterface* BtModelViewReadDisplay::qmlInterface ( ) const
inlinenoexcept

Definition at line 160 of file btmodelviewreaddisplay.h.

References m_qmlInterface.

Referenced by copyByReferences(), copySelectedText(), CDisplayWindow::hasSelectedText(), and reloadModules().

◆ quickWidget()

BtQuickWidget* BtModelViewReadDisplay::quickWidget ( ) const
inlinenoexcept

Definition at line 158 of file btmodelviewreaddisplay.h.

References m_quickWidget.

Referenced by CDisplayWindow::getMouseClickedKey().

◆ reloadModules()

void BtModelViewReadDisplay::reloadModules ( )

Definition at line 246 of file btmodelviewreaddisplay.cpp.

References qmlInterface(), and BtQmlInterface::textModel.

Referenced by CDisplayWindow::reload().

◆ save()

void BtModelViewReadDisplay::save ( TextPart const  part)

Saves the given text with the specified format into the applications clipboard.

Definition at line 172 of file btmodelviewreaddisplay.cpp.

References util::tool::savePlainFile(), and text().

Referenced by saveAnchorWithText().

◆ saveAnchorWithText()

void BtModelViewReadDisplay::saveAnchorWithText ( )
inline

Definition at line 85 of file btmodelviewreaddisplay.h.

References AnchorWithText, and save().

Referenced by CBibleReadWindow::initActions().

◆ scroll()

void BtModelViewReadDisplay::scroll ( int  pixels)

Definition at line 325 of file btmodelviewreaddisplay.cpp.

References m_quickWidget, and BtQuickWidget::scroll().

◆ scrollToKey()

void BtModelViewReadDisplay::scrollToKey ( CSwordKey *  key)

Definition at line 321 of file btmodelviewreaddisplay.cpp.

References m_qmlInterface, and BtQmlInterface::scrollToSwordKey().

Referenced by CDisplayWindow::lookupSwordKey().

◆ setBibleReference

void BtModelViewReadDisplay::setBibleReference ( const QString &  reference)
privateslot

Definition at line 115 of file btmodelviewreaddisplay.cpp.

References m_parentWindow, and CDisplayWindow::setBibleReference().

Referenced by BtModelViewReadDisplay().

◆ setDisplayFocus()

void BtModelViewReadDisplay::setDisplayFocus ( )

Definition at line 311 of file btmodelviewreaddisplay.cpp.

References m_quickWidget.

◆ setDisplayOptions()

void BtModelViewReadDisplay::setDisplayOptions ( const DisplayOptions &  displayOptions)

Definition at line 313 of file btmodelviewreaddisplay.cpp.

References m_qmlInterface, and BtQmlInterface::textModel.

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

◆ setFilterOptions()

void BtModelViewReadDisplay::setFilterOptions ( FilterOptions  filterOptions)

Definition at line 327 of file btmodelviewreaddisplay.cpp.

References m_qmlInterface, and BtQmlInterface::setFilterOptions().

Referenced by CDisplayWindow::lookupSwordKey().

◆ setLemma()

void BtModelViewReadDisplay::setLemma ( const QString &  lemma)

Definition at line 351 of file btmodelviewreaddisplay.cpp.

References m_nodeInfo.

Referenced by contextMenuEvent().

◆ setModules()

void BtModelViewReadDisplay::setModules ( QStringList const &  modules)

Definition at line 317 of file btmodelviewreaddisplay.cpp.

References m_qmlInterface, and BtQmlInterface::setModules().

Referenced by CDisplayWindow::CDisplayWindow(), CDisplayWindow::slotAddModule(), CDisplayWindow::slotRemoveModule(), and CDisplayWindow::slotReplaceModule().

◆ settingsChanged()

void BtModelViewReadDisplay::settingsChanged ( )

Definition at line 331 of file btmodelviewreaddisplay.cpp.

References m_qmlInterface, and BtQmlInterface::settingsChanged().

Referenced by CDisplayWindow::reload().

◆ slotSliderMoved

void BtModelViewReadDisplay::slotSliderMoved ( int  value)
privateslot

Definition at line 119 of file btmodelviewreaddisplay.cpp.

References BibleTime::autoScrollStop(), BibleTime::instance(), m_quickWidget, m_scrollBarPosition, and BtQuickWidget::scroll().

Referenced by BtModelViewReadDisplay().

◆ slotSliderPressed

void BtModelViewReadDisplay::slotSliderPressed ( )
privateslot

Definition at line 127 of file btmodelviewreaddisplay.cpp.

References m_scrollBar, and m_scrollBarPosition.

Referenced by BtModelViewReadDisplay().

◆ slotSliderReleased

void BtModelViewReadDisplay::slotSliderReleased ( )
privateslot

Definition at line 131 of file btmodelviewreaddisplay.cpp.

References m_quickWidget, m_scrollBar, and BtQuickWidget::updateReferenceText().

Referenced by BtModelViewReadDisplay().

◆ text()

QString BtModelViewReadDisplay::text ( TextPart const  part = Document)
Parameters
[in]formatThe format to use for the text.
[in]partThe part of the text to return.
Returns
the right text part in the specified format.

Definition at line 251 of file btmodelviewreaddisplay.cpp.

References AnchorOnly, AnchorTextOnly, AnchorWithText, BT_ASSERT, CSwordModuleInfo::Commentary, ReferenceManager::decodeHyperlink(), Document, CSwordModuleInfo::GenericBook, CSwordBackend::instance(), CDisplayWindow::key(), CSwordKey::key(), CSwordModuleInfo::Lexicon, m_activeAnchor, m_parentWindow, CSwordKey::module(), CSwordModuleInfo::name(), CSwordBackend::setFilterOptions(), CSwordKey::strippedText(), and CSwordModuleInfo::type().

Referenced by copyAsPlainText(), highlightText(), and save().

◆ updateReferenceText()

void BtModelViewReadDisplay::updateReferenceText ( )

Definition at line 335 of file btmodelviewreaddisplay.cpp.

References m_quickWidget, and BtQuickWidget::updateReferenceText().

Member Data Documentation

◆ m_activeAnchor

QString BtModelViewReadDisplay::m_activeAnchor
private

Definition at line 181 of file btmodelviewreaddisplay.h.

Referenced by contextMenuEvent(), hasActiveAnchor(), print(), and text().

◆ m_nodeInfo

QString BtModelViewReadDisplay::m_nodeInfo
private

Definition at line 183 of file btmodelviewreaddisplay.h.

Referenced by getCurrentNodeInfo(), and setLemma().

◆ m_parentWindow

CDisplayWindow* BtModelViewReadDisplay::m_parentWindow
private

Definition at line 179 of file btmodelviewreaddisplay.h.

Referenced by BtModelViewReadDisplay(), copyByReferences(), print(), setBibleReference(), and text().

◆ m_popup

QMenu* BtModelViewReadDisplay::m_popup = nullptr
private

Definition at line 180 of file btmodelviewreaddisplay.h.

Referenced by contextMenuEvent(), and installPopup().

◆ m_qmlInterface

BtQmlInterface* const BtModelViewReadDisplay::m_qmlInterface
private

Definition at line 186 of file btmodelviewreaddisplay.h.

Referenced by BtModelViewReadDisplay(), contextMenuEvent(), findText(), highlightText(), qmlInterface(), scrollToKey(), setDisplayOptions(), setFilterOptions(), setModules(), and settingsChanged().

◆ m_quickWidget

BtQuickWidget* const BtModelViewReadDisplay::m_quickWidget
private

Definition at line 185 of file btmodelviewreaddisplay.h.

Referenced by BtModelViewReadDisplay(), pageDown(), pageUp(), quickWidget(), scroll(), setDisplayFocus(), slotSliderMoved(), slotSliderReleased(), and updateReferenceText().

◆ m_scrollBar

QScrollBar* const BtModelViewReadDisplay::m_scrollBar
private

Definition at line 187 of file btmodelviewreaddisplay.h.

Referenced by BtModelViewReadDisplay(), slotSliderPressed(), and slotSliderReleased().

◆ m_scrollBarPosition

int BtModelViewReadDisplay::m_scrollBarPosition = 0
private

Definition at line 188 of file btmodelviewreaddisplay.h.

Referenced by slotSliderMoved(), and slotSliderPressed().

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