1 files changed, 75 insertions, 0 deletions
diff --git a/src/messaging/progressionListener.hpp b/src/messaging/progressionListener.hpp
new file mode 100644
index 00000000..1e75d862
--- /dev/null
+++ b/src/messaging/progressionListener.hpp
@@ -0,0 +1,75 @@
+//
+// VMime library (http://vmime.sourceforge.net)
+// Copyright (C) 2002-2004 Vincent Richard <[email protected]>
+//
+// 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 2 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., 675 Mass Ave, Cambridge, MA 02139, USA.
+//
+
+#ifndef VMIME_MESSAGING_PROGRESSIONLISTENER_HPP_INCLUDED
+#define VMIME_MESSAGING_PROGRESSIONLISTENER_HPP_INCLUDED
+
+
+namespace vmime {
+namespace messaging {
+
+
+/** An interface to implement if you want to be notified
+  * of a progression status by some objects.
+  */
+
+class progressionListener
+{
+protected:
+
+	virtual ~progressionListener() { }
+
+public:
+
+	/** Allow the caller object to cancel the current operation.
+	  *
+	  * @warning WARNING: this is implementation-dependant: the underlying
+	  * messaging protocol may not support this).
+	  *
+	  * @return true to cancel the operation, false otherwise
+	  */
+	virtual const bool cancel() const = 0;
+
+	/** Called at the beginning of the operation.
+	  *
+	  * @param predictedTotal predicted amount of units (this has
+	  * no concrete meaning: they 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;
+};
+
+
+} // messaging
+} // vmime
+
+
+#endif // VMIME_MESSAGING_PROGRESSIONLISTENER_HPP_INCLUDED