blob: 1e75d8621df7e24c8180343ac796619405b44bee (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
|
//
// VMime library (http://vmime.sourceforge.net)
// Copyright (C) 2002-2004 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 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
|
