1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: XEmbedPersist.idl,v $
* $Revision: 1.7 $
*
* 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_embed_XEmbedPersist_idl__
#define __com_sun_star_embed_XEmbedPersist_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_embed_XCommonEmbedPersist_idl__
#include <com/sun/star/embed/XCommonEmbedPersist.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 {
//============================================================================
/** specifies an implementation for embedded object persistence.
<p>
The idea is that any usable embedded object should be initialized
with an entry in the parent storage that will be used as persistent
representation.
</p>
*/
interface XEmbedPersist: XCommonEmbedPersist
{
//------------------------------------------------------------------------
/** provides object with a parent storage and a name for object's entry.
<p>
An entry with the specified name should be created/opened inside
provided storage. It can be a storage or a stream. For example,
OOo API will refer to ole storages only by streams, but the object
implementation will use storage based on this stream.
</p>
<p>
Factory does this call to initialize the embedded object.
The linked object can be initialized by factory in different way
( internally ).
</p>
<p>
It is also possible to switch object persistent representation through
this call. Actually this is the way, this call can be used by user
( since initialization is done by factory ).
</p>
@param xStorage
a parent storage the entry should be created in
@param sEntName
a name for the entry
@param nEntryConnectionMode
a mode in which the object should be initialized from entry
can take values from EntryInitModes constant set
@param aMediaArgs
optional parameters for the embedded document persistence
initialization, see also
<type scope="com::sun::star::document">MediaDescriptor</type>
@param aObjectArgs
optional parameters for the object persistence initialization,
see also
<type scope="com::sun::star::embed">EmbeddedObjectDescriptor</type>
@thrown ::com::sun::star::lang::IllegalArgumentException
one of arguments is illegal
@throws com::sun::star::embed::WrongStateException
the object is in wrong state
@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
*/
void setPersistentEntry(
[in] ::com::sun::star::embed::XStorage xStorage,
[in] string sEntName,
[in] long nEntryConnectionMode,
[in] sequence< ::com::sun::star::beans::PropertyValue > aMediaArgs,
[in] sequence< ::com::sun::star::beans::PropertyValue > aObjectArgs )
raises( ::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::embed::WrongStateException,
::com::sun::star::io::IOException,
::com::sun::star::uno::Exception );
//------------------------------------------------------------------------
/** lets the object store itself to an entry in destination storage,
the own persistence entry is not changed.
@param xStorage
a parent storage the entry should be created inside
@param sEntName
a name for the entry
@param aMediaArgs
optional parameters for document saving, see also
<type scope="com::sun::star::document">MediaDescriptor</type>
@param aObjectArgs
optional parameters for the object saving, see also
<type scope="com::sun::star::embed">EmbeddedObjectDescriptor</type>
@thrown ::com::sun::star::lang::IllegalArgumentException
one of arguments is illegal
@throws com::sun::star::embed::WrongStateException
the object is in wrong state
@throws com::sun::star::io::IOException
in case of io problems during storing
@throws com::sun::star::uno::Exception
in case of other problems
*/
void storeToEntry(
[in] ::com::sun::star::embed::XStorage xStorage,
[in] string sEntName,
[in] sequence< ::com::sun::star::beans::PropertyValue > aMediaArgs,
[in] sequence< ::com::sun::star::beans::PropertyValue > aObjectArgs )
raises( ::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::embed::WrongStateException,
::com::sun::star::io::IOException,
::com::sun::star::uno::Exception );
//------------------------------------------------------------------------
/** lets the object store itself to an entry in destination storage and
prepare to use the new entry for own persistence.
<p>
The object should be stored to the new entry, after that the entry
should be remembered by the object. After the storing process is
finished the <method>XEmbedPersist::saveCompleted</method> method
can be used to specify whether the object should use the new entry or
the old one. The object persistence can not be used until
<method>XEmbedPersist::saveCompleted</method> is called.
So this state can be treated as "HandsOff" state.
<p>
@param xStorage
a parent storage the entry should be created in
@param sEntName
a name for the entry
@param aMediaArgs
optional parameters for document saving, see also
<type scope="com::sun::star::document">MediaDescriptor</type>
@param aObjectArgs
optional parameters for the object saving, see also
<type scope="com::sun::star::embed">EmbeddedObjectDescriptor</type>
@thrown ::com::sun::star::lang::IllegalArgumentException
one of arguments is illegal
@throws com::sun::star::embed::WrongStateException
the object is in wrong state
@throws com::sun::star::io::IOException
in case of io problems during storing
@throws com::sun::star::uno::Exception
in case of other problems
*/
void storeAsEntry(
[in] ::com::sun::star::embed::XStorage xStorage,
[in] string sEntName,
[in] sequence< ::com::sun::star::beans::PropertyValue > aMediaArgs,
[in] sequence< ::com::sun::star::beans::PropertyValue > aObjectArgs )
raises( ::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::embed::WrongStateException,
::com::sun::star::io::IOException,
::com::sun::star::uno::Exception );
//------------------------------------------------------------------------
/** specifies whether the object should use an old storage or a new one
after "save as" operation.
@param bUseNew
<TRUE/> the new storage should be used
<FALSE/> the old one
@throws com::sun::star::embed::WrongStateException
the object is in wrong state
@throws com::sun::star::uno::Exception
in case of other problems
*/
void saveCompleted( [in] boolean bUseNew )
raises( ::com::sun::star::embed::WrongStateException,
::com::sun::star::uno::Exception );
//------------------------------------------------------------------------
/** allows to detect if the object has entry.
@returns
<TRUE/> if the object has own entry set
<FALSE/> otherwise
*/
boolean hasEntry()
raises( ::com::sun::star::embed::WrongStateException );
//------------------------------------------------------------------------
/** allows to retrieve the current object entry name.
@returns
the object entry name if any
@throws com::sun::star::embed::WrongStateException
the object is in wrong state ( has no entry )
*/
string getEntryName()
raises( ::com::sun::star::embed::WrongStateException );
};
//============================================================================
}; }; }; };
#endif
|
