include/cppuhelper/weakagg.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_WEAKAGG_HXX
  20 #define INCLUDED_CPPUHELPER_WEAKAGG_HXX
  21
  22 #include "cppuhelper/weak.hxx"
  23 #include "cppuhelper/weakref.hxx"
  24 #include "com/sun/star/uno/XAggregation.hpp"
  25 #include "cppuhelper/cppuhelperdllapi.h"
  26
  27
  28 namespace cppu
  29 {
  30
  31 /** Base class to implement a UNO object supporting weak references, i.e. the object can be held
  32     weakly (by a css::uno::WeakReference) and aggregation, i.e. the object can be
  33     aggregated by another (delegator).
  34     This implementation copes with reference counting.  Upon last release(), the virtual dtor
  35     is called.
  36
  37     @derive
  38     Inherit from this class and delegate acquire()/ release() calls.  Re-implement
  39     XAggregation::queryInterface().
  40 */
  41 class CPPUHELPER_DLLPUBLIC OWeakAggObject
  42     : public ::cppu::OWeakObject
  43     , public css::uno::XAggregation
  44 {
  45 public:
  46     /** Constructor.  No delegator set.
  47     */
  48     OWeakAggObject()
  49         {}
  50
  51     /** If a delegator is set, then the delegators gets acquired.  Otherwise call is delegated to
  52         base class ::cppu::OWeakObject.
  53     */
  54     virtual void SAL_CALL acquire() throw() SAL_OVERRIDE;
  55     /** If a delegator is set, then the delegators gets released.  Otherwise call is delegated to
  56         base class ::cppu::OWeakObject.
  57     */
  58     virtual void SAL_CALL release() throw() SAL_OVERRIDE;
  59     /** If a delegator is set, then the delegator is queried for the demanded interface.  If the
  60         delegator cannot provide the demanded interface, it calls queryAggregation() on its
  61         aggregated objects.
  62
  63         @param rType demanded interface type
  64         @return demanded type or empty any
  65         @see queryAggregation.
  66     */
  67     virtual css::uno::Any SAL_CALL queryInterface( const css::uno::Type & rType ) SAL_OVERRIDE;
  68
  69     /** Set the delegator.  The delegator member reference is a weak reference.
  70
  71         @param Delegator the object that delegate its queryInterface to this aggregate.
  72     */
  73     virtual void SAL_CALL setDelegator( const css::uno::Reference< css::uno::XInterface > & Delegator ) SAL_OVERRIDE;
  74     /** Called by the delegator or queryInterface. Re-implement this method instead of
  75         queryInterface.
  76
  77         @see queryInterface
  78     */
  79     virtual css::uno::Any SAL_CALL queryAggregation( const css::uno::Type & rType ) SAL_OVERRIDE;
  80
  81 protected:
  82     /** Virtual dtor. Called when reference count is 0.
  83
  84         @attention
  85         Despite the fact that a RuntimeException is allowed to be thrown, you must not throw any
  86         exception upon destruction!
  87     */
  88     virtual ~OWeakAggObject() SAL_OVERRIDE;
  89
  90     /** weak reference to delegator.
  91     */
  92     css::uno::WeakReferenceHelper xDelegator;
  93 private:
  94     OWeakAggObject( const OWeakAggObject & rObj ) SAL_DELETED_FUNCTION;
  95     OWeakAggObject & operator = ( const OWeakAggObject & rObj )
  96         SAL_DELETED_FUNCTION;
  97 };
  98
  99 }
 100
 101 #endif
 102
 103 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */