framework::StatusIndicator Class Reference

implement a status indicator object More...

#include <statusindicator.hxx>

Inheritance diagram for framework::StatusIndicator:

Collaboration diagram for framework::StatusIndicator:

Public Member Functions
	StatusIndicator (StatusIndicatorFactory *pFactory)
	initialize new instance of this class. More...
virtual	~StatusIndicator () override
	does nothing real... More...
virtual void SAL_CALL	start (const OUString &sText, sal_Int32 nRange) override
virtual void SAL_CALL	end () override
virtual void SAL_CALL	reset () override
virtual void SAL_CALL	setText (const OUString &sText) override
virtual void SAL_CALL	setValue (sal_Int32 nValue) override

Private Attributes
css::uno::WeakReference< css::task::XStatusIndicatorFactory >	m_xFactory
	weak reference to our factory @descr All our interface calls will be forwarded to a suitable c++ interface on this factory. More...
sal_Int32	m_nRange
int	m_nLastCallbackPercent

Detailed Description

implement a status indicator object

@descr With this indicator you can show a message and a progress... but you share the output device with other indicator objects, if this instances was created by the same factory. Then the last created object has full access to device. All others change her internal data structure only.

All objects of this StatusIndicator class calls a C++ interface on the StatusIndicatorFactory (where they were created). The factory holds all data structures and paints the progress.

@devstatus ready to use @threadsafe yes

Definition at line 50 of file statusindicator.hxx.

Constructor & Destructor Documentation

StatusIndicator()

framework::StatusIndicator::StatusIndicator

(

StatusIndicatorFactory *

pFactory

)

initialize new instance of this class.

Parameters

pFactory

pointer to our factory

Definition at line 25 of file statusindicator.cxx.

~StatusIndicator()

framework::StatusIndicator::~StatusIndicator ( )

overridevirtual

does nothing real...

Definition at line 32 of file statusindicator.cxx.

Member Function Documentation

end()

void SAL_CALL framework::StatusIndicator::end ( )

overridevirtual

Definition at line 55 of file statusindicator.cxx.

References framework::StatusIndicatorFactory::end(), comphelper::LibreOfficeKit::isActive(), m_xFactory, comphelper::LibreOfficeKit::statusIndicatorFinish(), and xFactory.

reset()

void SAL_CALL framework::StatusIndicator::reset ( )

overridevirtual

Definition at line 71 of file statusindicator.cxx.

References comphelper::LibreOfficeKit::isActive(), m_xFactory, framework::StatusIndicatorFactory::reset(), and xFactory.

setText()

void SAL_CALL framework::StatusIndicator::setText ( const OUString &  sText )

overridevirtual

Definition at line 85 of file statusindicator.cxx.

References comphelper::LibreOfficeKit::isActive(), m_xFactory, framework::StatusIndicatorFactory::setText(), and xFactory.

setValue()

void SAL_CALL framework::StatusIndicator::setValue ( sal_Int32  nValue )

overridevirtual

Definition at line 101 of file statusindicator.cxx.

References comphelper::LibreOfficeKit::isActive(), m_nLastCallbackPercent, m_nRange, m_xFactory, nValue, framework::StatusIndicatorFactory::setValue(), comphelper::LibreOfficeKit::statusIndicatorSetValue(), and xFactory.

start()

void SAL_CALL framework::StatusIndicator::start ( const OUString &  sText, sal_Int32  nRange  )

overridevirtual

Definition at line 34 of file statusindicator.cxx.

References comphelper::LibreOfficeKit::isActive(), m_nLastCallbackPercent, m_nRange, m_xFactory, framework::StatusIndicatorFactory::start(), comphelper::LibreOfficeKit::statusIndicatorStart(), and xFactory.

Member Data Documentation

m_nLastCallbackPercent

int framework::StatusIndicator::m_nLastCallbackPercent

private

Definition at line 68 of file statusindicator.hxx.

Referenced by setValue(), and start().

m_nRange

sal_Int32 framework::StatusIndicator::m_nRange

private

Definition at line 66 of file statusindicator.hxx.

Referenced by setValue(), and start().

m_xFactory

css::uno::WeakReference< css::task::XStatusIndicatorFactory > framework::StatusIndicator::m_xFactory

private

weak reference to our factory @descr All our interface calls will be forwarded to a suitable c++ interface on this factory.

But we don't hold our factory alive. They correspond with e.g. with a Frame service and will be owned by him. If the frame will be closed he close our factory too ...

Definition at line 64 of file statusindicator.hxx.

Referenced by end(), reset(), setText(), setValue(), and start().

---

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

• statusindicator.hxx
• statusindicator.cxx