ModelView::ViewModelBase Class Reference

Base class for all view models to show content of SessionModel in Qt views. More...

Inheritance diagram for ModelView::ViewModelBase:

Collaboration diagram for ModelView::ViewModelBase:

Classes
struct	ViewModelBaseImpl

Public Member Functions
	ViewModelBase (QObject *parent=nullptr)
	~ViewModelBase () override
void	appendRow (ViewItem *parent, std::vector< std::unique_ptr< ViewItem >> items)
	Appends row of items to given parent. More...
void	clearRows (ViewItem *parent)
int	columnCount (const QModelIndex &parent=QModelIndex()) const override
QVariant	data (const QModelIndex &index, int role=Qt::DisplayRole) const override
Qt::ItemFlags	flags (const QModelIndex &index) const override
	Returns the item flags for the given index. More...
QModelIndex	index (int row, int column, const QModelIndex &parent=QModelIndex()) const override
QModelIndex	indexFromItem (const ViewItem *item) const
	Returns the QModelIndex associated with the given item. More...
void	insertRow (ViewItem *parent, int row, std::vector< std::unique_ptr< ViewItem >> items)
	Insert a row of items at index 'row' to given parent. More...
ViewItem *	itemFromIndex (const QModelIndex &index) const
	Returns a pointer to the RefViewItem associated with the given index. More...
QModelIndex	parent (const QModelIndex &child) const override
void	removeRow (ViewItem *parent, int row)
ViewItem *	rootItem () const
	Returns a pointer to invisible root item. More...
int	rowCount (const QModelIndex &parent=QModelIndex()) const override
bool	setData (const QModelIndex &index, const QVariant &value, int role) override

Private Member Functions
void	setRootViewItem (std::unique_ptr< ViewItem > root_item)
	Sets new root item. Previous item will be deleted, model will be reset. More...

Private Attributes
std::unique_ptr< ViewModelBaseImpl >	p_impl

Friends
class	ViewModelController

Detailed Description

Base class for all view models to show content of SessionModel in Qt views.

ViewModelBase is made of ViewItems, where each ViewItem represents some concrete data role of SessionItem. ViewModelBase doesn't have own logic and needs ViewModelController to listen for SessionModel changes.

Definition at line 31 of file viewmodelbase.h.

Constructor & Destructor Documentation

ViewModelBase()

ViewModelBase::ViewModelBase ( QObject *  parent = nullptr )

explicit

Definition at line 32 of file viewmodelbase.cpp.

    : QAbstractItemModel(parent), p_impl(std::make_unique<ViewModelBaseImpl>(this))
{
    beginResetModel();
    setRootViewItem(std::make_unique<RootViewItem>(nullptr));
    endResetModel();
}

References setRootViewItem().

Here is the call graph for this function:

~ViewModelBase()

ViewModelBase::~ViewModelBase ( )

overridedefault

Member Function Documentation

appendRow()

void ViewModelBase::appendRow	(	ViewItem *	parent,
		std::vector< std::unique_ptr< ViewItem >>	items
	)

Appends row of items to given parent.

Definition at line 165 of file viewmodelbase.cpp.

{
    insertRow(parent, parent->rowCount(), std::move(items));
}

References insertRow(), and parent().

Referenced by ModelView::ViewModelController::ViewModelControllerImpl::iterate(), and TEST_F().

Here is the call graph for this function:

clearRows()

void ViewModelBase::clearRows

(

ViewItem *

parent

)

Definition at line 135 of file viewmodelbase.cpp.

{
    if (!p_impl->item_belongs_to_model(parent))
        throw std::runtime_error(
            "Error in ViewModelBase: attempt to use parent from another model");
 
    if (!parent->rowCount())
        return;
 
    beginRemoveRows(indexFromItem(parent), 0, parent->rowCount() - 1);
    parent->clear();
    endRemoveRows();
}

References indexFromItem(), p_impl, and parent().

Referenced by ModelView::ViewModelController::ViewModelControllerImpl::remove_children_of_view(), and TEST_F().

Here is the call graph for this function:

columnCount()

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

override

Definition at line 70 of file viewmodelbase.cpp.

{
    auto parent_item = itemFromIndex(parent);
    return parent_item ? parent_item->columnCount() : rootItem()->columnCount();
}

References ModelView::ViewItem::columnCount(), itemFromIndex(), parent(), and rootItem().

Referenced by index(), and TEST_F().

Here is the call graph for this function:

data()

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

override

Definition at line 76 of file viewmodelbase.cpp.

{
    if (!rootItem())
        return QVariant();
 
    auto item = itemFromIndex(index);
    return item ? item->data(role) : QVariant();
}

References index(), itemFromIndex(), and rootItem().

Referenced by gui2::DataViewModel::canDropMimeData(), gui2::DataViewModel::dropMimeData(), ModelView::ViewModel::headerData(), and TEST_F().

Here is the call graph for this function:

flags()

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

override

Returns the item flags for the given index.

Definition at line 172 of file viewmodelbase.cpp.

{
    Qt::ItemFlags result = QAbstractItemModel::flags(index);
    if (auto item = itemFromIndex(index); item)
        result |= item->flags();
    return result;
}

References index(), and itemFromIndex().

Referenced by gui2::DataViewModel::flags(), and TEST_F().

Here is the call graph for this function:

index()

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

override

Definition at line 42 of file viewmodelbase.cpp.

{
    auto parent_item = itemFromIndex(parent) ? itemFromIndex(parent) : rootItem();
    const bool is_valid_row = row >= 0 && row < rowCount(parent);
    const bool is_valid_column = column >= 0 && column < columnCount(parent);
    return is_valid_row && is_valid_column
               ? createIndex(row, column, parent_item->child(row, column))
               : QModelIndex();
}

References columnCount(), itemFromIndex(), parent(), rootItem(), and rowCount().

Referenced by data(), gui2::DataViewModel::flags(), flags(), itemFromIndex(), ModelView::ViewModel::sessionItemFromIndex(), setData(), TEST_F(), and ModelView::ViewModel::viewItemFromIndex().

Here is the call graph for this function:

indexFromItem()

QModelIndex ViewModelBase::indexFromItem

(

const ViewItem *

item

)

const

Returns the QModelIndex associated with the given item.

Definition at line 117 of file viewmodelbase.cpp.

{
    return item && item->parent()
               ? createIndex(item->row(), item->column(), const_cast<ViewItem*>(item))
               : QModelIndex();
}

References ModelView::ViewItem::column(), ModelView::ViewItem::parent(), and ModelView::ViewItem::row().

Referenced by clearRows(), ModelView::ViewModel::indexOfSessionItem(), insertRow(), ModelView::ViewModelBase::ViewModelBaseImpl::item_belongs_to_model(), removeRow(), and TEST_F().

Here is the call graph for this function:

insertRow()

void ViewModelBase::insertRow	(	ViewItem *	parent,
		int	row,
		std::vector< std::unique_ptr< ViewItem >>	items
	)

Insert a row of items at index 'row' to given parent.

Definition at line 151 of file viewmodelbase.cpp.

{
    if (!p_impl->item_belongs_to_model(parent))
        throw std::runtime_error(
            "Error in ViewModelBase: attempt to use parent from another model");
 
    beginInsertRows(indexFromItem(parent), row, row);
    parent->insertRow(row, std::move(items));
    endInsertRows();
}

References indexFromItem(), p_impl, and parent().

Referenced by appendRow(), ModelView::ViewModelController::ViewModelControllerImpl::insert_view(), and TEST_F().

Here is the call graph for this function:

itemFromIndex()

ViewItem * ViewModelBase::itemFromIndex

(

const QModelIndex &

index

)

const

Returns a pointer to the RefViewItem associated with the given index.

If index is invalid, returns nullptr.

Definition at line 110 of file viewmodelbase.cpp.

{
    return index.isValid() ? static_cast<ViewItem*>(index.internalPointer()) : nullptr;
}

References index().

Referenced by columnCount(), data(), ModelView::ViewModelController::ViewModelControllerImpl::findViews(), flags(), index(), parent(), rowCount(), ModelView::ViewModel::sessionItemFromIndex(), setData(), TEST_F(), and ModelView::ViewModel::viewItemFromIndex().

Here is the call graph for this function:

parent()

QModelIndex ViewModelBase::parent ( const QModelIndex &  child ) const

override

Definition at line 52 of file viewmodelbase.cpp.

{
    if (auto child_item = itemFromIndex(child); child_item) {
        auto parent_item = child_item->parent();
        return parent_item == rootItem()
                   ? QModelIndex()
                   : createIndex(parent_item->row(), parent_item->column(), parent_item);
    }
 
    return QModelIndex();
}

References itemFromIndex(), and rootItem().

Referenced by appendRow(), gui2::DataViewModel::canDropMimeData(), clearRows(), columnCount(), gui2::DataViewModel::dropMimeData(), index(), insertRow(), removeRow(), rowCount(), and TEST_F().

Here is the call graph for this function:

removeRow()

void ViewModelBase::removeRow	(	ViewItem *	parent,
		int	row
	)

Definition at line 124 of file viewmodelbase.cpp.

{
    if (!p_impl->item_belongs_to_model(parent))
        throw std::runtime_error(
            "Error in ViewModelBase: attempt to use parent from another model");
 
    beginRemoveRows(indexFromItem(parent), row, row);
    parent->removeRow(row);
    endRemoveRows();
}

References indexFromItem(), p_impl, and parent().

Referenced by ModelView::ViewModelController::ViewModelControllerImpl::remove_row_of_views(), and TEST_F().

Here is the call graph for this function:

rootItem()

ViewItem * ViewModelBase::rootItem

(

)

const

Returns a pointer to invisible root item.

Definition at line 102 of file viewmodelbase.cpp.

{
    return p_impl->root.get();
}

References p_impl.

Referenced by ModelView::ViewModel::ViewModel(), columnCount(), data(), ModelView::ViewModelController::ViewModelControllerImpl::findViews(), index(), ModelView::ViewModelController::ViewModelControllerImpl::init_view_model(), ModelView::ViewModelBase::ViewModelBaseImpl::item_belongs_to_model(), parent(), rowCount(), and TEST_F().

rowCount()

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

override

Definition at line 64 of file viewmodelbase.cpp.

{
    auto parent_item = itemFromIndex(parent);
    return parent_item ? parent_item->rowCount() : rootItem()->rowCount();
}

References itemFromIndex(), parent(), rootItem(), and ModelView::ViewItem::rowCount().

Referenced by index(), and TEST_F().

Here is the call graph for this function:

setData()

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

override

Definition at line 85 of file viewmodelbase.cpp.

{
    if (!index.isValid())
        return false;
 
    if (auto item = itemFromIndex(index); item) {
        bool result = item->setData(value, role);
        if (result)
            dataChanged(index, index, QVector<int>() << role);
        return result;
    }
 
    return false;
}

References index(), and itemFromIndex().

Referenced by TEST_F().

Here is the call graph for this function:

setRootViewItem()

void ViewModelBase::setRootViewItem ( std::unique_ptr< ViewItem >  root_item )

private

Sets new root item. Previous item will be deleted, model will be reset.

Definition at line 182 of file viewmodelbase.cpp.

{
    p_impl->root = std::move(root_item);
}

References p_impl.

Referenced by ViewModelBase(), and ModelView::ViewModelController::ViewModelControllerImpl::setRootSessionItemIntern().

Friends And Related Function Documentation

ViewModelController

friend class ViewModelController

friend

Definition at line 68 of file viewmodelbase.h.

Member Data Documentation

p_impl

std::unique_ptr<ViewModelBaseImpl> ModelView::ViewModelBase::p_impl

private

Definition at line 70 of file viewmodelbase.h.

Referenced by clearRows(), insertRow(), removeRow(), rootItem(), and setRootViewItem().

---

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

• /home/www/ba/mvvm/viewmodel/mvvm/viewmodel/viewmodelbase.h
• /home/www/ba/mvvm/viewmodel/mvvm/viewmodel/viewmodelbase.cpp