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