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