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