| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tlp::PluginProgress Class Reference Interface to notify and control the progression of a process. More...
Inheritance diagram for tlp::PluginProgress:
![]()
Detailed DescriptionInterface to notify and control the progression of a process. To notify the progression use the progress function. You can ask progress->setComment("First step");
for(int i = 0 ; i<50 ;++i){
//Perform some actions
//.....
//Check internal state
if(progress->state()!=TLP_CONTINUE){
//User want to stop the process
break;
}
//Notify progression.
progress->progress(i,50);
}
//Delete the progress once you're done with it
delete progress;
Constructor & Destructor Documentation
Member Function Documentation
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.
Implemented in tlp::SimplePluginProgress.
Returns a message describing the error encountered during the process. If no error has been encountered, an empty string is returned.
Implemented in tlp::SimplePluginProgress.
The preview mode redraws the graph while applying the algorithm, making it slower.
Implemented in tlp::SimplePluginProgress.
Notify the progression of the process.
Implemented in tlp::SimplePluginProgress.
Changes the comment about the process progression.
Implemented in tlp::SimplePluginProgress.
Sets the message describing the error encountered during the process.
Implemented in tlp::SimplePluginProgress.
The preview mode redraws the graph while applying the algorithm, making it slower.
Implemented in tlp::SimplePluginProgress.
This tells the widget if it should show a preview checkbox, allowing the user to decide if the algorithm should draw a preview or not.
Implemented in tlp::SimplePluginProgress.
Gets the current internal state of the PluginProgress.
Implemented in tlp::SimplePluginProgress.
Sets the state flag to stop, notifying to the process that the user wants to stop it. Stopping a process does not revert changes.
Implemented in tlp::SimplePluginProgress. |
Tulip Software by LaBRI Visualization Team 2001 - 2012 |