NameFilterProxyModel.h

/***************************************************************************
 *   Copyright (C) 2026 by Stefan Kebekus                                  *
 *   stefan.kebekus@gmail.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 3 of the License, 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.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
 
#pragma once
 
#include <QQmlEngine>
#include <QSortFilterProxyModel>
 
namespace Ui {

struct QSortFilterProxyModelForeign
{
    Q_GADGET
    QML_FOREIGN(QSortFilterProxyModel)
    QML_ANONYMOUS
};
 

 
class NameFilterProxyModel : public QSortFilterProxyModel
{
    Q_OBJECT
    QML_ELEMENT
 
public:
    explicit NameFilterProxyModel(QObject* parent = nullptr);
 
    // Default destructor
    ~NameFilterProxyModel() override = default;
 
 
    //
    // Properties
    //

    Q_PROPERTY(QString filter READ filter WRITE setFilter NOTIFY filterChanged)
 
    
    Q_PROPERTY(QString filterRoleName READ filterRoleName WRITE setFilterRoleName NOTIFY filterRoleNameChanged)

    Q_PROPERTY(bool filterRoleIsSimplified READ filterRoleIsSimplified WRITE setFilterRoleIsSimplified NOTIFY filterRoleIsSimplifiedChanged)
 
 
    //
    // Getter Methods
    //

    [[nodiscard]] QString filter() const { return m_filter; }

    [[nodiscard]] QString filterRoleName() const { return m_filterRoleName; }

    [[nodiscard]] bool filterRoleIsSimplified() const { return m_filterRoleIsSimplified; }
 
 
    //
    // Setter Methods
    //

    void setFilter(const QString& newFilter);

    void setFilterRoleName(const QString& newFilterRoleName);

    void setFilterRoleIsSimplified(bool newValue);
 
 
    //
    // Methods
    //

    void setSourceModel(QAbstractItemModel* newSourceModel) override;
 
signals:
    void filterChanged();

    void filterRoleNameChanged();

    void filterRoleIsSimplifiedChanged();
 
protected:
    [[nodiscard]] bool filterAcceptsRow(int sourceRow, const QModelIndex& sourceParent) const override;

    [[nodiscard]] int roleForName(const QString& roleName) const;
 
private:
    Q_DISABLE_COPY_MOVE(NameFilterProxyModel)
 
    QString m_filter;
    QString m_filterRoleName {QStringLiteral("name")};
 
    // Role matching m_filterRoleName in the current source model, or -1
    int m_filterRole {-1};
 
    bool m_filterRoleIsSimplified {false};
 
    // Librarian::filterWords(m_filter), recomputed in setFilter()
    QStringList m_filterWords;
};
 
} // namespace Ui