1*cdf0e10cSrcweir /************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir #ifndef _CPPUHELPER_WEAKAGG_HXX_ 28*cdf0e10cSrcweir #define _CPPUHELPER_WEAKAGG_HXX_ 29*cdf0e10cSrcweir 30*cdf0e10cSrcweir #include <cppuhelper/weak.hxx> 31*cdf0e10cSrcweir #include <com/sun/star/uno/XAggregation.hpp> 32*cdf0e10cSrcweir 33*cdf0e10cSrcweir 34*cdf0e10cSrcweir namespace cppu 35*cdf0e10cSrcweir { 36*cdf0e10cSrcweir 37*cdf0e10cSrcweir /** Base class to implement an UNO object supporting weak references, i.e. the object can be held 38*cdf0e10cSrcweir weakly (by a ::com::sun::star::uno::WeakReference) and aggregation, i.e. the object can be 39*cdf0e10cSrcweir aggregated by another (delegator). 40*cdf0e10cSrcweir This implementation copes with reference counting. Upon last release(), the virtual dtor 41*cdf0e10cSrcweir is called. 42*cdf0e10cSrcweir 43*cdf0e10cSrcweir @derive 44*cdf0e10cSrcweir Inherit from this class and delegate acquire()/ release() calls. Re-implement 45*cdf0e10cSrcweir XAggregation::queryInterface(). 46*cdf0e10cSrcweir */ 47*cdf0e10cSrcweir class OWeakAggObject 48*cdf0e10cSrcweir : public ::cppu::OWeakObject 49*cdf0e10cSrcweir , public ::com::sun::star::uno::XAggregation 50*cdf0e10cSrcweir { 51*cdf0e10cSrcweir public: 52*cdf0e10cSrcweir /** Constructor. No delegator set. 53*cdf0e10cSrcweir */ 54*cdf0e10cSrcweir inline OWeakAggObject() SAL_THROW( () ) 55*cdf0e10cSrcweir {} 56*cdf0e10cSrcweir 57*cdf0e10cSrcweir /** If a delegator is set, then the delegators gets acquired. Otherwise call is delegated to 58*cdf0e10cSrcweir base class ::cppu::OWeakObject. 59*cdf0e10cSrcweir */ 60*cdf0e10cSrcweir virtual void SAL_CALL acquire() throw(); 61*cdf0e10cSrcweir /** If a delegator is set, then the delegators gets released. Otherwise call is delegated to 62*cdf0e10cSrcweir base class ::cppu::OWeakObject. 63*cdf0e10cSrcweir */ 64*cdf0e10cSrcweir virtual void SAL_CALL release() throw(); 65*cdf0e10cSrcweir /** If a delegator is set, then the delegator is queried for the demanded interface. If the 66*cdf0e10cSrcweir delegator cannot provide the demanded interface, it calls queryAggregation() on its 67*cdf0e10cSrcweir aggregated objects. 68*cdf0e10cSrcweir 69*cdf0e10cSrcweir @param rType demanded interface type 70*cdf0e10cSrcweir @return demanded type or empty any 71*cdf0e10cSrcweir @see queryAggregation. 72*cdf0e10cSrcweir */ 73*cdf0e10cSrcweir virtual ::com::sun::star::uno::Any SAL_CALL queryInterface( const ::com::sun::star::uno::Type & rType ) 74*cdf0e10cSrcweir throw(::com::sun::star::uno::RuntimeException); 75*cdf0e10cSrcweir 76*cdf0e10cSrcweir /** Set the delegator. The delegator member reference is a weak reference. 77*cdf0e10cSrcweir 78*cdf0e10cSrcweir @param Delegator the object that delegate its queryInterface to this aggregate. 79*cdf0e10cSrcweir */ 80*cdf0e10cSrcweir virtual void SAL_CALL setDelegator( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > & Delegator ) 81*cdf0e10cSrcweir throw(::com::sun::star::uno::RuntimeException); 82*cdf0e10cSrcweir /** Called by the delegator or queryInterface. Re-implement this method instead of 83*cdf0e10cSrcweir queryInterface. 84*cdf0e10cSrcweir 85*cdf0e10cSrcweir @see queryInterface 86*cdf0e10cSrcweir */ 87*cdf0e10cSrcweir virtual ::com::sun::star::uno::Any SAL_CALL queryAggregation( const ::com::sun::star::uno::Type & rType ) 88*cdf0e10cSrcweir throw(::com::sun::star::uno::RuntimeException); 89*cdf0e10cSrcweir 90*cdf0e10cSrcweir protected: 91*cdf0e10cSrcweir /** Virtual dtor. Called when reference count is 0. 92*cdf0e10cSrcweir 93*cdf0e10cSrcweir @attention 94*cdf0e10cSrcweir Despite the fact that a RuntimeException is allowed to be thrown, you must not throw any 95*cdf0e10cSrcweir exception upon destruction! 96*cdf0e10cSrcweir */ 97*cdf0e10cSrcweir virtual ~OWeakAggObject() SAL_THROW( (::com::sun::star::uno::RuntimeException) ); 98*cdf0e10cSrcweir 99*cdf0e10cSrcweir /** weak reference to delegator. 100*cdf0e10cSrcweir */ 101*cdf0e10cSrcweir ::com::sun::star::uno::WeakReferenceHelper xDelegator; 102*cdf0e10cSrcweir private: 103*cdf0e10cSrcweir /** @internal */ 104*cdf0e10cSrcweir OWeakAggObject( const OWeakAggObject & rObj ) SAL_THROW( () ); 105*cdf0e10cSrcweir /** @internal */ 106*cdf0e10cSrcweir OWeakAggObject & operator = ( const OWeakAggObject & rObj ) SAL_THROW( () ); 107*cdf0e10cSrcweir }; 108*cdf0e10cSrcweir 109*cdf0e10cSrcweir } 110*cdf0e10cSrcweir 111*cdf0e10cSrcweir #endif 112