File indexing completed on 2025-01-19 03:56:06

 /* ============================================================
  *
  * This file is a part of digiKam project
  * https://www.digikam.org
  *
  * Date        : 2010-12-02
  * Description : Generic, standard item based model for DCategorizedView
  *
  * SPDX-FileCopyrightText: 2010-2011 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
  *
  * SPDX-License-Identifier: GPL-2.0-or-later
  *
  * ============================================================ */
 
 #ifndef DIGIKAM_CATEGORIZED_ITEM_MODEL_H
 #define DIGIKAM_CATEGORIZED_ITEM_MODEL_H
 
 // Qt includes
 
 #include <QFlags>
 #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
     {
         /// This role, per default, reflects the order in which items are added
         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
     {
         /// The toplevel menu's text is used as category
         ToplevelMenuCategory           = 1 << 0,
 
         /// If the action is in a submenu, this menu's text is taken as category
         ParentMenuCategory             = 1 << 1,
 
         /// Sort categories alphabetically by category name
         SortCategoriesAlphabetically   = 1 << 10,
 
         /// Sort categories by the order they are added (found in the scanned menu)
         SortCategoriesByInsertionOrder = 1 << 11
     };
     Q_DECLARE_FLAGS(MenuCategoryMode, MenuCategoryFlag)
 
 public:
 
     /**
      * This class is a CategorizedItemModel based on QActions, taking an action's text and icon
      * for display and decoration.
      * It is possible to retrieve an action for an index, and to call the action's slots from
      * a given index.
      */
     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;
 
     /**
      * Returns the action for the given index.
      * Note: these methods perform O(n).
      */
     QStandardItem* itemForAction(QAction* action)   const;
     QModelIndex    indexForAction(QAction* action)  const;
 
     /**
      * Returns the action for the given index.
      * The method can also be used for indices from proxy models.
      */
     static QAction* actionForIndex(const QModelIndex& index);
 
 public Q_SLOTS:
 
     /**
      * These three slots will cause the slots of the referred action to be called.
      * Connect here for example a view's signals.
      * Note that you can also pass indices from proxy models.
      */
     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