gear::xsi::uitoolkit::ProgressLog Class Reference
Log progress step in the script editor and/or in a progress bar.
More...
Public Member Functions |
| def | __init__ |
| | Init method.
|
| def | getTime |
| | Return the time ellapsed since the creation of the object.
|
| def | logTime |
| | Log the time ellapsed since the creation of the object.
|
| def | resetTime |
| | Reset the time counter.
|
| def | log |
| | Log a message and change progress bar caption and status text.
|
| def | showBar |
| | Show the progress bar.
|
| def | hideBar |
| | Hide the progress bar.
|
| def | increment |
| | Increment the progress bar.
|
| def | canceled |
| | Check if the progress bar Cancel button has been pressed.
|
|
def | start |
| def | reset |
| | Reset the progress bar.
|
Data Fields |
|
| showLog |
|
| showBar |
|
| startTime |
|
| bar |
Detailed Description
Log progress step in the script editor and/or in a progress bar.
Member Function Documentation
| def gear::xsi::uitoolkit::ProgressLog::__init__ |
( |
|
self, |
|
|
|
showLog = False, |
|
|
|
showBar = False, |
|
|
|
caption = "", |
|
|
|
statusText = "", |
|
|
|
maximum = 100, |
|
|
|
step = 1, |
|
|
|
cancel = False | |
|
) |
| | |
Init method.
- Parameters:
-
| 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::getTime |
( |
|
self |
) |
|
Return the time ellapsed since the creation of the object.
- Parameters:
-
- Returns:
- String - The time ellapsed.
| def gear::xsi::uitoolkit::ProgressLog::logTime |
( |
|
self, |
|
|
|
message = "" | |
|
) |
| | |
Log the time ellapsed since the creation of the object.
- Parameters:
-
| def gear::xsi::uitoolkit::ProgressLog::resetTime |
( |
|
self |
) |
|
Reset the time counter.
- Parameters:
-
| def gear::xsi::uitoolkit::ProgressLog::log |
( |
|
self, |
|
|
|
caption = None, |
|
|
|
statusText = None, |
|
|
|
increment = False | |
|
) |
| | |
Log a message and change progress bar caption and status text.
- Parameters:
-
| self | |
| caption | String - New caption name. |
| statusText | String - New status text. |
| increment | Boolean - True to increment the progress bar. |
| def gear::xsi::uitoolkit::ProgressLog::showBar |
( |
|
self |
) |
|
Show the progress bar.
- Parameters:
-
| def gear::xsi::uitoolkit::ProgressLog::hideBar |
( |
|
self |
) |
|
Hide the progress bar.
- Parameters:
-
| def gear::xsi::uitoolkit::ProgressLog::increment |
( |
|
self |
) |
|
Increment the progress bar.
- Parameters:
-
| def gear::xsi::uitoolkit::ProgressLog::canceled |
( |
|
self |
) |
|
Check if the progress bar Cancel button has been pressed.
- Parameters:
-
- Returns:
- Boolean - True if the button has been pressed
| def gear::xsi::uitoolkit::ProgressLog::reset |
( |
|
self, |
|
|
|
caption = None, |
|
|
|
statusText = None, |
|
|
|
maximum = None, |
|
|
|
step = None | |
|
) |
| | |
Reset the progress bar.
- Parameters:
-
| 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. |
The documentation for this class was generated from the following file:
- modules/gear/xsi/uitoolkit.py
