include/cppuhelper/component.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_COMPONENT_HXX
  20 #define INCLUDED_CPPUHELPER_COMPONENT_HXX
  21
  22 #include "cppuhelper/weakagg.hxx"
  23 #include "cppuhelper/interfacecontainer.h"
  24
  25 #include "com/sun/star/lang/XComponent.hpp"
  26 #include "com/sun/star/lang/XTypeProvider.hpp"
  27
  28 #include "cppuhelper/cppuhelperdllapi.h"
  29
  30 namespace osl { class Mutex; }
  31
  32 namespace cppu
  33 {
  34
  35 /** Deprecated.  Helper for implementing css::lang::XComponent.
  36     Upon disposing objects of this class, sub-classes receive a disposing() call.  Objects of
  37     this class can be held weakly, i.e. by a css::uno::WeakReference.  Object of
  38     this class can be aggregated, i.e. incoming queryInterface() calls are delegated.
  39
  40     @attention
  41     The life-cycle of the passed mutex reference has to be longer than objects of this class.
  42     @deprecated
  43 */
  44 class CPPUHELPER_DLLPUBLIC OComponentHelper
  45     : public ::cppu::OWeakAggObject
  46     , public css::lang::XTypeProvider
  47     , public css::lang::XComponent
  48 {
  49 public:
  50     /** Constructor.
  51
  52         @param rMutex
  53         the mutex used to protect multi-threaded access;
  54         lifetime must be longer than the lifetime of this object.
  55     */
  56     OComponentHelper( ::osl::Mutex & rMutex );
  57     /** Destructor. If this object was not disposed previously, object will be disposed manually.
  58     */
  59     virtual ~OComponentHelper() SAL_OVERRIDE;
  60
  61     // XAggregation
  62     virtual css::uno::Any SAL_CALL queryInterface(
  63         css::uno::Type const & rType ) SAL_OVERRIDE;
  64     virtual css::uno::Any SAL_CALL queryAggregation(
  65         css::uno::Type const & rType ) SAL_OVERRIDE;
  66     virtual void SAL_CALL acquire()
  67         throw () SAL_OVERRIDE;
  68     virtual void SAL_CALL release()
  69         throw () SAL_OVERRIDE;
  70
  71     /** @attention
  72         XTypeProvider::getImplementationId() has to be implemented separately!
  73     */
  74     virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() SAL_OVERRIDE = 0;
  75     /** @attention
  76         XTypeProvider::getTypes() has to be re-implemented!
  77     */
  78     virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes() SAL_OVERRIDE;
  79
  80     // XComponent
  81     virtual void SAL_CALL dispose() SAL_OVERRIDE;
  82     virtual void SAL_CALL addEventListener(
  83         const css::uno::Reference< css::lang::XEventListener >& aListener ) SAL_OVERRIDE;
  84     virtual void SAL_CALL removeEventListener(
  85         const css::uno::Reference< css::lang::XEventListener >& aListener ) SAL_OVERRIDE;
  86
  87 protected:
  88     /** Called in dispose method after the listeners were notified.
  89     */
  90     virtual void SAL_CALL disposing();
  91
  92     /// @cond INTERNAL
  93     OBroadcastHelper    rBHelper;
  94     /// @endcond
  95
  96 private:
  97     OComponentHelper( const OComponentHelper & ) SAL_DELETED_FUNCTION;
  98     OComponentHelper & operator = ( const OComponentHelper & )
  99         SAL_DELETED_FUNCTION;
 100 };
 101
 102 }
 103
 104 #endif
 105
 106 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */