UnoControls/source/inc/OConnectionPointHelper.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: OConnectionPointHelper.hxx,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef _OCONNECTIONPOINTHELPER_HXX
  32 #define _OCONNECTIONPOINTHELPER_HXX
  33
  34 //______________________________________________________________________________________________________________
  35 //      includes of other projects
  36 //______________________________________________________________________________________________________________
  37
  38 #include <com/sun/star/lang/XConnectionPointContainer.hpp>
  39 #include <com/sun/star/lang/XConnectionPoint.hpp>
  40 #include <cppuhelper/weak.hxx>
  41 #include <cppuhelper/propshlp.hxx>
  42
  43 //______________________________________________________________________________________________________________
  44 //      includes of my own project
  45 //______________________________________________________________________________________________________________
  46 #include "OConnectionPointContainerHelper.hxx"
  47
  48 //______________________________________________________________________________________________________________
  49 //      namespaces
  50 //______________________________________________________________________________________________________________
  51
  52 namespace unocontrols{
  53
  54 #define UNO3_ANY                                                                                ::com::sun::star::uno::Any
  55 #define UNO3_SEQUENCE                                                                   ::com::sun::star::uno::Sequence
  56 #define UNO3_TYPE                                                                               ::com::sun::star::uno::Type
  57 #define UNO3_REFERENCE                                                                  ::com::sun::star::uno::Reference
  58 #define UNO3_XCONNECTIONPOINTCONTAINER                                  ::com::sun::star::lang::XConnectionPointContainer
  59 #define UNO3_XCONNECTIONPOINT                                                   ::com::sun::star::lang::XConnectionPoint
  60 #define UNO3_MUTEX                                                                              ::osl::Mutex
  61 #define UNO3_RUNTIMEEXCEPTION                                                   ::com::sun::star::uno::RuntimeException
  62 #define UNO3_XINTERFACE                                                                 ::com::sun::star::uno::XInterface
  63 #define UNO3_OMULTITYPEINTERFACECONTAINERHELPER                 ::cppu::OMultiTypeInterfaceContainerHelper
  64 #define UNO3_LISTENEREXISTEXCEPTION                                             ::com::sun::star::lang::ListenerExistException
  65 #define UNO3_INVALIDLISTENEREXCEPTION                                   ::com::sun::star::lang::InvalidListenerException
  66 #define UNO3_WEAKREFERENCE                                                              ::com::sun::star::uno::WeakReference
  67 #define UNO3_OWEAKOBJECT                                                                ::cppu::OWeakObject
  68 #define UNO3_OCONNECTIONPOINTCONTAINERHELPER                    OConnectionPointContainerHelper
  69
  70 //______________________________________________________________________________________________________________
  71 //      defines
  72 //______________________________________________________________________________________________________________
  73
  74 //______________________________________________________________________________________________________________
  75 //      class declaration OConnectionPointHelper
  76 //______________________________________________________________________________________________________________
  77
  78 class OConnectionPointHelper    :       public  UNO3_XCONNECTIONPOINT
  79                                 ,       public  UNO3_OWEAKOBJECT
  80 {
  81
  82 //______________________________________________________________________________________________________________
  83 //      public methods
  84 //______________________________________________________________________________________________________________
  85
  86 public:
  87
  88     //__________________________________________________________________________________________________________
  89     //  construct/destruct
  90     //__________________________________________________________________________________________________________
  91
  92     /**_________________________________________________________________________________________________________
  93         @short
  94         @descr
  95
  96         @seealso
  97
  98         @param
  99
 100         @return
 101
 102         @onerror
 103     */
 104
 105     OConnectionPointHelper(     UNO3_MUTEX&                                                             aMutex                                          ,
 106                             UNO3_OCONNECTIONPOINTCONTAINERHELPER*       pContainerImplementation        ,
 107                             UNO3_TYPE                                                           aType                                           );
 108
 109     /**_________________________________________________________________________________________________________
 110         @short
 111         @descr
 112
 113         @seealso
 114
 115         @param
 116
 117         @return
 118
 119         @onerror
 120     */
 121
 122     virtual     ~OConnectionPointHelper();
 123
 124     //________________________________________________________________________________________________________
 125     //  XInterface
 126     //________________________________________________________________________________________________________
 127
 128     /**_______________________________________________________________________________________________________
 129         @short          give answer, if interface is supported
 130         @descr          The interfaces are searched by type.
 131
 132         @seealso        XInterface
 133
 134         @param      "rType" is the type of searched interface.
 135
 136         @return         Any             information about found interface
 137
 138         @onerror        A RuntimeException is thrown.
 139     */
 140
 141     virtual UNO3_ANY SAL_CALL queryInterface( const UNO3_TYPE& aType ) throw( UNO3_RUNTIMEEXCEPTION );
 142
 143     /**_______________________________________________________________________________________________________
 144         @short          increment refcount
 145         @descr          -
 146
 147         @seealso        XInterface
 148         @seealso        release()
 149
 150         @param          -
 151
 152         @return         -
 153
 154         @onerror        A RuntimeException is thrown.
 155     */
 156
 157     virtual void SAL_CALL acquire() throw();
 158
 159     /**_______________________________________________________________________________________________________
 160         @short          decrement refcount
 161         @descr          -
 162
 163         @seealso        XInterface
 164         @seealso        acquire()
 165
 166         @param          -
 167
 168         @return         -
 169
 170         @onerror        A RuntimeException is thrown.
 171     */
 172
 173     virtual void SAL_CALL release() throw();
 174
 175     //__________________________________________________________________________________________________________
 176     //  XConnectionPoint
 177     //__________________________________________________________________________________________________________
 178
 179     /**_________________________________________________________________________________________________________
 180         @short
 181         @descr
 182
 183         @seealso
 184
 185         @param
 186
 187         @return
 188
 189         @onerror
 190     */
 191
 192     virtual UNO3_TYPE SAL_CALL getConnectionType() throw( UNO3_RUNTIMEEXCEPTION );
 193
 194     /**_________________________________________________________________________________________________________
 195         @short
 196         @descr
 197
 198         @seealso
 199
 200         @param
 201
 202         @return
 203
 204         @onerror
 205     */
 206
 207     virtual UNO3_REFERENCE< UNO3_XCONNECTIONPOINTCONTAINER > SAL_CALL getConnectionPointContainer() throw( UNO3_RUNTIMEEXCEPTION );
 208
 209     /**_________________________________________________________________________________________________________
 210         @short
 211         @descr
 212
 213         @seealso
 214
 215         @param
 216
 217         @return
 218
 219         @onerror
 220     */
 221
 222     virtual void SAL_CALL advise( const UNO3_REFERENCE< UNO3_XINTERFACE >& xListener ) throw(   UNO3_LISTENEREXISTEXCEPTION             ,
 223                                                                                                 UNO3_INVALIDLISTENEREXCEPTION   ,
 224                                                                                                 UNO3_RUNTIMEEXCEPTION                   );
 225
 226     /**_________________________________________________________________________________________________________
 227         @short
 228         @descr
 229
 230         @seealso
 231
 232         @param
 233
 234         @return
 235
 236         @onerror
 237     */
 238
 239     virtual void SAL_CALL unadvise( const UNO3_REFERENCE< UNO3_XINTERFACE >& xListener ) throw( UNO3_RUNTIMEEXCEPTION );
 240
 241     /**_________________________________________________________________________________________________________
 242         @short
 243         @descr
 244
 245         @seealso
 246
 247         @param
 248
 249         @return
 250
 251         @onerror
 252     */
 253
 254     virtual UNO3_SEQUENCE< UNO3_REFERENCE< UNO3_XINTERFACE > > SAL_CALL getConnections() throw( UNO3_RUNTIMEEXCEPTION );
 255
 256 //______________________________________________________________________________________________________________
 257 //      private methods
 258 //______________________________________________________________________________________________________________
 259
 260 private:
 261
 262     /**_________________________________________________________________________________________________________
 263         @short
 264         @descr
 265
 266         @seealso
 267
 268         @param
 269
 270         @return
 271
 272         @onerror
 273     */
 274
 275     sal_Bool impl_LockContainer();
 276
 277     /**_________________________________________________________________________________________________________
 278         @short
 279         @descr
 280
 281         @seealso
 282
 283         @param
 284
 285         @return
 286
 287         @onerror
 288     */
 289
 290     void impl_UnlockContainer();
 291
 292 //______________________________________________________________________________________________________________
 293 //      private variables
 294 //______________________________________________________________________________________________________________
 295
 296 private:
 297
 298     UNO3_MUTEX&                                                                                         m_aSharedMutex                          ;
 299     UNO3_WEAKREFERENCE< UNO3_XCONNECTIONPOINTCONTAINER >        m_oContainerWeakReference       ;       // Reference to container-class!. Don't use Reference<...>
 300                                                                                             // It is a ring-reference => and must be a wekreference!
 301     UNO3_OCONNECTIONPOINTCONTAINERHELPER*                                       m_pContainerImplementation      ;
 302     UNO3_TYPE                                                                                           m_aInterfaceType                        ;
 303     UNO3_REFERENCE< UNO3_XINTERFACE >                                           m_xLock                                         ;
 304
 305 };      // class OConnectionPointHelper
 306
 307 }       // namespace unocontrols
 308
 309 #endif  // #ifndef _OCONNECTIONPOINTHELPER_HXX