listmodeldbobjects.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2015 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1

 
#ifndef SWIFT_GUI_MODELS_LISTMODELDBOBJECTS_H
#define SWIFT_GUI_MODELS_LISTMODELDBOBJECTS_H
 
#include <QColor>
#include <QList>
#include <QString>
#include <QVariant>
#include <Qt>
 
#include "gui/models/listmodelbase.h"
 
class QModelIndex;
class QObject;
 
namespace swift::gui::models
{
    template <typename T, typename K, bool UseCompare = false>
    class CListModelDbObjects : public CListModelBase<T, UseCompare>
    {
    public:
        using ContainerType = T;

        using ObjectType = typename T::value_type;

        using KeyType = K;

        ~CListModelDbObjects() override = default;

        void setHighlightedDbKeys(const QList<KeyType> &keys) { m_highlightKeys = keys; }

        void clearHighlightedDbKeys() { m_highlightKeys.clear(); }

        void clearHighlighting() override
        {
            this->clearHighlightedDbKeys();
            CListModelBase<ContainerType, UseCompare>::clearHighlighting();
        }

        bool hasHighlightedRows() const override { return !m_highlightKeys.isEmpty(); }

        void setHighlightColor(QColor color) { m_highlightColor = color; }

        QVariant data(const QModelIndex &index, int role) const override;

        KeyType dbKeyForIndex(const QModelIndex &index) const;

        bool isHighlightedIndex(const QModelIndex &index) const;
 
    protected:
        CListModelDbObjects(const QString &translationContext, QObject *parent = nullptr);
 
    private:
        QList<KeyType> m_highlightKeys; 
        QColor m_highlightColor = Qt::green;
    };

    template <typename T, typename K, bool UseCompare = false>
    class COrderableListModelDbObjects : public CListModelDbObjects<T, K, UseCompare>
    {
    public:
        using ContainerType = T;

        using ObjectType = typename T::value_type;

        using KeyType = K;

        ~COrderableListModelDbObjects() override = default;

        using COrderableListModelDbObjects::CListModelDbObjects::update;

        int update(const ContainerType &container, bool sort) override;

        void moveItems(const ContainerType &items, int position) override;

        bool setSortColumnToOrder();
 
    protected:
        COrderableListModelDbObjects(const QString &translationContext, QObject *parent = nullptr);
    };
} // namespace swift::gui::models
#endif // SWIFT_GUI_MODELS_LISTMODELDBOBJECTS_H