setupcollectionview.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2008-11-15
 * Description : collections setup tab model/view
 *
 * Copyright (C) 2008-2012 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 * Copyright (C) 2005-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_SETUP_COLLECTION_VIEW_H
#define DIGIKAM_SETUP_COLLECTION_VIEW_H
 
// Qt includes
 
#include <QAbstractItemModel>
#include <QAbstractItemDelegate>
#include <QList>
#include <QTreeView>
#include <QStyledItemDelegate>
#include <QPushButton>
#include <QToolButton>
 
// Local includes
 
#include "collectionlocation.h"
#include "dwitemdelegate.h"
#include "digikam_export.h"
 
namespace Digikam
{
 
class DIGIKAM_GUI_EXPORT SetupCollectionModel : public QAbstractItemModel
{
    Q_OBJECT
 
public:
 
    enum SetupCollectionDataRole
    {
        IsCategoryRole             = Qt::UserRole,
 
        CategoryButtonDisplayRole  = Qt::UserRole + 1,
        CategoryButtonMapId        = Qt::UserRole + 2,
 
        IsUpdateRole               = Qt::UserRole + 3,
 
        UpdateDecorationRole       = Qt::UserRole + 4,
        UpdateMapId                = Qt::UserRole + 5,
 
        IsDeleteRole               = Qt::UserRole + 6,
 
        DeleteDecorationRole       = Qt::UserRole + 7,
        DeleteMapId                = Qt::UserRole + 8
    };
 
    enum Columns
    {
        ColumnStatus       = 0,
        ColumnName         = 1,
        ColumnPath         = 2,
        ColumnUpdateButton = 3,
        ColumnDeleteButton = 4,
        NumberOfColumns
    };
 
    enum Category
    {
        CategoryLocal      = 0,
        CategoryRemovable  = 1,
        CategoryRemote     = 2,
        NumberOfCategories
    };
 
public:
 
    explicit SetupCollectionModel(QObject* const parent = nullptr);
    ~SetupCollectionModel() override;
 
    void loadCollections();
 
    void setParentWidgetForDialogs(QWidget* const widget);
 
    void apply();
 
    QModelIndex indexForCategory(Category category)                                           const;
    QList<QModelIndex> categoryIndexes()                                                      const;
 
    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;
    int columnCount(const QModelIndex& parent = QModelIndex())                                const override;
    Qt::ItemFlags flags(const QModelIndex& index)                                             const override;
    bool setData(const QModelIndex& index, const QVariant& value, int role = Qt::EditRole)          override;
    QModelIndex index(int row, int column, const QModelIndex& parent = QModelIndex())         const override;
    QModelIndex parent(const QModelIndex& index)                                              const override;
 
/*
    virtual Qt::DropActions supportedDropActions() const;
    virtual QStringList mimeTypes() const;
    virtual bool dropMimeData(const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex& parent);
    virtual QMimeData * mimeData(const QModelIndexList& indexes) const;
*/
 
Q_SIGNALS:
 
    void collectionsLoaded();
 
public Q_SLOTS:
 
    void slotCategoryButtonPressed(int mappedId);
 
    void slotUpdatePressed(int mappedId);
    void slotDeletePressed(int mappedId);
 
protected Q_SLOTS:
 
    void addCollection(int category);
    void updateCollection(int internalId);
    void deleteCollection(int internalId);
 
protected:
 
    QModelIndex indexForId(int id, int column)          const;
 
    bool askForNewCollectionPath(int category, QString* const newPath, QString* const newLabel);
    bool askForNewCollectionCategory(int* const category);
 
    int categoryButtonMapId(const QModelIndex& index)   const;
    int buttonMapId(const QModelIndex& index)           const;
 
    static Category typeToCategory(CollectionLocation::Type type);
 
protected:
 
    class Item
    {
    public:
 
        Item();
        explicit Item(const CollectionLocation& location);
        Item(const QString& path, const QString& label, SetupCollectionModel::Category category);
 
    public:
 
        CollectionLocation location;
        QString            label;
        QString            path;
        int                parentId;
        bool               updated;
        bool               deleted;
    };
 
protected:
 
    QList<Item> m_collections;
    QWidget*    m_dialogParentWidget;
};
 
// -----------------------------------------------------------------------
 
class SetupCollectionTreeView : public QTreeView
{
    Q_OBJECT
 
public:
 
    explicit SetupCollectionTreeView(QWidget* const parent = nullptr);
 
    void setModel(SetupCollectionModel* model);
 
protected Q_SLOTS:
 
    void modelLoadedCollections();
 
private:
 
    void setModel(QAbstractItemModel* model) override
    {
        setModel(static_cast<SetupCollectionModel*>(model));
    }
};
 
// -----------------------------------------------------------------------
 
class SetupCollectionDelegate : public DWItemDelegate
{
    Q_OBJECT
 
public:
 
    explicit SetupCollectionDelegate(QAbstractItemView* const view,
                                     QObject* const parent = nullptr);
    ~SetupCollectionDelegate()                                                    override;
 
    QWidget* createEditor(QWidget* parent,
                          const QStyleOptionViewItem& option,
                          const QModelIndex& index)                         const override;
 
    bool     editorEvent(QEvent* event,
                         QAbstractItemModel* model,
                         const QStyleOptionViewItem& option,
                         const QModelIndex& index)                                override;
 
    void     paint(QPainter* painter,
                   const QStyleOptionViewItem& option,
                   const QModelIndex& index)                                const override;
 
    void     setEditorData(QWidget* editor,
                           const QModelIndex& index)                        const override;
 
    void     setModelData(QWidget* editor,
                          QAbstractItemModel* model,
                          const QModelIndex& index)                         const override;
 
    QSize    sizeHint(const QStyleOptionViewItem& option,
                      const QModelIndex& index)                             const override;
 
    void     updateEditorGeometry(QWidget* editor,
                                  const QStyleOptionViewItem& option,
                                  const QModelIndex& index)                 const override;
 
    QList<QWidget*> createItemWidgets(const QModelIndex& index)             const override;
    void            updateItemWidgets(const QList<QWidget*>& widgets,
                                      const QStyleOptionViewItem& option,
                                      const QPersistentModelIndex& index)   const override;
 
Q_SIGNALS:
 
    void categoryButtonPressed(int mappedId)                                const;     // clazy:exclude=const-signal-or-slot
    void updatePressed(int mappedId)                                        const;     // clazy:exclude=const-signal-or-slot
    void deletePressed(int mappedId)                                        const;     // clazy:exclude=const-signal-or-slot
 
protected:
 
    QStyledItemDelegate* m_styledDelegate;
 
    QPushButton*         m_samplePushButton;
    QToolButton*         m_sampleUpdateButton;
    QToolButton*         m_sampleDeleteButton;
    int                  m_categoryMaxStyledWidth;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_SETUP_COLLECTION_VIEW_H