include/oox/helper/progressbar.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_OOX_HELPER_PROGRESSBAR_HXX
  21 #define INCLUDED_OOX_HELPER_PROGRESSBAR_HXX
  22
  23 #include <memory>
  24
  25 #include <com/sun/star/uno/Reference.hxx>
  26 #include <oox/dllapi.h>
  27 #include <rtl/ustring.hxx>
  28
  29 namespace com { namespace sun { namespace star {
  30     namespace task { class XStatusIndicator; }
  31 } } }
  32
  33 namespace oox {
  34
  35 // Interfaces =================================================================
  36
  37 /** Interface for progress bar classes.
  38  */
  39 class OOX_DLLPUBLIC IProgressBar
  40 {
  41 public:
  42     virtual             ~IProgressBar();
  43
  44     /** Returns the current position of the progress bar.
  45
  46         @return  Position of the progress bar, in the range from 0.0 (beginning
  47         of the progress bar) to 1.0 (end of the progress bar) inclusive.
  48      */
  49     virtual double      getPosition() const = 0;
  50
  51     /** Sets the current position of the progress bar.
  52
  53         @param fPosition  New position of the progress bar, in the range from
  54         0.0 (beginning of the progress bar) to 1.0 (end of the progress bar)
  55         inclusive.
  56      */
  57     virtual void        setPosition( double fPosition ) = 0;
  58 };
  59
  60
  61 class ISegmentProgressBar;
  62 typedef std::shared_ptr< ISegmentProgressBar > ISegmentProgressBarRef;
  63
  64 /** Interface for a segment in a progress bar, that is able to create sub
  65     segments from itself.
  66  */
  67 class OOX_DLLPUBLIC ISegmentProgressBar : public IProgressBar
  68 {
  69 public:
  70     virtual             ~ISegmentProgressBar() override;
  71
  72     /** Returns the length that is still free for creating sub segments. */
  73     virtual double      getFreeLength() const = 0;
  74
  75     /** Adds a new segment with the specified length. */
  76     virtual ISegmentProgressBarRef createSegment( double fLength ) = 0;
  77 };
  78
  79
  80 /** A simple progress bar.
  81  */
  82 class OOX_DLLPUBLIC ProgressBar : public IProgressBar
  83 {
  84 public:
  85     explicit            ProgressBar(
  86                             const css::uno::Reference< css::task::XStatusIndicator >& rxIndicator,
  87                             const OUString& rText );
  88
  89     virtual             ~ProgressBar() override;
  90
  91     /** Returns the current position of the progress bar. */
  92     virtual double      getPosition() const override;
  93     /** Sets the current position of the progress bar. */
  94     virtual void        setPosition( double fPosition ) override;
  95
  96 private:
  97     css::uno::Reference< css::task::XStatusIndicator >
  98                         mxIndicator;
  99     double              mfPosition;
 100 };
 101
 102
 103 /** A progress bar containing several independent segments.
 104  */
 105 class OOX_DLLPUBLIC SegmentProgressBar : public ISegmentProgressBar
 106 {
 107 public:
 108     explicit            SegmentProgressBar(
 109                             const css::uno::Reference< css::task::XStatusIndicator >& rxIndicator,
 110                             const OUString& rText );
 111
 112     /** Returns the current position of the progress bar segment. */
 113     virtual double      getPosition() const override;
 114     /** Sets the current position of the progress bar segment. */
 115     virtual void        setPosition( double fPosition ) override;
 116
 117     /** Returns the length that is still free for creating sub segments. */
 118     virtual double      getFreeLength() const override;
 119     /** Adds a new segment with the specified length. */
 120     virtual ISegmentProgressBarRef createSegment( double fLength ) override;
 121
 122 private:
 123     ProgressBar         maProgress;
 124     double              mfFreeStart;
 125 };
 126
 127
 128 } // namespace oox
 129
 130 #endif
 131
 132 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */