1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
|
/*
SPDX-FileCopyrightText: 2015 Laszlo Kis-Adam <laszlo.kis-adam@kdemail.net>
SPDX-License-Identifier: LGPL-2.0-or-later
*/
#ifndef PROBLEMMODELSET_H
#define PROBLEMMODELSET_H
#include <shell/shellexport.h>
#include <QObject>
namespace KDevelop
{
class ProblemModel;
class ProblemModelSetPrivate;
/// Struct that handles the model and it's name as one unit, stored in ProblemModelSet
struct ModelData
{
QString id;
QString name;
ProblemModel *model;
};
/**
* @brief Stores name/model pairs and emits signals when they are added/removed.
*
* Typically it's used from plugins, which maintains a reference to the model added.
* Therefore It assumes that models get removed, so it doesn't delete!
*
* Usage example:
* @code
* ProblemModelSet *set = new ProblemModelSet();
* ProblemModel *model = new ProblemModel(nullptr);
* set->addModel(QStringLiteral("MODEL_ID"), QStringLiteral("MODEL"), model); // added() signal is emitted
* set->models().count(); // returns 1
* set->findModel(QStringLiteral("MODEL_ID")); // returns the model just added
* set->removeModel(QStringLiteral("MODEL_ID")); // removed() signal is emitted
* @endcode
*
*/
class KDEVPLATFORMSHELL_EXPORT ProblemModelSet : public QObject
{
Q_OBJECT
public:
explicit ProblemModelSet(QObject *parent = nullptr);
~ProblemModelSet() override;
/// Adds a model
void addModel(const QString &id, const QString &name, ProblemModel *model);
/// Finds a model
ProblemModel* findModel(const QString &id) const;
/// Removes a model
void removeModel(const QString &id);
/// Show model in ProblemsView
void showModel(const QString &id);
/// Retrieves a list of models stored
QVector<ModelData> models() const;
Q_SIGNALS:
/// Emitted when a new model is added
void added(const ModelData &model);
/// Emitted when a model is removed
void removed(const QString &id);
/// Emitted when showModel() is called
void showRequested(const QString &id);
/// Emitted when any model emits problemsChanged()
void problemsChanged();
private:
const QScopedPointer<class ProblemModelSetPrivate> d_ptr;
Q_DECLARE_PRIVATE(ProblemModelSet)
};
}
Q_DECLARE_TYPEINFO(KDevelop::ModelData, Q_MOVABLE_TYPE);
#endif
|
