qabstractfiltermodel.h

/******************************************************************************
** This file is part of qadvanceditemviews.
**
** Copyright (c) 2011-2012 Martin Hoppe martin@2x2hoppe.de
**
** qadvanceditemviews is free software: you can redistribute it
** and/or modify it under the terms of the GNU Lesser General
** Public License as published by the Free Software Foundation,
** either version 3 of the License, or (at your option) any
** later version.
**
** qadvanceditemviews 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 Lesser General Public
** License along with qadvanceditemviews.
** If not, see <http://www.gnu.org/licenses/>.
******************************************************************************/
#ifndef QABSTRACTFILTERMODEL_H
#define QABSTRACTFILTERMODEL_H

#include <QAbstractItemModel>
#include <QAction>
#include <QMenu>

#include <qaiv.h>
#include <qaivlib_global.h>

class QAbstractFilterProxyModel;
class QAbstractFilter;
class QFilterGroup;

class QAbstractFilterModelPrivate;


class QAIVLIBSHARED_EXPORT QAbstractFilterModel : public QAbstractItemModel
{
    Q_OBJECT
public:
    struct FilterTypeEntry {
        int type;
        QIcon icon;
        QString text;
        QString tooltip;
    };
    enum ItemDataRole {
        ValueFilterTypeRole = Qt::UserRole + 42        
        ,DefaultFilterTypeRole
        ,ColumnFilterTypesRole
    };
    QAbstractFilterModel(QObject* parent = 0);
    ~QAbstractFilterModel();
    int columnCount(const QModelIndex & parent = QModelIndex()) const;
    virtual QAbstractFilter* createFilter(const QModelIndex & index, const QVariantMap & properties) const = 0;
    QVariant data( const QModelIndex & index, int role = Qt::DisplayRole ) const;
    QFilterGroup* filterGroup(const QModelIndex & index) const;
    QFilterGroup* groupAt(int row) const;
    QAbstractFilter* filter(const QModelIndex & index) const;
        QIcon filterDisabledIcon() const;
        QIcon filterEnabledIcon() const;
    QList<QAbstractFilter*> filtersAtRow(int row) const;
    Qt::ItemFlags flags(const QModelIndex & index) const;

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

    QModelIndex index(int row, int column, const QModelIndex & parent = QModelIndex()) const;

    bool insertRows(int row, int count, const QModelIndex & parent = QModelIndex());

    QAdvancedItemViews::FilterMatchMode matchMode() const;

    QAdvancedItemViews::FilterProxyMode mode() const;
    QModelIndex parent(const QModelIndex & index) const;
    QList<FilterTypeEntry> registeredFilterTypes() const;

    bool removeRows(int row, int count, const QModelIndex & parent = QModelIndex());

    int rowCount( const QModelIndex & parent = QModelIndex() ) const;

    bool setData( const QModelIndex & index, const QVariant & value, int role = Qt::EditRole );
    void setDefaultFilterType(int column, int type);
        void setFilterDisabledIcon(const QIcon & icon);
        void setFilterEnabledIcon(const QIcon & icon);
    bool setHeaderData (int section, Qt::Orientation orientation, const QVariant & value, int role = Qt::EditRole);

    void setMatchMode(QAdvancedItemViews::FilterMatchMode flag);

    void setMode(QAdvancedItemViews::FilterProxyMode mode);
    void setSourceModel(QAbstractItemModel* model);
    QAbstractItemModel* sourceModel() const;
signals:
    void matchModeChanged(QAdvancedItemViews::FilterMatchMode mode);
    void modeChanged(QAdvancedItemViews::FilterProxyMode mode);
protected:
    bool registerFilter(int type, const QString & text, const QString & toolTip = QString());
    bool registerFilter(int type, const QIcon & icon, const QString & text, const QString & toolTip = QString());
private slots:
        void sourceModelLayoutChanged();
private:
    QAbstractFilterModelPrivate* d;
};

#endif // QABSTRACTFILTERMODEL_H