flightsimulatorplatfrom/pilotclient
1
0
Fork 0
mirror of https://github.com/swift-project/pilotclient.git synced 2026-04-12 23:35:33 +08:00
Code Issues Packages Projects Releases Wiki Activity

refs #325, added async update member function to CListModelBase / CViewBase (+ resize modes)

Browse Source 
* model:
** required a non templated base class for Q_OBJECT / slots
** added worker for thread, QConcurrent is not used as it does not work with template classes
* views:
** added cpp file for view base class
** added template parameter for container in views
** different modes how resizing will be applied
This commit is contained in:
Klaus Basan
2014-09-18 02:10:36 +02:00
parent 89dc0fb289
commit dc3eff1c1f
14 changed files with 713 additions and 194 deletions
Download Patch File Download Diff File Expand all files Collapse all files

190
src/blackgui/models/listmodelbase.h
View File

@@ -13,24 +13,26 @@
#define BLACKGUI_LISTMODELBASE_H
#include "blackgui/models/columns.h"
#include "blackgui/updateworker.h"
#include "blackmisc/propertyindex.h"
#include <QAbstractItemModel>
#include <QThread>
namespace BlackGui
{
namespace Models
{
/*!
* List model
*/
template <typename ObjectType, typename ContainerType> class CListModelBase : public QAbstractListModel
//! Non templated base class, allows Q_OBJECT and signals to be used
class CListModelBaseNonTemplate : public QAbstractListModel
{
Q_OBJECT
public:
//! Number of elements when to use asynchronous updates
static const int asyncThreshold = 50;
//! Destructor
virtual ~CListModelBase() {}
virtual ~CListModelBaseNonTemplate() {}
//! \copydoc QAbstractListModel::columnCount()
virtual int columnCount(const QModelIndex &modelIndex) const override;
@@ -47,14 +49,6 @@ namespace BlackGui
return this->columnToPropertyIndex(index.column());
}
//! Valid index (in range)
virtual bool isValidIndex(const QModelIndex &index) const
{
if (!index.isValid()) return false;
return (index.row() >= 0 && index.row() < this->m_container.size() &&
index.column() >= 0 && index.column() < this->columnCount(index));
}
//! Set sort column
virtual void setSortColumn(int column) { this->m_sortedColumn = column; }
@@ -71,14 +65,67 @@ namespace BlackGui
virtual int getSortColumn() const { return this->m_sortedColumn; }
//! Has valid sort column?
virtual bool hasValidSortColumn() const
{
return this->m_sortedColumn >= 0 && this->m_sortedColumn < this->m_columns.size();
}
virtual bool hasValidSortColumn() const;
//! Get sort order
virtual Qt::SortOrder getSortOrder() const { return this->m_sortOrder; }
//! \copydoc QAbstractTableModel::flags
Qt::ItemFlags flags(const QModelIndex &index) const override;
//! Translation context
virtual const QString &getTranslationContext() const
{
return m_columns.getTranslationContext();
}
signals:
//! Asynchronous update finished
void asyncUpdateFinished();
protected slots:
//! Helper method with template free signature
int updateContainer(const QVariant &variant, bool sort)
{
return this->performUpdateContainer(variant, sort);
}
protected:
/*!
* Constructor
* \param translationContext I18N context
* \param parent
*/
CListModelBaseNonTemplate(const QString &translationContext, QObject *parent = nullptr)
: QAbstractListModel(parent), m_columns(translationContext), m_sortedColumn(-1), m_sortOrder(Qt::AscendingOrder)
{
// non unique default name, set translation context as default
this->setObjectName(translationContext);
}
//! Helper method with template free signature
virtual int performUpdateContainer(const QVariant &variant, bool sort) = 0;
CColumns m_columns; //!< columns metadata
int m_sortedColumn; //!< current sort column
Qt::SortOrder m_sortOrder; //!< sort order (asc/desc)
};
/*!
* List model
*/
template <typename ObjectType, typename ContainerType> class CListModelBase :
public CListModelBaseNonTemplate
{
public:
//! Destructor
virtual ~CListModelBase() {}
//! Valid index (in range)
virtual bool isValidIndex(const QModelIndex &index) const;
//! Used container data
virtual const ContainerType &getContainer() const { return this->m_container; }
@@ -88,13 +135,17 @@ namespace BlackGui
//! \copydoc QAbstractListModel::rowCount()
virtual int rowCount(const QModelIndex &index = QModelIndex()) const override;
//! \copydoc QAbstractTableModel::flags
Qt::ItemFlags flags(const QModelIndex &index) const override;
//! Update by new container
//! \remarks a sorting is performed only if a valid sort column is set
virtual int update(const ContainerType &container, bool sort = true);
//! Asynchronous update
//! \return worker or nullptr if worker could not be started
virtual BlackGui::IUpdateWorker *updateAsync(const ContainerType &container, bool sort = true);
//! Update by new container
virtual void updateContainerMaybeAsync(const ContainerType &container, bool sort = true);
//! Update single element
virtual void update(const QModelIndex &index, const ObjectType &object);
@@ -105,22 +156,21 @@ namespace BlackGui
}
//! Object at row position
virtual const ObjectType &at(const QModelIndex &index) const
{
if (index.row() < 0 || index.row() >= this->m_container.size())
{
const static ObjectType def; // default object
return def;
}
else
{
return this->m_container[index.row()];
}
}
virtual const ObjectType &at(const QModelIndex &index) const;
//! \copydoc QAbstractListModel::sort()
virtual void sort(int column, Qt::SortOrder order) override;
/*!
* Sort container by given column / order. This is used by sort() but als
* for asynchronous updates in the views
* \param container used list
* \param column column inder
* \param order sort order (ascending / descending)
* \threadsafe
*/
ContainerType sortContainerByColumn(const ContainerType &container, int column, Qt::SortOrder order) const;
//! Similar to ContainerType::push_back
virtual void push_back(const ObjectType &object);
@@ -133,17 +183,8 @@ namespace BlackGui
//! Clear the list
virtual void clear();
//! Translation context
virtual const QString &getTranslationContext() const
{
return m_columns.getTranslationContext();
}
protected:
ContainerType m_container; //!< used container
CColumns m_columns; //!< columns metadata
int m_sortedColumn; //!< current sort column
Qt::SortOrder m_sortOrder; //!< sort order (asc/desc)
/*!
* Constructor
@@ -151,22 +192,61 @@ namespace BlackGui
* \param parent
*/
CListModelBase(const QString &translationContext, QObject *parent = nullptr)
: QAbstractListModel(parent), m_columns(translationContext), m_sortedColumn(-1), m_sortOrder(Qt::AscendingOrder)
{
// non unique default name, set translation context as default
this->setObjectName(translationContext);
}
: CListModelBaseNonTemplate(translationContext, parent)
{ }
/*!
* Sort container by given column / order. This is used by sort().
* \param list used list
* \param column column inder
* \param order sort order (ascending / descending)
* \return
*/
ContainerType sortListByColumn(const ContainerType &list, int column, Qt::SortOrder order);
//! \copydoc CModelBaseNonTemplate::performUpdateContainer
virtual int performUpdateContainer(const QVariant &variant, bool sort) override;
// ---- worker -----------------------------------------------------------------------------------
//! Worker class performing update and sorting in background
class CModelUpdateWorker : public BlackGui::IUpdateWorker
{
public:
//! Constructor
CModelUpdateWorker(CListModelBase *model, const ContainerType &container, bool sort) :
BlackGui::IUpdateWorker(sort), m_model(model), m_container(container)
{
Q_ASSERT(model);
this->m_sortColumn = model->getSortColumn();
this->m_sortOrder = model->getSortOrder();
connect(this, &CModelUpdateWorker::updateFinished, model, &CListModelBase::asyncUpdateFinished, Qt::QueuedConnection);
this->setObjectName(model->objectName().append(":CModelUpdateWorker"));
}
//! Destructor
virtual ~CModelUpdateWorker() {}
protected:
//! \copydoc CUpdateWorkerPrivate::update
virtual void update() override
{
// KWB remove later
qDebug() << this->objectName() << "thread:" << QThread::currentThreadId();
if (m_model)
{
if (m_sort)
{
// almost thread safe sorting in background
m_container = m_model->sortContainerByColumn(m_container, m_sortColumn, m_sortOrder);
}
// now update model itself thread safe, but time for sort was saved
QMetaObject::invokeMethod(m_model, "updateContainer", Qt::QueuedConnection,
Q_ARG(QVariant, m_container.toQVariant()), Q_ARG(bool, false));
}
}
CListModelBase *m_model = nullptr; //!< model to be updated, actually const but invokeMethod does not allow const
ContainerType m_container; //!< container with data
};
// ---- worker -----------------------------------------------------------------------------------
};
} // namespace
} // namespace
#endif // guard