1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_frame_XDispatchProviderInterception_idl__
24#define __com_sun_star_frame_XDispatchProviderInterception_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_frame_XDispatchProviderInterceptor_idl__
31#include <com/sun/star/frame/XDispatchProviderInterceptor.idl>
32#endif
33
34
35//=============================================================================
36
37 module com {  module sun {  module star {  module frame {
38
39//=============================================================================
40/** makes it possible to register an <type>XDispatchProvider</type> which
41    intercepts all requests of <type>XDispatch</type> to this instance.
42
43    <p>
44    Note: Nobody can guarantee order of used interceptor objects if more then ones exist.
45    Later registered ones will be used at first. But it's possible to increase the chance
46    for that by providing the optional interface <type>XInterceptorInfo</type>.
47    </p>
48
49    @see XDispatchProvider
50    @see XDispatch
51    @see XInterceptorInfo
52 */
53published interface XDispatchProviderInterception: com::sun::star::uno::XInterface
54{
55	//-------------------------------------------------------------------------
56	/** registers an <type>XDispatchProviderInterceptor</type>, which will become
57		the first interceptor in the chain of registered interceptors.
58
59        @param Interceptor
60            the interceptor which whish to be registered
61
62        @see XDispatchProviderInterception::releaseDispatchProviderInterceptor()
63	 */
64    void registerDispatchProviderInterceptor( [in] XDispatchProviderInterceptor Interceptor );
65
66	//-------------------------------------------------------------------------
67	/** removes an <type>XDispatchProviderInterceptor</type> which was previously registered
68
69        <p>
70        The order of removals is arbitrary. It is not necessary to remove the last
71        registered interceptor first.
72        </p>
73
74        @param Interceptor
75            the interceptor which whish to be unregistered
76
77        @see XDispatchProviderInterception::registerDispatchProviderInterceptor()
78	 */
79    void releaseDispatchProviderInterceptor( [in] XDispatchProviderInterceptor Interceptor );
80};
81
82//=============================================================================
83
84}; }; }; };
85
86#endif
87