|
Crazy Eddies GUI System 0.7.6
|
Base class for progress bars. More...
Inheritance diagram for CEGUI::ProgressBar:
Collaboration diagram for CEGUI::ProgressBar:Public Member Functions | |
| float | getProgress (void) const |
| return the current progress value | |
| float | getStep (void) const |
| return the current step size | |
| void | setProgress (float progress) |
| set the current progress. | |
| void | setStepSize (float step_val) |
| set the size of the 'step' in percentage points (default is 0.01f or 1%). | |
| void | step (void) |
| cause the progress to step | |
| void | adjustProgress (float delta) |
| Modify the progress level by a specified delta. | |
| ProgressBar (const String &type, const String &name) | |
| Constructor for ProgressBar class. | |
| virtual | ~ProgressBar (void) |
| Destructor for ProgressBar. | |
Static Public Attributes | |
| static const String | EventNamespace |
| Namespace for global events. | |
| static const String | WidgetTypeName |
| Window factory name. | |
| static const String | EventProgressChanged |
| static const String | EventProgressDone |
Protected Member Functions | |
| virtual bool | testClassName_impl (const String &class_name) const |
| Return whether this window was inherited from the given class name at some point in the inheritance hierarchy. | |
| virtual void | onProgressChanged (WindowEventArgs &e) |
| event triggered when progress changes | |
| virtual void | onProgressDone (WindowEventArgs &e) |
| event triggered when progress reaches 100% | |
Protected Attributes | |
| float | d_progress |
| current progress (from 0.0f to 1.0f) | |
| float | d_step |
| amount to 'step' progress by on a call to step() | |
Base class for progress bars.
| void CEGUI::ProgressBar::adjustProgress | ( | float | delta | ) | [inline] |
Modify the progress level by a specified delta.
| delta | amount to adjust the progress by. Whatever this value is, the progress of the bar will be kept within the range: 0.0f <= progress <= 1.0f. |
| void CEGUI::ProgressBar::setProgress | ( | float | progress | ) |
set the current progress.
| progress | The level of progress to set. If this value is >1.0f (100%) progress will be limited to 1.0f. |
| void CEGUI::ProgressBar::setStepSize | ( | float | step_val | ) | [inline] |
set the size of the 'step' in percentage points (default is 0.01f or 1%).
| step | Amount to increase the progress by each time the step method is called. |
| void CEGUI::ProgressBar::step | ( | void | ) | [inline] |
cause the progress to step
The amount the progress bar will step can be changed by calling the setStepSize method. The default step size is 0.01f which is equal to 1%.
| virtual bool CEGUI::ProgressBar::testClassName_impl | ( | const String & | class_name | ) | const [inline, protected, virtual] |
Return whether this window was inherited from the given class name at some point in the inheritance hierarchy.
| class_name | The class name that is to be checked. |
Reimplemented from CEGUI::Window.
References CEGUI::Window::testClassName_impl().
const String CEGUI::ProgressBar::EventProgressChanged [static] |
Event fired whenever the progress value is changed. Handlers are passed a const WindowEventArgs reference with WindowEventArgs::window set to the ProgressBar whose value has been changed.
const String CEGUI::ProgressBar::EventProgressDone [static] |
Event fired when the progress bar's value reaches 100%. Handlers are passed a const WindowEventArgs reference with WindowEventArgs::window set to the ProgressBar whose progress value has reached 100%.
1.7.4