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