oox/source/helper/progressbar.cxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: progressbar.cxx,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #include "oox/helper/progressbar.hxx"
  32 #include <com/sun/star/task/XStatusIndicator.hpp>
  33 #include "oox/helper/helper.hxx"
  34
  35 using ::rtl::OUString;
  36 using ::com::sun::star::uno::Reference;
  37 using ::com::sun::star::task::XStatusIndicator;
  38
  39 namespace oox {
  40
  41 // ============================================================================
  42
  43 namespace {
  44
  45 const sal_Int32 PROGRESS_RANGE      = 1000000;
  46
  47 } // namespace
  48
  49 // ============================================================================
  50
  51 IProgressBar::~IProgressBar()
  52 {
  53 }
  54
  55 // ----------------------------------------------------------------------------
  56
  57 ISegmentProgressBar::~ISegmentProgressBar()
  58 {
  59 }
  60
  61 // ============================================================================
  62 // ============================================================================
  63
  64 ProgressBar::ProgressBar( const Reference< XStatusIndicator >& rxIndicator, const OUString& rText ) :
  65     mxIndicator( rxIndicator ),
  66     mfPosition( 0 )
  67 {
  68     if( mxIndicator.is() )
  69         mxIndicator->start( rText, PROGRESS_RANGE );
  70 }
  71
  72 ProgressBar::~ProgressBar()
  73 {
  74     if( mxIndicator.is() )
  75         mxIndicator->end();
  76 }
  77
  78 double ProgressBar::getPosition() const
  79 {
  80     return mfPosition;
  81 }
  82
  83 void ProgressBar::setPosition( double fPosition )
  84 {
  85     OSL_ENSURE( (mfPosition <= fPosition) && (fPosition <= 1.0), "ProgressBar::setPosition - invalid position" );
  86     mfPosition = getLimitedValue< double >( fPosition, mfPosition, 1.0 );
  87     if( mxIndicator.is() )
  88         mxIndicator->setValue( static_cast< sal_Int32 >( mfPosition * PROGRESS_RANGE ) );
  89 }
  90
  91 // ============================================================================
  92
  93 namespace prv {
  94
  95 class SubSegment : public ISegmentProgressBar
  96 {
  97 public:
  98     explicit            SubSegment( IProgressBar& rParentProgress, double fStartPos, double fLength );
  99
 100     virtual double      getPosition() const;
 101     virtual void        setPosition( double fPosition );
 102
 103     virtual double      getFreeLength() const;
 104     virtual ISegmentProgressBarRef createSegment( double fLength );
 105
 106 private:
 107     IProgressBar&       mrParentProgress;
 108     double              mfStartPos;
 109     double              mfLength;
 110     double              mfPosition;
 111     double              mfFreeStart;
 112 };
 113
 114 // ----------------------------------------------------------------------------
 115
 116 SubSegment::SubSegment( IProgressBar& rParentProgress, double fStartPos, double fLength ) :
 117     mrParentProgress( rParentProgress ),
 118     mfStartPos( fStartPos ),
 119     mfLength( fLength ),
 120     mfPosition( 0.0 ),
 121     mfFreeStart( 0.0 )
 122 {
 123 }
 124
 125 double SubSegment::getPosition() const
 126 {
 127     return mfPosition;
 128 }
 129
 130 void SubSegment::setPosition( double fPosition )
 131 {
 132     OSL_ENSURE( (mfPosition <= fPosition) && (fPosition <= 1.0), "SubSegment::setPosition - invalid position" );
 133     mfPosition = getLimitedValue< double >( fPosition, mfPosition, 1.0 );
 134     mrParentProgress.setPosition( mfStartPos + mfPosition * mfLength );
 135 }
 136
 137 double SubSegment::getFreeLength() const
 138 {
 139     return 1.0 - mfFreeStart;
 140 }
 141
 142 ISegmentProgressBarRef SubSegment::createSegment( double fLength )
 143 {
 144     OSL_ENSURE( (0.0 < fLength) && (fLength <= getFreeLength()), "SubSegment::createSegment - invalid length" );
 145     fLength = getLimitedValue< double >( fLength, 0.0, getFreeLength() );
 146     ISegmentProgressBarRef xSegment( new prv::SubSegment( *this, mfFreeStart, fLength ) );
 147     mfFreeStart += fLength;
 148     return xSegment;
 149 }
 150
 151 } // namespace prv
 152
 153 // ============================================================================
 154
 155 SegmentProgressBar::SegmentProgressBar( const Reference< XStatusIndicator >& rxIndicator, const OUString& rText ) :
 156     maProgress( rxIndicator, rText ),
 157     mfFreeStart( 0.0 )
 158 {
 159 }
 160
 161 double SegmentProgressBar::getPosition() const
 162 {
 163     return maProgress.getPosition();
 164 }
 165
 166 void SegmentProgressBar::setPosition( double fPosition )
 167 {
 168     maProgress.setPosition( fPosition );
 169 }
 170
 171 double SegmentProgressBar::getFreeLength() const
 172 {
 173     return 1.0 - mfFreeStart;
 174 }
 175
 176 ISegmentProgressBarRef SegmentProgressBar::createSegment( double fLength )
 177 {
 178     OSL_ENSURE( (0.0 < fLength) && (fLength <= getFreeLength()), "SegmentProgressBar::createSegment - invalid length" );
 179     fLength = getLimitedValue< double >( fLength, 0.0, getFreeLength() );
 180     ISegmentProgressBarRef xSegment( new prv::SubSegment( maProgress, mfFreeStart, fLength ) );
 181     mfFreeStart += fLength;
 182     return xSegment;
 183 }
 184
 185 // ============================================================================
 186
 187 } // namespace oox
 188