sc/source/filter/inc/fprogressbar.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_SC_SOURCE_FILTER_INC_FPROGRESSBAR_HXX
  21 #define INCLUDED_SC_SOURCE_FILTER_INC_FPROGRESSBAR_HXX
  22
  23 #include <vector>
  24 #include <memory>
  25 #include <rtl/ustring.hxx>
  26 #include <progress.hxx>
  27
  28 class SfxObjectShell;
  29 class SvStream;
  30
  31 const sal_Int32 SCF_INV_SEGMENT = -1;
  32
  33 /** Progress bar for complex progress representation.
  34
  35     The progress bar contains one or more segments, each with customizable
  36     size. Each segment is represented by a unique identifier. While showing the
  37     progress bar, several segments can be started simultaneously. The progress
  38     bar displays the sum of all started segments on screen.
  39
  40     It is possible to create a full featured ScfProgressBar object from
  41     any segment. This sub progress bar works only on that parent segment, with
  42     the effect, that if the sub progress bar reaches 100%, the parent segment is
  43     filled completely.
  44
  45     After adding segments, the progress bar has to be activated. In this step the
  46     total size of all segments is calculated. Therefore it is not possible to add
  47     more segments from here.
  48
  49     If a sub progress bar is created from a segment, and the main progress bar
  50     has been started (but not the sub progress bar), it is still possible to add
  51     segments to the sub progress bar. It is not allowed to get the sub progress bar
  52     of a started segment. And it is not allowed to modify the segment containing
  53     a sub progress bar directly.
  54
  55     Following a few code examples, how to use the progress bar.
  56
  57     Example 1: Simple progress bar (see also ScfSimpleProgressBar below).
  58
  59         ScfProgressBar aProgress( ... );
  60         sal_Int32 nSeg = aProgress.AddSegment( 50 );        // segment with 50 steps (1 step = 2%)
  61
  62         aProgress.ActivateSegment( nSeg );                  // start segment nSeg
  63         aProgress.Progress();                               // 0->1; display: 2%
  64         aProgress.ProgressAbs( 9 );                         // 1->9; display: 18%
  65
  66     Example 2: Progress bar with 2 segments.
  67
  68         ScfProgressBar aProgress( ... );
  69         sal_Int32 nSeg1 = aProgress.AddSegment( 70 );       // segment with 70 steps
  70         sal_Int32 nSeg2 = aProgress.AddSegment( 30 );       // segment with 30 steps
  71                                                             // both segments: 100 steps (1 step = 1%)
  72
  73         aProgress.ActivateSegment( nSeg1 );                 // start first segment
  74         aProgress.Progress();                               // 0->1, display: 1%
  75         aProgress.Progress( 2 );                            // 1->3, display: 3%
  76         aProgress.ActivateSegment( nSeg2 );                 // start second segment
  77         aProgress.Progress( 5 );                            // 0->5, display: 8% (5+3 steps)
  78         aProgress.ActivateSegment( nSeg1 );                 // continue with first segment
  79         aProgress.Progress();                               // 3->4, display: 9% (5+4 steps)
  80
  81     Example 3: Progress bar with 2 segments, one contains a sub progress bar.
  82
  83         ScfProgressBar aProgress( ... );
  84         sal_Int32 nSeg1 = aProgress.AddSegment( 75 );       // segment with 75 steps
  85         sal_Int32 nSeg2 = aProgress.AddSegment( 25 );       // segment with 25 steps
  86                                                             // both segments: 100 steps (1 step = 1%)
  87
  88         aProgress.ActivateSegment( nSeg1 );                 // start first segment
  89         aProgress.Progress();                               // 0->1, display: 1%
  90
  91         ScfProgressBar& rSubProgress = aProgress.GetSegmentProgressBar( nSeg2 );
  92                                                             // sub progress bar from second segment
  93         sal_Int32 nSubSeg = rSubProgress.AddSegment( 5 );   // 5 steps, mapped to second segment
  94                                                             // => 1 step = 5 steps in parent = 5%
  95
  96         rSubProgress.ActivateSegment( nSubSeg );            // start the segment (auto activate parent segment)
  97         rSubProgress.Progress();                            // 0->1 (0->5 in parent); display: 6% (1+5)
  98
  99         // not allowed (second segment active):   aProgress.Progress();
 100         // not allowed (first segment not empty): aProgress.GetSegmentProgressBar( nSeg1 );
 101  */
 102 class ScfProgressBar final
 103 {
 104 public:
 105     ScfProgressBar(const ScfProgressBar&) = delete;
 106     const ScfProgressBar operator=(const ScfProgressBar&) = delete;
 107
 108     explicit            ScfProgressBar(SfxObjectShell* pDocShell, const OUString& rText);
 109     explicit            ScfProgressBar(SfxObjectShell* pDocShell, const char* pResId);
 110                         ~ScfProgressBar();
 111
 112     /** Adds a new segment to the progress bar.
 113         @return  the identifier of the segment. */
 114     sal_Int32           AddSegment( std::size_t nSize );
 115     /** Returns a complete progress bar for the specified segment.
 116         @descr  The progress bar can be used to create sub segments inside of the
 117         segment. Do not delete it (done by root progress bar)!
 118         @return  A reference to an ScfProgressBar connected to the segment. */
 119     ScfProgressBar&     GetSegmentProgressBar( sal_Int32 nSegment );
 120
 121     /** Returns true, if the current progress segment is already full. */
 122     bool                IsFull() const;
 123
 124     /** Starts the progress bar or activates another segment. */
 125     void                ActivateSegment( sal_Int32 nSegment );
 126     /** Starts the progress bar (with first segment). */
 127     void         Activate() { ActivateSegment( 0 ); }
 128     /** Set current segment to the specified absolute position. */
 129     void                ProgressAbs( std::size_t nPos );
 130     /** Increase current segment by the passed value. */
 131     void                Progress( std::size_t nDelta = 1 );
 132
 133 private:
 134     struct ScfProgressSegment;
 135
 136     /** Used to create sub progress bars. */
 137     explicit            ScfProgressBar(
 138                             ScfProgressBar& rParProgress,
 139                             ScfProgressSegment* pParSegment );
 140
 141     /** Initializes all members on construction. */
 142     void                Init( SfxObjectShell* pDocShell );
 143
 144     /** Returns the segment specified by list index. */
 145     ScfProgressSegment* GetSegment( sal_Int32 nSegment );
 146     /** Activates progress bar and sets current segment. */
 147     void                SetCurrSegment( ScfProgressSegment* pSegment );
 148     /** Increases mnTotalPos and calls the system progress bar. */
 149     void                IncreaseProgressBar( std::size_t nDelta );
 150
 151 private:
 152     /** Contains all data of a segment of the progress bar. */
 153     struct ScfProgressSegment
 154     {
 155         typedef ::std::unique_ptr< ScfProgressBar > ScfProgressBarPtr;
 156
 157         ScfProgressBarPtr   mxProgress;     /// Pointer to sub progress bar for this segment.
 158         std::size_t const   mnSize;         /// Size of this segment.
 159         std::size_t         mnPos;          /// Current position of this segment.
 160
 161         explicit            ScfProgressSegment( std::size_t nSize );
 162                             ~ScfProgressSegment();
 163     };
 164
 165     typedef ::std::unique_ptr< ScProgress >         ScProgressPtr;
 166     typedef std::vector< std::unique_ptr<ScfProgressSegment> > ScfSegmentList;
 167
 168     ScfSegmentList      maSegments;         /// List of progress segments.
 169     OUString const      maText;             /// UI string for system progress.
 170
 171     ScProgressPtr       mxSysProgress;      /// System progress bar.
 172     SfxObjectShell*     mpDocShell;         /// The document shell for the progress bar.
 173     ScfProgressBar*     mpParentProgress;   /// Parent progress bar, if this is a segment progress bar.
 174     ScfProgressSegment* mpParentSegment;    /// Parent segment, if this is a segment progress bar.
 175     ScfProgressSegment* mpCurrSegment;      /// Current segment for progress.
 176
 177     std::size_t         mnTotalSize;        /// Total size of all segments.
 178     std::size_t         mnTotalPos;         /// Sum of positions of all segments.
 179     std::size_t         mnUnitSize;         /// Size between two calls of system progress.
 180     std::size_t         mnNextUnitPos;      /// Limit for next system progress call.
 181     std::size_t         mnSysProgressScale; /// Additionally scaling factor for system progress.
 182     bool                mbInProgress;       /// true = progress bar started.
 183 };
 184
 185 /** A simplified progress bar with only one segment. */
 186 class ScfSimpleProgressBar
 187 {
 188 public:
 189     explicit            ScfSimpleProgressBar(std::size_t nSize, SfxObjectShell* pDocShell, const OUString& rText);
 190     explicit            ScfSimpleProgressBar(std::size_t nSize, SfxObjectShell* pDocShell, const char* pResId);
 191
 192     /** Set progress bar to the specified position. */
 193     void         ProgressAbs( std::size_t nPos ) { maProgress.ProgressAbs( nPos ); }
 194
 195 private:
 196     /** Initializes and starts the progress bar. */
 197     void                Init( std::size_t nSize );
 198
 199 private:
 200     ScfProgressBar      maProgress;     /// The used progress bar.
 201 };
 202
 203 /** A simplified progress bar based on the stream position of an existing stream. */
 204 class ScfStreamProgressBar
 205 {
 206 public:
 207     explicit            ScfStreamProgressBar( SvStream& rStrm, SfxObjectShell* pDocShell );
 208
 209     /** Sets the progress bar to the current stream position. */
 210     void                Progress();
 211
 212 private:
 213     /** Initializes and starts the progress bar. */
 214     void                Init( SfxObjectShell* pDocShell, const OUString& rText );
 215
 216 private:
 217     typedef ::std::unique_ptr< ScfSimpleProgressBar > ScfSimpleProgressBarPtr;
 218
 219     ScfSimpleProgressBarPtr mxProgress; /// The used progress bar.
 220     SvStream&           mrStrm;         /// The used stream.
 221 };
 222
 223 #endif
 224
 225 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */