File indexing completed on 2024-05-12 05:06:15

 /*
     SPDX-FileCopyrightText: 2019 Thomas Baumgart <tbaumgart@kde.org>
     SPDX-License-Identifier: GPL-2.0-or-later
 */
 
 #ifndef ITEMRENAMEPROXYMODEL_H
 #define ITEMRENAMEPROXYMODEL_H
 
 #include "kmm_models_export.h"
 
 // ----------------------------------------------------------------------------
 // QT Includes
 
 #include <QSortFilterProxyModel>
 
 // ----------------------------------------------------------------------------
 // KDE Includes
 
 // ----------------------------------------------------------------------------
 // Project Includes
 
 
 /**
   * A proxy model to provide in view rename for an item .
   *
   * /// @todo update description
   *
   * Here is an example of how to use this class in combination with the @ref institutionsModel.
   * (in the example @a widget is a pointer to a model/view widget):
   *
   * @code
   *   InstitutionsFilterProxyModel *filterModel = new InstitutionsFilterProxyModel(widget);
   *   filterModel->setSourceModel(MyMoneyFile::instance()->institutionsModel());
   *   filterModel->sort(0);
   *
   *   widget->setModel(filterModel);
   * @endcode
   *
   * @author Thomas Baumgart
   *
   */
 
 class KMM_MODELS_EXPORT ItemRenameProxyModel : public QSortFilterProxyModel
 {
     Q_OBJECT
     Q_DISABLE_COPY(ItemRenameProxyModel)
 
 public:
     typedef enum  {
         eAllItem = 0,
         eReferencedItems,
         eUnReferencedItems,
         eOpenedItems,
         eClosedItems,
         // insert new values above this line
         eMaxItems,
     } ReferenceFilterType;
 
     explicit ItemRenameProxyModel(QObject *parent = nullptr);
     virtual ~ItemRenameProxyModel();
 
     bool setData(const QModelIndex& idx, const QVariant& value, int role) override;
 
     Qt::ItemFlags flags(const QModelIndex& idx) const override;
     void setRenameColumn(int column);
 
     void setReferenceFilter(ReferenceFilterType filterType);
     void setReferenceFilter(const QVariant& filterType);
 
     ReferenceFilterType referenceFilter() const;
 
 protected:
     virtual bool filterAcceptsRow(int source_row, const QModelIndex &source_parent) const override;
 
 Q_SIGNALS:
     void renameItem(const QModelIndex& idx, const QVariant& value);
 
 private:
     int                   m_renameColumn;
     ReferenceFilterType   m_referenceFilter;
 };
 
 #endif