entitymimetypefiltermodel.h

/*
    Copyright (c) 2007 Bruno Virlet <[email protected]>
    Copyright (c) 2009 Stephen Kelly <[email protected]>

    This library is free software; you can redistribute it and/or modify it
    under the terms of the GNU Library General Public License as published by
    the Free Software Foundation; either version 2 of the License, or (at your
    option) any later version.

    This library 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 Library General Public
    License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to the
    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
    02110-1301, USA.
*/

#ifndef AKONADI_ENTITYMIMETYPEFILTERMODEL_H
#define AKONADI_ENTITYMIMETYPEFILTERMODEL_H

#include "akonadicore_export.h"
#include "entitytreemodel.h"

#include <QSortFilterProxyModel>

namespace Akonadi
{

class EntityMimeTypeFilterModelPrivate;

class AKONADICORE_EXPORT EntityMimeTypeFilterModel : public QSortFilterProxyModel
{
    Q_OBJECT

public:
    explicit EntityMimeTypeFilterModel(QObject *parent = nullptr);

    ~EntityMimeTypeFilterModel() override;

    void addMimeTypeInclusionFilters(const QStringList &mimeTypes);

    void addMimeTypeExclusionFilters(const QStringList &mimeTypes);

    void addMimeTypeInclusionFilter(const QString &mimeType);

    void addMimeTypeExclusionFilter(const QString &mimeType);

    Q_REQUIRED_RESULT QStringList mimeTypeInclusionFilters() const;

    Q_REQUIRED_RESULT QStringList mimeTypeExclusionFilters() const;

    void clearFilters();

    void setHeaderGroup(EntityTreeModel::HeaderGroup headerGroup);

    QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const override;

    Q_REQUIRED_RESULT bool hasChildren(const QModelIndex &parent = QModelIndex()) const override;

    Q_REQUIRED_RESULT bool canFetchMore(const QModelIndex &parent) const override;

    Q_REQUIRED_RESULT QModelIndexList match(const QModelIndex &start, int role, const QVariant &value, int hits = 1, Qt::MatchFlags flags = Qt::MatchFlags(Qt::MatchStartsWith | Qt::MatchWrap)) const override;

    Q_REQUIRED_RESULT int columnCount(const QModelIndex &parent = QModelIndex()) const override;

protected:
    bool filterAcceptsRow(int sourceRow, const QModelIndex &sourceParent) const override;
    bool filterAcceptsColumn(int sourceColumn, const QModelIndex &sourceParent) const override;

private:
    //@cond PRIVATE
    Q_DECLARE_PRIVATE(EntityMimeTypeFilterModel)
    EntityMimeTypeFilterModelPrivate *const d_ptr;
    //@endcond
};

}

#endif