LibreOffice Module framework (master) 1
Public Member Functions | Public Attributes | List of all members
framework::IndicatorInfo Struct Reference

@descr This struct hold some information about all currently running progress processes. More...

#include <statusindicatorfactory.hxx>

Public Member Functions

 IndicatorInfo (const css::uno::Reference< css::task::XStatusIndicator > &xIndicator, const OUString &sText)
 initialize new instance of this class More...
 
bool operator== (const css::uno::Reference< css::task::XStatusIndicator > &xIndicator) const
 Used to locate an info struct inside a stl structure... More...
 

Public Attributes

css::uno::Reference< css::task::XStatusIndicator > m_xIndicator
 points to the indicator child, where we hold its states alive here. More...
 
OUString m_sText
 the last set text for this indicator More...
 
sal_Int32 m_nValue
 the last set value for this indicator More...
 

Detailed Description

@descr This struct hold some information about all currently running progress processes.

Because the can be used on a stack, we must cache her states but must paint only the top most one.

Definition at line 51 of file statusindicatorfactory.hxx.

Constructor & Destructor Documentation

◆ IndicatorInfo()

framework::IndicatorInfo::IndicatorInfo ( const css::uno::Reference< css::task::XStatusIndicator > &  xIndicator,
const OUString &  sText 
)
inline

initialize new instance of this class

Parameters
xIndicatorthe new child indicator of our factory.
sTextits initial text.
nRangethe max range for this indicator.

Definition at line 81 of file statusindicatorfactory.hxx.

References m_nValue, m_sText, and m_xIndicator.

Member Function Documentation

◆ operator==()

bool framework::IndicatorInfo::operator== ( const css::uno::Reference< css::task::XStatusIndicator > &  xIndicator) const
inline

Used to locate an info struct inside a stl structure...

@descr The indicator object itself is used as key. Its values are not interesting then. Because more than one child indicator can use the same values...

Definition at line 95 of file statusindicatorfactory.hxx.

References m_xIndicator.

Member Data Documentation

◆ m_nValue

sal_Int32 framework::IndicatorInfo::m_nValue

the last set value for this indicator

Definition at line 65 of file statusindicatorfactory.hxx.

Referenced by IndicatorInfo().

◆ m_sText

OUString framework::IndicatorInfo::m_sText

the last set text for this indicator

Definition at line 62 of file statusindicatorfactory.hxx.

Referenced by IndicatorInfo().

◆ m_xIndicator

css::uno::Reference< css::task::XStatusIndicator > framework::IndicatorInfo::m_xIndicator

points to the indicator child, where we hold its states alive here.

Definition at line 59 of file statusindicatorfactory.hxx.

Referenced by IndicatorInfo(), and operator==().


The documentation for this struct was generated from the following file: