xref: /AOO41X/main/offapi/com/sun/star/frame/XNotifyingDispatch.idl (revision 1ecadb572e7010ff3b3382ad9bf179dbc6efadbb)
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_XNotifyingDispatch_idl__
28#define __com_sun_star_frame_XNotifyingDispatch_idl__
29
30#ifndef __com_sun_star_frame_XDispatch_idl__
31#include <com/sun/star/frame/XDispatch.idl>
32#endif
33
34#ifndef __com_sun_star_frame_XDispatchResultListener_idl__
35#include <com/sun/star/frame/XDispatchResultListener.idl>
36#endif
37//=============================================================================
38
39module com {  module sun {  module star {  module frame {
40
41//=============================================================================
42/** dispatch with guaranteed notify (instead of <type>XDispatch</type>)
43
44    @see XDispatch
45    @see XStatusListener
46 */
47published interface XNotifyingDispatch: XDispatch
48{
49	//-------------------------------------------------------------------------
50    /** Do the same like <member>XDispatch::dispatch()</member> but notifies
51        listener in every case. Should be used if result must be known.
52
53        @param URL
54            full parsed URL describes the feature which should be dispatched (executed)
55
56        @param Arguments
57            optional arguments for this request
58            (see <type scope="com::sun::star::document">MediaDescriptor</type>)
59
60        @param Listener
61            optional listener for guaranteed notifications of this request
62    */
63    [oneway] void dispatchWithNotification(
64        [in] com::sun::star::util::URL URL,
65        [in] sequence<com::sun::star::beans::PropertyValue> Arguments,
66        [in] XDispatchResultListener Listener);
67};
68
69//=============================================================================
70
71}; }; }; };
72
73#endif
74