xref: /AOO41X/main/offapi/com/sun/star/embed/XInsertObjectDialog.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
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_XInsertObjectDialog_idl__
24#define __com_sun_star_embed_XInsertObjectDialog_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 using GUI dialog.
60 */
61published interface XInsertObjectDialog: com::sun::star::uno::XInterface
62{
63    //-------------------------------------------------------------------------
64    /** creates a new object using GUI dialog.
65
66        <p>
67        The dialog allows for user to do a number of choices that are container
68        related. This infomation will be returned in the
69        <type>InsertedObjectInfo</type> object.
70        <p>
71
72        @param xStorage
73            a parent storage the entry should be created/opened in
74
75        @param sEntName
76            a name for the entry
77
78        @param lObjArgs
79            optional parameters for the object persistence initialization
80            see also <type scope="com::sun::star::embed">EmbeddedObjectDescriptor</type>
81
82        @returns
83            the structure containing the object and container related options
84
85        @thrown ::com::sun::star::lang::IllegalArgumentException
86            one of arguments is illegal
87
88        @throws com::sun::star::io::IOException
89            in case of io problems during opening\creation
90
91        @throws com::sun::star::uno::Exception
92            in case of other problems
93     */
94    InsertedObjectInfo createInstanceByDialog(
95                            [in] ::com::sun::star::embed::XStorage xStorage,
96                            [in] string sEntName,
97                            [in] sequence< ::com::sun::star::beans::PropertyValue > lObjArgs )
98        raises( ::com::sun::star::lang::IllegalArgumentException,
99                ::com::sun::star::io::IOException,
100                ::com::sun::star::uno::Exception );
101};
102
103//=============================================================================
104
105}; }; }; };
106
107#endif
108
109