VMime
Public Member Functions | Protected Member Functions | List of all members
progressListener Class Referenceabstract
Inheritance diagram for progressListener:
Inheritance graph
[legend]

Public Member Functions

virtual void start (const size_t predictedTotal)=0
 
virtual void progress (const size_t current, const size_t currentTotal)=0
 
virtual void stop (const size_t 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 ( )
protectedvirtual

Member Function Documentation

virtual void progress ( const size_t  current,
const size_t  currentTotal 
)
pure virtual

Called during the operation (can be called several times).

Parameters
currentcurrent position
currentTotaladjusted total amount of units

Implemented in progressListenerSizeAdapter.

Referenced by IMAPFolder::addMessage(), vmime::utility::bufferedStreamCopy(), qpEncoder::decode(), b64Encoder::decode(), uuEncoder::decode(), qpEncoder::encode(), b64Encoder::encode(), uuEncoder::encode(), stringProxy::extract(), POP3Folder::fetchMessages(), maildirFolder::fetchMessages(), IMAPFolder::fetchMessages(), and progressListenerSizeAdapter::progress().

virtual void start ( const size_t  predictedTotal)
pure virtual

Called at the beginning of the operation.

Parameters
predictedTotalpredicted amount of units (this has no concrete meaning: these are not bytes, nor percentage...)

Implemented in progressListenerSizeAdapter.

Referenced by IMAPFolder::addMessage(), vmime::utility::bufferedStreamCopy(), b64Encoder::decode(), uuEncoder::decode(), b64Encoder::encode(), qpEncoder::encode(), uuEncoder::encode(), emptyContentHandler::extract(), stringProxy::extract(), emptyContentHandler::extractRaw(), POP3Folder::fetchMessages(), maildirFolder::fetchMessages(), IMAPFolder::fetchMessages(), SMTPChunkingOutputStreamAdapter::SMTPChunkingOutputStreamAdapter(), and progressListenerSizeAdapter::start().

virtual void stop ( const size_t  total)
pure virtual

Called at the end of the operation.

Parameters
totalfinal total amount of units

Implemented in progressListenerSizeAdapter.

Referenced by IMAPFolder::addMessage(), vmime::utility::bufferedStreamCopy(), qpEncoder::decode(), uuEncoder::decode(), b64Encoder::decode(), b64Encoder::encode(), qpEncoder::encode(), uuEncoder::encode(), emptyContentHandler::extract(), stringProxy::extract(), emptyContentHandler::extractRaw(), POP3Folder::fetchMessages(), maildirFolder::fetchMessages(), IMAPFolder::fetchMessages(), SMTPChunkingOutputStreamAdapter::flush(), and progressListenerSizeAdapter::stop().

The documentation for this class was generated from the following file: