| /************************************************************** |
| * |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| #ifndef __com_sun_star_embed_XEmbedObjectCreator_idl__ |
| #define __com_sun_star_embed_XEmbedObjectCreator_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_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. |
| |
| <p> |
| This interface contains methods that can help to create and initialize |
| an embedded object. |
| </p> |
| */ |
| published interface XEmbedObjectCreator: com::sun::star::uno::XInterface |
| { |
| // ----------------------------------------------------------------------- |
| /** creates a new object and initializes it as a new one. |
| |
| <p> In case specified entry exists it's contents are ignored and |
| will be overwritten on storing. |
| </p> |
| |
| @param aClassID |
| the class id of the new object |
| |
| @param sClassName |
| the class name of the new object |
| |
| @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> |
| |
| @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 |
| */ |
| ::com::sun::star::uno::XInterface createInstanceInitNew( |
| [in] sequence< byte > aClassID, |
| [in] string sClassName, |
| [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 ); |
| |
| |
| // ----------------------------------------------------------------------- |
| /** creates a new object that should be based on specified storage entry. |
| |
| <p> The specified entry must exists and the object should be loaded |
| from the entry. In case a persistent representation of a link is |
| specified, the result object will be a link. |
| </p> |
| |
| @param xStorage |
| a parent storage the entry should be opened in |
| |
| @param sEntryName |
| a name for the entry |
| |
| @param aMediaDescriptor |
| an object of type |
| <type scope="com::sun::star::document">MediaDescriptor</type> that |
| specifies document related properties; please remember that target |
| related parameters, for example URL, will be ignored since the |
| object should be loaded from storage entry |
| |
| @param aObjectArgs |
| an object of type <type>EmbeddedObjectDescriptor</type> |
| contains object related properties |
| |
| @thrown ::com::sun::star::lang::IllegalArgumentException |
| one of arguments is illegal |
| |
| @thrown ::com::sun::star::container::NoSuchElementException |
| the specified entry does not exist |
| |
| @throws com::sun::star::io::IOException |
| in case of io problems during opening |
| |
| @throws com::sun::star::uno::Exception |
| in case of other problems |
| */ |
| ::com::sun::star::uno::XInterface createInstanceInitFromEntry( |
| [in] ::com::sun::star::embed::XStorage xStorage, |
| [in] string sEntryName, |
| [in] sequence< ::com::sun::star::beans::PropertyValue > aMediaDescriptor, |
| [in] sequence< ::com::sun::star::beans::PropertyValue > aObjectArgs ) |
| raises( ::com::sun::star::lang::IllegalArgumentException, |
| ::com::sun::star::container::NoSuchElementException, |
| ::com::sun::star::io::IOException, |
| ::com::sun::star::uno::Exception ); |
| |
| // ----------------------------------------------------------------------- |
| /** creates a new object and initializes it based on |
| <type scope="com::sun::star::document">MediaDescriptor</type>. |
| |
| <p> In case specified entry exists it's contents are ignored and will |
| be overwritten on storing. |
| </p> |
| |
| @param xStorage |
| a parent storage the entry should be created/opened in |
| |
| @param sEntryName |
| a name for the entry |
| |
| @param aMediaDescriptor |
| an object of type |
| <type scope="com::sun::star::document">MediaDescriptor</type> that |
| specifies source |
| |
| @param aObjectArgs |
| an object of type <type>EmbeddedObjectDescriptor</type> |
| contains object related properties |
| |
| @thrown ::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 |
| */ |
| ::com::sun::star::uno::XInterface createInstanceInitFromMediaDescriptor( |
| [in] ::com::sun::star::embed::XStorage xStorage, |
| [in] string sEntryName, |
| [in] sequence< ::com::sun::star::beans::PropertyValue > aMediaDescriptor, |
| [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 |
| |