LibreOffice Module xmloff (master)  1
ProgressBarHelper.cxx
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3  * This file is part of the LibreOffice project.
4  *
5  * This Source Code Form is subject to the terms of the Mozilla Public
6  * License, v. 2.0. If a copy of the MPL was not distributed with this
7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8  *
9  * This file incorporates work covered by the following license notice:
10  *
11  * Licensed to the Apache Software Foundation (ASF) under one or more
12  * contributor license agreements. See the NOTICE file distributed
13  * with this work for additional information regarding copyright
14  * ownership. The ASF licenses this file to you under the Apache
15  * License, Version 2.0 (the "License"); you may not use this file
16  * except in compliance with the License. You may obtain a copy of
17  * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18  */
19 
21 
22 #include <osl/diagnose.h>
23 
24 using namespace ::com::sun::star;
25 
26 const sal_Int32 nDefaultProgressBarRange = 1000000;
27 const float fProgressStep = 0.5;
28 
29 ProgressBarHelper::ProgressBarHelper(const css::uno::Reference < css::task::XStatusIndicator>& xTempStatusIndicator,
30  const bool bTempStrict)
31 : xStatusIndicator(xTempStatusIndicator)
33 , nReference(100)
34 , nValue(0)
35 , fOldPercent(0.0)
36 , bStrict(bTempStrict)
37 , bRepeat(true)
38 #ifdef DBG_UTIL
39 , bFailure(false)
40 #endif
41 {
42 }
43 
45 {
46 }
47 
48 void ProgressBarHelper::ChangeReference(sal_Int32 nNewReference)
49 {
50  if((nNewReference <= 0) || (nNewReference == nReference))
51  return;
52 
53  if (nReference)
54  {
55  double fPercent(static_cast<double>(nNewReference) / nReference);
56  double fValue(nValue * fPercent);
57  nValue = static_cast<sal_Int32>(fValue);
58  nReference = nNewReference;
59  }
60  else
61  {
62  nReference = nNewReference;
63  nValue = 0;
64  }
65 }
66 
67 void ProgressBarHelper::SetValue(sal_Int32 nTempValue)
68 {
69  if (!xStatusIndicator.is() || (nReference <= 0))
70  return;
71 
72  if ((nTempValue >= nValue) && (!bStrict || (nTempValue <= nReference)))
73  {
74  // #91317# no progress bar with values > 100%
75  if (nTempValue > nReference)
76  {
77  if (!bRepeat)
79  else
80  {
81  xStatusIndicator->reset();
82  nValue = 0;
83  }
84  }
85  else
86  nValue = nTempValue;
87 
88  double fValue(nValue);
89  double fNewValue ((fValue * nRange) / nReference);
90 
91  double fPercent((fNewValue * 100) / nRange);
92  if (fPercent >= (fOldPercent + fProgressStep) || fPercent < fOldPercent)
93  {
94  xStatusIndicator->setValue(static_cast<sal_Int32>(fNewValue));
95  fOldPercent = fPercent;
96  }
97  }
98 #ifdef DBG_UTIL
99  else if (!bFailure)
100  {
101  OSL_FAIL("tried to set a wrong value on the progressbar");
102  bFailure = true;
103  }
104 #endif
105 }
106 
107 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
const sal_Int32 nDefaultProgressBarRange
ProgressBarHelper(const css::uno::Reference< css::task::XStatusIndicator > &xStatusIndicator, const bool bStrict)
css::uno::Reference< css::task::XStatusIndicator > xStatusIndicator
void SetValue(sal_Int32 nValue)
void ChangeReference(sal_Int32 nNewReference)
const float fProgressStep
sal_Int16 nValue