UnoControls/source/inc/OConnectionPointHelper.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 _OCONNECTIONPOINTHELPER_HXX
  21 #define _OCONNECTIONPOINTHELPER_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 #include "OConnectionPointContainerHelper.hxx"
  29
  30 //______________________________________________________________________________________________________________
  31 //  namespaces
  32 //______________________________________________________________________________________________________________
  33
  34 namespace unocontrols{
  35
  36 //______________________________________________________________________________________________________________
  37 //  class declaration OConnectionPointHelper
  38 //______________________________________________________________________________________________________________
  39
  40 class OConnectionPointHelper    :   public  ::com::sun::star::lang::XConnectionPoint
  41                                 ,   public  ::cppu::OWeakObject
  42 {
  43
  44 //______________________________________________________________________________________________________________
  45 //  public methods
  46 //______________________________________________________________________________________________________________
  47
  48 public:
  49
  50     //__________________________________________________________________________________________________________
  51     //  construct/destruct
  52     //__________________________________________________________________________________________________________
  53
  54     /**_________________________________________________________________________________________________________
  55         @short
  56         @descr
  57
  58         @seealso
  59
  60         @param
  61
  62         @return
  63
  64         @onerror
  65     */
  66
  67     OConnectionPointHelper( ::osl::Mutex&                       aMutex                      ,
  68                             OConnectionPointContainerHelper*    pContainerImplementation    ,
  69                             ::com::sun::star::uno::Type                       aType                       );
  70
  71     /**_________________________________________________________________________________________________________
  72         @short
  73         @descr
  74
  75         @seealso
  76
  77         @param
  78
  79         @return
  80
  81         @onerror
  82     */
  83
  84     virtual ~OConnectionPointHelper();
  85
  86     //________________________________________________________________________________________________________
  87     //  XInterface
  88     //________________________________________________________________________________________________________
  89
  90     /**_______________________________________________________________________________________________________
  91         @short      give answer, if interface is supported
  92         @descr      The interfaces are searched by type.
  93
  94         @seealso    XInterface
  95
  96         @param      "rType" is the type of searched interface.
  97
  98         @return     Any     information about found interface
  99
 100         @onerror    A RuntimeException is thrown.
 101     */
 102
 103     virtual ::com::sun::star::uno::Any SAL_CALL queryInterface( const ::com::sun::star::uno::Type& aType )
 104         throw( ::com::sun::star::uno::RuntimeException );
 105
 106     /**_______________________________________________________________________________________________________
 107         @short      increment refcount
 108         @descr      -
 109
 110         @seealso    XInterface
 111         @seealso    release()
 112
 113         @param      -
 114
 115         @return     -
 116
 117         @onerror    A RuntimeException is thrown.
 118     */
 119
 120     virtual void SAL_CALL acquire() throw();
 121
 122     /**_______________________________________________________________________________________________________
 123         @short      decrement refcount
 124         @descr      -
 125
 126         @seealso    XInterface
 127         @seealso    acquire()
 128
 129         @param      -
 130
 131         @return     -
 132
 133         @onerror    A RuntimeException is thrown.
 134     */
 135
 136     virtual void SAL_CALL release() throw();
 137
 138     //__________________________________________________________________________________________________________
 139     //  XConnectionPoint
 140     //__________________________________________________________________________________________________________
 141
 142     /**_________________________________________________________________________________________________________
 143         @short
 144         @descr
 145
 146         @seealso
 147
 148         @param
 149
 150         @return
 151
 152         @onerror
 153     */
 154
 155     virtual ::com::sun::star::uno::Type SAL_CALL getConnectionType()
 156         throw( ::com::sun::star::uno::RuntimeException );
 157
 158     /**_________________________________________________________________________________________________________
 159         @short
 160         @descr
 161
 162         @seealso
 163
 164         @param
 165
 166         @return
 167
 168         @onerror
 169     */
 170
 171     virtual ::com::sun::star::uno::Reference< ::com::sun::star::lang::XConnectionPointContainer > SAL_CALL getConnectionPointContainer()
 172         throw( ::com::sun::star::uno::RuntimeException );
 173
 174     /**_________________________________________________________________________________________________________
 175         @short
 176         @descr
 177
 178         @seealso
 179
 180         @param
 181
 182         @return
 183
 184         @onerror
 185     */
 186
 187     virtual void SAL_CALL advise(
 188         const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& xListener
 189     ) throw (
 190         ::com::sun::star::lang::ListenerExistException,
 191         ::com::sun::star::lang::InvalidListenerException ,
 192         ::com::sun::star::uno::RuntimeException
 193     );
 194
 195     /**_________________________________________________________________________________________________________
 196         @short
 197         @descr
 198
 199         @seealso
 200
 201         @param
 202
 203         @return
 204
 205         @onerror
 206     */
 207
 208     virtual void SAL_CALL unadvise( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& xListener )
 209         throw( ::com::sun::star::uno::RuntimeException );
 210
 211     /**_________________________________________________________________________________________________________
 212         @short
 213         @descr
 214
 215         @seealso
 216
 217         @param
 218
 219         @return
 220
 221         @onerror
 222     */
 223
 224     virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > > SAL_CALL getConnections()
 225         throw( ::com::sun::star::uno::RuntimeException );
 226
 227 //______________________________________________________________________________________________________________
 228 //  private methods
 229 //______________________________________________________________________________________________________________
 230
 231 private:
 232
 233     /**_________________________________________________________________________________________________________
 234         @short
 235         @descr
 236
 237         @seealso
 238
 239         @param
 240
 241         @return
 242
 243         @onerror
 244     */
 245
 246     sal_Bool impl_LockContainer();
 247
 248     /**_________________________________________________________________________________________________________
 249         @short
 250         @descr
 251
 252         @seealso
 253
 254         @param
 255
 256         @return
 257
 258         @onerror
 259     */
 260
 261     void impl_UnlockContainer();
 262
 263 //______________________________________________________________________________________________________________
 264 //  private variables
 265 //______________________________________________________________________________________________________________
 266
 267 private:
 268
 269     ::osl::Mutex&                                                   m_aSharedMutex              ;
 270     ::com::sun::star::uno::WeakReference< ::com::sun::star::lang::XConnectionPointContainer >   m_oContainerWeakReference   ;   // Reference to container-class!. Don't use Reference<...>
 271                                                                                             // It is a ring-reference => and must be a wekreference!
 272     OConnectionPointContainerHelper*                                m_pContainerImplementation  ;
 273     ::com::sun::star::uno::Type                                                   m_aInterfaceType            ;
 274     ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >                       m_xLock                     ;
 275
 276 };  // class OConnectionPointHelper
 277
 278 }   // namespace unocontrols
 279
 280 #endif  // #ifndef _OCONNECTIONPOINTHELPER_HXX
 281
 282 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */