progressListener Class Reference

Inheritance diagram for progressListener:

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

~progressListener()

virtual ~progressListener ( )

protectedvirtual

Member Function Documentation

progress()

virtual void progress ( const size_t  current, const size_t  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 maildirFolder::addMessage(), IMAPFolder::addMessage(), vmime::utility::bufferedStreamCopy(), uuEncoder::decode(), b64Encoder::decode(), qpEncoder::decode(), uuEncoder::encode(), b64Encoder::encode(), qpEncoder::encode(), stringProxy::extract(), maildirMessage::extractPart(), POP3Folder::fetchMessages(), maildirFolder::fetchMessages(), IMAPFolder::fetchMessages(), POP3Response::getLineCount(), progressListenerSizeAdapter::progress(), and SMTPChunkingOutputStreamAdapter::SMTPChunkingOutputStreamAdapter().

start()

virtual void start ( const size_t  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 maildirFolder::addMessage(), IMAPFolder::addMessage(), vmime::utility::bufferedStreamCopy(), uuEncoder::decode(), b64Encoder::decode(), b64Encoder::encode(), uuEncoder::encode(), qpEncoder::encode(), emptyContentHandler::extract(), stringProxy::extract(), maildirMessage::extractPart(), emptyContentHandler::extractRaw(), POP3Folder::fetchMessages(), maildirFolder::fetchMessages(), IMAPFolder::fetchMessages(), POP3Response::getLineCount(), SMTPChunkingOutputStreamAdapter::SMTPChunkingOutputStreamAdapter(), and progressListenerSizeAdapter::start().

stop()

virtual void stop ( const size_t  total )

pure virtual

Called at the end of the operation.

Parameters

total

final total amount of units

Implemented in progressListenerSizeAdapter.

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

---

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

• progressListener.hpp