Differential D21721 Diff 66944 src/qtquick/categoriesmodel.h

Changeset View

Standalone View

src/qtquick/categoriesmodel.h

This file was added.

1		/*
2		* Copyright (C) 2019 Dan Leinir Turthra Jensen <admin@leinir.dk>
3		*
4		* This library is free software; you can redistribute it and/or
5		* modify it under the terms of the GNU Lesser General Public
6		* License as published by the Free Software Foundation; either
7		* version 2.1 of the License, or (at your option) version 3, or any
8		* later version accepted by the membership of KDE e.V. (or its
9		* successor approved by the membership of KDE e.V.), which shall
10		* act as a proxy defined in Section 6 of version 3 of the license.
11		*
12		* This library is distributed in the hope that it will be useful,
13		* but WITHOUT ANY WARRANTY; without even the implied warranty of
14		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15		* Lesser General Public License for more details.
16		*
17		* You should have received a copy of the GNU Lesser General Public
18		* License along with this library. If not, see <http://www.gnu.org/licenses/>.
19		*
20		*/
21
22		#ifndef CATEGORIESMODEL_H
23		#define CATEGORIESMODEL_H
24
25		#include <QAbstractListModel>
26
27		#include "provider.h"
28		#include "quickengine.h"
29
30		/**
31		* @short A model which shows the categories found in an Engine
32		* @since 5.63
33		*/
34		class CategoriesModel : public QAbstractListModel
35		{
36		Q_OBJECT
37		public:
38		explicit CategoriesModel(Engine *parent = nullptr);
39		virtual ~CategoriesModel();
40
41		enum Roles {
42		NameRole = Qt::UserRole + 1,
43		IdRole,
44		DisplayNameRole
45		};
46		Q_ENUMS(Roles)
47
48		QHash< int, QByteArray > roleNames() const override;
49		QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const override;
50		int rowCount(const QModelIndex &parent = QModelIndex()) const override;
51
52		/**
53		* Get the display name for the category with the id passed to the function
54		*
55		* @param id The ID of the category you want to get the display name for
56		* @return The display name (or the translated string "Unknown Category" for the requested category
57		*/
58		Q_INVOKABLE QString idToDisplayName(const QString &id) const;
59		private:
60		class Private;
61		// TODO KF6: Switch all the pimpls to const std::unique_ptr<Private> d;
62		Private *d;
	ahiemstraUnsubmitted Done Suggestion: I use `const std::unique_ptr<Private> d;` these days, it removes the need to explicitly delete the d pointer. ahiemstra: Suggestion: I use `const std::unique_ptr<Private> d;` these days, it removes the need to…
	leinirAuthorUnsubmitted Not Done That sounds like something that'll want doing for KF6 as well, yes - i like the consistency, so just leaving it like this for now, but certainly something for the todo list :) leinir: That sounds like something that'll want doing for KF6 as well, yes - i like the consistency, so…
63		};
64
65		#endif//CATEGORIESMODEL_H