Files
loongoffice/include/oox/helper/progressbar.hxx
Stephan Bergmann 567ef6d578 Second batch of adding SAL_OVERRIDE to overriding function declarations
...mostly done with a rewriting Clang plugin, with just some manual tweaking
necessary to fix poor macro usage.

Change-Id: Ie656f9d653fc716f72ac175925272696d509038f
2014-03-27 18:12:18 +01:00

139 lines
4.4 KiB
C++

/* -*- 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 .
*/
#ifndef INCLUDED_OOX_HELPER_PROGRESSBAR_HXX
#define INCLUDED_OOX_HELPER_PROGRESSBAR_HXX
#include <boost/shared_ptr.hpp>
#include <com/sun/star/uno/Reference.hxx>
#include <oox/dllapi.h>
namespace com { namespace sun { namespace star {
namespace task { class XStatusIndicator; }
} } }
namespace oox {
// Interfaces =================================================================
/** Interface for progress bar classes.
*/
class OOX_DLLPUBLIC IProgressBar
{
public:
virtual ~IProgressBar();
/** Returns the current position of the progress bar.
@return Position of the progress bar, in the range from 0.0 (beginning
of the progress bar) to 1.0 (end of the progress bar) inclusive.
*/
virtual double getPosition() const = 0;
/** Sets the current position of the progress bar.
@param fPosition New position of the progress bar, in the range from
0.0 (beginning of the progress bar) to 1.0 (end of the progress bar)
inclusive.
*/
virtual void setPosition( double fPosition ) = 0;
};
typedef ::boost::shared_ptr< IProgressBar > IProgressBarRef;
class ISegmentProgressBar;
typedef ::boost::shared_ptr< ISegmentProgressBar > ISegmentProgressBarRef;
/** Interface for a segment in a progress bar, that is able to create sub
segments from itself.
*/
class OOX_DLLPUBLIC ISegmentProgressBar : public IProgressBar
{
public:
virtual ~ISegmentProgressBar();
/** Returns the length that is still free for creating sub segments. */
virtual double getFreeLength() const = 0;
/** Adds a new segment with the specified length. */
virtual ISegmentProgressBarRef createSegment( double fLength ) = 0;
};
/** A simple progress bar.
*/
class OOX_DLLPUBLIC ProgressBar : public IProgressBar
{
public:
explicit ProgressBar(
const ::com::sun::star::uno::Reference< ::com::sun::star::task::XStatusIndicator >& rxIndicator,
const OUString& rText );
virtual ~ProgressBar();
/** Returns the current position of the progress bar. */
virtual double getPosition() const SAL_OVERRIDE;
/** Sets the current position of the progress bar. */
virtual void setPosition( double fPosition ) SAL_OVERRIDE;
private:
::com::sun::star::uno::Reference< ::com::sun::star::task::XStatusIndicator >
mxIndicator;
double mfPosition;
};
/** A progress bar containing several independent segments.
*/
class OOX_DLLPUBLIC SegmentProgressBar : public ISegmentProgressBar
{
public:
explicit SegmentProgressBar(
const ::com::sun::star::uno::Reference< ::com::sun::star::task::XStatusIndicator >& rxIndicator,
const OUString& rText );
/** Returns the current position of the progress bar segment. */
virtual double getPosition() const SAL_OVERRIDE;
/** Sets the current position of the progress bar segment. */
virtual void setPosition( double fPosition ) SAL_OVERRIDE;
/** Returns the length that is still free for creating sub segments. */
virtual double getFreeLength() const SAL_OVERRIDE;
/** Adds a new segment with the specified length. */
virtual ISegmentProgressBarRef createSegment( double fLength ) SAL_OVERRIDE;
private:
ProgressBar maProgress;
double mfFreeStart;
};
} // namespace oox
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */