MWS_SRX644: migrate branch mws_srx644 -> HEAD

1 files changed, 136 insertions, 16 deletions

diff --git a/sc/source/filter/inc/fprogressbar.hxx b/sc/source/filter/inc/fprogressbar.hxx
index 8bfe4c50f8fb..a13096323656 100644
--- a/sc/source/filter/inc/fprogressbar.hxx
+++ b/sc/source/filter/inc/fprogressbar.hxx
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: fprogressbar.hxx,v $
  *
- *  $Revision: 1.1 $
+ *  $Revision: 1.2 $
  *
- *  last change: $Author: dr $ $Date: 2002-11-21 12:11:09 $
+ *  last change: $Author: hr $ $Date: 2003-03-26 18:05:03 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -64,21 +64,89 @@
 #ifndef SC_FPROGRESSBAR_HXX
 #define SC_FPROGRESSBAR_HXX
 
+#include "globstr.hrc"
+
 #ifndef SC_FTOOLS_HXX
 #include "ftools.hxx"
 #endif
 
+class SfxObjectShell;
 class ScProgress;
 
 
 // ============================================================================
 
-/** Progress bar for complex progress representation. */
+/** Progress bar for complex progress representation.
+    @descr  The progress bar contains one or more segments, each with customable
+    size. Each segment is represented by a unique identifier. While showing the
+    progress bar, several segments can be started simultaneously. The progress
+    bar displays the sum of all started segments on screen.
+
+    It is possible to create a full featured ScfProgressBar object from
+    any segment. This sub progress bar works only on that parent segment, with
+    the effect, that if the sub progress bar reaches 100%, the parent segment is
+    filled completely.
+
+    After adding segments, the progress bar has to be activated. In this step the
+    total size of all segments is calculated. Therefore it is not possible to add
+    more segments from here.
+
+    If a sub progress bar is created from a segment, and the main progress bar
+    has been started (but not the sub progress bar), it is still possible to add
+    segments to the sub progress bar. It is not allowed to get the sub progress bar
+    of a started segment. And it is not allowed to modify the segment containing
+    a sub progress bar directly.
+
+    Following a few code examples, how to use the progress bar.
+
+    Example 1: Simple progress bar (see also ScfSimpleProgressBar below).
+
+        ScfProgressBar aProgress( ... );
+        sal_Int32 nSeg = aProgress.AddSegment( 50 );        // segment with 50 steps (1 step = 2%)
+
+        aProgress.ActivateSegment( nSeg );                  // start segment nSeg
+        aProgress.Progress();                               // 0->1; display: 2%
+        aProgress.Progress( 9 );                            // 1->9; display: 18%
+
+    Example 2: Progress bar with 2 segments.
+
+        ScfProgressBar aProgress( ... );
+        sal_Int32 nSeg1 = aProgress.AddSegment( 70 );       // segment with 70 steps
+        sal_Int32 nSeg2 = aProgress.AddSegment( 30 );       // segment with 30 steps
+                                                            // both segments: 100 steps (1 step = 1%)
+
+        aProgress.ActivateSegment( nSeg1 );                 // start first segment
+        aProgress.Progress();                               // 0->1, display: 1%
+        aProgress.Progress( 3 );                            // 1->3, display: 3%
+        aProgress.ActivateSegment( nSeg2 );                 // start second segment
+        aProgress.Progress( 5 );                            // 0->5, display: 8% (5+3 steps)
+        aProgress.ActivateSegment( nSeg1 );                 // continue with first segment
+        aProgress.Progress();                               // 3->4, display: 9% (5+4 steps)
+
+    Example 3: Progress bar with 2 segments, one contains a sub progress bar.
+
+        ScfProgressBar aProgress( ... );
+        sal_Int32 nSeg1 = aProgress.AddSegment( 75 );       // segment with 75 steps
+        sal_Int32 nSeg2 = aProgress.AddSegment( 25 );       // segment with 25 steps
+                                                            // both segments: 100 steps (1 step = 1%)
+
+        aProgress.ActivateSegment( nSeg1 );                 // start first segment
+        aProgress.Progress();                               // 0->1, display: 1%
+
+        ScfProgressBar& rSubProgress = aProgress.GetSegmentProgressBar( nSeg2 );
+                                                            // sub progress bar from second segment
+        sal_Int32 nSubSeg = rSubProgress.AddSegment( 5 );   // 5 steps, mapped to second segment
+                                                            // => 1 step = 5 steps in parent = 5%
+
+        rSubProgress.ActivateSegment( nSubSeg );            // start the segment (auto activate parent segment)
+        rSubProgress.Progress();                            // 0->1 (0->5 in parent); display: 6% (1+5)
+
+        // not allowed (second segment active):   aProgress.Progress();
+        // not allowed (first segment not empty): aProgress.GetSegmentProgressBar( nSeg1 );
+ */
 class ScfProgressBar : ScfNoCopy
 {
 private:
-    typedef ::std::auto_ptr< ScProgress > ScProgressPtr;
-
     /** Contains all data of a segment of the progress bar. */
     struct ScfProgressSegment
     {
@@ -92,10 +160,14 @@ private:
                                     ~ScfProgressSegment();
     };
 
-    ScfDelList< ScfProgressSegment > maSegments;    /// List of progress segments.
+    typedef ::std::auto_ptr< ScProgress >       ScProgressPtr;
+    typedef ScfDelList< ScfProgressSegment >    ScfSegmentList;
+
+    ScfSegmentList              maSegments;         /// List of progress segments.
     String                      maText;             /// UI string for system progress.
 
     ScProgressPtr               mpSysProgress;      /// System progress bar.
+    SfxObjectShell*             mpDocShell;         /// The document shell for the progress bar.
     ScfProgressBar*             mpParentProgress;   /// Parent progress bar, if this is a segment progress bar.
     ScfProgressSegment*         mpParentSegment;    /// Parent segment, if this is a segment progress bar.
     ScfProgressSegment*         mpCurrSegment;      /// Current segment for progress.
@@ -107,24 +179,24 @@ private:
     bool                        mbInProgress;       /// true = progress bar started.
 
 public:
-    /** Creates a system progress bar with a resource string. */
-    explicit                    ScfProgressBar( const String& rText );
-                                ~ScfProgressBar();
+    explicit                    ScfProgressBar( SfxObjectShell* pDocShell, const String& rText );
+    explicit                    ScfProgressBar( SfxObjectShell* pDocShell, sal_uInt16 nResId );
+    virtual                     ~ScfProgressBar();
 
     /** Adds a new segment to the progress bar.
         @return  the identifier of the segment. */
-    sal_uInt32                  AddSegment( sal_uInt32 nSize );
+    sal_Int32                   AddSegment( sal_uInt32 nSize );
     /** Returns a complete progress bar for the specified segment.
         @descr  The progress bar can be used to create sub segments inside of the
         segment. Do not delete it (done by root progress bar)!
         @return  A reference to an ScfProgressBar connected to the segment. */
-    ScfProgressBar&             GetSegmentProgressBar( sal_uInt32 nSegment );
+    ScfProgressBar&             GetSegmentProgressBar( sal_Int32 nSegment );
 
     /** Returns true, if any progress segment has been started. */
     inline bool                 IsStarted() const { return mbInProgress; }
 
     /** Starts the progress bar or activates another segment. */
-    void                        ActivateSegment( sal_uInt32 nSegment );
+    void                        ActivateSegment( sal_Int32 nSegment );
     /** Starts the progress bar (with first segment). */
     inline void                 Activate() { ActivateSegment( 0 ); }
     /** Set current segment to the specified position. */
@@ -135,15 +207,16 @@ public:
 private:
     /** Used to create sub progress bars. */
     explicit                    ScfProgressBar(
-                                    ScfProgressBar* pParProgress,
+                                    ScfProgressBar& rParProgress,
                                     ScfProgressSegment* pParSegment );
 
-    /** Returns the segment specified by list index. */
-    ScfProgressSegment*         GetSegment( sal_uInt32 nSegment ) const;
+    /** Initializes all members on construction. */
+    void                        Init( SfxObjectShell* pDocShell );
 
+    /** Returns the segment specified by list index. */
+    ScfProgressSegment*         GetSegment( sal_Int32 nSegment ) const;
     /** Activates progress bar and sets current segment. */
     void                        SetCurrSegment( ScfProgressSegment* pSegment );
-
     /** Increases mnTotalPos and calls the system progress bar. */
     void                        IncreaseProgressBar( sal_uInt32 nDelta );
 };
@@ -151,5 +224,52 @@ private:
 
 // ============================================================================
 
+/** A simplified progress bar with only one segment. */
+class ScfSimpleProgressBar
+{
+private:
+    ScfProgressBar              maProgress;     /// The used progress bar.
+
+public:
+    explicit                    ScfSimpleProgressBar( sal_uInt32 nSize, SfxObjectShell* pDocShell, const String& rText );
+    explicit                    ScfSimpleProgressBar( sal_uInt32 nSize, SfxObjectShell* pDocShell, sal_uInt16 nResId );
+
+    /** Set progress bar to the specified position. */
+    inline void                 Progress( sal_uInt32 nPos ) { maProgress.Progress( nPos ); }
+    /** Increase progress bar by 1. */
+    inline void                 Progress() { maProgress.Progress(); }
+
+private:
+    /** Initializes and starts the progress bar. */
+    void                        Init( sal_uInt32 nSize );
+};
+
+
+// ============================================================================
+
+/** A simplified progress bar based on the stream position of an existing stream. */
+class ScfStreamProgressBar
+{
+private:
+    typedef ::std::auto_ptr< ScfSimpleProgressBar > ScfSimpleProgressBarPtr;
+
+    ScfSimpleProgressBarPtr     mpProgress;     /// The used progress bar.
+    SvStream&                   mrStrm;         /// The used stream.
+
+public:
+    explicit                    ScfStreamProgressBar( SvStream& rStrm, SfxObjectShell* pDocShell, const String& rText );
+    explicit                    ScfStreamProgressBar( SvStream& rStrm, SfxObjectShell* pDocShell, sal_uInt16 nResId = STR_LOAD_DOC );
+
+    /** Sets the progress bar to the current stream position. */
+    void                        Progress();
+
+private:
+    /** Initializes and starts the progress bar. */
+    void                        Init( SfxObjectShell* pDocShell, const String& rText );
+};
+
+
+// ============================================================================
+
 #endif