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_XDispatchProvider_idl__
28#define __com_sun_star_frame_XDispatchProvider_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_XDispatch_idl__
35#include <com/sun/star/frame/XDispatch.idl>
36#endif
37
38#ifndef __com_sun_star_util_URL_idl__
39#include <com/sun/star/util/URL.idl>
40#endif
41
42#ifndef __com_sun_star_frame_DispatchDescriptor_idl__
43#include <com/sun/star/frame/DispatchDescriptor.idl>
44#endif
45
46
47//=============================================================================
48
49 module com {  module sun {  module star {  module frame {
50
51//=============================================================================
52/** provides <type>XDispatch</type> interfaces for certain functions which
53	are useful at the UI.
54
55    @see XDispatch
56 */
57published interface XDispatchProvider: com::sun::star::uno::XInterface
58{
59	//-------------------------------------------------------------------------
60	/** searches for an <type>XDispatch</type> for the specified URL within
61        the specified target frame.
62
63        @param URL
64            describe the feature which should be supported by returned dispatch object
65
66        @param TargetFrameName
67            specify 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        @return
74            the dispatch object which provides queried functionality
75            <br>
76            or <NULL/> if no dispatch object is available
77
78        @see XFrame::findFrame()
79        @see XDispatchProvider::queryDispatches()
80	 */
81    XDispatch queryDispatch(
82        [in] com::sun::star::util::URL URL,
83        [in] string TargetFrameName,
84        [in] long SearchFlags );
85
86	//-------------------------------------------------------------------------
87    /** actually this method is redundant to <member>XDispatchProvider::queryDispatch()</member>
88        to avoid multiple remote calls.
89
90        @param Requests
91            list of dispatch requests
92
93        @returns
94            multiple dispatch interfaces for the specified descriptors at once
95
96            <p>
97            It's not allowed to pack it - because every request must match
98            to his real result. Means: don't delete <NULL/> entries inside this list.
99            </p>
100	 */
101    sequence< XDispatch > queryDispatches(
102        [in] sequence<DispatchDescriptor> Requests);
103};
104
105//=============================================================================
106
107}; }; }; };
108
109#endif
110