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_embed_XEmbedObjectClipboardCreator_idl__
24#define __com_sun_star_embed_XEmbedObjectClipboardCreator_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_embed_XStorage_idl__
31#include <com/sun/star/embed/XStorage.idl>
32#endif
33
34#ifndef __com_sun_star_embed_InsertedObjectInfo_idl__
35#include <com/sun/star/embed/InsertedObjectInfo.idl>
36#endif
37
38#ifndef __com_sun_star_io_IOException_idl__
39#include <com/sun/star/io/IOException.idl>
40#endif
41
42#ifndef __com_sun_star_embed_WrongStateException_idl__
43#include <com/sun/star/embed/WrongStateException.idl>
44#endif
45
46#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
47#include <com/sun/star/lang/IllegalArgumentException.idl>
48#endif
49
50#ifndef __com_sun_star_beans_PropertyValue_idl__
51#include <com/sun/star/beans/PropertyValue.idl>
52#endif
53
54//============================================================================
55
56 module com {  module sun {  module star {  module embed {
57
58//============================================================================
59/** allows to create and initialize a new embedded object from clipboard.
60
61	<p>
62	This interface contains methods that can help to create and initialize
63	an embedded object based on system clipboard.
64	</p>
65 */
66published interface XEmbedObjectClipboardCreator: com::sun::star::uno::XInterface
67{
68	// -----------------------------------------------------------------------
69    /** creates a new object and initializes it from the system clipboard.
70
71		<p> In case specified entry exists it's contents are ignored and
72		will be overwritten on storing.
73		</p>
74
75		<p>
76		The clipboard can provide a number of choices that are container
77		related. This information will be returned in the
78		<type>InsertedObjectInfo</type> object.
79		<p>
80
81		@param xStorage
82			a parent storage the entry should be created/opened in
83
84		@param sEntryName
85			a name for the entry
86
87        @param aObjectArgs
88            optional parameters for the object persistence initialization
89            see also
90			<type>EmbeddedObjectDescriptor</type>
91
92		@returns
93			the structure containing the object and container related options
94
95		@throws ::com::sun::star::lang::IllegalArgumentException
96			one of arguments is illegal
97
98        @throws com::sun::star::io::IOException
99			in case of io problems during opening\creation
100
101        @throws com::sun::star::uno::Exception
102			in case of other problems
103	 */
104	InsertedObjectInfo createInstanceInitFromClipboard(
105			[in] ::com::sun::star::embed::XStorage xStorage,
106		 	[in] string sEntryName,
107			[in] sequence< ::com::sun::star::beans::PropertyValue > aObjectArgs )
108		raises( ::com::sun::star::lang::IllegalArgumentException,
109				::com::sun::star::io::IOException,
110				::com::sun::star::uno::Exception );
111};
112
113//============================================================================
114
115}; }; }; };
116
117#endif
118
119