xref: /aoo42x/main/offapi/com/sun/star/frame/XStorable2.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 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 extention 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>

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

        @throws com::sun::star::io::IOException
            if an IO error occured 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