|
gear_mc
|
PROGRESS LOGGER. More...
Public Member Functions | |
| def | __init__ |
| Init method. More... | |
| def | getTime |
| Return the time ellapsed since the creation of the object. More... | |
| def | logTime |
| Log the time ellapsed since the creation of the object. More... | |
| def | resetTime |
| Reset the time counter. More... | |
| def | log |
| Log a message and change progress bar caption and status text. More... | |
| def | showBar |
| Show the progress bar. More... | |
| def | hideBar |
| Hide the progress bar. More... | |
| def | increment |
| Increment the progress bar. More... | |
| def | canceled |
| Check if the progress bar Cancel button has been pressed. More... | |
| def | start |
| def | reset |
| Reset the progress bar. More... | |
Public Attributes | |
| showLog | |
| showBar | |
| startTime | |
| bar | |
PROGRESS LOGGER.
Log progress step in the script editor and/or in a progress bar
| def gear.xsi.uitoolkit.ProgressLog.__init__ | ( | self, | |
showLog = False, |
|||
showBar = False, |
|||
caption = "", |
|||
statusText = "", |
|||
maximum = 100, |
|||
step = 1, |
|||
cancel = False |
|||
| ) |
Init method.
| self | |
| showLog | Boolean - True to log messages. |
| showBar | Boolean - True to display a progress bar. |
| caption | String - Caption Name. |
| statusText | String - Status text. |
| maximum | Double - Maximum limit of the progress bar. |
| step | Double - Step incrementation of the progress bar. |
| cancel | Boolean - Cancel button on the progress bar. |
| def gear.xsi.uitoolkit.ProgressLog.canceled | ( | self | ) |
Check if the progress bar Cancel button has been pressed.
| self |
| def gear.xsi.uitoolkit.ProgressLog.getTime | ( | self | ) |
Return the time ellapsed since the creation of the object.
| self |
| def gear.xsi.uitoolkit.ProgressLog.hideBar | ( | self | ) |
Hide the progress bar.
| self |
| def gear.xsi.uitoolkit.ProgressLog.increment | ( | self | ) |
Increment the progress bar.
| self |
| def gear.xsi.uitoolkit.ProgressLog.log | ( | self, | |
caption = None, |
|||
statusText = None, |
|||
increment = False |
|||
| ) |
Log a message and change progress bar caption and status text.
| self | |
| caption | String - New caption name. |
| statusText | String - New status text. |
| increment | Boolean - True to increment the progress bar. |
| def gear.xsi.uitoolkit.ProgressLog.logTime | ( | self, | |
message = "" |
|||
| ) |
Log the time ellapsed since the creation of the object.
| self |
| def gear.xsi.uitoolkit.ProgressLog.reset | ( | self, | |
caption = None, |
|||
statusText = None, |
|||
maximum = None, |
|||
step = None |
|||
| ) |
Reset the progress bar.
| self | |
| caption | String - New caption name. |
| statusText | String - New status text. |
| maximum | Double - Maximum limit of the progress bar. |
| step | Double - Step incrementation of the progress bar. |
| def gear.xsi.uitoolkit.ProgressLog.resetTime | ( | self | ) |
Reset the time counter.
| self |
| def gear.xsi.uitoolkit.ProgressLog.showBar | ( | self | ) |
Show the progress bar.
| self |
1.8.5
