fprogressbar.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
 
#pragma once
 
#include <vector>
#include <memory>
#include <rtl/ustring.hxx>
#include <progress.hxx>
#include <unotools/resmgr.hxx>
 
class SfxObjectShell;
class SvStream;
 
const sal_Int32 SCF_INV_SEGMENT = -1;
 
class ScfProgressBar final
{
public:
    ScfProgressBar(const ScfProgressBar&) = delete;
    const ScfProgressBar operator=(const ScfProgressBar&) = delete;
 
    explicit            ScfProgressBar(SfxObjectShell* pDocShell, OUString aText);
    explicit            ScfProgressBar(SfxObjectShell* pDocShell, TranslateId pResId);
                        ~ScfProgressBar();
 
    sal_Int32           AddSegment( std::size_t nSize );
    ScfProgressBar&     GetSegmentProgressBar( sal_Int32 nSegment );
 
    bool                IsFull() const;
 
    void                ActivateSegment( sal_Int32 nSegment );
    void         Activate() { ActivateSegment( 0 ); }
    void                ProgressAbs( std::size_t nPos );
    void                Progress( std::size_t nDelta = 1 );
 
private:
    struct ScfProgressSegment;
 
    explicit            ScfProgressBar(
                            ScfProgressBar& rParProgress,
                            ScfProgressSegment* pParSegment );
 
    void                Init( SfxObjectShell* pDocShell );
 
    ScfProgressSegment* GetSegment( sal_Int32 nSegment );
    void                SetCurrSegment( ScfProgressSegment* pSegment );
    void                IncreaseProgressBar( std::size_t nDelta );
 
private:
    struct ScfProgressSegment
    {
        typedef ::std::unique_ptr< ScfProgressBar > ScfProgressBarPtr;
 
        ScfProgressBarPtr   mxProgress;     
        std::size_t         mnSize;         
        std::size_t         mnPos;          
 
        explicit            ScfProgressSegment( std::size_t nSize );
                            ~ScfProgressSegment();
    };
 
    typedef ::std::unique_ptr< ScProgress >         ScProgressPtr;
    typedef std::vector< std::unique_ptr<ScfProgressSegment> > ScfSegmentList;
 
    ScfSegmentList      maSegments;         
    OUString            maText;             
 
    ScProgressPtr       mxSysProgress;      
    SfxObjectShell*     mpDocShell;         
    ScfProgressBar*     mpParentProgress;   
    ScfProgressSegment* mpParentSegment;    
    ScfProgressSegment* mpCurrSegment;      
 
    std::size_t         mnTotalSize;        
    std::size_t         mnTotalPos;         
    std::size_t         mnUnitSize;         
    std::size_t         mnNextUnitPos;      
    std::size_t         mnSysProgressScale; 
    bool                mbInProgress;       
};
 
class ScfSimpleProgressBar
{
public:
    explicit            ScfSimpleProgressBar(std::size_t nSize, SfxObjectShell* pDocShell, const OUString& rText);
    explicit            ScfSimpleProgressBar(std::size_t nSize, SfxObjectShell* pDocShell, TranslateId pResId);
 
    void         ProgressAbs( std::size_t nPos ) { maProgress.ProgressAbs( nPos ); }
 
private:
    void                Init( std::size_t nSize );
 
private:
    ScfProgressBar      maProgress;     
};
 
class ScfStreamProgressBar
{
public:
    explicit            ScfStreamProgressBar( SvStream& rStrm, SfxObjectShell* pDocShell );
 
    void                Progress();
 
private:
    void                Init( SfxObjectShell* pDocShell, const OUString& rText );
 
private:
    typedef ::std::unique_ptr< ScfSimpleProgressBar > ScfSimpleProgressBarPtr;
 
    ScfSimpleProgressBarPtr mxProgress; 
    SvStream&           mrStrm;         
};
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */