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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
|
/**
*
* This file is part of Tulip (www.tulip-software.org)
*
* Authors: David Auber and the Tulip development Team
* from LaBRI, University of Bordeaux 1 and Inria Bordeaux - Sud Ouest
*
* Tulip is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation, either version 3
* of the License, or (at your option) any later version.
*
* Tulip is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU General Public License for more details.
*
*/
// +-------------------------------------------------------------------------+
// | Tulip Python Bindings |
// | inspired from bindings by the Booggie project development team |
// | (http://booggie.org/) |
// +-------------------------------------------------------------------------+
namespace tlp {
enum ProgressState{TLP_CONTINUE, TLP_CANCEL , TLP_STOP };
class PluginProgress /Abstract/ {
%TypeHeaderCode
#include <tulip/PluginProgress.h>
%End
public:
%Docstring
This interface allows to notify and control the progression of a process.
%End
%ConvertToSubClassCode
if (dynamic_cast<tlp::SimplePluginProgress*>(sipCpp)) {
sipType = sipFindType("tlp::SimplePluginProgress");
} else {
sipType = NULL;
}
%End
PluginProgress();
virtual tlp::ProgressState progress(int step, int max_step) = 0;
%Docstring
tlp.PluginProgress.progress(step, maxStep)
Use this method to notify the progression of the process.
:param step: the current step number
:type step: integer
:param maxStep: the total number of steps
:type maxStep: integer
:rtype: a value indicating whether the progress has been stopped (:const:`tlp.TLP_STOP`), cancelled (:const:`tlp.TLP_CANCEL`), or will continue (:const:`tlp.TLP_CONTINUE`).
%End
virtual void cancel() = 0;
%Docstring
tlp.PluginProgress.cancel()
Sets the state flag to cancel, notifying to the process that the user wants to cancel it.
Canceling a process must stop it and revert all the changes performed since its start.
%End
virtual void stop() = 0;
%Docstring
tlp.PluginProgress.stop()
Sets the state flag to stop, notifying to the process that the user wants to stop it.
Stopping a process does not revert changes.
%End
virtual bool isPreviewMode() const = 0;
%Docstring
tlp.PluginProgress.isPreviewMode()
Returns :const:`True` if the preview mode is enabled.
The preview mode redraws the graph while applying the algorithm, making it slower.
:rtype: boolean
%End
virtual void setPreviewMode(bool) = 0;
%Docstring
tlp.PluginProgress.setPreviewMode(preview)
Enables / disables the preview mode.
The preview mode redraws the graph while applying the algorithm, making it slower.
:param preview: indicates if the preview mode should be activated
:type preview: boolean
%End
virtual void showPreview(bool) = 0;
%Docstring
tlp.PluginProgress.showPreview(showPreview)
This tells the widget associated to this PluginProgress if it should show a preview checkbox,
allowing the user to decide if the algorithm should draw a preview or not.
:param showPreview: whether the progress widget should contain a preview checkbox or not.
:type showPreview: boolean
%End
virtual tlp::ProgressState state() const = 0;
%Docstring
tlp.PluginProgress.state()
Gets the current internal state of the PluginProgress.
:rtype: a value indicating whether the progress has been stopped (:const:`tlp.TLP_STOP`), cancelled (:const:`tlp.TLP_CANCEL`), or will continue (:const:`tlp.TLP_CONTINUE`).
%End
virtual std::string getError() = 0;
%Docstring
tlp.PluginProgress.getError()
Returns a message describing the error encountered during the process.
If no error has been encountered, an empty string is returned.
:rtype: string
%End
virtual void setError(std::string error) = 0;
%Docstring
tlp.PluginProgress.setError(errorMsg)
Sets the message describing the error encountered during the process.
:param errorMsg: the error message to set
:type errorMsg: string
%End
virtual void setComment(std::string msg) = 0;
%Docstring
tlp.PluginProgress.setComment(msg)
Changes the comment about the process progression.
:param msg: A description of what the process is currently doing, displayed to inform the user.
:type msg: string
%End
};
class SimplePluginProgress : tlp::PluginProgress {
%TypeHeaderCode
#include <tulip/SimplePluginProgress.h>
%End
public:
SimplePluginProgress();
virtual tlp::ProgressState progress(int step, int max_step);
virtual void cancel();
virtual void stop();
virtual bool isPreviewMode() const ;
virtual void setPreviewMode(bool);
virtual void showPreview(bool);
virtual tlp::ProgressState state() const;
virtual std::string getError();
virtual void setError(const std::string& error);
virtual void setComment(const std::string&);
virtual void setTitle(const std::string&);
};
};
|
