My Project
UDK 3.2.7 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 Reference

Deprecated. More...

#include <component.hxx>

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

Public Member Functions

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

Protected Member Functions

virtual void disposing ()
 Called in dispose method after the listeners were notified.
- Protected Member Functions inherited from cppu::OWeakAggObject
virtual ~OWeakAggObject () throw (::com::sun::star::uno::RuntimeException)
 Virtual dtor.
- Protected Member Functions inherited from cppu::OWeakObject
virtual ~OWeakObject () throw (::com::sun::star::uno::RuntimeException)
 Virtual dtor.
void disposeWeakConnectionPoint ()
 disposes and resets m_pWeakConnectionPoint m_refCount equals 0

Additional Inherited Members

- Protected Attributes inherited from cppu::OWeakAggObject
::com::sun::star::uno::WeakReferenceHelper xDelegator
 weak reference to delegator.

Detailed Description

Deprecated.

Helper for implementing ::com::sun::star::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 com::sun::star::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) throw ()

Constructor.

Parameters
rMutexthe mutex used to protect multi-threaded access; lifetime must be longer than the lifetime of this object.
virtual cppu::OComponentHelper::~OComponentHelper ( ) throw (::com::sun::star::uno::RuntimeException)
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 ::com::sun::star::uno::Reference< ::com::sun::star::lang::XEventListener > &  aListener) throw (::com::sun::star::uno::RuntimeException)
virtual
virtual void cppu::OComponentHelper::dispose ( ) throw (::com::sun::star::uno::RuntimeException)
virtual
virtual void cppu::OComponentHelper::disposing ( )
protectedvirtual

Called in dispose method after the listeners were notified.

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

Called by the delegator or queryInterface.

Re-implement this method instead of queryInterface.

See Also
queryInterface

Reimplemented from cppu::OWeakAggObject.

virtual ::com::sun::star::uno::Any cppu::OComponentHelper::queryInterface ( ::com::sun::star::uno::Type const &  rType) throw (::com::sun::star::uno::RuntimeException)

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 ::com::sun::star::uno::Reference< ::com::sun::star::lang::XEventListener > &  aListener) throw (::com::sun::star::uno::RuntimeException)
virtual

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