VMime
progressListenerSizeAdapter Class Reference

#include <progressListener.hpp>

Inheritance diagram for progressListenerSizeAdapter:
Collaboration diagram for progressListenerSizeAdapter:

Public Member Functions

 progressListenerSizeAdapter (progressListener *list, const size_t total)
void start (const size_t predictedTotal)
void progress (const size_t current, const size_t currentTotal)
void stop (const size_t total)

Additional Inherited Members

Protected Member Functions inherited from progressListener
virtual ~progressListener ()

Detailed Description

A progress listener used when total size is known by the receiver, but not by the notifier.

Constructor & Destructor Documentation

◆ progressListenerSizeAdapter()

progressListenerSizeAdapter ( progressListener * list,
const size_t total )

Construct a new progressListenerSizeAdapter object.

Parameters
listwrapped progress listener (can be NULL)
totalpredicted total

Member Function Documentation

◆ progress()

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

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

Parameters
currentcurrent position
currentTotaladjusted total amount of units

Implements progressListener.

◆ start()

void start ( const size_t predictedTotal)
virtual

Called at the beginning of the operation.

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

Implements progressListener.

◆ stop()

void stop ( const size_t total)
virtual

Called at the end of the operation.

Parameters
totalfinal total amount of units

Implements progressListener.


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