categorizeditemmodel.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2010-12-02
 * Description : Generic, standard item based model for DCategorizedView
 *
 * Copyright (C) 2010-2011 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 *
 * 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_CATEGORIZED_ITEM_MODEL_H
#define DIGIKAM_CATEGORIZED_ITEM_MODEL_H
 
// Qt includes
 
#include <QStandardItemModel>
 
// Local includes
 
#include "digikam_export.h"
#include "dcategorizedsortfilterproxymodel.h"
 
class QAction;
 
namespace Digikam
{
 
class DIGIKAM_EXPORT CategorizedItemModel : public QStandardItemModel
{
    Q_OBJECT
 
public:
 
    enum ExtraRoles
    {
        ItemOrderRole = Qt::UserRole + 1
    };
 
public:
 
    explicit CategorizedItemModel(QObject* const parent = nullptr);
 
    QStandardItem* addItem(const QString& text, const QVariant& category, const QVariant& categorySorting = QVariant());
    QStandardItem* addItem(const QString& text, const QIcon& decoration, const QVariant& category,
                           const QVariant& categorySorting = QVariant());
 
    virtual DCategorizedSortFilterProxyModel* createFilterModel();
};
 
// -----------------------------------------------------------------------------------------------------------------------
 
class DIGIKAM_EXPORT ActionItemModel : public CategorizedItemModel
{
    Q_OBJECT
 
public:
 
    enum ExtraRoles
    {
        ItemActionRole = Qt::UserRole + 10
    };
 
    enum MenuCategoryFlag
    {
        ToplevelMenuCategory           = 1 << 0,
 
        ParentMenuCategory             = 1 << 1,
 
        SortCategoriesAlphabetically   = 1 << 10,
 
        SortCategoriesByInsertionOrder = 1 << 11
    };
    Q_DECLARE_FLAGS(MenuCategoryMode, MenuCategoryFlag)
 
public:
 
    explicit ActionItemModel(QObject* const parent = nullptr);
 
    QStandardItem* addAction(QAction* action, const QString& category, const QVariant& categorySorting = QVariant());
 
    void             setMode(MenuCategoryMode mode);
    MenuCategoryMode mode()                         const;
 
    void addActions(QWidget* widget);
    void addActions(QWidget* widget, const QList<QAction*>& actionWhiteList);
 
    DCategorizedSortFilterProxyModel* createFilterModel() override;
 
    QStandardItem* itemForAction(QAction* action)   const;
    QModelIndex    indexForAction(QAction* action)  const;
 
    static QAction* actionForIndex(const QModelIndex& index);
 
public Q_SLOTS:
 
    void hover(const QModelIndex& index);
    void toggle(const QModelIndex& index);
    void trigger(const QModelIndex& index);
 
protected Q_SLOTS:
 
    void slotActionChanged();
 
protected:
 
    void setPropertiesFromAction(QStandardItem* item, QAction* action);
 
protected:
 
    MenuCategoryMode                  m_mode;
    DCategorizedSortFilterProxyModel* m_filterModel;
};
 
} // namespace Digikam
 
Q_DECLARE_OPERATORS_FOR_FLAGS(Digikam::ActionItemModel::MenuCategoryMode)
 
#endif // DIGIKAM_CATEGORIZED_ITEM_MODEL_H