/*
  This file is part of libkldap.
  Copyright (c) 2006 Sean Harmer <sh@theharmers.co.uk>

  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 KLDAP_LDAPSTRUCTUREPROXYMODEL_H
#define KLDAP_LDAPSTRUCTUREPROXYMODEL_H

#include <QSortFilterProxyModel>

#include "kldap_export.h"

namespace KLDAP {

class KLDAP_EXPORT LdapStructureProxyModel : public QSortFilterProxyModel
{
  Q_OBJECT
  public:
    explicit LdapStructureProxyModel( QObject *parent = 0 );
    ~LdapStructureProxyModel();

    virtual QVariant data( const QModelIndex &index, int role ) const;
    /**
     * Reimplemented from QAbstractItemModel::setData(). This is a placeholder for when
     * LdapStructureProxyModel beomes writeable and always returns false.
     */
    virtual bool setData( const QModelIndex &index,
                          const QVariant &value,
                          int role = Qt::EditRole );
    virtual bool filterAcceptsRow( int sourceRow, const QModelIndex &sourceParent ) const;
    virtual QVariant headerData( int section, Qt::Orientation orientation, int role ) const;
    virtual int columnCount( const QModelIndex &parent ) const;
    virtual Qt::ItemFlags flags( const QModelIndex &index ) const;
    virtual bool hasChildren( const QModelIndex &parent ) const;

    virtual QModelIndex mapFromSource ( const QModelIndex & sourceIndex ) const;
    virtual QModelIndex mapToSource ( const QModelIndex & proxyIndex ) const;

    /**
     * Reimplemented from QAbstractItemModel::insertRows(). This is a placeholder for when
     * LdapStructureProxyModel beomes writeable and always returns false.
     */
    virtual bool insertRows( int row, int count,
                             const QModelIndex &parent = QModelIndex() );
    /**
     * Reimplemented from QAbstractItemModel::removeRows(). This is a placeholder for when
     * LdapStructureProxyModel beomes writeable and always returns false.
     */
    virtual bool removeRows( int row, int count,
                             const QModelIndex &parent = QModelIndex() );
    /**
     * Reimplemented from QAbstractItemModel::removeRows(). The default implementation
     * does nothing.
     */
    virtual void sort( int column, Qt::SortOrder order = Qt::AscendingOrder );

    //
    // Drag and drop support
    //
    /**
     * Reimplemented from QAbstractItemModel::supportedDropActions(). The default
     * implementation returns Qt::MoveAction.
     */
    virtual Qt::DropActions supportedDropActions() const;
    /**
     * Reimplemented from QAbstractItemModel::mimedata(). This is a placeholder for when
     * LdapStructureProxyModel beomes writeable and always returns 0.
     */
    virtual QMimeData *mimeData( const QModelIndexList &indexes ) const;
    /**
     * Reimplemented from QAbstractItemModel::dropMimedata(). This is a placeholder for when
     * LdapStructureProxyModel beomes writeable and always returns false.
     */
    virtual bool dropMimeData( const QMimeData *data, Qt::DropAction action,
                               int row, int column, const QModelIndex &parent );

  private:
    class LdapStructureProxyModelPrivate;
    LdapStructureProxyModelPrivate *const m_d;
};

}
#endif
