xref: /trunk/main/offapi/com/sun/star/frame/XStorable2.idl (revision 8e0daafc)

/**************************************************************
 *
 * 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_frame_XStorable2_idl__
#define __com_sun_star_frame_XStorable2_idl__

#ifndef __com_sun_star_frame_XStorable_idl__
#include <com/sun/star/frame/XStorable.idl>
#endif

#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif

#ifndef __com_sun_star_io_IOException_idl__
#include <com/sun/star/io/IOException.idl>
#endif

#ifndef __com_sun_star_beans_PropertyValue_idl__
#include <com/sun/star/beans/PropertyValue.idl>
#endif


//=============================================================================

 module com {  module sun {  module star {  module frame {

//=============================================================================
/** extends <type>XStorable</type>.
 */
published interface XStorable2: XStorable
{
	/** stores the data to the URL from which it was loaded.

		<p>
			Only objects which know their locations can be stored.
		</p>

		<p>
			This is an extension of the <method>XStorable::store()</method>.
			This method allows to specify some additional parametes for
			storing process.
		</p>

        @param lArguments
            optional parameters for saving, can take values from subset of
			<type scope="com::sun::star::document">MediaDescriptor</type>

		@throws ::com::sun::star::lang::IllegalArgumentException
			the optional parameters contain unacceptable for save entry

        @throws com::sun::star::io::IOException
            if an IO error occurred during save operation

        @see XStorable::store
	 */
	void storeSelf(
		[in] sequence<com::sun::star::beans::PropertyValue> lArguments )
			raises( com::sun::star::lang::IllegalArgumentException,
					com::sun::star::io::IOException );

};

//=============================================================================

}; }; }; };

#endif