LibreOffice
LibreOffice 5.3 SDK C/C++ API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Protected Member Functions | List of all members
cppu::OComponentHelper Class Referenceabstract

Deprecated. More...

#include <component.hxx>

Inheritance diagram for cppu::OComponentHelper:
cppu::OWeakAggObject cppu::OWeakObject

Public Member Functions

 OComponentHelper (::osl::Mutex &rMutex)
 Constructor. More...
 
virtual ~OComponentHelper () SAL_OVERRIDE
 Destructor. More...
 
virtual css::uno::Any queryInterface (css::uno::Type const &rType) SAL_OVERRIDE throw (css::uno::RuntimeException, std::exception)
 If a delegator is set, then the delegator is queried for the demanded interface. More...
 
virtual css::uno::Any queryAggregation (css::uno::Type const &rType) SAL_OVERRIDE throw (css::uno::RuntimeException, std::exception)
 Called by the delegator or queryInterface. More...
 
virtual void acquire () SAL_OVERRIDE throw ()
 If a delegator is set, then the delegators gets acquired. More...
 
virtual void release () SAL_OVERRIDE throw ()
 If a delegator is set, then the delegators gets released. More...
 
virtual css::uno::Sequence
< sal_Int8
getImplementationId () SAL_OVERRIDE=0 throw (css::uno::RuntimeException, std::exception)
 
virtual css::uno::Sequence
< css::uno::Type > 
getTypes () SAL_OVERRIDE throw (css::uno::RuntimeException, std::exception)
 
virtual void dispose () SAL_OVERRIDE throw (css::uno::RuntimeException, std::exception)
 
virtual void addEventListener (const css::uno::Reference< css::lang::XEventListener > &aListener) SAL_OVERRIDE throw (css::uno::RuntimeException, std::exception)
 
virtual void removeEventListener (const css::uno::Reference< css::lang::XEventListener > &aListener) SAL_OVERRIDE throw (css::uno::RuntimeException, std::exception)
 
- Public Member Functions inherited from cppu::OWeakAggObject
 OWeakAggObject ()
 Constructor. More...
 
virtual void setDelegator (const css::uno::Reference< css::uno::XInterface > &Delegator) SAL_OVERRIDE throw (css::uno::RuntimeException, std::exception)
 Set the delegator. More...
 
- Public Member Functions inherited from cppu::OWeakObject
 OWeakObject ()
 Default Constructor. More...
 
 OWeakObject (const OWeakObject &rObj)
 Dummy copy constructor. More...
 
OWeakObjectoperator= (const OWeakObject &)
 Dummy assignment operator. More...
 
virtual css::uno::Reference
< css::uno::XAdapter > 
queryAdapter () SAL_OVERRIDE throw (css::uno::RuntimeException, std::exception)
 XWeak::queryAdapter() implementation. More...
 
 operator css::uno::Reference< css::uno::XInterface > ()
 Cast operator to XInterface reference. More...
 

Protected Member Functions

virtual void disposing ()
 Called in dispose method after the listeners were notified. More...
 
- Protected Member Functions inherited from cppu::OWeakAggObject
virtual ~OWeakAggObject () SAL_OVERRIDE
 Virtual dtor. More...
 
- Protected Member Functions inherited from cppu::OWeakObject
virtual ~OWeakObject ()
 Virtual dtor. More...
 
void disposeWeakConnectionPoint ()
 disposes and resets m_pWeakConnectionPoint More...
 

Additional Inherited Members

- Protected Attributes inherited from cppu::OWeakAggObject
css::uno::WeakReferenceHelper xDelegator
 weak reference to delegator. More...
 
- Protected Attributes inherited from cppu::OWeakObject
oslInterlockedCount m_refCount
 reference count. More...
 

Detailed Description

Deprecated.

Helper for implementing css::lang::XComponent. Upon disposing objects of this class, sub-classes receive a disposing() call. Objects of this class can be held weakly, i.e. by a css::uno::WeakReference. Object of this class can be aggregated, i.e. incoming queryInterface() calls are delegated.

Attention
The life-cycle of the passed mutex reference has to be longer than objects of this class.
Deprecated:

Constructor & Destructor Documentation

cppu::OComponentHelper::OComponentHelper ( ::osl::Mutex rMutex)

Constructor.

Parameters
rMutexthe mutex used to protect multi-threaded access; lifetime must be longer than the lifetime of this object.
virtual cppu::OComponentHelper::~OComponentHelper ( )
virtual

Destructor.

If this object was not disposed previously, object will be disposed manually.

Member Function Documentation

virtual void cppu::OComponentHelper::acquire ( )
throw (
)
virtual

If a delegator is set, then the delegators gets acquired.

Otherwise call is delegated to base class cppu::OWeakObject.

Reimplemented from cppu::OWeakAggObject.

virtual void cppu::OComponentHelper::addEventListener ( const css::uno::Reference< css::lang::XEventListener > &  aListener)
throw (css::uno::RuntimeException,
std::exception
)
virtual
virtual void cppu::OComponentHelper::dispose ( )
throw (css::uno::RuntimeException,
std::exception
)
virtual
virtual void cppu::OComponentHelper::disposing ( )
protectedvirtual

Called in dispose method after the listeners were notified.

virtual css::uno::Sequence< sal_Int8 > cppu::OComponentHelper::getImplementationId ( )
throw (css::uno::RuntimeException,
std::exception
)
pure virtual
Attention
XTypeProvider::getImplementationId() has to be implemented separately!
virtual css::uno::Sequence< css::uno::Type > cppu::OComponentHelper::getTypes ( )
throw (css::uno::RuntimeException,
std::exception
)
virtual
Attention
XTypeProvider::getTypes() has to be re-implemented!
virtual css::uno::Any cppu::OComponentHelper::queryAggregation ( css::uno::Type const &  rType)
throw (css::uno::RuntimeException,
std::exception
)
virtual

Called by the delegator or queryInterface.

Re-implement this method instead of queryInterface.

See Also
queryInterface

Reimplemented from cppu::OWeakAggObject.

virtual css::uno::Any cppu::OComponentHelper::queryInterface ( css::uno::Type const &  rType)
throw (css::uno::RuntimeException,
std::exception
)
virtual

If a delegator is set, then the delegator is queried for the demanded interface.

If the delegator cannot provide the demanded interface, it calls queryAggregation() on its aggregated objects.

Parameters
rTypedemanded interface type
Returns
demanded type or empty any
See Also
queryAggregation.

Reimplemented from cppu::OWeakAggObject.

virtual void cppu::OComponentHelper::release ( )
throw (
)
virtual

If a delegator is set, then the delegators gets released.

Otherwise call is delegated to base class cppu::OWeakObject.

Reimplemented from cppu::OWeakAggObject.

virtual void cppu::OComponentHelper::removeEventListener ( const css::uno::Reference< css::lang::XEventListener > &  aListener)
throw (css::uno::RuntimeException,
std::exception
)
virtual

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