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