/***************************************************************************
 *   Copyright (C) 2014-2015 by Eike Hein <hein@kde.org>                   *
 *   Copyright (C) 2016-2017 by Ivan Cukic <ivan.cukic@kde.org>            *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   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 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 FAVORITESMODEL_H
#define FAVORITESMODEL_H

#include "placeholdermodel.h"

#include <QPointer>

#include <KService>
#include <KConfig>

class PlaceholderModel;

namespace KActivities {
    class Consumer;
namespace Stats {
    class ResultModel;
namespace Terms {
    class Activity;
} // namespace Terms
} // namespace Stats
} // namespace KActivities

class KAStatsFavoritesModel : public PlaceholderModel
{
    Q_OBJECT

    Q_PROPERTY(bool enabled READ enabled WRITE setEnabled NOTIFY enabledChanged)
    Q_PROPERTY(QStringList favorites READ favorites WRITE setFavorites NOTIFY favoritesChanged)
    Q_PROPERTY(int maxFavorites READ maxFavorites WRITE setMaxFavorites NOTIFY maxFavoritesChanged)

    Q_PROPERTY(QObject* activities READ activities CONSTANT)

    public:
        explicit KAStatsFavoritesModel(QObject *parent = 0);
        ~KAStatsFavoritesModel();

        QString description() const;

        Q_INVOKABLE bool trigger(int row, const QString &actionId, const QVariant &argument);

        bool enabled() const;
        void setEnabled(bool enable);

        QStringList favorites() const;
        void setFavorites(const QStringList &favorites);

        int maxFavorites() const;
        void setMaxFavorites(int max);

        Q_INVOKABLE bool isFavorite(const QString &id) const;

        Q_INVOKABLE void addFavorite(const QString &id, int index = -1);
        Q_INVOKABLE void removeFavorite(const QString &id);

        Q_INVOKABLE void addFavoriteTo(const QString &id, const QString &activityId, int index = -1);
        Q_INVOKABLE void removeFavoriteFrom(const QString &id, const QString &activityId);

        Q_INVOKABLE void setFavoriteOn(const QString &id, const QString &activityId);

        Q_INVOKABLE void portOldFavorites(const QStringList &ids);

        Q_INVOKABLE QStringList linkedActivitiesFor(const QString &id) const;

        Q_INVOKABLE void moveRow(int from, int to);

        Q_INVOKABLE void initForClient(const QString &client);

        QObject *activities() const;
        Q_INVOKABLE QString activityNameForId(const QString &activityId) const;

        AbstractModel* favoritesModel();

    public Q_SLOTS:
        virtual void refresh();

    Q_SIGNALS:
        void enabledChanged() const;
        void favoritesChanged() const;
        void maxFavoritesChanged() const;

    private:
        class Private;
        Private * d;

        AbstractEntry *favoriteFromId(const QString &id) const;

        void addFavoriteTo(const QString &id, const KActivities::Stats::Terms::Activity &activityId, int index = -1);
        void removeFavoriteFrom(const QString &id, const KActivities::Stats::Terms::Activity &activityId);

        bool m_enabled;

        int m_maxFavorites;

        KActivities::Consumer *m_activities;
};

#endif
