plasma-framework/appletbrowser/kcategorizeditemsviewmodels_p.h

/*
 *   Copyright (C) 2007 Ivan Cukic <ivan.cukic+kde@gmail.com>
 *
 *   This program is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License version 2 (or,
 *   at your option, any later version) as published by the Free Software
 *   Foundation
 *
 *   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 Library General Public
 *   License along with this program; if not, write to the
 *   Free Software Foundation, Inc.,
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */

#ifndef KCATEGORIZEDITEMSVIEWMODELS_H_
#define KCATEGORIZEDITEMSVIEWMODELS_H_

#include <QtGui>
#include <QtCore>
#include <KIcon>
#include <KDebug>
namespace KCategorizedItemsViewModels {

typedef QPair<QString, QVariant> Filter;

/**
 * Abstract class that needs to be implemented and used with the ItemModel
 */
class AbstractItem : public QStandardItem
{
public:
    /**
     * Returns a localized string - name of the item 
     */
    virtual QString name() const;

    /**
     * Returns a localized string - description of the item 
     */
    virtual QString description() const;

    /**
     * Returns if the item is flagged as favorite
     * Default implementation checks if the item passes the Filter("favorite", "1") filter 
     */
    virtual bool isFavorite() const;

    /**
     * Returns if the item contains string specified by pattern.
     * Default implementation checks whether name or description contain the
     * string (not needed to be exactly that string) 
     */
    virtual bool matches(const QString & pattern) const;

    /**
     * sets the favorite flag for the item 
     */
    virtual void setFavorite(bool favorite) = 0;

    /**
     * Returns if the item passes the filter specified 
     */
    virtual bool passesFiltering(const Filter & filter) const = 0;
private:
};

/**
 * The default implementation of the model containing filters
 */
class DefaultFilterModel : public QStandardItemModel
{
public:
    DefaultFilterModel(QObject * parent = 0);

    /**
     * Adds a filter to the model 
     * @param caption The localized string to be displayed as a name of the filter
     * @param filter The filter structure
     */
    void addFilter(const QString & caption, const Filter & filter, const KIcon * icon = NULL);

    /**
     * Adds a separator to the model 
     * @param caption The localized string to be displayed as a name of the separator
     */
    void addSeparator(const QString & caption);
};

/**
 * Default filter proxy model.
 */
class DefaultItemFilterProxyModel : public QSortFilterProxyModel
{
public:
    DefaultItemFilterProxyModel(QObject * parent = 0);

    bool filterAcceptsRow(int sourceRow, const QModelIndex &sourceParent) const;
    bool lessThan(const QModelIndex &left, const QModelIndex &right) const;

    void setSearch(const QString & pattern);
    void setFilter(const Filter & filter);

    void setSourceModel(QStandardItemModel * sourceModel);

    QStandardItemModel * sourceModel() const;

    int columnCount(const QModelIndex& index) const;

    QVariant data(const QModelIndex & index, int role = Qt::DisplayRole) const;

private:

    class InnerProxyModel : public QAbstractItemModel
    {
    public:
        InnerProxyModel(QObject * parent = 0);

        Qt::ItemFlags flags(const QModelIndex & index) const;

        QVariant data(const QModelIndex & index, bool favoriteColumn,
                int role = Qt::DisplayRole) const;
        QVariant data(const QModelIndex & index, int role = Qt::DisplayRole) const;
        bool setData(const QModelIndex & index, const QVariant & value,
                int role = Qt::EditRole);

        QVariant headerData(int section, Qt::Orientation orientation,
                int role = Qt::DisplayRole) const;
        bool setHeaderData(int section, Qt::Orientation orientation,
                const QVariant & value, int role = Qt::EditRole);

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


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

        QMimeData * mimeData(const QModelIndexList & indexes) const;

        void setSourceModel(QStandardItemModel * sourceModel);
        QStandardItemModel * sourceModel() const;

    private:
        QStandardItemModel * m_sourceModel;
    };

    Filter m_filter;
    QString m_searchPattern;
    InnerProxyModel m_innerModel;

};

/**
 * The default implementation of the model containing items. It /is/ QStandardItemModel
 */
class DefaultItemModel : public QStandardItemModel
{
public:
    DefaultItemModel(QObject * parent = 0);
};

}

Q_DECLARE_METATYPE(KCategorizedItemsViewModels::Filter)

#endif /*KCATEGORIZEDITEMSVIEWMODELS_H_*/