itemmodel.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2009-03-05
 * Description : Qt item model for database entries
 *
 * Copyright (C) 2009-2011 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 * Copyright (C) 2012-2022 by Gilles Caulier <caulier dot gilles at gmail dot com>
 *
 * This program is free software; you can redistribute it
 * and/or modify it under the terms of the GNU General
 * Public License as published by the Free Software Foundation;
 * either version 2, or (at your option)
 * any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * ============================================================ */
 
#ifndef DIGIKAM_ITEM_MODEL_H
#define DIGIKAM_ITEM_MODEL_H
 
// Qt includes
 
#include <QAbstractListModel>
 
// Local includes
 
#include "dragdropimplementations.h"
#include "iteminfo.h"
#include "digikam_export.h"
 
class QItemSelection;
 
namespace Digikam
{
 
class ImageChangeset;
class ImageTagChangeset;
 
namespace DatabaseFields
{
class Set;
}
 
class DIGIKAM_DATABASE_EXPORT ItemModel : public QAbstractListModel,
                                          public DragDropModelImplementation
{
    Q_OBJECT
 
public:
 
    enum ItemModelRoles
    {
        ItemModelPointerRole    = Qt::UserRole,
        ItemModelInternalId     = Qt::UserRole + 1,
 
        ThumbnailRole           = Qt::UserRole + 2,
 
        CreationDateRole        = Qt::UserRole + 3,
 
        ExtraDataRole           = Qt::UserRole + 5,
 
        ExtraDataDuplicateCount = Qt::UserRole + 6,
 
        LTLeftPanelRole         = Qt::UserRole + 50,
 
        LTRightPanelRole        = Qt::UserRole + 51,
 
        SubclassRoles           = Qt::UserRole + 100,
 
        FilterModelRoles        = Qt::UserRole + 500
    };
 
public:
 
    explicit ItemModel(QObject* const parent = nullptr);
    ~ItemModel() override;
 
    void setKeepsFilePathCache(bool keepCache);
    bool keepsFilePathCache()                                                                               const;
 
    void setWatchFlags(const DatabaseFields::Set& set);
 
    ItemInfo         imageInfo(const QModelIndex& index)                                                    const;
    ItemInfo&        imageInfoRef(const QModelIndex& index)                                                 const;
    qlonglong        imageId(const QModelIndex& index)                                                      const;
    QList<ItemInfo>  imageInfos(const QList<QModelIndex>& indexes)                                          const;
    QList<qlonglong> imageIds(const QList<QModelIndex>& indexes)                                            const;
 
    ItemInfo   imageInfo(int row)                                                                           const;
    ItemInfo&  imageInfoRef(int row)                                                                        const;
    qlonglong  imageId(int row)                                                                             const;
 
    QModelIndex        indexForItemInfo(const ItemInfo& info)                                               const;
    QModelIndex        indexForItemInfo(const ItemInfo& info, const QVariant& extraValue)                   const;
    QModelIndex        indexForImageId(qlonglong id)                                                        const;
    QModelIndex        indexForImageId(qlonglong id, const QVariant& extraValue)                            const;
    QList<QModelIndex> indexesForItemInfo(const ItemInfo& info)                                             const;
    QList<QModelIndex> indexesForImageId(qlonglong id)                                                      const;
 
    int numberOfIndexesForItemInfo(const ItemInfo& info)                                                    const;
    int numberOfIndexesForImageId(qlonglong id)                                                             const;
 
    QModelIndex        indexForPath(const QString& filePath)                                                const;
    ItemInfo           imageInfo(const QString& filePath)                                                   const;
    QList<QModelIndex> indexesForPath(const QString& filePath)                                              const;
    QList<ItemInfo>    imageInfos(const QString& filePath)                                                  const;
 
    void addItemInfo(const ItemInfo& info);
    void addItemInfos(const QList<ItemInfo>& infos);
    void addItemInfos(const QList<ItemInfo>& infos, const QList<QVariant>& extraValues);
 
    void clearItemInfos();
 
    void setItemInfos(const QList<ItemInfo>& infos);
 
    void removeIndex(const QModelIndex& indexes);
    void removeIndexes(const QList<QModelIndex>& indexes);
    void removeItemInfo(const ItemInfo& info);
    void removeItemInfos(const QList<ItemInfo>& infos);
    void removeItemInfos(const QList<ItemInfo>& infos, const QList<QVariant>& extraValues);
 
    void addItemInfoSynchronously(const ItemInfo& info);
    void addItemInfosSynchronously(const QList<ItemInfo>& infos);
    void addItemInfosSynchronously(const QList<ItemInfo>& infos, const QList<QVariant>& extraValues);
 
    void ensureHasItemInfo(const ItemInfo& info);
    void ensureHasItemInfos(const QList<ItemInfo>& infos);
    void ensureHasItemInfos(const QList<ItemInfo>& infos, const QList<QVariant>& extraValues);
 
    void ensureHasGroupedImages(const ItemInfo& groupLeader);
 
    QList<ItemInfo>  imageInfos()                                                                           const;
    QList<qlonglong> imageIds()                                                                             const;
    QList<ItemInfo>  uniqueItemInfos()                                                                      const;
 
    bool hasImage(qlonglong id)                                                                             const;
    bool hasImage(const ItemInfo& info)                                                                     const;
    bool hasImage(const ItemInfo& info, const QVariant& extraValue)                                         const;
    bool hasImage(qlonglong id, const QVariant& extraValue)                                                 const;
 
    bool isEmpty()                                                                                          const;
    int  itemCount()                                                                                        const;
 
    // Drag and Drop
    DECLARE_MODEL_DRAG_DROP_METHODS
 
    void setPreprocessor(QObject* const processor);
    void unsetPreprocessor(QObject* const processor);
 
    bool isRefreshing()                                                                                     const;
 
    void setSendRemovalSignals(bool send);
 
    QVariant      data(const QModelIndex& index, int role = Qt::DisplayRole)                        const override;
    QVariant      headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole)  const override;
    int           rowCount(const QModelIndex& parent = QModelIndex())                               const override;
    Qt::ItemFlags flags(const QModelIndex& index)                                                   const override;
    QModelIndex   index(int row, int column = 0, const QModelIndex& parent = QModelIndex())         const override;
 
    static ItemInfo retrieveItemInfo(const QModelIndex& index);
    static qlonglong retrieveImageId(const QModelIndex& index);
 
Q_SIGNALS:
 
    void imageInfosAboutToBeAdded(const QList<ItemInfo>& infos);
 
    void imageInfosAdded(const QList<ItemInfo>& infos);
 
    void imageInfosAboutToBeRemoved(const QList<ItemInfo>& infos);
 
    void imageInfosRemoved(const QList<ItemInfo>& infos);
 
    void preprocess(const QList<ItemInfo>& infos, const QList<QVariant>&);
    void processAdded(const QList<ItemInfo>& infos, const QList<QVariant>&);
 
    void imageChange(const ImageChangeset&, const QItemSelection&);
 
    void imageTagChange(const ImageTagChangeset&, const QItemSelection&);
 
    void readyForIncrementalRefresh();
 
    void allRefreshingFinished();
 
public Q_SLOTS:
 
    void reAddItemInfos(const QList<ItemInfo>& infos, const QList<QVariant>& extraValues);
    void reAddingFinished();
 
protected:
 
    void startRefresh();
    void finishRefresh();
 
    void requestIncrementalRefresh();
    bool hasIncrementalRefreshPending()                                                                     const;
 
    void startIncrementalRefresh();
    void finishIncrementalRefresh();
 
    void emitDataChangedForAll();
    void emitDataChangedForSelection(const QItemSelection& selection);
 
    virtual void imageInfosCleared() {};
 
    virtual void imageInfosAboutToBeRemoved(int /*begin*/, int /*end*/) {};
 
protected Q_SLOTS:
 
    virtual void slotImageChange(const ImageChangeset& changeset);
    virtual void slotImageTagChange(const ImageTagChangeset& changeset);
 
private:
 
    void appendInfos(const QList<ItemInfo>& infos, const QList<QVariant>& extraValues);
    void appendInfosChecked(const QList<ItemInfo>& infos, const QList<QVariant>& extraValues);
    void publiciseInfos(const QList<ItemInfo>& infos, const QList<QVariant>& extraValues);
    void cleanSituationChecks();
    void removeRowPairsWithCheck(const QList<QPair<int, int> >& toRemove);
    void removeRowPairs(const QList<QPair<int, int> >& toRemove);
 
public:
 
    // Declared public because it's used in ItemModelIncrementalUpdater class
    class Private;
 
private:
 
    // Disable
    ItemModel(const ItemModel&)            = delete;
    ItemModel& operator=(const ItemModel&) = delete;
 
    Private* const d;
};
 
} // namespace Digikam
 
Q_DECLARE_METATYPE(Digikam::ItemModel*)
 
#endif // DIGIKAM_ITEM_MODEL_H