/****************************************************************************
 *    Copyright (C) 2013-2019 Savoir-faire Linux Inc.                          *
 *   Author : Emmanuel Lepage Vallee <emmanuel.lepage@savoirfairelinux.com> *
 *                                                                          *
 *   This library 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 2.1 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      *
 *   Lesser General Public License for more details.                        *
 *                                                                          *
 *   You should have received a copy of the GNU General Public License      *
 *   along with this program.  If not, see <http://www.gnu.org/licenses/>.  *
 ***************************************************************************/
#pragma once

#include <QtCore/QHash>
#include <QtCore/QStringList>
#include <QtCore/QAbstractItemModel>

//Ring
#include "typedefs.h"
#include "person.h"
class PersonModel;
class ContactTreeNode;
class TopLevelItem;
class ContactTreeBinder;
class CategorizedContactModelPrivate;
class QSortFilterProxyModel;
class QItemSelectionModel;

class LIB_EXPORT CategorizedContactModel :  public QAbstractItemModel
{
   #pragma GCC diagnostic push
   #pragma GCC diagnostic ignored "-Wzero-as-null-pointer-constant"
   Q_OBJECT
   #pragma GCC diagnostic pop
public:
   friend class PersonModel      ;
   friend class ContactTreeNode  ;
   friend class ContactTreeBinder;
   friend class SortedProxy      ;

   virtual ~CategorizedContactModel();

   //Setters
   void setRole             ( int role           );
   void setSortAlphabetical ( bool alpha = true  );
   void setDefaultCategory  ( const QString& cat );
   void setUnreachableHidden( bool value         );

   //Model implementation
   virtual bool          setData     ( const QModelIndex& index, const QVariant &value, int role      )       override;
   virtual bool          dropMimeData( const QMimeData*, Qt::DropAction, int, int, const QModelIndex& )       override;
   virtual QVariant      data        ( const QModelIndex& index, int role = Qt::DisplayRole           ) const override;
   virtual int           rowCount    ( const QModelIndex& parent = QModelIndex()                      ) const override;
   virtual Qt::ItemFlags flags       ( const QModelIndex& index                                       ) const override;
   virtual int           columnCount ( const QModelIndex& parent = QModelIndex()                      ) const override;
   virtual QModelIndex   parent      ( const QModelIndex& index                                       ) const override;
   virtual QModelIndex   index       ( int row, int column, const QModelIndex& parent=QModelIndex()   ) const override;
   virtual QStringList   mimeTypes   (                                                                ) const override;
   virtual QMimeData*    mimeData    ( const QModelIndexList &indexes                                 ) const override;
   virtual QVariant      headerData  ( int section, Qt::Orientation orientation, int role = Qt::DisplayRole ) const override;
   virtual QHash<int,QByteArray> roleNames() const override;

   //Getter
   static int acceptedPayloadTypes()      ;
   bool       isSortAlphabetical  () const;
   QString    defaultCategory     () const;
   bool       areUnreachableHidden() const;

   struct SortedProxy {
      enum class Categories {
         NAME        ,
         ORGANIZATION,
         RECENTLYUSED,
         GROUP       ,
         DEPARTMENT  ,
         COUNT__
      };

      QSortFilterProxyModel* model                 () const;
      QAbstractItemModel   * categoryModel         () const;
      QItemSelectionModel  * categorySelectionModel() const;
      static CategorizedContactModel::SortedProxy& instance();
   };

   //Singleton
   static CategorizedContactModel& instance();

private:
   explicit CategorizedContactModel(int role = Qt::DisplayRole);

   QScopedPointer<CategorizedContactModelPrivate> d_ptr;
   Q_DECLARE_PRIVATE(CategorizedContactModel)
};

