CSwordKey implementation for Sword's TreeKey. More...

#include <cswordtreekey.h>

Inheritance diagram for CSwordTreeKey:

Public Types
using	Offset = decltype(std::declval< sword::TreeKeyIdx const & >().getOffset())

Public Types inherited from CSwordKey
enum	TextRenderType { Normal , ProcessEntryAttributesOnly }

Public Member Functions
sword::TreeKeyIdx const &	asSwordKey () const noexcept final override

CSwordTreeKey *	copy () const final override

	CSwordTreeKey (const CSwordTreeKey &k)

	CSwordTreeKey (const sword::TreeKeyIdx k, const CSwordModuleInfo module)

QString	getLocalNameUnicode ()

bool	hasChildren ()

QString	key () const final override

Offset	offset () const

CSwordTreeKey &	operator= (CSwordTreeKey const &)=delete

bool	positionToFirstChild ()

bool	positionToNextSibling ()

bool	positionToParent ()

void	positionToRoot ()

bool	setKey (const char *key) final override

bool	setKey (const QString &key) final override

void	setModule (const CSwordModuleInfo *newModule) final override

void	setOffset (Offset value)

Public Member Functions inherited from CSwordKey
bool	isValid () const

CSwordModuleInfo const *	module () const

virtual QString	normalizedKey () const

CSwordKey &	operator= (CSwordKey const &)=delete

QString	rawText ()

QString	renderedText (const CSwordKey::TextRenderType mode=CSwordKey::Normal)

QString	strippedText ()

virtual	~CSwordKey () noexcept

Protected Member Functions
const char *	rawKey () const final override

Protected Member Functions inherited from CSwordKey
	CSwordKey (CSwordKey const &copy)=default

	CSwordKey (CSwordModuleInfo const *const module=nullptr)

Private Attributes
sword::TreeKeyIdx	m_key

Friends
auto	operator<=> (CSwordTreeKey const &lhs, CSwordTreeKey const &rhs)

auto	operator== (CSwordTreeKey const &lhs, CSwordTreeKey const &rhs)

Additional Inherited Members
Protected Attributes inherited from CSwordKey
const CSwordModuleInfo *	m_module

bool	m_valid = true

Detailed Description

CSwordKey implementation for Sword's TreeKey.

BibleTime's implementation of Sword's TreeKeyIdx class.

Author: The BibleTime team

Definition at line 43 of file cswordtreekey.h.

Member Typedef Documentation

◆ Offset

using CSwordTreeKey::Offset = decltype(std::declval<sword::TreeKeyIdx const &>().getOffset())

Definition at line 47 of file cswordtreekey.h.

Constructor & Destructor Documentation

◆ CSwordTreeKey() [1/2]

CSwordTreeKey::CSwordTreeKey	(	const sword::TreeKeyIdx *	k,
		const CSwordModuleInfo *	module
	)

Parameters

k	The Sword tree key which belongs to this key
module	The module which belongs to this key

Definition at line 31 of file cswordtreekey.cpp.

◆ CSwordTreeKey() [2/2]

CSwordTreeKey::CSwordTreeKey ( const CSwordTreeKey & k )

Definition at line 26 of file cswordtreekey.cpp.

Member Function Documentation

◆ asSwordKey()

sword::TreeKeyIdx const & CSwordTreeKey::asSwordKey ( ) const

finaloverridevirtualnoexcept

Returns: a reference to this object as a sword::SWKey.

Implements CSwordKey.

Definition at line 37 of file cswordtreekey.cpp.

References m_key.

◆ copy()

CSwordTreeKey * CSwordTreeKey::copy ( ) const

finaloverridevirtual

Returns: a clone of this object.

Implements CSwordKey.

Definition at line 40 of file cswordtreekey.cpp.

◆ getLocalNameUnicode()

QString CSwordTreeKey::getLocalNameUnicode ( )

Returns the TreeKeyIdx::getLocalKey value in unicode. Local key is the last part of the tree key, for example "Subsection1" from "/Section1/Subsection1". Use this instead of getLocalKey() to avoid encoding problems.

Definition at line 83 of file cswordtreekey.cpp.

References BT_ASSERT, CSwordModuleInfo::isUnicode(), m_key, CSwordKey::m_module, and util::cp1252::toUnicode().

Referenced by CBookKeyChooser::setKey(), and CBookKeyChooser::setupCombo().

◆ hasChildren()

bool CSwordTreeKey::hasChildren ( )

inline

Definition at line 90 of file cswordtreekey.h.

References hasChildren(), and m_key.

Referenced by hasChildren(), and CBookKeyChooser::setKey().

◆ key()

QString CSwordTreeKey::key ( ) const

finaloverridevirtual

Sets the key of this instance

Implements CSwordKey.

Definition at line 45 of file cswordtreekey.cpp.

References BT_ASSERT, CSwordModuleInfo::isUnicode(), m_key, CSwordKey::m_module, and util::cp1252::toUnicode().

Referenced by BtModelViewReadDisplay::print(), CBookTreeChooser::setKey(), CBookKeyChooser::setKey(), and setModule().

◆ offset()

Offset CSwordTreeKey::offset ( ) const

inline

Definition at line 95 of file cswordtreekey.h.

References m_key.

Referenced by BtQmlInterface::getCurrentModelIndex(), CBookKeyChooser::setKey(), CBookTreeChooser::setModules(), and CBookTreeChooser::setupTree().

◆ operator=()

CSwordTreeKey & CSwordTreeKey::operator= ( CSwordTreeKey const & )

delete

◆ positionToFirstChild()

bool CSwordTreeKey::positionToFirstChild ( )

inline

Definition at line 93 of file cswordtreekey.h.

References m_key.

Referenced by CBookKeyChooser::setKey(), setModule(), and CBookKeyChooser::setupCombo().

◆ positionToNextSibling()

bool CSwordTreeKey::positionToNextSibling ( )

inline

Definition at line 94 of file cswordtreekey.h.

References m_key.

Referenced by CBookKeyChooser::setKey(), and CBookKeyChooser::setupCombo().

◆ positionToParent()

bool CSwordTreeKey::positionToParent ( )

inline

Definition at line 92 of file cswordtreekey.h.

References m_key.

Referenced by CBookKeyChooser::setupCombo().

◆ positionToRoot()

void CSwordTreeKey::positionToRoot ( )

inline

Definition at line 91 of file cswordtreekey.h.

References m_key.

Referenced by BtQmlInterface::getCurrentModelIndex(), setKey(), CBookKeyChooser::setKey(), setModule(), and CBookTreeChooser::setupTree().

◆ rawKey()

const char * CSwordTreeKey::rawKey ( ) const

finaloverrideprotectedvirtual

Returns: the encoded key appropriate for use directly with Sword.

Implements CSwordKey.

Definition at line 56 of file cswordtreekey.cpp.

References m_key.

◆ setKey() [1/2]

bool CSwordTreeKey::setKey ( const char * key )

finaloverridevirtual

Set the key using a utf8-decoded c-string.

Parameters

[in] key The key which should be used to set the current one.

Implements CSwordKey.

Definition at line 70 of file cswordtreekey.cpp.

References BT_ASSERT, m_key, and positionToRoot().

◆ setKey() [2/2]

bool CSwordTreeKey::setKey ( const QString & key )

finaloverridevirtual

Sets the current key using a utf8 enabled QString.

Parameters

[in] key The key which should be used to set the current one.

Implements CSwordKey.

Definition at line 58 of file cswordtreekey.cpp.

References BT_ASSERT, util::cp1252::fromUnicode(), CSwordModuleInfo::isUnicode(), CSwordKey::m_module, and setKey().

Referenced by BtQmlInterface::getCurrentModelIndex(), CBookTreeChooser::itemActivated(), CBookKeyChooser::keyChooserChanged(), setKey(), CBookKeyChooser::setKey(), setModule(), and CBookKeyChooser::setupCombo().

◆ setModule()

void CSwordTreeKey::setModule ( const CSwordModuleInfo * newModule )

finaloverridevirtual

Sets the module which belongs to this key.

Parameters

[in] newModule the module to set.

Reimplemented from CSwordKey.

Definition at line 95 of file cswordtreekey.cpp.

References BT_ASSERT, CSwordModuleInfo::GenericBook, key(), m_key, CSwordKey::m_module, positionToFirstChild(), positionToRoot(), setKey(), and CSwordModuleInfo::type().

◆ setOffset()

void CSwordTreeKey::setOffset ( Offset value )

inline

Definition at line 96 of file cswordtreekey.h.

References m_key.

Referenced by CBookKeyChooser::setKey(), CBookTreeChooser::setModules(), and CBookTreeChooser::setupTree().

Friends And Related Symbol Documentation

◆ operator<=>

auto operator<=>	(	CSwordTreeKey const &	lhs,
		CSwordTreeKey const &	rhs
	)

friend

Definition at line 52 of file cswordtreekey.h.

◆ operator==

auto operator==	(	CSwordTreeKey const &	lhs,
		CSwordTreeKey const &	rhs
	)

friend

Definition at line 57 of file cswordtreekey.h.

Member Data Documentation

◆ m_key

sword::TreeKeyIdx CSwordTreeKey::m_key

private

Definition at line 104 of file cswordtreekey.h.

Referenced by asSwordKey(), getLocalNameUnicode(), hasChildren(), key(), offset(), positionToFirstChild(), positionToNextSibling(), positionToParent(), positionToRoot(), rawKey(), setKey(), setModule(), and setOffset().

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

Public Types

Public Member Functions

Protected Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Offset

Constructor & Destructor Documentation

◆ CSwordTreeKey() [1/2]

◆ CSwordTreeKey() [2/2]

Member Function Documentation

◆ asSwordKey()

◆ copy()

◆ getLocalNameUnicode()

◆ hasChildren()

◆ key()

◆ offset()

◆ operator=()

◆ positionToFirstChild()

◆ positionToNextSibling()

◆ positionToParent()

◆ positionToRoot()

◆ rawKey()

◆ setKey() [1/2]

◆ setKey() [2/2]

◆ setModule()

◆ setOffset()

Friends And Related Symbol Documentation

◆ operator<=>

◆ operator==

Member Data Documentation

◆ m_key