summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/frame/XNotifyingDispatch.idl
blob: 7e5f6eaa66a631d8e3e5a00817f7d5b3bae4328b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: XNotifyingDispatch.idl,v $
 * $Revision: 1.5 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_frame_XNotifyingDispatch_idl__
#define __com_sun_star_frame_XNotifyingDispatch_idl__

#ifndef __com_sun_star_frame_XDispatch_idl__
#include <com/sun/star/frame/XDispatch.idl>
#endif

#ifndef __com_sun_star_frame_XDispatchResultListener_idl__
#include <com/sun/star/frame/XDispatchResultListener.idl>
#endif
//=============================================================================

module com {  module sun {  module star {  module frame {

//=============================================================================
/** dispatch with guaranteed notify (instead of <type>XDispatch</type>)

    @see XDispatch
    @see XStatusListener
 */
published interface XNotifyingDispatch: XDispatch
{
    //-------------------------------------------------------------------------
    /** Do the same like <member>XDispatch::dispatch()</member> but notifies
        listener in every case. Should be used if result must be known.

        @param URL
            full parsed URL describes the feature which should be dispatched (executed)

        @param Arguments
            optional arguments for this request
            (see <type scope="com::sun::star::document">MediaDescriptor</type>)

        @param Listener
            optional listener for guaranteed notifications of this request
    */
    [oneway] void dispatchWithNotification(
        [in] com::sun::star::util::URL URL,
        [in] sequence<com::sun::star::beans::PropertyValue> Arguments,
        [in] XDispatchResultListener Listener);
};

//=============================================================================

}; }; }; };

#endif