diff options
author | Daniel Boelzle <dbo@openoffice.org> | 2001-05-14 10:58:06 +0000 |
---|---|---|
committer | Daniel Boelzle <dbo@openoffice.org> | 2001-05-14 10:58:06 +0000 |
commit | 94efb043e4b6ca43a3b545cd3a05ef7b9fe7f5a9 (patch) | |
tree | 2d6b83bb804b1b3b8cfe0a96cec5a5f514ddffb8 /cppuhelper/inc/cppuhelper/implbase6.hxx | |
parent | 6c489e0902503ba9dd138b8e0dbaf78110ee713f (diff) |
API documentation
Diffstat (limited to 'cppuhelper/inc/cppuhelper/implbase6.hxx')
-rw-r--r-- | cppuhelper/inc/cppuhelper/implbase6.hxx | 40 |
1 files changed, 38 insertions, 2 deletions
diff --git a/cppuhelper/inc/cppuhelper/implbase6.hxx b/cppuhelper/inc/cppuhelper/implbase6.hxx index 3ee92ae0fc0e..55793bd23b8b 100644 --- a/cppuhelper/inc/cppuhelper/implbase6.hxx +++ b/cppuhelper/inc/cppuhelper/implbase6.hxx @@ -2,9 +2,9 @@ * * $RCSfile: implbase6.hxx,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: dbo $ $Date: 2001-03-15 15:47:29 $ + * last change: $Author: dbo $ $Date: 2001-05-14 11:58:06 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -84,6 +84,16 @@ namespace cppu : ClassDataBase( nClassCode ) {} }; + /** This template class serves as a base class for all subsequent implementation helper classes. + It inherits from given interfaces (template parameters) and com.sun.star.lang.XTypeProvider. + + Do not use this class directly, use + ImplHelperBaseN<>, + WeakImplHelperN<>, + WeakAggImplHelperN<> + WeakComponentImplHelperN<>, + WeakAggComponentImplHelperN<>. + */ template< class Ifc1, class Ifc2, class Ifc3, class Ifc4, class Ifc5, class Ifc6 > class ImplHelperBase6 : public ::com::sun::star::lang::XTypeProvider @@ -117,6 +127,14 @@ namespace cppu return rCD; } }; + /** This template class inherits from ImplHelperBaseN<> and implements + com.sun.star.uno.XInterface::queryInterface() and the com.sun.star.lang.XTypeProvider + interface. + + All other virtual functions (inherited from given template parameter interfaces) + have to be implemented by sub-classing from the templated class, e.g. + class MyImpl : public ::cppu::ImplHelperN<> { ... }; + */ template< class Ifc1, class Ifc2, class Ifc3, class Ifc4, class Ifc5, class Ifc6 > class ImplHelper6 : public ImplHelperBase6< Ifc1, Ifc2, Ifc3, Ifc4, Ifc5, Ifc6 > @@ -130,6 +148,15 @@ namespace cppu virtual ::com::sun::star::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() throw (::com::sun::star::uno::RuntimeException) { return getClassData( s_aCD ).getImplementationId(); } }; + /** This template class inherits from ::cppu::ImplHelperBaseN<> and ::cppu::OWeakObject, + thus delegating life-cycle to that implementation. + Use this helper implementing an object, that can be held weakly, using the + ::cppu::WeakReference<> template class. + + All other virtual functions (inherited from given template parameter interfaces) + have to be implemented by sub-classing from the templated class, e.g. + class MyImpl : public ::cppu::WeakImplHelperN<> { ... }; + */ template< class Ifc1, class Ifc2, class Ifc3, class Ifc4, class Ifc5, class Ifc6 > class WeakImplHelper6 : public ::cppu::OWeakObject @@ -151,6 +178,15 @@ namespace cppu virtual ::com::sun::star::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() throw (::com::sun::star::uno::RuntimeException) { return getClassData( s_aCD ).getImplementationId(); } }; + /** This template class inherits from ::cppu::ImplHelperBaseN<> and ::cppu::OWeakAggObject, + thus delegating life-cycle to that implementation. + Use this helper implementing an object, that can be held weakly using the + ::cppu::WeakReference<> template class and can be aggregated by other objects. + + All other virtual functions (inherited from given template parameter interfaces) + have to be implemented by sub-classing from the templated class, e.g. + class MyImpl : public ::cppu::WeakAggImplHelperN<> { ... }; + */ template< class Ifc1, class Ifc2, class Ifc3, class Ifc4, class Ifc5, class Ifc6 > class WeakAggImplHelper6 : public ::cppu::OWeakAggObject |