progressListenerSizeAdapter Class Reference
A progress listener used when total size is known by the receiver, but not by the notifier. More...
Inheritance diagram for progressListenerSizeAdapter:
Collaboration diagram for progressListenerSizeAdapter:
Public Member Functions | |
| progressListenerSizeAdapter (progressListener *list, const int total) | |
| bool | cancel () const |
| void | start (const int predictedTotal) |
| void | progress (const int current, const int currentTotal) |
| void | stop (const int total) |
Detailed Description
A progress listener used when total size is known by the receiver, but not by the notifier.
Constructor & Destructor Documentation
| progressListenerSizeAdapter | ( | progressListener * | list, | |
| const int | total | |||
| ) |
Construct a new progressListenerSizeAdapter object.
- Parameters:
-
list wrapped progress listener (can be NULL) total predicted total
Member Function Documentation
| bool cancel | ( | ) | const [virtual] |
Allow the caller object to cancel the current operation.
- Warning:
- WARNING: this is implementation-dependent: cancelling may not be supported by the notifier object.
- Returns:
- true to cancel the operation, false otherwise
Implements progressListener.
References progressListener::cancel().
| void progress | ( | const int | current, | |
| const int | currentTotal | |||
| ) | [virtual] |
Called during the operation (can be called several times).
- Parameters:
-
current current position currentTotal adjusted total amount of units
Implements progressListener.
References progressListener::progress().
| void start | ( | const int | predictedTotal | ) | [virtual] |
Called at the beginning of the operation.
- Parameters:
-
predictedTotal predicted amount of units (this has no concrete meaning: these are not bytes, nor percentage...)
Implements progressListener.
References progressListener::start().
| void stop | ( | const int | total | ) | [virtual] |
Called at the end of the operation.
- Parameters:
-
total final total amount of units
Implements progressListener.
References progressListener::stop().
The documentation for this class was generated from the following files:
