offapi/com/sun/star/frame/XDispatchProviderInterception.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_frame_XDispatchProviderInterception_idl__
  28 #define __com_sun_star_frame_XDispatchProviderInterception_idl__
  29
  30 #ifndef __com_sun_star_uno_XInterface_idl__
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_frame_XDispatchProviderInterceptor_idl__
  35 #include <com/sun/star/frame/XDispatchProviderInterceptor.idl>
  36 #endif
  37
  38
  39 //=============================================================================
  40
  41  module com {  module sun {  module star {  module frame {
  42
  43 //=============================================================================
  44 /** makes it possible to register an <type>XDispatchProvider</type> which
  45     intercepts all requests of <type>XDispatch</type> to this instance.
  46
  47     <p>
  48     Note: Nobody can guarantee order of used interceptor objects if more then ones exist.
  49     Later registered ones will be used at first. But it's possible to increase the chance
  50     for that by providing the optional interface <type>XInterceptorInfo</type>.
  51     </p>
  52
  53     @see XDispatchProvider
  54     @see XDispatch
  55     @see XInterceptorInfo
  56  */
  57 published interface XDispatchProviderInterception: com::sun::star::uno::XInterface
  58 {
  59     //-------------------------------------------------------------------------
  60     /** registers an <type>XDispatchProviderInterceptor</type>, which will become
  61         the first interceptor in the chain of registered interceptors.
  62
  63         @param Interceptor
  64             the interceptor which whish to be registered
  65
  66         @see XDispatchProviderInterception::releaseDispatchProviderInterceptor()
  67      */
  68     void registerDispatchProviderInterceptor( [in] XDispatchProviderInterceptor Interceptor );
  69
  70     //-------------------------------------------------------------------------
  71     /** removes an <type>XDispatchProviderInterceptor</type> which was previously registered
  72
  73         <p>
  74         The order of removals is arbitrary. It is not necessary to remove the last
  75         registered interceptor first.
  76         </p>
  77
  78         @param Interceptor
  79             the interceptor which whish to be unregistered
  80
  81         @see XDispatchProviderInterception::registerDispatchProviderInterceptor()
  82      */
  83     void releaseDispatchProviderInterceptor( [in] XDispatchProviderInterceptor Interceptor );
  84 };
  85
  86 //=============================================================================
  87
  88 }; }; }; };
  89
  90 #endif