blob: 7f590384968c5999dfc48e6807598aa1e6a313b0 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_frame_XSynchronousFrameLoader_idl__
#define __com_sun_star_frame_XSynchronousFrameLoader_idl__
#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_frame_XFrame_idl__
#include <com/sun/star/frame/XFrame.idl>
#endif
#ifndef __com_sun_star_beans_PropertyValue_idl__
#include <com/sun/star/beans/PropertyValue.idl>
#endif
//=============================================================================
module com { module sun { module star { module frame {
//=============================================================================
/** loads a resource into a <type>Frame</type>.
<p>
Unlike the <type>XFrameLoader</type> interface, this loading will be synchronous.
</p>
@see XFrameLoader
*/
published interface XSynchronousFrameLoader: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
/** starts the loading of the specified resource into the specified <type>Frame</type>.
@param Descriptor
describes the resource which should be loaded
It use a <type scope="com::sun::star::document">MediaDescriptor</type> for that.
@param Frame
the target frame which should contain the new loaded component
@return
<TRUE/> if loading is successfully
<br>
<FALSE/> otherwise
*/
boolean load(
[in] sequence< com::sun::star::beans::PropertyValue > Descriptor,
[in] XFrame Frame );
//-------------------------------------------------------------------------
/** cancels the loading process.
<p>
No notifications (neither to the frame or the caller) must be notified.
Because it's a synchronous process this cancel call can be forced by
another thread the loader thread only. Method
<member>XSynchronousFrameLoader::load()</member> must return <FALSE/>
then and caller of this method <member>XSynchronousFrameLoader::cancel()</member>
already knows the state ...
</p>
*/
void cancel();
};
//=============================================================================
}; }; }; };
#endif
|