xref: /aoo41x/main/offapi/com/sun/star/frame/XLoadable.idl (revision d1766043)
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_XLoadable_idl__
24#define __com_sun_star_frame_XLoadable_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_io_IOException_idl__
31#include <com/sun/star/io/IOException.idl>
32#endif
33
34#ifndef __com_sun_star_frame_DoubleInitializationException_idl__
35#include <com/sun/star/frame/DoubleInitializationException.idl>
36#endif
37
38#ifndef __com_sun_star_beans_PropertyValue_idl__
39#include <com/sun/star/beans/PropertyValue.idl>
40#endif
41
42
43//=============================================================================
44
45 module com {  module sun {  module star {  module frame {
46
47//=============================================================================
48/** offers a simple way to initialize a component or load it from an URL.
49	<p>In case an object supports the interface the object must be initialized
50	   with either initNew() or load() call before any usage. In case the object
51	   is already initialized the mentioned methods should throw DoubleInitializationException.
52	</p>
53
54	@since OOo 1.1.2
55 */
56published interface XLoadable: com::sun::star::uno::XInterface
57{
58	//-------------------------------------------------------------------------
59	/** creates a component from scratch
60	*/
61	void initNew()
62        raises( DoubleInitializationException, com::sun::star::io::IOException, com::sun::star::uno::Exception );
63
64	//-------------------------------------------------------------------------
65	/** loads a component from an URL
66        @param lArguments
67            parameters for saving
68            (see <type scope="com::sun::star::document">MediaDescriptor</type> for further details)
69			the FileName parameter must be specified, other parameters are optional
70	*/
71
72	void load( [in] sequence<com::sun::star::beans::PropertyValue> lArguments )
73        raises( DoubleInitializationException, com::sun::star::io::IOException, com::sun::star::uno::Exception );
74
75};
76
77//=============================================================================
78
79}; }; }; };
80
81#endif
82