xref: /AOO41X/main/offapi/com/sun/star/frame/XDispatchProviderInterceptor.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca) !
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_XDispatchProviderInterceptor_idl__
24#define __com_sun_star_frame_XDispatchProviderInterceptor_idl__
25
26#ifndef __com_sun_star_frame_XDispatchProvider_idl__
27#include <com/sun/star/frame/XDispatchProvider.idl>
28#endif
29
30
31//=============================================================================
32
33 module com {  module sun {  module star {  module frame {
34
35//=============================================================================
36/** makes it possible to intercept request of <type>XDispatch</type>.
37
38    <p>
39    Can be registered as an interceptor by using interface <type>XDispatchProviderInterception</type>.
40    </p>
41
42    @see XDispatchProviderInterception
43 */
44published interface XDispatchProviderInterceptor: XDispatchProvider
45{
46    //-------------------------------------------------------------------------
47    /** access to the slave <type>XDispatchProvider</type> of this interceptor
48
49        @returns
50            the slave of this interceptor
51
52        @see XDispatchProviderInterceptor::setSlaveDispatchProvider()
53     */
54    XDispatchProvider getSlaveDispatchProvider();
55
56    //-------------------------------------------------------------------------
57    /** sets the slave <type>XDispatchProvider</type> to which calls to
58        <member>XDispatchProvider::queryDispatch()</member> can be forwarded
59        under control of this dispatch provider.
60
61        @param xNewDispatchProvider
62            the new slave of this interceptor
63
64        @see XDispatchProviderInterceptor::getSlaveDispatchProvider()
65     */
66    void setSlaveDispatchProvider( [in] XDispatchProvider NewDispatchProvider );
67
68    //-------------------------------------------------------------------------
69    /** access to the master <type>XDispatchProvider</type> of this interceptor
70
71        @returns
72            the master of this interceptor
73
74        @see XDispatchProviderInterceptor::setMasterDispatchProvider()
75     */
76    XDispatchProvider getMasterDispatchProvider();
77
78    //-------------------------------------------------------------------------
79    /** sets the master <type>XDispatchProvider</type>, which may forward
80        calls to its <member>XDispatchProvider::queryDispatch()</member>
81        to this dispatch provider.
82
83        @param NewSupplier
84            the master of this interceptor
85
86        @see XDispatchProviderInterceptor::getMasterDispatchProvider()
87     */
88    void setMasterDispatchProvider( [in] XDispatchProvider NewSupplier );
89
90};
91
92//=============================================================================
93
94}; }; }; };
95
96#endif
97