importimagemodel.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2012-05-22
 * Description : Qt model for camera entries
 *
 * Copyright (C) 2012 by Islam Wazery <wazery at ubuntu 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_IMPORT_IMAGE_MODEL_H
#define DIGIKAM_IMPORT_IMAGE_MODEL_H
 
// Qt includes
 
#include <QAbstractListModel>
#include <QUrl>
 
// Local includes
 
#include "dragdropimplementations.h"
#include "camerathumbsctrl.h"
#include "camiteminfo.h"
 
namespace Digikam
{
class AbstractItemDragDropHandler;
 
class ImportItemModel : public QAbstractListModel, public DragDropModelImplementation
{
    Q_OBJECT
 
public:
 
    enum ImportItemModelRoles
    {
        ImportItemModelPointerRole = Qt::UserRole,
        ImportItemModelInternalId  = Qt::UserRole + 1,
 
        ThumbnailRole               = Qt::UserRole + 2,
        ExtraDataRole               = Qt::UserRole + 3,
 
        ExtraDataDuplicateCount     = Qt::UserRole + 6,
 
        FilterModelRoles            = Qt::UserRole + 100
    };
 
public:
 
    explicit ImportItemModel(QObject* const parent = nullptr);
    ~ImportItemModel() override;
 
    virtual void setCameraThumbsController(CameraThumbsCtrl* const controller);
 
    void setKeepsFileUrlCache(bool keepCache);
    bool keepsFileUrlCache() const;
 
    CamItemInfo      camItemInfo(const QModelIndex& index)           const;
    CamItemInfo&     camItemInfoRef(const QModelIndex& index)        const;
    qlonglong        camItemId(const QModelIndex& index)             const;
    CamItemInfoList  camItemInfos(const QList<QModelIndex>& indexes) const;
    QList<qlonglong> camItemIds(const QList<QModelIndex>& indexes)   const;
 
    CamItemInfo  camItemInfo(int row)    const;
    CamItemInfo& camItemInfoRef(int row) const;
    qlonglong    camItemId(int row)      const;
 
    QModelIndex        indexForCamItemInfo(const CamItemInfo& info)   const;
    QList<QModelIndex> indexesForCamItemInfo(const CamItemInfo& info) const;
    QModelIndex        indexForCamItemId(qlonglong id)                const;
    QList<QModelIndex> indexesForCamItemId(qlonglong id)              const;
 
    QModelIndex        indexForUrl(const QUrl& fileUrl)   const;
    QList<QModelIndex> indexesForUrl(const QUrl& fileUrl) const;
    CamItemInfo        camItemInfo(const QUrl& fileUrl)   const;
    QList<CamItemInfo> camItemInfos(const QUrl& fileUrl)  const;
 
    void clearCamItemInfos();
 
    void addCamItemInfoSynchronously(const CamItemInfo& info);
    void addCamItemInfosSynchronously(const Digikam::CamItemInfoList& infos);
 
    void setCamItemInfos(const CamItemInfoList& infos);
 
    QList<CamItemInfo> camItemInfos()       const;
    QList<qlonglong>   camItemIds()         const;
    QList<CamItemInfo> uniqueCamItemInfos() const;
 
    bool hasImage(qlonglong id)             const;
    bool hasImage(const CamItemInfo& info)  const;
 
    bool isEmpty()                          const;
 
    void removeIndex(const QModelIndex& index);
    void removeIndexs(const QList<QModelIndex>& indexes);
    void removeCamItemInfo(const CamItemInfo& info);
    void removeCamItemInfos(const QList<CamItemInfo>& infos);
 
    int numberOfIndexesForCamItemInfo(const CamItemInfo& info) const;
    int numberOfIndexesForCamItemId(qlonglong id)              const;
 
    static CamItemInfo retrieveCamItemInfo(const QModelIndex& index);
    static qlonglong   retrieveCamItemId(const QModelIndex& index);
 
    int           rowCount(const QModelIndex& parent)                            const override;
    QVariant      data(const QModelIndex& index, int role)                       const override;
    QVariant      headerData(int section, Qt::Orientation orientation, int role) const override;
    Qt::ItemFlags flags(const QModelIndex& index)                                const override;
    QModelIndex   index(int row, int column, const QModelIndex& parent)          const override;
 
    DECLARE_MODEL_DRAG_DROP_METHODS
 
    void setSendRemovalSignals(bool send);
 
    bool isRefreshing() const;
 
Q_SIGNALS:
 
    void itemInfosAboutToBeAdded(const QList<CamItemInfo>& infos);
 
    void itemInfosAdded(const QList<CamItemInfo>& infos);
 
    void itemInfosAboutToBeRemoved(const QList<CamItemInfo>& infos);
 
    void itemInfosRemoved(const QList<CamItemInfo>& infos);
 
    void preprocess(const QList<CamItemInfo>& infos);
    void processAdded(const QList<CamItemInfo>& infos);
 
    void readyForIncrementalRefresh();
 
    void allRefreshingFinished();
 
public Q_SLOTS:
 
    void reAddCamItemInfos(const CamItemInfoList& infos);
    void reAddingFinished();
    void slotFileDeleted(const QString& folder, const QString& file, bool status);
    void slotFileUploaded(const CamItemInfo& info);
    void addCamItemInfo(const CamItemInfo& info);
    void addCamItemInfos(const CamItemInfoList& infos);
 
protected:
 
    void startRefresh();
    void finishRefresh();
 
    void requestIncrementalRefresh();
    bool hasIncrementalRefreshPending() const;
 
    void startIncrementalRefresh();
    void finishIncrementalRefresh();
 
    void emitDataChangedForAll();
    void emitDataChangedForSelections(const QItemSelection& selection);
 
    virtual void camItemInfosCleared() {};
 
    virtual void itemInfosAboutToBeRemoved(int /*begin*/, int /*end*/) {};
 
private:
 
    void appendInfos(const CamItemInfoList& infos);
    void publiciseInfos(const CamItemInfoList& infos);
    void cleanSituationChecks();
    void removeRowPairs(const QList<QPair<int, int> >& toRemove);
    void removeRowPairsWithCheck(const QList<QPair<int, int> >& toRemove);
 
public:
 
    // NOTE: Declared public because it's used in ItemModelIncrementalUpdater class
    class Private;
 
private:
 
    // Disable
    ImportItemModel(const ImportItemModel&)            = delete;
    ImportItemModel& operator=(const ImportItemModel&) = delete;
 
private:
 
    Private* const d;
};
 
} // namespace Digikam
 
Q_DECLARE_METATYPE(Digikam::ImportItemModel*)
 
#endif // DIGIKAM_IMPORT_IMAGE_MODEL_H