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_XDispatchHelper_idl__
28#define __com_sun_star_frame_XDispatchHelper_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34#ifndef __com_sun_star_frame_XDispatchProvider_idl__
35#include <com/sun/star/frame/XDispatchProvider.idl>
36#endif
37
38#ifndef __com_sun_star_beans_PropertyValue_idl__
39#include <com/sun/star/beans/PropertyValue.idl>
40#endif
41
42//=============================================================================
43
44 module com {  module sun {  module star {  module frame {
45
46//=============================================================================
47/** provides an easy way to dispatch functions useful at UI level.
48
49    @see XDispatch
50
51    @since OOo 1.1.2
52 */
53published interface XDispatchHelper : com::sun::star::uno::XInterface
54{
55	//-------------------------------------------------------------------------
56        /** executes the dispatch.
57
58        Listeners are not supported here!
59
60        @param DispatchProvider
61             points to the provider, which should be asked for valid dispatch objects
62
63        @param URL
64            describes the feature which should be supported by internally used dispatch object
65
66        @param TargetFrameName
67            specifies the frame which should be the target for this request
68
69        @param SearchFlags
70            optional search parameter for finding the frame if no special
71            <var>TargetFrameName</var> was used
72
73        @param Arguments
74            optional arguments for this request
75            They depend on the real implementation of the dispatch object.
76
77        @return
78            A possible result of the executed internal dispatch.
79            The information behind this <atom>any</atom> depends on the dispatch!
80
81        @see XDispatch::dispatch()
82        */
83
84        any executeDispatch(
85                [in] XDispatchProvider DispatchProvider,
86                [in] string URL,
87                [in] string TargetFrameName,
88                [in] long SearchFlags,
89                [in] sequence< com::sun::star::beans::PropertyValue > Arguments );
90};
91
92//=============================================================================
93
94}; }; }; };
95
96#endif
97