110 lines
2.9 KiB
C++
110 lines
2.9 KiB
C++
//
|
|
// VMime library (http://www.vmime.org)
|
|
// Copyright (C) 2002-2009 Vincent Richard <vincent@vincent-richard.net>
|
|
//
|
|
// This program is free software; you can redistribute it and/or
|
|
// modify it under the terms of the GNU General Public License as
|
|
// published by the Free Software Foundation; either version 3 of
|
|
// the License, or (at your option) any later version.
|
|
//
|
|
// This program is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
// General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License along
|
|
// with this program; if not, write to the Free Software Foundation, Inc.,
|
|
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
//
|
|
// Linking this library statically or dynamically with other modules is making
|
|
// a combined work based on this library. Thus, the terms and conditions of
|
|
// the GNU General Public License cover the whole combination.
|
|
//
|
|
|
|
#ifndef VMIME_UTILITY_PROGRESSLISTENER_HPP_INCLUDED
|
|
#define VMIME_UTILITY_PROGRESSLISTENER_HPP_INCLUDED
|
|
|
|
|
|
namespace vmime {
|
|
namespace utility {
|
|
|
|
|
|
/** An interface to implement if you want to be notified
|
|
* of a state of progress by some objects.
|
|
*/
|
|
|
|
class progressListener
|
|
{
|
|
protected:
|
|
|
|
virtual ~progressListener() { }
|
|
|
|
public:
|
|
|
|
/** Allow the caller object to cancel the current operation.
|
|
*
|
|
* @warning WARNING: this is implementation-dependent: cancelling
|
|
* may not be supported by the notifier object.
|
|
*
|
|
* @return true to cancel the operation, false otherwise
|
|
*/
|
|
virtual bool cancel() const = 0;
|
|
|
|
/** Called at the beginning of the operation.
|
|
*
|
|
* @param predictedTotal predicted amount of units (this has
|
|
* no concrete meaning: these are not bytes, nor percentage...)
|
|
*/
|
|
virtual void start(const int predictedTotal) = 0;
|
|
|
|
/** Called during the operation (can be called several times).
|
|
*
|
|
* @param current current position
|
|
* @param currentTotal adjusted total amount of units
|
|
*/
|
|
virtual void progress(const int current, const int currentTotal) = 0;
|
|
|
|
/** Called at the end of the operation.
|
|
*
|
|
* @param total final total amount of units
|
|
*/
|
|
virtual void stop(const int total) = 0;
|
|
};
|
|
|
|
|
|
|
|
/** A progress listener used when total size is known by the
|
|
* receiver, but not by the notifier.
|
|
*/
|
|
|
|
class progressListenerSizeAdapter : public progressListener
|
|
{
|
|
public:
|
|
|
|
/** Construct a new progressListenerSizeAdapter object.
|
|
*
|
|
* @param list wrapped progress listener (can be NULL)
|
|
* @param total predicted total
|
|
*/
|
|
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);
|
|
|
|
private:
|
|
|
|
progressListener* m_wrapped;
|
|
int m_total;
|
|
};
|
|
|
|
|
|
} // utility
|
|
} // vmime
|
|
|
|
|
|
#endif // VMIME_UTILITY_PROGRESSLISTENER_HPP_INCLUDED
|
|
|