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