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
|
/*
SPDX-FileCopyrightText: 2007 Hamish Rodda <rodda@kde.org>
SPDX-License-Identifier: LGPL-2.0-or-later
*/
#ifndef KDEVPLATFORM_ISTATUS_H
#define KDEVPLATFORM_ISTATUS_H
#include "interfacesexport.h"
#include <QObject>
namespace KDevelop {
/**
* An interface for plugins, languages etc. to provide status updates.
* Plugins only have to implement this extension interface, registration
* happens automagically.
* Regular QObjects can register themselves through IUiController like so:
* @code
* Foo* f; // some QObject that implements IStatus
* ICore::self()->uiController()->registerStatus(f);
* @endcode
*/
class KDEVPLATFORMINTERFACES_EXPORT IStatus
{
public:
virtual ~IStatus();
/**
* Return a name for the status object
*/
virtual QString statusName() const = 0;
static constexpr int limitMessageToProgressItemStatus = -1;
Q_SIGNALS:
/**
* Request the current message for this plugin to be cleared.
*/
virtual void clearMessage( IStatus* ) = 0;
/**
* Request a status \a message to be shown for this plugin, with a given \a timeout.
*
* \param message Message to display
* \param timeout Timeout in milliseconds. Pass 0 for no timeout.
* Pass limitMessageToProgressItemStatus for no timeout and to prevent showing
* the message on the status bar (when there is no associated progress item).
*/
virtual void showMessage( IStatus*, const QString & message, int timeout = 0) = 0;
/**
* Request an error \a message to be shown for this plugin, with a given \a timeout.
*
* \param message Message to display
* \param timeout Timeout in seconds how long to show the message.
*/
virtual void showErrorMessage(const QString& message, int timeout = 5) = 0;
/**
* Hide the progress bar.
*/
virtual void hideProgress( IStatus* ) = 0;
/**
* Show a progress bar, with the given \a percentage.
*/
virtual void showProgress( IStatus*, int minimum, int maximum, int value) = 0;
};
}
Q_DECLARE_METATYPE(KDevelop::IStatus*)
Q_DECLARE_INTERFACE( KDevelop::IStatus, "org.kdevelop.IStatus" )
#endif
|
