include/xmloff/ProgressBarHelper.hxx

   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
  20 #ifndef INCLUDED_XMLOFF_PROGRESSBARHELPER_HXX
  21 #define INCLUDED_XMLOFF_PROGRESSBARHELPER_HXX
  22
  23 #include <sal/config.h>
  24 #include <xmloff/dllapi.h>
  25 #include <com/sun/star/task/XStatusIndicator.hpp>
  26
  27 #define XML_PROGRESSRANGE   "ProgressRange"
  28 #define XML_PROGRESSMAX     "ProgressMax"
  29 #define XML_PROGRESSCURRENT "ProgressCurrent"
  30 #define XML_PROGRESSREPEAT  "ProgressRepeat"
  31
  32 class XMLOFF_DLLPUBLIC ProgressBarHelper
  33 {
  34             css::uno::Reference < css::task::XStatusIndicator >   xStatusIndicator;
  35             sal_Int32                                             nRange;
  36             sal_Int32                                             nReference;
  37             sal_Int32                                             nValue;
  38             double                                                fOldPercent;
  39             bool const                                            bStrict;
  40             // #96469#; if the value goes over the Range the progressbar starts again
  41             bool                                                  bRepeat;
  42
  43 #ifdef DBG_UTIL
  44             bool                                                  bFailure;
  45 #endif
  46 public:
  47             ProgressBarHelper(const css::uno::Reference < css::task::XStatusIndicator>& xStatusIndicator,
  48                                 const bool bStrict);
  49             ~ProgressBarHelper();
  50
  51             void SetRange(sal_Int32 nVal) { nRange = nVal; }
  52             void SetReference(sal_Int32 nVal) { nReference = nVal; }
  53             void SetValue(sal_Int32 nValue);
  54             void SetRepeat(bool bValue) { bRepeat = bValue; }
  55             void Increment(sal_Int32 nInc = 1) { SetValue( nValue+nInc ); }
  56             void End() { if (xStatusIndicator.is()) xStatusIndicator->end(); }
  57
  58             // set the new reference and returns the new value which gives the
  59             // Progress Bar the same position as before
  60             void ChangeReference(sal_Int32 nNewReference);
  61
  62             sal_Int32 GetReference() const { return nReference; }
  63             sal_Int32 GetValue() const { return nValue; }
  64             bool GetRepeat() const { return bRepeat; }
  65 };
  66
  67 #endif
  68
  69 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */