87 lines
2.8 KiB
C++
87 lines
2.8 KiB
C++
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/*
|
|
* This file is part of the LibreOffice project.
|
|
*
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
*
|
|
* This file incorporates work covered by the following license notice:
|
|
*
|
|
* Licensed to the Apache Software Foundation (ASF) under one or more
|
|
* contributor license agreements. See the NOTICE file distributed
|
|
* with this work for additional information regarding copyright
|
|
* ownership. The ASF licenses this file to you under the Apache
|
|
* License, Version 2.0 (the "License"); you may not use this file
|
|
* except in compliance with the License. You may obtain a copy of
|
|
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
|
|
*/
|
|
|
|
#ifndef INCLUDED_DBACCESS_SOURCE_EXT_MACROMIGRATION_PROGRESSMIXER_HXX
|
|
#define INCLUDED_DBACCESS_SOURCE_EXT_MACROMIGRATION_PROGRESSMIXER_HXX
|
|
|
|
#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;
|
|
|
|
protected:
|
|
~IProgressConsumer() {}
|
|
};
|
|
|
|
// 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 // INCLUDED_DBACCESS_SOURCE_EXT_MACROMIGRATION_PROGRESSMIXER_HXX
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|