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