progressListener Class Reference
An interface to implement if you want to be notified of a state of progress by some objects. More...
Public Member Functions | |
| virtual bool | cancel () const =0 |
| virtual void | start (const int predictedTotal)=0 |
| virtual void | progress (const int current, const int currentTotal)=0 |
| virtual void | stop (const int total)=0 |
Protected Member Functions | |
| virtual | ~progressListener () |
Detailed Description
An interface to implement if you want to be notified of a state of progress by some objects.
Constructor & Destructor Documentation
| virtual ~progressListener | ( | ) | [protected, virtual] |
Member Function Documentation
| virtual bool cancel | ( | ) | const [pure 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
Implemented in progressListenerSizeAdapter.
Referenced by progressListenerSizeAdapter::cancel().
| virtual void progress | ( | const int | current, | |
| const int | currentTotal | |||
| ) | [pure virtual] |
Called during the operation (can be called several times).
- Parameters:
-
current current position currentTotal adjusted total amount of units
Implemented in progressListenerSizeAdapter.
Referenced by uuEncoder::decode(), qpEncoder::decode(), b64Encoder::decode(), uuEncoder::encode(), qpEncoder::encode(), b64Encoder::encode(), stringProxy::extract(), maildirFolder::fetchMessage(), and progressListenerSizeAdapter::progress().
| virtual void start | ( | const int | predictedTotal | ) | [pure 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...)
Implemented in progressListenerSizeAdapter.
Referenced by uuEncoder::decode(), b64Encoder::decode(), uuEncoder::encode(), qpEncoder::encode(), b64Encoder::encode(), stringProxy::extract(), emptyContentHandler::extract(), emptyContentHandler::extractRaw(), and progressListenerSizeAdapter::start().
| virtual void stop | ( | const int | total | ) | [pure virtual] |
Called at the end of the operation.
- Parameters:
-
total final total amount of units
Implemented in progressListenerSizeAdapter.
Referenced by uuEncoder::decode(), qpEncoder::decode(), b64Encoder::decode(), uuEncoder::encode(), qpEncoder::encode(), b64Encoder::encode(), stringProxy::extract(), emptyContentHandler::extract(), emptyContentHandler::extractRaw(), IMAPFolder::fetchMessage(), and progressListenerSizeAdapter::stop().
The documentation for this class was generated from the following file:
