LibreOffice Module oox (master): oox::SegmentProgressBar Class Reference

LibreOffice Module oox (master) 1

A progress bar containing several independent segments. More...

#include <progressbar.hxx>

Inheritance diagram for oox::SegmentProgressBar:

Collaboration diagram for oox::SegmentProgressBar:

Public Member Functions
	SegmentProgressBar (const css::uno::Reference< css::task::XStatusIndicator > &rxIndicator, const OUString &rText)

virtual double	getPosition () const override
	Returns the current position of the progress bar segment. More...

virtual void	setPosition (double fPosition) override
	Sets the current position of the progress bar segment. More...

virtual double	getFreeLength () const override
	Returns the length that is still free for creating sub segments. More...

virtual ISegmentProgressBarRef	createSegment (double fLength) override
	Adds a new segment with the specified length. More...

Public Member Functions inherited from oox::ISegmentProgressBar
virtual	~ISegmentProgressBar () override

virtual double	getFreeLength () const =0
	Returns the length that is still free for creating sub segments. More...

virtual ISegmentProgressBarRef	createSegment (double fLength)=0
	Adds a new segment with the specified length. More...

Public Member Functions inherited from oox::IProgressBar
virtual	~IProgressBar ()

virtual double	getPosition () const =0
	Returns the current position of the progress bar. More...

virtual void	setPosition (double fPosition)=0
	Sets the current position of the progress bar. More...

Private Attributes
ProgressBar	maProgress

double	mfFreeStart

Detailed Description

A progress bar containing several independent segments.

Definition at line 105 of file progressbar.hxx.

Constructor & Destructor Documentation

◆ SegmentProgressBar()

oox::SegmentProgressBar::SegmentProgressBar	(	const css::uno::Reference< css::task::XStatusIndicator > &	rxIndicator,
		const OUString &	rText
	)

explicit

Definition at line 135 of file progressbar.cxx.

Member Function Documentation

◆ createSegment()

ISegmentProgressBarRef oox::SegmentProgressBar::createSegment ( double fLength )

overridevirtual

Adds a new segment with the specified length.

Implements oox::ISegmentProgressBar.

Definition at line 156 of file progressbar.cxx.

References getFreeLength(), maProgress, mfFreeStart, and SAL_WARN_IF.

◆ getFreeLength()

double oox::SegmentProgressBar::getFreeLength ( ) const

overridevirtual

Returns the length that is still free for creating sub segments.

Implements oox::ISegmentProgressBar.

Definition at line 151 of file progressbar.cxx.

References mfFreeStart.

Referenced by createSegment().

◆ getPosition()

double oox::SegmentProgressBar::getPosition ( ) const

overridevirtual

Returns the current position of the progress bar segment.

Implements oox::IProgressBar.

Definition at line 141 of file progressbar.cxx.

References oox::ProgressBar::getPosition(), and maProgress.

◆ setPosition()

void oox::SegmentProgressBar::setPosition ( double fPosition )

overridevirtual

Sets the current position of the progress bar segment.

Implements oox::IProgressBar.

Definition at line 146 of file progressbar.cxx.

References maProgress, and oox::ProgressBar::setPosition().

Member Data Documentation

◆ maProgress

ProgressBar oox::SegmentProgressBar::maProgress

private

Definition at line 123 of file progressbar.hxx.

Referenced by createSegment(), getPosition(), and setPosition().

◆ mfFreeStart

double oox::SegmentProgressBar::mfFreeStart

private

Definition at line 124 of file progressbar.hxx.

Referenced by createSegment(), and getFreeLength().

The documentation for this class was generated from the following files: