Commentary module implementation. More...

#include <cswordcommentarymoduleinfo.h>

Inheritance diagram for CSwordCommentaryModuleInfo:

Public Member Functions
	CSwordCommentaryModuleInfo (sword::SWModule &module, CSwordBackend &backend)

bool	isWritable () const final override

Public Member Functions inherited from CSwordBibleModuleInfo
unsigned int	bookNumber (const QString &book) const

QStringList const &	books () const

unsigned int	chapterCount (const QString &book) const

unsigned int	chapterCount (const unsigned int book) const

CSwordKey *	createKey () const final override

	CSwordBibleModuleInfo (sword::SWModule &module, CSwordBackend &backend, ModuleType type=Bible)

bool	hasNewTestament () const

bool	hasOldTestament () const

CSwordVerseKey const &	lowerBound () const

CSwordVerseKey const &	upperBound () const

unsigned int	verseCount (const QString &book, const unsigned int chapter) const

unsigned int	verseCount (const unsigned int book, const unsigned int chapter) const

	~CSwordBibleModuleInfo () noexcept override

Public Member Functions inherited from CSwordModuleInfo
QString	aboutText () const

void	buildIndex ()

CSwordModuleInfo::Category	category () const

QString	config (const CSwordModuleInfo::ConfigEntry entry) const

	CSwordModuleInfo (CSwordModuleInfo &&)=delete

	CSwordModuleInfo (CSwordModuleInfo const &)=delete

void	deleteIndex ()

QString	getModuleBaseIndexLocation () const

QString	getModuleStandardIndexLocation () const

QString	getUnlockInfo ()

std::shared_ptr< Language const >	glossaryTargetlanguage () const

bool	has (CSwordModuleInfo::Feature const feature) const noexcept

bool	has (CSwordModuleInfo::FilterOption const &) const

bool	hasIndex () const

bool	hasVersion () const

::qint64	indexSize () const

bool	isEncrypted () const

bool	isHidden () const

bool	isLocked () const

bool	isUnicode () const noexcept

std::shared_ptr< Language const >	language () const

sword::SWVersion	minimumSwordVersion () const

QIcon	moduleIcon () const

QString const &	name () const

CSwordModuleInfo &	operator= (CSwordModuleInfo &&)=delete

CSwordModuleInfo &	operator= (CSwordModuleInfo const &)=delete

CSwordModuleSearch::ModuleResultList	searchIndexed (QString const &searchedText, sword::ListKey const &scope) const

bool	setHidden (bool hide)

virtual bool	snap () const

sword::SWModule &	swordModule () const

CSwordModuleInfo::TextDirection	textDirection () const

char const *	textDirectionAsHtml () const

ModuleType	type () const

bool	unlock (const QString &unlockKey)

bool	unlockKeyIsValid () const

void	write (CSwordKey *key, const QString &newText)

Additional Inherited Members
Public Types inherited from CSwordModuleInfo
enum class	Category { Bibles = 0x01 , Commentaries = 0x02 , Books = 0x04 , Lexicons = 0x08 , Glossaries = 0x10 , DailyDevotionals = 0x20 , MapsAndImages = 0x40 , Questionable = 0x80 }

enum	ConfigEntry { AboutInformation , AbsoluteDataPath , CipherKey , DataPath , Description , ModuleVersion , MinimumSwordVersion , TextDir , DisplayLevel , GlossaryFrom , GlossaryTo , DistributionLicense , DistributionSource , DistributionNotes , TextSource , CopyrightNotes , CopyrightHolder , CopyrightDate , CopyrightContactName , CopyrightContactAddress , CopyrightContactEmail , Markup }

enum	Feature { FeatureStrongsNumbers = 1 , FeatureGreekDef = 1 << 1 , FeatureHebrewDef = 1 << 2 , FeatureGreekParse = 1 << 3 , FeatureHebrewParse = 1 << 4 , FeatureDailyDevotion = 1 << 5 , FeatureGlossary = 1 << 6 , FeatureImages = 1 << 7 , FeatureNoParagraphs = 1 << 8 }

enum	ModuleType { Bible , Commentary , Lexicon , GenericBook }

enum	TextDirection { LeftToRight , RightToLeft }

enum	UnlockErrorCode { noError , wrongUnlockKey , notLocked , noPermission }

Public Slots inherited from CSwordModuleInfo
void	cancelIndexing (std::memory_order const memoryOrder=std::memory_order_relaxed) noexcept

Signals inherited from CSwordModuleInfo
void	hasIndexChanged (bool hasIndex)

void	hiddenChanged (bool hidden)

void	indexingFinished ()

void	indexingProgress (int)

void	unlockedChanged (bool unlocked)

Static Public Member Functions inherited from CSwordModuleInfo
static QIcon const &	categoryIcon (CSwordModuleInfo::Category category)

static QIcon const &	categoryIconAdd (CSwordModuleInfo::Category category)

static QIcon const &	categoryIconAdd (CSwordModuleInfo::ModuleType type)

static QIcon const &	categoryIconLocked (CSwordModuleInfo::Category category)

static QString	categoryName (const CSwordModuleInfo::Category &category)

static void	deleteIndexForModule (const QString &name)

static QString	getGlobalBaseIndexLocation ()

Static Public Attributes inherited from CSwordModuleInfo
static FilterOption const	footnotes

static FilterOption const	greekAccents

static FilterOption const	headings

static FilterOption const	hebrewCantillation

static FilterOption const	hebrewPoints

static FilterOption const	lemmas

static FilterOption const	morphSegmentation

static FilterOption const	morphTags

static FilterOption const	redLetterWords

static FilterOption const	scriptureReferences

static FilterOption const	strongNumbers

static FilterOption const	textualVariants

Protected Member Functions inherited from CSwordModuleInfo
CSwordBackend &	backend () const

	CSwordModuleInfo (sword::SWModule &module, CSwordBackend &backend, ModuleType type)

QString	getFormattedConfigEntry (const QString &name) const

QString	getSimpleConfigEntry (const QString &name) const

bool	hasImportantFilterOption () const

void	setImportantFilterOptions (bool enable)