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_DispatchProvider_idl__
24#define __com_sun_star_frame_DispatchProvider_idl__
25
26#ifndef __com_sun_star_frame_XDispatchProvider_idl__
27#include <com/sun/star/frame/XDispatchProvider.idl>
28#endif
29
30#ifndef __com_sun_star_frame_XDispatchProviderInterception_idl__
31#include <com/sun/star/frame/XDispatchProviderInterception.idl>
32#endif
33
34//=============================================================================
35
36module com {  module sun {  module star {  module frame {
37
38//=============================================================================
39/** provides <type>XDispatch</type> objects for certain functions which
40    are useful at the UI
41
42    <p>
43    Such dispatch objects must be queried explicitly and used for
44    queried purposes only. They can handle requests with guaranteed
45    notifications (<type>XNotifyingDispatch</type>) or with possible
46    (but not guaranteed) notifications (<type>XDispatch</type>).
47    </p>
48
49    @see XNotifyingDispatch
50    @see XDispatch
51    @see XControlNotificationListener
52 */
53published service DispatchProvider
54{
55    //-------------------------------------------------------------------------
56    /** provides handling of dispatches with defined result state
57
58        <p>
59        Base interface of <type>XNotifyingDispatch</type> is <type>XDispatch</type>
60        and can be called for requests if result isn't necessary for dispatch operation.
61        </p>
62
63        @see XDispatch
64	 */
65    interface XDispatchProvider;
66
67    //-------------------------------------------------------------------------
68    /** provides dispatch interception
69
70        <p>
71        It makes it possible to register an <type>XDispatchProvider</type> which
72        intercepts all requests of <type>XDispatch</type> to this instance.
73        </p>
74	 */
75    [optional] interface XDispatchProviderInterception;
76};
77
78//=============================================================================
79
80}; }; }; };
81
82#endif
83