UnoControls/source/inc/OConnectionPointContainerHelper.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: OConnectionPointContainerHelper.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 _OCONNECTIONPOINTCONTAINERHELPER_HXX
  32 #define _OCONNECTIONPOINTCONTAINERHELPER_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
  47 //______________________________________________________________________________________________________________
  48 //      namespaces
  49 //______________________________________________________________________________________________________________
  50
  51 namespace unocontrols{
  52
  53 #define UNO3_ANY                                                                                ::com::sun::star::uno::Any
  54 #define UNO3_SEQUENCE                                                                   ::com::sun::star::uno::Sequence
  55 #define UNO3_TYPE                                                                               ::com::sun::star::uno::Type
  56 #define UNO3_REFERENCE                                                                  ::com::sun::star::uno::Reference
  57 #define UNO3_XCONNECTIONPOINTCONTAINER                                  ::com::sun::star::lang::XConnectionPointContainer
  58 #define UNO3_XCONNECTIONPOINT                                                   ::com::sun::star::lang::XConnectionPoint
  59 #define UNO3_MUTEX                                                                              ::osl::Mutex
  60 #define UNO3_RUNTIMEEXCEPTION                                                   ::com::sun::star::uno::RuntimeException
  61 #define UNO3_XINTERFACE                                                                 ::com::sun::star::uno::XInterface
  62 #define UNO3_OMULTITYPEINTERFACECONTAINERHELPER                 ::cppu::OMultiTypeInterfaceContainerHelper
  63 #define UNO3_LISTENEREXISTEXCEPTION                                             ::com::sun::star::lang::ListenerExistException
  64 #define UNO3_INVALIDLISTENEREXCEPTION                                   ::com::sun::star::lang::InvalidListenerException
  65 #define UNO3_WEAKREFERENCE                                                              ::com::sun::star::uno::WeakReference
  66 #define UNO3_OWEAKOBJECT                                                                ::cppu::OWeakObject
  67
  68 //______________________________________________________________________________________________________________
  69 //      defines
  70 //______________________________________________________________________________________________________________
  71
  72 //______________________________________________________________________________________________________________
  73 //      class declaration OConnectionPointContainerHelper
  74 //______________________________________________________________________________________________________________
  75
  76 class OConnectionPointContainerHelper   :       public  UNO3_XCONNECTIONPOINTCONTAINER
  77                                         ,       public  UNO3_OWEAKOBJECT
  78 {
  79
  80 //______________________________________________________________________________________________________________
  81 //      public methods
  82 //______________________________________________________________________________________________________________
  83
  84 public:
  85
  86     //__________________________________________________________________________________________________________
  87     //  construct/destruct
  88     //__________________________________________________________________________________________________________
  89
  90     /**_________________________________________________________________________________________________________
  91         @short
  92         @descr
  93
  94         @seealso
  95
  96         @param
  97
  98         @return
  99
 100         @onerror
 101     */
 102
 103     OConnectionPointContainerHelper( UNO3_MUTEX& aMutex );
 104
 105     /**_________________________________________________________________________________________________________
 106         @short
 107         @descr
 108
 109         @seealso
 110
 111         @param
 112
 113         @return
 114
 115         @onerror
 116     */
 117
 118     virtual     ~OConnectionPointContainerHelper();
 119
 120     //________________________________________________________________________________________________________
 121     //  XInterface
 122     //________________________________________________________________________________________________________
 123
 124     /**_______________________________________________________________________________________________________
 125         @short          give answer, if interface is supported
 126         @descr          The interfaces are searched by type.
 127
 128         @seealso        XInterface
 129
 130         @param      "rType" is the type of searched interface.
 131
 132         @return         Any             information about found interface
 133
 134         @onerror        A RuntimeException is thrown.
 135     */
 136
 137     virtual UNO3_ANY SAL_CALL queryInterface( const UNO3_TYPE& aType ) throw( UNO3_RUNTIMEEXCEPTION );
 138
 139     /**_______________________________________________________________________________________________________
 140         @short          increment refcount
 141         @descr          -
 142
 143         @seealso        XInterface
 144         @seealso        release()
 145
 146         @param          -
 147
 148         @return         -
 149
 150         @onerror        A RuntimeException is thrown.
 151     */
 152
 153     virtual void SAL_CALL acquire() throw();
 154
 155     /**_______________________________________________________________________________________________________
 156         @short          decrement refcount
 157         @descr          -
 158
 159         @seealso        XInterface
 160         @seealso        acquire()
 161
 162         @param          -
 163
 164         @return         -
 165
 166         @onerror        A RuntimeException is thrown.
 167     */
 168
 169     virtual void SAL_CALL release() throw();
 170
 171     //__________________________________________________________________________________________________________
 172     //  XConnectionPointContainer
 173     //__________________________________________________________________________________________________________
 174
 175     /**_________________________________________________________________________________________________________
 176         @short
 177         @descr
 178
 179         @seealso
 180
 181         @param
 182
 183         @return
 184
 185         @onerror
 186     */
 187
 188     virtual UNO3_SEQUENCE< UNO3_TYPE > SAL_CALL getConnectionPointTypes() throw( UNO3_RUNTIMEEXCEPTION );
 189
 190     /**_________________________________________________________________________________________________________
 191         @short
 192         @descr
 193
 194         @seealso
 195
 196         @param
 197
 198         @return
 199
 200         @onerror
 201     */
 202
 203     virtual UNO3_REFERENCE< UNO3_XCONNECTIONPOINT > SAL_CALL queryConnectionPoint( const UNO3_TYPE& aType ) throw( UNO3_RUNTIMEEXCEPTION );
 204
 205     /**_________________________________________________________________________________________________________
 206         @short
 207         @descr
 208
 209         @seealso
 210
 211         @param
 212
 213         @return
 214
 215         @onerror
 216     */
 217
 218     virtual void SAL_CALL advise(       const   UNO3_TYPE&                                                      aType           ,
 219                                     const       UNO3_REFERENCE< UNO3_XINTERFACE >&      xListener       ) throw( UNO3_RUNTIMEEXCEPTION );
 220
 221     /**_________________________________________________________________________________________________________
 222         @short
 223         @descr
 224
 225         @seealso
 226
 227         @param
 228
 229         @return
 230
 231         @onerror
 232     */
 233
 234     virtual void SAL_CALL unadvise(     const   UNO3_TYPE&                                                      aType           ,
 235                                     const       UNO3_REFERENCE< UNO3_XINTERFACE >&      xListener       ) throw( UNO3_RUNTIMEEXCEPTION );
 236
 237     /**_________________________________________________________________________________________________________
 238         @short
 239         @descr
 240
 241         @seealso
 242
 243         @param
 244
 245         @return
 246
 247         @onerror
 248     */
 249
 250     UNO3_OMULTITYPEINTERFACECONTAINERHELPER& impl_getMultiTypeContainer();
 251
 252 //______________________________________________________________________________________________________________
 253 //      private variables
 254 //______________________________________________________________________________________________________________
 255
 256 private:
 257
 258     UNO3_MUTEX&                                                                 m_aSharedMutex                  ;
 259     UNO3_OMULTITYPEINTERFACECONTAINERHELPER             m_aMultiTypeContainer   ;       // Container to hold listener
 260
 261 };      // class OConnectionPointContainerHelper
 262
 263 }       // namespace unocontrols
 264
 265 #endif  // #ifndef _OCONNECTIONPOINTCONTAINERHELPER_HXX