INTEGRATION: CWS mav17 (1.1.2); FILE ADDED

2005/02/24 14:07:40 mav 1.1.2.1: #i41699# creation of an object from clipboard

offapi/com/sun/star/embed/XEmbedObjectClipboardCreator.idl

@@ -0,0 +1,156 @@
+/*************************************************************************
+ *
+ *  $RCSfile: XEmbedObjectClipboardCreator.idl,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: obo $ $Date: 2005-03-15 11:29:34 $
+ *
+ *  The Contents of this file are made available subject to the terms of
+ *  either of the following licenses
+ *
+ *         - GNU Lesser General Public License Version 2.1
+ *         - Sun Industry Standards Source License Version 1.1
+ *
+ *  Sun Microsystems Inc., October, 2000
+ *
+ *  GNU Lesser General Public License Version 2.1
+ *  =============================================
+ *  Copyright 2000 by Sun Microsystems, Inc.
+ *  901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *  This library is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU Lesser General Public
+ *  License version 2.1, as published by the Free Software Foundation.
+ *
+ *  This library 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 for more details.
+ *
+ *  You should have received a copy of the GNU Lesser General Public
+ *  License along with this library; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *  MA  02111-1307  USA
+ *
+ *
+ *  Sun Industry Standards Source License Version 1.1
+ *  =================================================
+ *  The contents of this file are subject to the Sun Industry Standards
+ *  Source License Version 1.1 (the "License"); You may not use this file
+ *  except in compliance with the License. You may obtain a copy of the
+ *  License at http://www.openoffice.org/license.html.
+ *
+ *  Software provided under this License is provided on an "AS IS" basis,
+ *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ *  See the License for the specific provisions governing your rights and
+ *  obligations concerning the Software.
+ *
+ *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ *  Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ *  All Rights Reserved.
+ *
+ *  Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+#ifndef __com_sun_star_embed_XEmbedObjectClipboardCreator_idl__
+#define __com_sun_star_embed_XEmbedObjectClipboardCreator_idl__
+
+#ifndef __com_sun_star_uno_XInterface_idl__
+#include <com/sun/star/uno/XInterface.idl>
+#endif
+
+#ifndef __com_sun_star_embed_XStorage_idl__
+#include <com/sun/star/embed/XStorage.idl>
+#endif
+
+#ifndef __com_sun_star_embed_InsertedObjectInfo_idl__
+#include <com/sun/star/embed/InsertedObjectInfo.idl>
+#endif
+
+#ifndef __com_sun_star_io_IOException_idl__
+#include <com/sun/star/io/IOException.idl>
+#endif
+
+#ifndef __com_sun_star_embed_WrongStateException_idl__
+#include <com/sun/star/embed/WrongStateException.idl>
+#endif
+
+#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
+#include <com/sun/star/lang/IllegalArgumentException.idl>
+#endif
+
+#ifndef __com_sun_star_beans_PropertyValue_idl__
+#include <com/sun/star/beans/PropertyValue.idl>
+#endif
+
+//============================================================================
+
+ module com {  module sun {  module star {  module embed {
+
+//============================================================================
+/** allows to create and initialize a new embedded object from clipboard.
+
+    <p>
+    This interface contains methods that can help to create and initialize
+    an embedded object based on system clipboard.
+    </p>
+ */
+interface XEmbedObjectClipboardCreator: com::sun::star::uno::XInterface
+{
+    // -----------------------------------------------------------------------
+    /** creates a new object and initializes it from the system clipboard.
+
+        <p> In case specified entry exists it's contents are ignored and
+        will be overwritten on storing.
+        </p>
+
+        <p>
+        The clipboard can provide a number of choices that are container
+        related. This infomation will be returned in the
+        <type>InsertedObjectInfo</type> object.
+        <p>
+
+        @param xStorage
+            a parent storage the entry should be created/opened in
+
+        @param sEntryName
+            a name for the entry
+
+        @param aObjectArgs
+            optional parameters for the object persistence initialization
+            see also
+            <type>EmbeddedObjectDescriptor</type>
+
+        @returns
+            the structure containing the object and container related options
+
+        @throws ::com::sun::star::lang::IllegalArgumentException
+            one of arguments is illegal
+
+        @throws com::sun::star::io::IOException
+            in case of io problems during opening\creation
+
+        @throws com::sun::star::uno::Exception
+            in case of other problems
+     */
+    InsertedObjectInfo createInstanceInitFromClipboard(
+            [in] ::com::sun::star::embed::XStorage xStorage,
+             [in] string sEntryName,
+            [in] sequence< ::com::sun::star::beans::PropertyValue > aObjectArgs )
+        raises( ::com::sun::star::lang::IllegalArgumentException,
+                ::com::sun::star::io::IOException,
+                ::com::sun::star::uno::Exception );
+};
+
+//============================================================================
+
+}; }; }; };
+
+#endif
+