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
|
/*
SPDX-FileCopyrightText: 2009 Andreas Pakulat <apaku@gmx.de>
SPDX-License-Identifier: LGPL-2.0-or-later
*/
#ifndef KDEVPLATFORM_ISELECTIONCONTROLLER_H
#define KDEVPLATFORM_ISELECTIONCONTROLLER_H
#include <QObject>
#include "interfacesexport.h"
namespace KDevelop
{
class Context;
/**
* The main controller for selection updates in the GUI.
*
* This controller can be used by selection consumers and selection providers.
*
* A selection provider (for example a treeview for the projects) should
* call updateSelection() with an appropriate context filled with the details
* of the selection
*
* A selection consumer who is interested in notifications when the selection has
* been changed, should connect to the selectionChanged signal. The consumer should
* retrieve all necessary information that it might need to do something with the
* selection and store those. Storing the whole Context* might be dangerous as it
* will be deleted on the next selection change.
*
*/
class KDEVPLATFORMINTERFACES_EXPORT ISelectionController : public QObject
{
Q_OBJECT
public:
///Constructor.
explicit ISelectionController(QObject *parent);
~ISelectionController() override;
/**
* Provides the current selection, note that this might be 0
*/
virtual Context* currentSelection() = 0;
public Q_SLOTS:
/**
* updates the current selection.
* The SelectionController takes ownership of the given context and
* deletes it when the selection is updated the next time.
* @param context the new selection
*/
virtual void updateSelection( Context* context ) = 0;
Q_SIGNALS:
/**
* Notify that the current selection changed.
* @note The context might be deleted behind the back (when a new selection
* is set) of the receivers of this signal, so make sure to copy all the
* needed information.
*/
void selectionChanged( KDevelop::Context* );
};
}
#endif // KDEVPLATFORM_ISELECTIONCONTROLLER_H
|
