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_embed_XStorageBasedDocument_idl__
28#define __com_sun_star_embed_XStorageBasedDocument_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34#ifndef __com_sun_star_embed_XStorage_idl__
35#include <com/sun/star/embed/XStorage.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_frame_DoubleInitializationException_idl__
43#include <com/sun/star/frame/DoubleInitializationException.idl>
44#endif
45
46#ifndef __com_sun_star_document_XStorageChangeListener_idl__
47#include <com/sun/star/document/XStorageChangeListener.idl>
48#endif
49
50#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
51#include <com/sun/star/lang/IllegalArgumentException.idl>
52#endif
53
54#ifndef __com_sun_star_beans_PropertyValue_idl__
55#include <com/sun/star/beans/PropertyValue.idl>
56#endif
57
58//============================================================================
59
60 module com {  module sun {  module star {  module document {
61
62//============================================================================
63/** allows to initialize document with a storage, to store document to
64    a storage, and to set document to be based on provided storage.
65 */
66published interface XStorageBasedDocument: com::sun::star::uno::XInterface
67{
68    //------------------------------------------------------------------------
69    /** lets the document load itself using provided storage.
70     */
71    void loadFromStorage(
72            [in] ::com::sun::star::embed::XStorage xStorage,
73            [in] sequence< ::com::sun::star::beans::PropertyValue > aMediaDescriptor )
74        raises( ::com::sun::star::lang::IllegalArgumentException,
75                ::com::sun::star::frame::DoubleInitializationException,
76                ::com::sun::star::io::IOException,
77                ::com::sun::star::uno::Exception );
78
79    //------------------------------------------------------------------------
80    /** lets the document store itself to the provided storage.
81     */
82    void storeToStorage(
83            [in] ::com::sun::star::embed::XStorage xStorage,
84            [in] sequence< ::com::sun::star::beans::PropertyValue > aMediaDescriptor )
85        raises( ::com::sun::star::lang::IllegalArgumentException,
86                ::com::sun::star::io::IOException,
87                ::com::sun::star::uno::Exception );
88
89    //------------------------------------------------------------------------
90    /** allows to switch the document to the provided storage.
91     */
92    void switchToStorage( [in] ::com::sun::star::embed::XStorage xStorage )
93        raises( ::com::sun::star::lang::IllegalArgumentException,
94                ::com::sun::star::io::IOException,
95                ::com::sun::star::uno::Exception );
96
97
98    //------------------------------------------------------------------------
99    /** allows to get the storage the document is based on.
100     */
101    ::com::sun::star::embed::XStorage getDocumentStorage()
102        raises( ::com::sun::star::io::IOException,
103                ::com::sun::star::uno::Exception );
104
105    //------------------------------------------------------------------------
106    /** allows to register a listener that will be notified when another
107        storage is set to the document.
108     */
109    void addStorageChangeListener( [in] XStorageChangeListener xListener );
110
111    //------------------------------------------------------------------------
112    /** allows to deregister the listener.
113     */
114    void removeStorageChangeListener( [in] XStorageChangeListener xListener );
115
116};
117
118//============================================================================
119
120}; }; }; };
121
122#endif
123
124