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