showfotoitemmodel.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2013-07-05
 * Description : Qt model for Showfoto entries
 *
 * Copyright (C) 2013 by Mohamed_Anwer <m_dot_anwer at gmx 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 SHOW_FOTO_ITEM_MODEL_H
#define SHOW_FOTO_ITEM_MODEL_H
 
// Qt includes
 
#include <QAbstractListModel>
#include <QUrl>
 
// Local includes
 
#include "dragdropimplementations.h"
#include "abstractitemdragdrophandler.h"
#include "showfotoiteminfo.h"
 
using namespace Digikam;
 
namespace ShowFoto
{
 
typedef QPair<int, int> IntPair;
 
class ShowfotoItemModel : public QAbstractListModel,
                          public DragDropModelImplementation
{
    Q_OBJECT
 
public:
 
    enum ShowfotoItemModelRoles
    {
        ShowfotoItemModelPointerRole = Qt::UserRole,
        ShowfotoItemModelInternalId  = Qt::UserRole + 1,
 
        ThumbnailRole                = Qt::UserRole + 2,
 
        ExtraDataRole                = Qt::UserRole + 3,
 
        ExtraDataDuplicateCount      = Qt::UserRole + 6,
 
        FilterModelRoles             = Qt::UserRole + 100
    };
 
public:
 
     explicit ShowfotoItemModel(QObject* const parent);
    ~ShowfotoItemModel()                                                                  override;
 
    void setKeepsFileUrlCache(bool keepCache);
 
    ShowfotoItemInfo      showfotoItemInfo(const QModelIndex& index)                const;
    ShowfotoItemInfo&     showfotoItemInfoRef(const QModelIndex& index)             const;
    qlonglong             showfotoItemId(const QModelIndex& index)                  const;
    ShowfotoItemInfoList  showfotoItemInfos(const QList<QModelIndex>& indexes)      const;
    QList<qlonglong>      showfotoItemIds(const QList<QModelIndex>& indexes)        const;
 
    ShowfotoItemInfo  showfotoItemInfo(int row)                                     const;
    ShowfotoItemInfo& showfotoItemInfoRef(int row)                                  const;
    qlonglong         showfotoItemId(int row)                                       const;
 
    QModelIndex        indexForShowfotoItemInfo(const ShowfotoItemInfo& info)       const;
    QList<QModelIndex> indexesForShowfotoItemInfo(const ShowfotoItemInfo& info)     const;
    QModelIndex        indexForShowfotoItemId(qlonglong id)                         const;
    QList<QModelIndex> indexesForShowfotoItemId(qlonglong id)                       const;
 
    QModelIndex             indexForUrl(const QUrl& fileUrl)                        const;
    QList<QModelIndex>      indexesForUrl(const QUrl& fileUrl)                      const;
    ShowfotoItemInfo        showfotoItemInfo(const QUrl& fileUrl)                   const;
    QList<ShowfotoItemInfo> showfotoItemInfos(const QUrl& fileUrl)                  const;
 
    void addShowfotoItemInfo(const ShowfotoItemInfo& info);
    void addShowfotoItemInfos(const QList<ShowfotoItemInfo>& infos);
 
    void clearShowfotoItemInfos();
 
    void addShowfotoItemInfoSynchronously(const ShowfotoItemInfo& info);
    void addShowfotoItemInfosSynchronously(const QList<ShowfotoItemInfo>& infos);
 
    void setShowfotoItemInfos(const QList<ShowfotoItemInfo>& infos);
 
    QList<ShowfotoItemInfo> showfotoItemInfos()                                     const;
    QList<qlonglong>        showfotoItemIds()                                       const;
    QList<ShowfotoItemInfo> uniqueShowfotoItemInfos()                               const;
 
    bool hasImage(qlonglong id)                                                     const;
    bool hasImage(const ShowfotoItemInfo& info)                                     const;
 
    bool isEmpty()                                                                  const;
 
    void removeIndex(const QModelIndex& index);
    void removeIndexs(const QList<QModelIndex>& indexes);
    void removeShowfotoItemInfo(const ShowfotoItemInfo& info);
    void removeShowfotoItemInfos(const QList<ShowfotoItemInfo>& infos);
 
    int numberOfIndexesForShowfotoItemInfo(const ShowfotoItemInfo& info)            const;
    int numberOfIndexesForShowfotoItemId(qlonglong id)                              const;
 
    static ShowfotoItemInfo retrieveShowfotoItemInfo(const QModelIndex& index);
    static qlonglong        retrieveShowfotoItemId(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);
 
Q_SIGNALS:
 
    void itemInfosAboutToBeAdded(const QList<ShowfotoItemInfo>& infos);
 
    void itemInfosAdded(const QList<ShowfotoItemInfo>& infos);
 
    void itemInfosAboutToBeRemoved(const QList<ShowfotoItemInfo>& infos);
 
    void itemInfosRemoved(const QList<ShowfotoItemInfo>& infos);
 
    void preprocess(const QList<ShowfotoItemInfo>& infos);
    void processAdded(const QList<ShowfotoItemInfo>& infos);
 
    void readyForIncrementalRefresh();
 
    void allRefreshingFinished();
 
public Q_SLOTS:
 
    void reAddShowfotoItemInfos(const ShowfotoItemInfoList& infos);
    void reAddingFinished();
    void slotFileDeleted(const QString& folder, const QString& file, bool status);
    void slotFileUploaded(const ShowfotoItemInfo& info);
 
protected:
 
    void requestIncrementalRefresh();
 
    void startIncrementalRefresh();
    void finishIncrementalRefresh();
 
    void emitDataChangedForAll();
    void emitDataChangedForSelections(const QItemSelection& selection);
 
    virtual void showfotoItemInfosCleared()                                    {};
 
    virtual void showfotoItemInfosAboutToBeRemoved(int /*begin*/, int /*end*/) {};
 
private:
 
    void appendInfos(const QList<ShowfotoItemInfo>& infos);
    void publiciseInfos(const QList<ShowfotoItemInfo>& infos);
/*
    void cleanSituationChecks();
*/
    void removeRowPairs(const QList<QPair<int, int> >& toRemove);
/*
    void removeRowPairsWithCheck(const QList<QPair<int, int> >& toRemove);
*/
    static QList<IntPair> toContiguousPairs(const QList<int>& unsorted);
 
public:
 
    class Private;
 
private:
 
    // Disable
    ShowfotoItemModel(const ShowfotoItemModel&)            = delete;
    ShowfotoItemModel& operator=(const ShowfotoItemModel&) = delete;
 
private:
 
    Private* const d;
};
 
} // namespace ShowFoto
 
Q_DECLARE_METATYPE(ShowFoto::ShowfotoItemModel*)
 
#endif // SHOW_FOTO_IMAGE_MODEL_H