blob: 784692da07a38ead0f93b1bcc3881f69a0127d0f (
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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
|
/*************************************************************************
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org 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 Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef DBACCESS_PROGRESSMIXER_HXX
#define DBACCESS_PROGRESSMIXER_HXX
/** === begin UNO includes === **/
/** === end UNO includes === **/
#include <sal/types.h>
#include <memory>
//........................................................................
namespace dbmm
{
//........................................................................
typedef sal_uInt32 PhaseID;
typedef sal_uInt32 PhaseWeight;
//====================================================================
//= IProgressConsumer
//====================================================================
class SAL_NO_VTABLE IProgressConsumer
{
public:
virtual void start( sal_uInt32 _nRange ) = 0;
virtual void advance( sal_uInt32 _nValue ) = 0;
virtual void end() = 0;
};
//====================================================================
//= ProgressMixer
//====================================================================
struct ProgressMixer_Data;
/** a class which mixes (i.e. concatenates) progress values from different
sources/phases, with different weight
*/
class ProgressMixer
{
public:
ProgressMixer( IProgressConsumer& _rConsumer );
~ProgressMixer();
/** registers a phase of the process, which has the given weight
in the overall process
@precond
the progress is not runnig, yet
*/
void registerPhase( const PhaseID _nID, const PhaseWeight _nWeight );
/** enters the phase with the given ID, with the phase having
the given overall range
*/
void startPhase( const PhaseID _nID, const sal_uInt32 _nPhaseRange );
/** announces a new progress in the current phase.
The given phase progress must be between 0 and the overall phase range
as specified in ->startPhase.
*/
void advancePhase( const sal_uInt32 _nPhaseProgress );
/** leaves the current phase, which has been started with ->startPhase previously
*/
void endPhase();
private:
::std::auto_ptr< ProgressMixer_Data > m_pData;
};
//........................................................................
} // namespace dbmm
//........................................................................
#endif // DBACCESS_PROGRESSMIXER_HXX
|
