Public Member Functions | |
| TProgressBarHelper (TMCString &inPrompt, real32 inMaxValue=100.0f) | |
| ~TProgressBarHelper () | |
| void | SetProgressPrompt (TMCString &inPrompt) |
| void | IncrementProgress (real32 inIncrement) |
| void | SetProgressValue (real32 inValue) |
| void | SetProgressValue0to1 (real32 inValue) |
| void | SetProgressDelay (const real seconds) |
| IMCUnknown * | GetProgressKey () const |
Protected Attributes | |
| TMCCountedPtr < IMCUnknown > | fProgressKey |
| real32 | fMaxValue |
Constructor for the TProgressBarHelper. Starts a new progress bar.
| inPrompt | Title to associate with the progress bar | |
| inMaxValue | Maximum value for the progress bar. When the progress bar reaches this number, it will appear full. |
| TProgressBarHelper::~TProgressBarHelper | ( | ) |
| void TProgressBarHelper::SetProgressPrompt | ( | TMCString & | inPrompt | ) |
Changes the title of the progress bar.
| inPrompt | New title for progress bar. |
| void TProgressBarHelper::IncrementProgress | ( | real32 | inIncrement | ) |
Increments the progress counter by inIncrement.
| inIncrement | Increment to add to the bar's counter |
| void TProgressBarHelper::SetProgressValue | ( | real32 | inValue | ) |
Sets the progress value to a given value (on a scale of 0 to the max value of the progress bar)
| inValue | Value to assign to the bar |
| void TProgressBarHelper::SetProgressValue0to1 | ( | real32 | inValue | ) |
Sets the progress value to a given value (on a scale of 0 to 1.0)
| inValue | Value to assign to the bar |
| void TProgressBarHelper::SetProgressDelay | ( | const real | seconds | ) |
Sets the time that the progress will wait before being displayed
| seconds | The time to wait before displaying the progress bar on the screen. |
| IMCUnknown* TProgressBarHelper::GetProgressKey | ( | ) | const [inline] |
returns the progress key.
TMCCountedPtr<IMCUnknown> TProgressBarHelper::fProgressKey [protected] |
real32 TProgressBarHelper::fMaxValue [protected] |
1.5.3