1d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5d1766043SAndrew Rist * distributed with this work for additional information
6d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10d1766043SAndrew Rist *
11d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12d1766043SAndrew Rist *
13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14d1766043SAndrew Rist * software distributed under the License is distributed on an
15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17d1766043SAndrew Rist * specific language governing permissions and limitations
18d1766043SAndrew Rist * under the License.
19d1766043SAndrew Rist *
20d1766043SAndrew Rist *************************************************************/
21d1766043SAndrew Rist
22d1766043SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_frame_XFrameLoader_idl__
24cdf0e10cSrcweir#define __com_sun_star_frame_XFrameLoader_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__
27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl>
28cdf0e10cSrcweir#endif
29cdf0e10cSrcweir
30cdf0e10cSrcweir#ifndef __com_sun_star_frame_XFrame_idl__
31cdf0e10cSrcweir#include <com/sun/star/frame/XFrame.idl>
32cdf0e10cSrcweir#endif
33cdf0e10cSrcweir
34cdf0e10cSrcweir#ifndef __com_sun_star_beans_PropertyValue_idl__
35cdf0e10cSrcweir#include <com/sun/star/beans/PropertyValue.idl>
36cdf0e10cSrcweir#endif
37cdf0e10cSrcweir
38cdf0e10cSrcweir#ifndef __com_sun_star_frame_XLoadEventListener_idl__
39cdf0e10cSrcweir#include <com/sun/star/frame/XLoadEventListener.idl>
40cdf0e10cSrcweir#endif
41cdf0e10cSrcweir
42cdf0e10cSrcweir
43cdf0e10cSrcweir//=============================================================================
44cdf0e10cSrcweir
45cdf0e10cSrcweir module com {  module sun {  module star {  module frame {
46cdf0e10cSrcweir
47cdf0e10cSrcweir//=============================================================================
48cdf0e10cSrcweir/** load components into a frame
49cdf0e10cSrcweir
50cdf0e10cSrcweir    <p>
51cdf0e10cSrcweir    It's an asynchronous loading. For synchronous processes use <type>XSynchronousFrameLoader</type>
52*a893be29SPedro Giffuni    instead of this one. The generic load algorithm of the office supports both - but preferes
53cdf0e10cSrcweir    the synchronous interface.
54cdf0e10cSrcweir    </p>
55cdf0e10cSrcweir
56cdf0e10cSrcweir    @see XFrame
57cdf0e10cSrcweir */
58cdf0e10cSrcweirpublished interface XFrameLoader: com::sun::star::uno::XInterface
59cdf0e10cSrcweir{
60cdf0e10cSrcweir	//-------------------------------------------------------------------------
61cdf0e10cSrcweir	/** starts the loading of the specified resource into the specified <type>Frame</type>.
62cdf0e10cSrcweir
63cdf0e10cSrcweir        @param Frame
64cdf0e10cSrcweir            specifies the loading target
65cdf0e10cSrcweir
66cdf0e10cSrcweir        @param URL
67cdf0e10cSrcweir            describes the ressource of loading component
68cdf0e10cSrcweir            Support of special protocols are implementation details
69cdf0e10cSrcweir            and depends from the environment.
70cdf0e10cSrcweir
71cdf0e10cSrcweir        @param Arguments
72cdf0e10cSrcweir            optional arguments for loading
73cdf0e10cSrcweir            (see <type scope="com::sun::star::document">MediaDescriptor</type> for further informations)
74cdf0e10cSrcweir
75cdf0e10cSrcweir        @param Listener
76cdf0e10cSrcweir            this listener will be informed about success
77cdf0e10cSrcweir
78cdf0e10cSrcweir        @see XLoadEventListener
79cdf0e10cSrcweir	 */
80cdf0e10cSrcweir    [oneway] void load(
81cdf0e10cSrcweir        [in] XFrame Frame,
82cdf0e10cSrcweir        [in] string URL,
83cdf0e10cSrcweir        [in] sequence< com::sun::star::beans::PropertyValue > Arguments,
84cdf0e10cSrcweir        [in] XLoadEventListener Listener);
85cdf0e10cSrcweir
86cdf0e10cSrcweir	//-------------------------------------------------------------------------
87cdf0e10cSrcweir	/** cancels the loading process.
88cdf0e10cSrcweir
89cdf0e10cSrcweir        <p>
90cdf0e10cSrcweir        After returning from this call, neither the frame nor the
91cdf0e10cSrcweir        load-event-listener specified in <member>XFrameLoader::load()</member> may be called back.
92cdf0e10cSrcweir        Because only the owner of this process who called load method
93cdf0e10cSrcweir        before can cancel this process. And he doesn't need any notification about that.
94cdf0e10cSrcweir        On the other hand - nobody then this owner himself can be registered as an
95cdf0e10cSrcweir        <type>XLoadEventListener</type> here.
96cdf0e10cSrcweir        </p>
97cdf0e10cSrcweir	 */
98cdf0e10cSrcweir	[oneway] void cancel();
99cdf0e10cSrcweir};
100cdf0e10cSrcweir
101cdf0e10cSrcweir//=============================================================================
102cdf0e10cSrcweir
103cdf0e10cSrcweir}; }; }; };
104cdf0e10cSrcweir
105cdf0e10cSrcweir#endif
106