Branch data     Line data    Source code

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