/****************************************************************************
 *   Copyright (C) 2013-2016 by Savoir-faire Linux                          *
 *   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 "typedefs.h"

#include <QtCore/QAbstractListModel>
#include <QtCore/QVector>
#include "collectionmanagerinterface.h"

class ContactMethod;
class NumberCategory;
class NumberCategoryModelPrivate;

/**
 * This class manage the ContactMethod categories. Those are usually associated
 * with PhoneNumber types used by contacts.
 *
 * The model is mostly for debugging purpose. The information is also available
 * in the CollectionModel.
 */
class LIB_EXPORT NumberCategoryModel : public QAbstractListModel, public CollectionManagerInterface<ContactMethod> {
   Q_OBJECT
public:
   friend class NumberCategory;
   friend class ContactMethod ;

   enum Role {
      KEY = 100,
   };

   //Abstract model member
   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 bool          setData  (const QModelIndex& index, const QVariant &value, int role)       override;
   virtual QHash<int,QByteArray> roleNames() const override;

   //Mutator
   NumberCategory* addCategory(const QString& name, const QVariant& icon, int key = -1);

   //Singleton
   static NumberCategoryModel& instance();

   //Getter
   QModelIndex     nameToIndex(const QString& name       ) const;
   NumberCategory* getCategory(const QString& type       ) const;
   NumberCategory* getCategory(const QModelIndex& index  ) const;
   NumberCategory* forKey     (int   key                 ) const;

   static NumberCategory* other();

   virtual ~NumberCategoryModel();
private:
   explicit NumberCategoryModel(QObject* parent = nullptr);

   NumberCategoryModelPrivate* d_ptr;

   //Re-implementation
   virtual void collectionAddedCallback(CollectionInterface* collection) override;
   virtual bool addItemCallback        (const ContactMethod* item      ) override;
   virtual bool removeItemCallback     (const ContactMethod* item      ) override;
};

