xref: /trunk/main/offapi/com/sun/star/frame/XStorable2.idl (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
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_frame_XStorable2_idl__
28#define __com_sun_star_frame_XStorable2_idl__
29
30#ifndef __com_sun_star_frame_XStorable_idl__
31#include <com/sun/star/frame/XStorable.idl>
32#endif
33
34#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
35#include <com/sun/star/lang/IllegalArgumentException.idl>
36#endif
37
38#ifndef __com_sun_star_io_IOException_idl__
39#include <com/sun/star/io/IOException.idl>
40#endif
41
42#ifndef __com_sun_star_beans_PropertyValue_idl__
43#include <com/sun/star/beans/PropertyValue.idl>
44#endif
45
46
47//=============================================================================
48
49 module com {  module sun {  module star {  module frame {
50
51//=============================================================================
52/** extends <type>XStorable</type>.
53 */
54published interface XStorable2: XStorable
55{
56    /** stores the data to the URL from which it was loaded.
57
58        <p>
59            Only objects which know their locations can be stored.
60        </p>
61
62        <p>
63            This is an extention of the <method>XStorable::store()</method>.
64            This method allows to specify some additional parametes for
65            storing process.
66        </p>
67
68        @param lArguments
69            optional parameters for saving, can take values from subset of
70            <type scope="com::sun::star::document">MediaDescriptor</type>
71
72        @thrown ::com::sun::star::lang::IllegalArgumentException
73            the optional parameters contain unacceptable for save entry
74
75        @throws com::sun::star::io::IOException
76            if an IO error occured during save operation
77
78        @see XStorable::store
79     */
80    void storeSelf(
81        [in] sequence<com::sun::star::beans::PropertyValue> lArguments )
82            raises( com::sun::star::lang::IllegalArgumentException,
83                    com::sun::star::io::IOException );
84
85};
86
87//=============================================================================
88
89}; }; }; };
90
91#endif
92
93