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_XFrameLoader_idl__
24#define __com_sun_star_frame_XFrameLoader_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_XFrame_idl__
31#include <com/sun/star/frame/XFrame.idl>
32#endif
33
34#ifndef __com_sun_star_beans_PropertyValue_idl__
35#include <com/sun/star/beans/PropertyValue.idl>
36#endif
37
38#ifndef __com_sun_star_frame_XLoadEventListener_idl__
39#include <com/sun/star/frame/XLoadEventListener.idl>
40#endif
41
42
43//=============================================================================
44
45 module com {  module sun {  module star {  module frame {
46
47//=============================================================================
48/** load components into a frame
49
50    <p>
51    It's an asynchronous loading. For synchronous processes use <type>XSynchronousFrameLoader</type>
52    instead of this one. The generic load algorithm of the office supports both ones - but prefered
53    the synchronous interface.
54    </p>
55
56    @see XFrame
57 */
58published interface XFrameLoader: com::sun::star::uno::XInterface
59{
60	//-------------------------------------------------------------------------
61	/** starts the loading of the specified resource into the specified <type>Frame</type>.
62
63        @param Frame
64            specifies the loading target
65
66        @param URL
67            describes the ressource of loading component
68            Support of special protocols are implementation details
69            and depends from the environment.
70
71        @param Arguments
72            optional arguments for loading
73            (see <type scope="com::sun::star::document">MediaDescriptor</type> for further informations)
74
75        @param Listener
76            this listener will be informed about success
77
78        @see XLoadEventListener
79	 */
80    [oneway] void load(
81        [in] XFrame Frame,
82        [in] string URL,
83        [in] sequence< com::sun::star::beans::PropertyValue > Arguments,
84        [in] XLoadEventListener Listener);
85
86	//-------------------------------------------------------------------------
87	/** cancels the loading process.
88
89        <p>
90        After returning from this call, neither the frame nor the
91        load-event-listener specified in <member>XFrameLoader::load()</member> may be called back.
92        Because only the owner of this process who called load method
93        before can cancel this process. And he doesn't need any notification about that.
94        On the other hand - nobody then this owner himself can be registered as an
95        <type>XLoadEventListener</type> here.
96        </p>
97	 */
98	[oneway] void cancel();
99};
100
101//=============================================================================
102
103}; }; }; };
104
105#endif
106