listmodelbasenontemplate.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2018 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
 
 
#ifndef SWIFT_GUI_MODELS_LISTMODELBASENONTEMPLATE_H
#define SWIFT_GUI_MODELS_LISTMODELBASENONTEMPLATE_H
 
#include <QJsonDocument>
#include <QJsonObject>
#include <QModelIndex>
#include <QStandardItemModel>
#include <QString>
#include <QStringList>
#include <QVariant>
#include <QVector>
 
#include "gui/dropbase.h"
#include "gui/models/columns.h"
#include "gui/swiftguiexport.h"
#include "misc/digestsignal.h"
#include "misc/propertyindexlist.h"
#include "misc/variant.h"
 
class QMimeData;
class QModelIndex;
 
namespace swift::misc
{
    class CWorker;
}
namespace swift::gui::models
{
    class SWIFT_GUI_EXPORT CListModelBaseNonTemplate : public QStandardItemModel, public CDropBase
    {
        Q_OBJECT
 
    public:
        static constexpr int asyncThreshold = 50;
 
        ~CListModelBaseNonTemplate() override = default;
 
        int columnCount(const QModelIndex &modelIndex = QModelIndex()) const final;
 
        QVariant headerData(int section, Qt::Orientation orientation, int role) const final;
 
        QModelIndex index(int row, int column, const QModelIndex &parent = QModelIndex()) const final;
 
        QModelIndex parent(const QModelIndex &child) const final;
 
        Qt::ItemFlags flags(const QModelIndex &index) const final;
 
        Qt::DropActions supportedDragActions() const final;
 
        Qt::DropActions supportedDropActions() const final;
 
        QStringList mimeTypes() const final;
 
        virtual swift::misc::CPropertyIndex columnToPropertyIndex(int column) const;
 
        virtual int propertyIndexToColumn(const swift::misc::CPropertyIndex &propertyIndex) const;
 
        virtual swift::misc::CPropertyIndex modelIndexToPropertyIndex(const QModelIndex &index) const;
 
        virtual void setSortColumn(int column) { m_sortColumn = column; }
 
        void setNoSorting() { this->setSortColumn(-1); }
 
        void sortByPropertyIndex(const swift::misc::CPropertyIndex &propertyIndex,
                                 Qt::SortOrder order = Qt::AscendingOrder);
 
        virtual bool setSortColumnByPropertyIndex(const swift::misc::CPropertyIndex &propertyIndex);
 
        virtual bool setSorting(const swift::misc::CPropertyIndex &propertyIndex,
                                Qt::SortOrder order = Qt::AscendingOrder);
 
        virtual int getSortColumn() const { return m_sortColumn; }
 
        swift::misc::CPropertyIndex getSortProperty() const;
 
        virtual bool hasValidSortColumn() const;
 
        virtual Qt::SortOrder getSortOrder() const { return m_sortOrder; }
 
        virtual bool isOrderable() const = 0;
 
        void markDestroyed();
 
        bool isModelDestroyed();
 
        virtual void clearHighlighting();
 
        virtual bool hasHighlightedRows() const;
 
        void setDropActions(Qt::DropActions dropActions) { m_dropActions = dropActions; }
 
        void emitDataChanged(int startRowIndex, int endRowIndex);
 
        virtual QJsonObject toJson(bool selectedOnly = false) const = 0;
 
        virtual QString toJsonString(QJsonDocument::JsonFormat format = QJsonDocument::Indented,
                                     bool selectedOnly = false) const = 0;
 
        const CColumns &getColumns() const { return m_columns; }
 
        bool endsWithEmptyColumn() const { return m_columns.endsWithEmptyColumn(); }
 
    signals:
        void asyncUpdateFinished();
 
        void modelDataChanged(int count, bool withFilter);
 
        void modelDataChangedDigest(int count, bool withFilter);
 
        void changed();
 
        void changedDigest();
 
        void objectChanged(const swift::misc::CVariant &object, const swift::misc::CPropertyIndex &changedIndex);
 
    protected:
        virtual void onDataChanged(const QModelIndex &topLeft, const QModelIndex &bottomRight,
                                   const QVector<int> &roles) = 0;
 
        virtual void onChangedDigest() = 0;
 
        CListModelBaseNonTemplate(const QString &translationContext, QObject *parent = nullptr);
 
        CColumns m_columns; 
        int m_sortColumn; 
        bool m_modelDestroyed = false; 
        Qt::SortOrder m_sortOrder; 
        Qt::DropActions m_dropActions = Qt::IgnoreAction; 
        swift::misc::CPropertyIndexList
            m_sortTieBreakers; 
 
    private:
        swift::misc::CDigestSignal m_dsModelsChanged { this, &CListModelBaseNonTemplate::changed,
                                                       &CListModelBaseNonTemplate::onChangedDigest,
                                                       std::chrono::milliseconds(500), 10 };
    };
 
} // namespace swift::gui::models
#endif // SWIFT_GUI_MODELS_LISTMODELBASENONTEMPLATE_H