1*2e2212a7SAndrew Rist /************************************************************** 2cdf0e10cSrcweir * 3*2e2212a7SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*2e2212a7SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*2e2212a7SAndrew Rist * distributed with this work for additional information 6*2e2212a7SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*2e2212a7SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*2e2212a7SAndrew Rist * "License"); you may not use this file except in compliance 9*2e2212a7SAndrew Rist * with the License. You may obtain a copy of the License at 10*2e2212a7SAndrew Rist * 11*2e2212a7SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*2e2212a7SAndrew Rist * 13*2e2212a7SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*2e2212a7SAndrew Rist * software distributed under the License is distributed on an 15*2e2212a7SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*2e2212a7SAndrew Rist * KIND, either express or implied. See the License for the 17*2e2212a7SAndrew Rist * specific language governing permissions and limitations 18*2e2212a7SAndrew Rist * under the License. 19*2e2212a7SAndrew Rist * 20*2e2212a7SAndrew Rist *************************************************************/ 21*2e2212a7SAndrew Rist 22*2e2212a7SAndrew Rist 23cdf0e10cSrcweir 24cdf0e10cSrcweir #ifndef DBACCESS_PROGRESSMIXER_HXX 25cdf0e10cSrcweir #define DBACCESS_PROGRESSMIXER_HXX 26cdf0e10cSrcweir 27cdf0e10cSrcweir /** === begin UNO includes === **/ 28cdf0e10cSrcweir /** === end UNO includes === **/ 29cdf0e10cSrcweir 30cdf0e10cSrcweir #include <sal/types.h> 31cdf0e10cSrcweir 32cdf0e10cSrcweir #include <memory> 33cdf0e10cSrcweir 34cdf0e10cSrcweir //........................................................................ 35cdf0e10cSrcweir namespace dbmm 36cdf0e10cSrcweir { 37cdf0e10cSrcweir //........................................................................ 38cdf0e10cSrcweir 39cdf0e10cSrcweir typedef sal_uInt32 PhaseID; 40cdf0e10cSrcweir typedef sal_uInt32 PhaseWeight; 41cdf0e10cSrcweir 42cdf0e10cSrcweir //==================================================================== 43cdf0e10cSrcweir //= IProgressConsumer 44cdf0e10cSrcweir //==================================================================== 45cdf0e10cSrcweir class SAL_NO_VTABLE IProgressConsumer 46cdf0e10cSrcweir { 47cdf0e10cSrcweir public: 48cdf0e10cSrcweir virtual void start( sal_uInt32 _nRange ) = 0; 49cdf0e10cSrcweir virtual void advance( sal_uInt32 _nValue ) = 0; 50cdf0e10cSrcweir virtual void end() = 0; 51cdf0e10cSrcweir }; 52cdf0e10cSrcweir 53cdf0e10cSrcweir //==================================================================== 54cdf0e10cSrcweir //= ProgressMixer 55cdf0e10cSrcweir //==================================================================== 56cdf0e10cSrcweir struct ProgressMixer_Data; 57cdf0e10cSrcweir /** a class which mixes (i.e. concatenates) progress values from different 58cdf0e10cSrcweir sources/phases, with different weight 59cdf0e10cSrcweir */ 60cdf0e10cSrcweir class ProgressMixer 61cdf0e10cSrcweir { 62cdf0e10cSrcweir public: 63cdf0e10cSrcweir ProgressMixer( IProgressConsumer& _rConsumer ); 64cdf0e10cSrcweir ~ProgressMixer(); 65cdf0e10cSrcweir 66cdf0e10cSrcweir /** registers a phase of the process, which has the given weight 67cdf0e10cSrcweir in the overall process 68cdf0e10cSrcweir @precond 69cdf0e10cSrcweir the progress is not runnig, yet 70cdf0e10cSrcweir */ 71cdf0e10cSrcweir void registerPhase( const PhaseID _nID, const PhaseWeight _nWeight ); 72cdf0e10cSrcweir 73cdf0e10cSrcweir /** enters the phase with the given ID, with the phase having 74cdf0e10cSrcweir the given overall range 75cdf0e10cSrcweir */ 76cdf0e10cSrcweir void startPhase( const PhaseID _nID, const sal_uInt32 _nPhaseRange ); 77cdf0e10cSrcweir 78cdf0e10cSrcweir /** announces a new progress in the current phase. 79cdf0e10cSrcweir 80cdf0e10cSrcweir The given phase progress must be between 0 and the overall phase range 81cdf0e10cSrcweir as specified in ->startPhase. 82cdf0e10cSrcweir */ 83cdf0e10cSrcweir void advancePhase( const sal_uInt32 _nPhaseProgress ); 84cdf0e10cSrcweir 85cdf0e10cSrcweir /** leaves the current phase, which has been started with ->startPhase previously 86cdf0e10cSrcweir */ 87cdf0e10cSrcweir void endPhase(); 88cdf0e10cSrcweir 89cdf0e10cSrcweir private: 90cdf0e10cSrcweir ::std::auto_ptr< ProgressMixer_Data > m_pData; 91cdf0e10cSrcweir }; 92cdf0e10cSrcweir 93cdf0e10cSrcweir //........................................................................ 94cdf0e10cSrcweir } // namespace dbmm 95cdf0e10cSrcweir //........................................................................ 96cdf0e10cSrcweir 97cdf0e10cSrcweir #endif // DBACCESS_PROGRESSMIXER_HXX 98