UnoControls/source/inc/OConnectionPointContainerHelper.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
  20 #ifndef INCLUDED_UNOCONTROLS_SOURCE_INC_OCONNECTIONPOINTCONTAINERHELPER_HXX
  21 #define INCLUDED_UNOCONTROLS_SOURCE_INC_OCONNECTIONPOINTCONTAINERHELPER_HXX
  22
  23 #include <com/sun/star/lang/XConnectionPointContainer.hpp>
  24 #include <com/sun/star/lang/XConnectionPoint.hpp>
  25 #include <cppuhelper/weak.hxx>
  26 #include <cppuhelper/propshlp.hxx>
  27
  28 //  namespaces
  29
  30 namespace unocontrols{
  31
  32 //  class declaration OConnectionPointContainerHelper
  33
  34 class OConnectionPointContainerHelper   :   public  ::com::sun::star::lang::XConnectionPointContainer
  35                                         ,   public  ::cppu::OWeakObject
  36 {
  37
  38 //  public methods
  39
  40 public:
  41
  42     //  construct/destruct
  43
  44     /**_________________________________________________________________________________________________________
  45         @short
  46         @descr
  47
  48         @seealso
  49
  50         @param
  51
  52         @return
  53
  54         @onerror
  55     */
  56
  57     OConnectionPointContainerHelper( ::osl::Mutex& aMutex );
  58
  59     /**_________________________________________________________________________________________________________
  60         @short
  61         @descr
  62
  63         @seealso
  64
  65         @param
  66
  67         @return
  68
  69         @onerror
  70     */
  71
  72     virtual ~OConnectionPointContainerHelper();
  73
  74     //  XInterface
  75
  76     /**_______________________________________________________________________________________________________
  77         @short      give answer, if interface is supported
  78         @descr      The interfaces are searched by type.
  79
  80         @seealso    XInterface
  81
  82         @param      "rType" is the type of searched interface.
  83
  84         @return     Any     information about found interface
  85
  86         @onerror    A RuntimeException is thrown.
  87     */
  88
  89     virtual ::com::sun::star::uno::Any SAL_CALL queryInterface( const ::com::sun::star::uno::Type& aType )
  90         throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
  91
  92     /**_______________________________________________________________________________________________________
  93         @short      increment refcount
  94         @seealso    XInterface
  95         @seealso    release()
  96         @onerror    A RuntimeException is thrown.
  97     */
  98
  99     virtual void SAL_CALL acquire() throw() SAL_OVERRIDE;
 100
 101     /**_______________________________________________________________________________________________________
 102         @short      decrement refcount
 103         @seealso    XInterface
 104         @seealso    acquire()
 105         @onerror    A RuntimeException is thrown.
 106     */
 107
 108     virtual void SAL_CALL release() throw() SAL_OVERRIDE;
 109
 110     //  XConnectionPointContainer
 111
 112     /**_________________________________________________________________________________________________________
 113         @short
 114         @descr
 115
 116         @seealso
 117
 118         @param
 119
 120         @return
 121
 122         @onerror
 123     */
 124
 125     virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type > SAL_CALL getConnectionPointTypes()
 126         throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
 127
 128     /**_________________________________________________________________________________________________________
 129         @short
 130         @descr
 131
 132         @seealso
 133
 134         @param
 135
 136         @return
 137
 138         @onerror
 139     */
 140
 141     virtual ::com::sun::star::uno::Reference< ::com::sun::star::lang::XConnectionPoint > SAL_CALL queryConnectionPoint(
 142         const ::com::sun::star::uno::Type& aType
 143     ) throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
 144
 145     /**_________________________________________________________________________________________________________
 146         @short
 147         @descr
 148
 149         @seealso
 150
 151         @param
 152
 153         @return
 154
 155         @onerror
 156     */
 157
 158     virtual void SAL_CALL advise(
 159         const   ::com::sun::star::uno::Type&                              aType ,
 160         const   ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >&  xListener
 161     ) throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
 162
 163     /**_________________________________________________________________________________________________________
 164         @short
 165         @descr
 166
 167         @seealso
 168
 169         @param
 170
 171         @return
 172
 173         @onerror
 174     */
 175
 176     virtual void SAL_CALL unadvise(
 177         const   ::com::sun::star::uno::Type&                              aType       ,
 178         const   ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >&  xListener
 179     ) throw( ::com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
 180
 181     //  public but impl method!
 182     //  Is necessary to get container member at OConnectionPoint-instance.
 183     // Impl methods are not threadsafe!
 184     // "Parent" function must do this.
 185     ::cppu::OMultiTypeInterfaceContainerHelper& impl_getMultiTypeContainer() { return m_aMultiTypeContainer; }
 186
 187
 188 //  private variables
 189
 190 private:
 191
 192     ::osl::Mutex&                                   m_aSharedMutex;
 193     ::cppu::OMultiTypeInterfaceContainerHelper      m_aMultiTypeContainer;   // Container to hold listener
 194
 195 };  // class OConnectionPointContainerHelper
 196
 197 }   // namespace unocontrols
 198
 199 #endif // INCLUDED_UNOCONTROLS_SOURCE_INC_OCONNECTIONPOINTCONTAINERHELPER_HXX
 200
 201 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */