include/cppuhelper/compbase3.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef INCLUDED_CPPUHELPER_COMPBASE3_HXX
  20 #define INCLUDED_CPPUHELPER_COMPBASE3_HXX
  21
  22 #include "cppuhelper/implbase3.hxx"
  23 #include "cppuhelper/compbase_ex.hxx"
  24
  25 namespace cppu
  26 {
  27
  28     /** Implementation helper supporting css::lang::XTypeProvider and
  29         css::lang::XComponent.
  30
  31         Upon disposing objects of this class, sub-classes receive a disposing()
  32         call.  Objects of this class can be held weakly, i.e. by a
  33         css::uno::WeakReference.
  34
  35         @attention
  36         The life-cycle of the passed mutex reference has to be longer than objects of this class.
  37
  38         @derive
  39         Inherit from this class giving your interface(s) to be implemented as template argument(s).
  40         Your sub class defines method implementations for these interface(s).
  41     */
  42     template< class Ifc1, class Ifc2, class Ifc3 >
  43     class SAL_NO_VTABLE SAL_DLLPUBLIC_TEMPLATE WeakComponentImplHelper3
  44         : public WeakComponentImplHelperBase
  45         , public css::lang::XTypeProvider
  46         , public Ifc1, public Ifc2, public Ifc3
  47     {
  48         struct cd : public rtl::StaticAggregate< class_data, ImplClassData3 < Ifc1, Ifc2, Ifc3, WeakComponentImplHelper3<Ifc1, Ifc2, Ifc3> > > {};
  49     public:
  50         WeakComponentImplHelper3( ::osl::Mutex & rMutex ) throw ()
  51             : WeakComponentImplHelperBase( rMutex )
  52             {}
  53         virtual css::uno::Any SAL_CALL queryInterface( css::uno::Type const & rType ) SAL_OVERRIDE
  54             { return WeakComponentImplHelper_query( rType, cd::get(), this, static_cast<WeakComponentImplHelperBase *>(this) ); }
  55         virtual void SAL_CALL acquire() throw () SAL_OVERRIDE
  56             { WeakComponentImplHelperBase::acquire(); }
  57         virtual void SAL_CALL release() throw () SAL_OVERRIDE
  58             { WeakComponentImplHelperBase::release(); }
  59         virtual void SAL_CALL dispose() SAL_OVERRIDE
  60             { WeakComponentImplHelperBase::dispose(); }
  61         virtual void SAL_CALL addEventListener(const css::uno::Reference< css::lang::XEventListener > & xListener) SAL_OVERRIDE
  62             { WeakComponentImplHelperBase::addEventListener(xListener); }
  63         virtual void SAL_CALL removeEventListener(const css::uno::Reference< css::lang::XEventListener > & xListener) SAL_OVERRIDE
  64             { WeakComponentImplHelperBase::removeEventListener(xListener); }
  65         virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes() SAL_OVERRIDE
  66             { return WeakComponentImplHelper_getTypes( cd::get() ); }
  67         virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() SAL_OVERRIDE
  68             { return ImplHelper_getImplementationId( cd::get() ); }
  69     };
  70
  71     /** Same as WeakComponentImplHelper3, except doesn't implement
  72         addEventListener, removeEventListener and dispose.
  73
  74         This requires derived classes to implement those three methods.
  75         This makes it possible to implement classes which are required to
  76         implement methods from multiple bases which have different
  77         addEventListener/removeEventListener signatures without triggering
  78         the g++ overloaded-virtual warning
  79     */
  80     template< class Ifc1, class Ifc2, class Ifc3 >
  81     class SAL_NO_VTABLE SAL_DLLPUBLIC_TEMPLATE PartialWeakComponentImplHelper3
  82         : public WeakComponentImplHelperBase
  83         , public css::lang::XTypeProvider
  84         , public Ifc1, public Ifc2, public Ifc3
  85     {
  86         struct cd : public rtl::StaticAggregate< class_data, ImplClassData3 < Ifc1, Ifc2, Ifc3, PartialWeakComponentImplHelper3<Ifc1, Ifc2, Ifc3> > > {};
  87     public:
  88         PartialWeakComponentImplHelper3( ::osl::Mutex & rMutex ) throw ()
  89             : WeakComponentImplHelperBase( rMutex )
  90             {}
  91         virtual css::uno::Any SAL_CALL queryInterface( css::uno::Type const & rType ) SAL_OVERRIDE
  92             { return WeakComponentImplHelper_query( rType, cd::get(), this, static_cast<WeakComponentImplHelperBase *>(this) ); }
  93         virtual void SAL_CALL acquire() throw () SAL_OVERRIDE
  94             { WeakComponentImplHelperBase::acquire(); }
  95         virtual void SAL_CALL release() throw () SAL_OVERRIDE
  96             { WeakComponentImplHelperBase::release(); }
  97         virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes() SAL_OVERRIDE
  98             { return WeakComponentImplHelper_getTypes( cd::get() ); }
  99         virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() SAL_OVERRIDE
 100             { return ImplHelper_getImplementationId( cd::get() ); }
 101     };
 102
 103     /** Implementation helper supporting css::lang::XTypeProvider and
 104         css::lang::XComponent.
 105
 106         Upon disposing objects of this class, sub-classes receive a disposing()
 107         call.  Objects of this class can be held weakly, i.e. by a
 108         css::uno::WeakReference.  Object of this class can be
 109         aggregated, i.e. incoming queryInterface() calls are delegated.
 110
 111         @attention
 112         The life-cycle of the passed mutex reference has to be longer than objects of this class.
 113
 114         @derive
 115         Inherit from this class giving your interface(s) to be implemented as template argument(s).
 116         Your sub class defines method implementations for these interface(s).
 117
 118         @deprecated
 119     */
 120     template< class Ifc1, class Ifc2, class Ifc3 >
 121     class SAL_NO_VTABLE SAL_DLLPUBLIC_TEMPLATE WeakAggComponentImplHelper3
 122         : public WeakAggComponentImplHelperBase
 123         , public css::lang::XTypeProvider
 124         , public Ifc1, public Ifc2, public Ifc3
 125     {
 126         struct cd : public rtl::StaticAggregate< class_data, ImplClassData3 < Ifc1, Ifc2, Ifc3, WeakAggComponentImplHelper3<Ifc1, Ifc2, Ifc3> > > {};
 127     public:
 128         WeakAggComponentImplHelper3( ::osl::Mutex & rMutex ) throw ()
 129             : WeakAggComponentImplHelperBase( rMutex )
 130             {}
 131         virtual css::uno::Any SAL_CALL queryInterface( css::uno::Type const & rType ) SAL_OVERRIDE
 132             { return WeakAggComponentImplHelperBase::queryInterface( rType ); }
 133         virtual css::uno::Any SAL_CALL queryAggregation( css::uno::Type const & rType ) SAL_OVERRIDE
 134             { return WeakAggComponentImplHelper_queryAgg( rType, cd::get(), this, static_cast<WeakAggComponentImplHelperBase *>(this) ); }
 135         virtual void SAL_CALL acquire() throw () SAL_OVERRIDE
 136             { WeakAggComponentImplHelperBase::acquire(); }
 137         virtual void SAL_CALL release() throw () SAL_OVERRIDE
 138             { WeakAggComponentImplHelperBase::release(); }
 139         virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes() SAL_OVERRIDE
 140             { return WeakAggComponentImplHelper_getTypes( cd::get() ); }
 141         virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() SAL_OVERRIDE
 142             { return ImplHelper_getImplementationId( cd::get() ); }
 143     };
 144 }
 145
 146 #endif
 147
 148 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */