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

   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: XDispatchProviderInterception.idl,v $
  10  * $Revision: 1.9 $
  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 #ifndef __com_sun_star_frame_XDispatchProviderInterception_idl__
  31 #define __com_sun_star_frame_XDispatchProviderInterception_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_frame_XDispatchProviderInterceptor_idl__
  38 #include <com/sun/star/frame/XDispatchProviderInterceptor.idl>
  39 #endif
  40
  41
  42 //=============================================================================
  43
  44  module com {  module sun {  module star {  module frame {
  45
  46 //=============================================================================
  47 /** makes it possible to register an <type>XDispatchProvider</type> which
  48     intercepts all requests of <type>XDispatch</type> to this instance.
  49
  50     <p>
  51     Note: Nobody can guarantee order of used interceptor objects if more then ones exist.
  52     Later registered ones will be used at first. But it's possible to increase the chance
  53     for that by providing the optional interface <type>XInterceptorInfo</type>.
  54     </p>
  55
  56     @see XDispatchProvider
  57     @see XDispatch
  58     @see XInterceptorInfo
  59  */
  60 published interface XDispatchProviderInterception: com::sun::star::uno::XInterface
  61 {
  62     //-------------------------------------------------------------------------
  63     /** registers an <type>XDispatchProviderInterceptor</type>, which will become
  64         the first interceptor in the chain of registered interceptors.
  65
  66         @param Interceptor
  67             the interceptor which whish to be registered
  68
  69         @see XDispatchProviderInterception::releaseDispatchProviderInterceptor()
  70      */
  71     void registerDispatchProviderInterceptor( [in] XDispatchProviderInterceptor Interceptor );
  72
  73     //-------------------------------------------------------------------------
  74     /** removes an <type>XDispatchProviderInterceptor</type> which was previously registered
  75
  76         <p>
  77         The order of removals is arbitrary. It is not necessary to remove the last
  78         registered interceptor first.
  79         </p>
  80
  81         @param Interceptor
  82             the interceptor which whish to be unregistered
  83
  84         @see XDispatchProviderInterception::registerDispatchProviderInterceptor()
  85      */
  86     void releaseDispatchProviderInterceptor( [in] XDispatchProviderInterceptor Interceptor );
  87 };
  88
  89 //=============================================================================
  90
  91 }; }; }; };
  92
  93 #endif