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_XSynchronousFrameLoader_idl__
24#define __com_sun_star_frame_XSynchronousFrameLoader_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//=============================================================================
39
40 module com {  module sun {  module star {  module frame {
41
42//=============================================================================
43/** loads a resource into a <type>Frame</type>.
44
45	<p>
46	Unlike the <type>XFrameLoader</type> interface, this loading will be synchronous.
47 	</p>
48
49    @see XFrameLoader
50 */
51published interface XSynchronousFrameLoader: com::sun::star::uno::XInterface
52{
53	//-------------------------------------------------------------------------
54	/** starts the loading of the specified resource into the specified <type>Frame</type>.
55
56        @param Descriptor
57            describes the ressource which should be loaded
58            It use a <type scope="com::sun::star::document">MediaDescriptor</type> for that.
59
60        @param Frame
61            the target frame which should contain the new loaded component
62
63        @return
64            <TRUE/> if loading is successfully
65            <br>
66            <FALSE/> otherwise
67	 */
68    boolean load(
69        [in] sequence< com::sun::star::beans::PropertyValue > Descriptor,
70        [in] XFrame Frame );
71
72	//-------------------------------------------------------------------------
73	/** cancels the loading process.
74
75        <p>
76        No notifications (neither to the frame or the caller) must be notified.
77        Because it's a synchronous process this cancel call can be forced by
78        another thread the loader thread only. Method
79        <member>XSynchronousFrameLoader::load()</member> must return <FALSE/>
80        then and caller of this method <member>XSynchronousFrameLoader::cancel()</member>
81        already knows the state ...
82        </p>
83	 */
84	void cancel();
85};
86
87//=============================================================================
88
89}; }; }; };
90
91#endif
92