Differential D3805 Diff 19034 applets/kicker/plugin/kastatsfavoritesmodel.h

Changeset View

Standalone View

applets/kicker/plugin/kastatsfavoritesmodel.h

This file was added.

1		/***************************************************************************
2		* Copyright (C) 2014-2015 by Eike Hein <hein@kde.org> *
3		* Copyright (C) 2016-2017 by Ivan Cukic <ivan.cukic@kde.org> *
4		* *
5		* This program is free software; you can redistribute it and/or modify *
6		* it under the terms of the GNU General Public License as published by *
7		* the Free Software Foundation; either version 2 of the License, or *
8		* (at your option) any later version. *
9		* *
10		* This program is distributed in the hope that it will be useful, *
11		* but WITHOUT ANY WARRANTY; without even the implied warranty of *
12		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13		* GNU General Public License for more details. *
14		* *
15		* You should have received a copy of the GNU General Public License *
16		* along with this program; if not, write to the *
17		* Free Software Foundation, Inc., *
18		* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA . *
19		***************************************************************************/
20
21		#ifndef FAVORITESMODEL_H
22		#define FAVORITESMODEL_H
23
24		#include "placeholdermodel.h"
25
26		#include <QPointer>
27
28		#include <KService>
29		#include <KConfig>
30
31		class PlaceholderModel;
32
33		namespace KActivities {
34		class Consumer;
35		namespace Stats {
36		class ResultModel;
37		namespace Terms {
38		class Activity;
39		} // namespace Terms
40		} // namespace Stats
41		} // namespace KActivities
42
43		class KAStatsFavoritesModel : public PlaceholderModel
44		{
45		Q_OBJECT
46
	martUnsubmitted Not Done just a line of comments for each property would help a lot for future reference mart: just a line of comments for each property would help a lot for future reference
	ivanAuthorUnsubmitted Not Done That is copied from the old model. Most of them are for back-compatibility. Will see what to do with them. ivan: That is copied from the old model. Most of them are for back-compatibility. Will see what to do…
47		Q_PROPERTY(bool enabled READ enabled WRITE setEnabled NOTIFY enabledChanged)
48		Q_PROPERTY(QStringList favorites READ favorites WRITE setFavorites NOTIFY favoritesChanged)
49		Q_PROPERTY(int maxFavorites READ maxFavorites WRITE setMaxFavorites NOTIFY maxFavoritesChanged)
50
51		Q_PROPERTY(QObject* activities READ activities CONSTANT)
52
53		public:
54		explicit KAStatsFavoritesModel(QObject *parent = 0);
55		~KAStatsFavoritesModel();
56
57		QString description() const;
58
59		Q_INVOKABLE bool trigger(int row, const QString &actionId, const QVariant &argument);
60
61		bool enabled() const;
62		void setEnabled(bool enable);
63
64		QStringList favorites() const;
65		void setFavorites(const QStringList &favorites);
66
67		int maxFavorites() const;
68		void setMaxFavorites(int max);
69
70		Q_INVOKABLE bool isFavorite(const QString &id) const;
71
72		Q_INVOKABLE void addFavorite(const QString &id, int index = -1);
73		Q_INVOKABLE void removeFavorite(const QString &id);
74
75		Q_INVOKABLE void addFavoriteTo(const QString &id, const QString &activityId, int index = -1);
76		Q_INVOKABLE void removeFavoriteFrom(const QString &id, const QString &activityId);
77
78		Q_INVOKABLE void addFavorites(const QStringList &ids, int index = -1);
79		Q_INVOKABLE void addFavoritesTo(const QStringList &ids, const QString &activityId, int index = -1);
80
81		Q_INVOKABLE QStringList linkedActivitiesFor(const QString &id) const;
82
83		Q_INVOKABLE void moveRow(int from, int to);
84
85		Q_INVOKABLE void initForClient(const QString &client);
86
87		QObject *activities() const;
88		Q_INVOKABLE QString activityNameForId(const QString &activityId) const;
89
90		AbstractModel* favoritesModel();
91
92		public Q_SLOTS:
93		virtual void refresh();
94
95		Q_SIGNALS:
96		void enabledChanged() const;
97		void favoritesChanged() const;
98		void maxFavoritesChanged() const;
99
100		private:
101		class Private;
102		Private * d;
103
104		AbstractEntry *favoriteFromId(const QString &id) const;
105
106		void addFavoriteTo(const QString &id, const KActivities::Stats::Terms::Activity &activityId, int index = -1);
107		void removeFavoriteFrom(const QString &id, const KActivities::Stats::Terms::Activity &activityId);
108
109		bool m_enabled;
110
111		int m_maxFavorites;
112
113		KActivities::Consumer *m_activities;
114		};
115
116		#endif