BtBookshelfTreeModel Class Reference

#include <btbookshelftreemodel.h>

Inheritance diagram for BtBookshelfTreeModel:

Classes
class	Grouping

Public Types
enum	CheckedBehavior { CHECKED , UNCHECKED , MODULE_HIDDEN , MODULE_INDEXED }
enum	Group : int { GROUP_CATEGORY = 0 , GROUP_LANGUAGE = 1 , GROUP_INDEXING }
enum	ModuleRole { CheckStateRole = BtBookshelfModel::UserRole , UserRole = BtBookshelfModel::UserRole + 100 }

Public Slots
void	setCheckable (bool checkable)
void	setCheckedModules (BtConstModuleSet const &modules)
void	setDefaultChecked (CheckedBehavior const b)
void	setGroupingOrder (BtBookshelfTreeModel::Grouping const &groupingOrder, bool emitSignal=true)
void	setSourceModel (std::shared_ptr< QAbstractItemModel > sourceModel)

Signals
void	groupingOrderChanged (BtBookshelfTreeModel::Grouping newGrouping)
void	moduleChecked (CSwordModuleInfo *module, bool checked)

Public Member Functions
	BtBookshelfTreeModel (BtConfigCore const &config, QString const &configKey, QObject *const parent=nullptr)
	BtBookshelfTreeModel (Grouping const &grouping, QObject *parent=nullptr)
	BtBookshelfTreeModel (QObject *parent=nullptr)
bool	checkable () const
BtModuleSet const &	checkedModules () const
int	columnCount (QModelIndex const &parent=QModelIndex()) const override
QVariant	data (CSwordModuleInfo &module, int role=Qt::DisplayRole) const
QVariant	data (QModelIndex const &index, int role=Qt::DisplayRole) const override
CheckedBehavior	defaultChecked () const
Qt::ItemFlags	flags (QModelIndex const &index) const override
Grouping const &	groupingOrder () const
bool	hasChildren (QModelIndex const &parent=QModelIndex()) const override
QVariant	headerData (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const override
QModelIndex	index (int row, int column, QModelIndex const &parent=QModelIndex()) const override
CSwordModuleInfo *	module (QModelIndex const &index) const
QList< CSwordModuleInfo * >	modules () const
QModelIndex	parent (QModelIndex const &index) const override
int	rowCount (QModelIndex const &parent=QModelIndex()) const override
bool	setData (QModelIndex const &index, QVariant const &value, int role) override
std::shared_ptr< QAbstractItemModel >	sourceModel () const noexcept
	~BtBookshelfTreeModel () override

Protected Slots
void	moduleDataChanged (QModelIndex const &topLeft, QModelIndex const &bottomRight)
void	moduleInserted (QModelIndex const &parent, int start, int end)
void	moduleRemoved (QModelIndex const &parent, int start, int end)

Protected Member Functions
void	resetData ()

Private Types
using	ModuleItemMap = QMap< CSwordModuleInfo *, BookshelfModel::ModuleItem * >
using	SourceIndexMap = QMap< CSwordModuleInfo *, QPersistentModelIndex >

Private Member Functions
void	addModule (CSwordModuleInfo &module, bool checked, bool inReset)
template<class T >
QModelIndex	getGroup (CSwordModuleInfo const &module, QModelIndex const parentIndex, bool &beginInsert)
QModelIndex	getIndex (BookshelfModel::Item const &item)
BookshelfModel::Item &	getItem (QModelIndex const &index) const
void	removeModule (CSwordModuleInfo &module)
void	resetParentCheckStates (QModelIndex parentIndex, bool inReset)

Private Attributes
bool	m_checkable
BtModuleSet	m_checkedModulesCache
CheckedBehavior	m_defaultChecked
Grouping	m_groupingOrder
ModuleItemMap	m_modules
std::unique_ptr< BookshelfModel::Item >	m_rootItem
SourceIndexMap	m_sourceIndexMap
std::shared_ptr< QAbstractItemModel >	m_sourceModel

Detailed Description

Definition at line 37 of file btbookshelftreemodel.h.

Member Typedef Documentation

ModuleItemMap

using BtBookshelfTreeModel::ModuleItemMap = QMap<CSwordModuleInfo *, BookshelfModel::ModuleItem *>

private

Definition at line 44 of file btbookshelftreemodel.h.

SourceIndexMap

using BtBookshelfTreeModel::SourceIndexMap = QMap<CSwordModuleInfo *, QPersistentModelIndex>

private

Definition at line 45 of file btbookshelftreemodel.h.

Member Enumeration Documentation

CheckedBehavior

enum BtBookshelfTreeModel::CheckedBehavior

Enumerator
CHECKED	Check all added modules by default.
UNCHECKED	Uncheck all added modules by default.
MODULE_HIDDEN	By default, check only added modules that are not hidden.
MODULE_INDEXED	By default, check only added modules that are indexed.

Definition at line 60 of file btbookshelftreemodel.h.

Group

enum BtBookshelfTreeModel::Group : int

Enumerator
GROUP_CATEGORY
GROUP_LANGUAGE
GROUP_INDEXING

Definition at line 54 of file btbookshelftreemodel.h.

ModuleRole

enum BtBookshelfTreeModel::ModuleRole

Enumerator
CheckStateRole
UserRole

Definition at line 49 of file btbookshelftreemodel.h.

Constructor & Destructor Documentation

BtBookshelfTreeModel() [1/3]

BtBookshelfTreeModel::BtBookshelfTreeModel

(

QObject *

parent = nullptr

)

Definition at line 68 of file btbookshelftreemodel.cpp.

BtBookshelfTreeModel() [2/3]

BtBookshelfTreeModel::BtBookshelfTreeModel	(	BtConfigCore const &	config,
		QString const &	configKey,
		QObject *const	parent = nullptr
	)

Definition at line 74 of file btbookshelftreemodel.cpp.

References BtBookshelfTreeModel::Grouping::DEFAULT, and BtBookshelfTreeModel::Grouping::loadFrom().

BtBookshelfTreeModel() [3/3]

BtBookshelfTreeModel::BtBookshelfTreeModel	(	Grouping const &	grouping,
		QObject *	parent = nullptr
	)

Definition at line 89 of file btbookshelftreemodel.cpp.

~BtBookshelfTreeModel()

BtBookshelfTreeModel::~BtBookshelfTreeModel ( )

overridedefault

Member Function Documentation

addModule()

void BtBookshelfTreeModel::addModule ( CSwordModuleInfo &  module, bool  checked, bool  inReset  )

private

Definition at line 392 of file btbookshelftreemodel.cpp.

References getGroup(), getItem(), GROUP_CATEGORY, GROUP_INDEXING, GROUP_LANGUAGE, BtBookshelfTreeModel::Grouping::list(), m_checkedModulesCache, m_groupingOrder, m_modules, module(), and resetParentCheckStates().

Referenced by moduleInserted(), setGroupingOrder(), and setSourceModel().

checkable()

bool BtBookshelfTreeModel::checkable ( ) const

inline

Definition at line 144 of file btbookshelftreemodel.h.

References m_checkable.

Referenced by setCheckable().

checkedModules()

BtModuleSet const & BtBookshelfTreeModel::checkedModules ( ) const

inline

Definition at line 147 of file btbookshelftreemodel.h.

References m_checkedModulesCache.

Referenced by BtBookshelfWorksPage::checkedModules(), and BtSearchModuleChooserDialog::checkedModules().

columnCount()

int BtBookshelfTreeModel::columnCount ( QModelIndex const &  parent = QModelIndex() ) const

override

Definition at line 103 of file btbookshelftreemodel.cpp.

References parent().

Referenced by resetData().

data() [1/2]

QVariant BtBookshelfTreeModel::data	(	CSwordModuleInfo &	module,
		int	role = Qt::DisplayRole
	)		const

Definition at line 180 of file btbookshelftreemodel.cpp.

References BT_ASSERT, m_sourceIndexMap, m_sourceModel, and module().

data() [2/2]

QVariant BtBookshelfTreeModel::data ( QModelIndex const &  index, int  role = Qt::DisplayRole  ) const

override

Definition at line 142 of file btbookshelftreemodel.cpp.

References BT_ASSERT, BookshelfModel::Item::checkState(), CheckStateRole, BookshelfModel::Item::data(), data(), index(), BookshelfModel::Item::ITEM_MODULE, m_checkable, BtBookshelfModel::ModuleHiddenRole, BookshelfModel::ModuleItem::moduleInfo(), BtBookshelfModel::ModulePointerRole, and BookshelfModel::Item::type().

Referenced by BookshelfModel::ModuleItem::data(), BtInstallPageModel::data(), data(), module(), moduleDataChanged(), moduleInserted(), and moduleRemoved().

defaultChecked()

CheckedBehavior BtBookshelfTreeModel::defaultChecked ( ) const

inline

Definition at line 145 of file btbookshelftreemodel.h.

References m_defaultChecked.

flags()

Qt::ItemFlags BtBookshelfTreeModel::flags ( QModelIndex const &  index ) const

override

Definition at line 243 of file btbookshelftreemodel.cpp.

References index(), BookshelfModel::Item::ITEM_MODULE, m_checkable, and BookshelfModel::Item::type().

getGroup()

template<class T >

QModelIndex BtBookshelfTreeModel::getGroup ( CSwordModuleInfo const &  module, QModelIndex const  parentIndex, bool &  beginInsert  )

inlineprivate

Definition at line 186 of file btbookshelftreemodel.h.

References getGroup(), getItem(), index(), module(), and T.

Referenced by addModule(), BtInstallPageModel::columnCount(), BtInstallPageModel::data(), getGroup(), getIndex(), BtInstallPageModel::headerData(), moduleDataChanged(), moduleInserted(), moduleRemoved(), removeModule(), resetParentCheckStates(), and setDefaultChecked().

getIndex()

QModelIndex BtBookshelfTreeModel::getIndex ( BookshelfModel::Item const &  item )

private

Definition at line 483 of file btbookshelftreemodel.cpp.

References BookshelfModel::Item::childIndex(), getGroup(), and index().

Referenced by moduleDataChanged(), removeModule(), and setCheckedModules().

getItem()

Item & BtBookshelfTreeModel::getItem ( QModelIndex const &  index ) const

private

Definition at line 474 of file btbookshelftreemodel.cpp.

References BT_ASSERT, index(), m_rootItem, and UNLIKELY.

Referenced by addModule(), getGroup(), hasChildren(), index(), and rowCount().

groupingOrder()

Grouping const & BtBookshelfTreeModel::groupingOrder ( ) const

inline

Definition at line 143 of file btbookshelftreemodel.h.

References m_groupingOrder.

Referenced by BtBookshelfDockWidget::groupingOrder(), BtOpenWorkActionMenu::postBuildMenu(), setGroupingOrder(), and BtBookshelfWidget::setTreeModel().

groupingOrderChanged

void BtBookshelfTreeModel::groupingOrderChanged ( BtBookshelfTreeModel::Grouping  newGrouping )

signal

Referenced by BtBookshelfWorksPage::BtBookshelfWorksPage(), BtSearchModuleChooserDialog::BtSearchModuleChooserDialog(), setGroupingOrder(), and BtBookshelfWidget::setTreeModel().

hasChildren()

bool BtBookshelfTreeModel::hasChildren ( QModelIndex const &  parent = QModelIndex() ) const

override

Definition at line 109 of file btbookshelftreemodel.cpp.

References BookshelfModel::Item::children(), getItem(), and parent().

headerData()

QVariant BtBookshelfTreeModel::headerData ( int  section, Qt::Orientation  orientation, int  role = Qt::DisplayRole  ) const

override

Definition at line 260 of file btbookshelftreemodel.cpp.

References m_sourceModel.

index()

QModelIndex BtBookshelfTreeModel::index ( int  row, int  column, QModelIndex const &  parent = QModelIndex()  ) const

override

Definition at line 113 of file btbookshelftreemodel.cpp.

References BookshelfModel::Item::children(), getItem(), and parent().

Referenced by BtInstallPageModel::data(), data(), anonymous_namespace{btmodulechoosermenu.cpp}::SortModel::filterAcceptsRowNoHiddenCheck(), flags(), getGroup(), getIndex(), getItem(), module(), parent(), removeModule(), resetData(), and setData().

module()

CSwordModuleInfo * BtBookshelfTreeModel::module ( QModelIndex const &  index ) const

inline

Definition at line 135 of file btbookshelftreemodel.h.

References data(), index(), and BtBookshelfModel::ModulePointerRole.

Referenced by addModule(), data(), BtInstallPageModel::data(), getGroup(), moduleDataChanged(), moduleInserted(), moduleRemoved(), removeModule(), setGroupingOrder(), and setSourceModel().

moduleChecked

void BtBookshelfTreeModel::moduleChecked ( CSwordModuleInfo *  module, bool  checked  )

signal

Referenced by BtBookshelfWorksPage::BtBookshelfWorksPage(), and setData().

moduleDataChanged

void BtBookshelfTreeModel::moduleDataChanged ( QModelIndex const &  topLeft, QModelIndex const &  bottomRight  )

protectedslot

Definition at line 547 of file btbookshelftreemodel.cpp.

References BT_ASSERT, data(), getGroup(), getIndex(), m_modules, m_sourceModel, module(), and BtBookshelfModel::ModulePointerRole.

Referenced by setSourceModel().

moduleInserted

void BtBookshelfTreeModel::moduleInserted ( QModelIndex const &  parent, int  start, int  end  )

protectedslot

Definition at line 576 of file btbookshelftreemodel.cpp.

References addModule(), BT_ASSERT, CHECKED, data(), getGroup(), m_defaultChecked, m_sourceIndexMap, m_sourceModel, module(), MODULE_HIDDEN, MODULE_INDEXED, BtBookshelfModel::ModuleHasIndexRole, BtBookshelfModel::ModuleHiddenRole, BtBookshelfModel::ModulePointerRole, parent(), and UNCHECKED.

Referenced by setSourceModel().

moduleRemoved

void BtBookshelfTreeModel::moduleRemoved ( QModelIndex const &  parent, int  start, int  end  )

protectedslot

Definition at line 604 of file btbookshelftreemodel.cpp.

References BT_ASSERT, data(), getGroup(), m_sourceIndexMap, m_sourceModel, module(), BtBookshelfModel::ModulePointerRole, parent(), and removeModule().

Referenced by setSourceModel().

modules()

QList< CSwordModuleInfo * > BtBookshelfTreeModel::modules ( ) const

inline

Definition at line 146 of file btbookshelftreemodel.h.

References m_modules.

Referenced by setCheckedModules().

parent()

QModelIndex BtBookshelfTreeModel::parent ( QModelIndex const &  index ) const

override

Definition at line 126 of file btbookshelftreemodel.cpp.

References BT_ASSERT, BookshelfModel::Item::childIndex(), index(), m_rootItem, and BookshelfModel::Item::parent().

Referenced by BtInstallPageModel::columnCount(), columnCount(), hasChildren(), index(), moduleInserted(), moduleRemoved(), resetData(), and rowCount().

removeModule()

void BtBookshelfTreeModel::removeModule ( CSwordModuleInfo &  module )

private

Definition at line 444 of file btbookshelftreemodel.cpp.

References BT_ASSERT, getGroup(), getIndex(), index(), m_checkedModulesCache, m_modules, m_rootItem, module(), and resetParentCheckStates().

Referenced by moduleRemoved().

resetData()

void BtBookshelfTreeModel::resetData ( )

protected

Definition at line 377 of file btbookshelftreemodel.cpp.

References columnCount(), index(), parent(), and rowCount().

Referenced by setCheckable().

resetParentCheckStates()

void BtBookshelfTreeModel::resetParentCheckStates ( QModelIndex  parentIndex, bool  inReset  )

private

Definition at line 500 of file btbookshelftreemodel.cpp.

References BT_ASSERT, BookshelfModel::Item::checkState(), and getGroup().

Referenced by addModule(), removeModule(), and setData().

rowCount()

int BtBookshelfTreeModel::rowCount ( QModelIndex const &  parent = QModelIndex() ) const

override

Definition at line 99 of file btbookshelftreemodel.cpp.

References BookshelfModel::Item::children(), getItem(), and parent().

Referenced by resetData().

setCheckable

void BtBookshelfTreeModel::setCheckable ( bool  checkable )

slot

Definition at line 356 of file btbookshelftreemodel.cpp.

References checkable(), m_checkable, m_sourceModel, and resetData().

Referenced by BtInstallPageModel::BtInstallPageModel().

setCheckedModules

void BtBookshelfTreeModel::setCheckedModules ( BtConstModuleSet const &  modules )

slot

Definition at line 367 of file btbookshelftreemodel.cpp.

References getIndex(), m_modules, modules(), and setData().

Referenced by BtSearchModuleChooserDialog::setCheckedModules().

setData()

bool BtBookshelfTreeModel::setData ( QModelIndex const &  index, QVariant const &  value, int  role  )

override

Definition at line 185 of file btbookshelftreemodel.cpp.

References BT_ASSERT, BookshelfModel::Item::checkState(), BookshelfModel::Item::children(), index(), BookshelfModel::Item::ITEM_MODULE, m_checkedModulesCache, moduleChecked(), BookshelfModel::ModuleItem::moduleInfo(), resetParentCheckStates(), BookshelfModel::Item::setCheckState(), BookshelfModel::Item::type(), and UNLIKELY.

Referenced by setCheckedModules().

setDefaultChecked

void BtBookshelfTreeModel::setDefaultChecked ( CheckedBehavior const  b )

inlineslot

Definition at line 157 of file btbookshelftreemodel.h.

References getGroup(), and m_defaultChecked.

Referenced by BtBookshelfWorksPage::BtBookshelfWorksPage(), and BtInstallPageModel::BtInstallPageModel().

setGroupingOrder

void BtBookshelfTreeModel::setGroupingOrder ( BtBookshelfTreeModel::Grouping const &  groupingOrder, bool  emitSignal = true  )

slot

Definition at line 325 of file btbookshelftreemodel.cpp.

References addModule(), BtModuleSet::contains(), groupingOrder(), groupingOrderChanged(), m_checkedModulesCache, m_groupingOrder, m_modules, m_rootItem, m_sourceIndexMap, m_sourceModel, and module().

Referenced by BtBookshelfWidget::initMenus(), BtOpenWorkActionMenu::postBuildMenu(), and BtBookshelfWorksPage::slotGroupingActionTriggered().

setSourceModel

void BtBookshelfTreeModel::setSourceModel ( std::shared_ptr< QAbstractItemModel >  sourceModel )

slot

Definition at line 270 of file btbookshelftreemodel.cpp.

References addModule(), BT_CONNECT, CHECKED, m_checkedModulesCache, m_defaultChecked, m_modules, m_rootItem, m_sourceIndexMap, m_sourceModel, module(), MODULE_HIDDEN, MODULE_INDEXED, moduleDataChanged(), BtBookshelfModel::ModuleHasIndexRole, BtBookshelfModel::ModuleHiddenRole, moduleInserted(), moduleRemoved(), and sourceModel().

Referenced by BtBookshelfWorksPage::BtBookshelfWorksPage(), BtBookshelfWidget::setSourceModel(), BtOpenWorkActionMenu::setSourceModel(), and BtBookshelfWidget::setTreeModel().

sourceModel()

std::shared_ptr< QAbstractItemModel > BtBookshelfTreeModel::sourceModel ( ) const

inlinenoexcept

Definition at line 140 of file btbookshelftreemodel.h.

References m_sourceModel.

Referenced by setSourceModel(), and BtOpenWorkActionMenu::sourceModel().

Member Data Documentation

m_checkable

bool BtBookshelfTreeModel::m_checkable

private

Definition at line 214 of file btbookshelftreemodel.h.

Referenced by checkable(), data(), flags(), and setCheckable().

m_checkedModulesCache

BtModuleSet BtBookshelfTreeModel::m_checkedModulesCache

private

Definition at line 216 of file btbookshelftreemodel.h.

Referenced by addModule(), checkedModules(), removeModule(), setData(), setGroupingOrder(), and setSourceModel().

m_defaultChecked

CheckedBehavior BtBookshelfTreeModel::m_defaultChecked

private

Definition at line 213 of file btbookshelftreemodel.h.

Referenced by defaultChecked(), moduleInserted(), setDefaultChecked(), and setSourceModel().

m_groupingOrder

Grouping BtBookshelfTreeModel::m_groupingOrder

private

Definition at line 212 of file btbookshelftreemodel.h.

Referenced by addModule(), groupingOrder(), and setGroupingOrder().

m_modules

ModuleItemMap BtBookshelfTreeModel::m_modules

private

Definition at line 210 of file btbookshelftreemodel.h.

Referenced by addModule(), moduleDataChanged(), modules(), removeModule(), setCheckedModules(), setGroupingOrder(), and setSourceModel().

m_rootItem

std::unique_ptr<BookshelfModel::Item> BtBookshelfTreeModel::m_rootItem

private

Definition at line 209 of file btbookshelftreemodel.h.

Referenced by getItem(), parent(), removeModule(), setGroupingOrder(), and setSourceModel().

m_sourceIndexMap

SourceIndexMap BtBookshelfTreeModel::m_sourceIndexMap

private

Definition at line 211 of file btbookshelftreemodel.h.

Referenced by data(), moduleInserted(), moduleRemoved(), setGroupingOrder(), and setSourceModel().

m_sourceModel

std::shared_ptr<QAbstractItemModel> BtBookshelfTreeModel::m_sourceModel

private

Definition at line 208 of file btbookshelftreemodel.h.

Referenced by data(), headerData(), moduleDataChanged(), moduleInserted(), moduleRemoved(), setCheckable(), setGroupingOrder(), setSourceModel(), and sourceModel().

---

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

• btbookshelftreemodel.h
• btbookshelftreemodel.cpp