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
|
/*************************************************************************
*
* 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_resource_XStringResourcePersistence_idl__
#define __com_sun_star_resource_XStringResourcePersistence_idl__
#ifndef __com_sun_star_resource_XStringResourceManager_idl__
#include <com/sun/star/resource/XStringResourceManager.idl>
#endif
#ifndef __com_sun_star_embed_XStorage_idl__
#include <com/sun/star/embed/XStorage.idl>
#endif
#ifndef __com_sun_star_task_XInteractionHandler_idl__
#include <com/sun/star/task/XInteractionHandler.idl>
#endif
//=============================================================================
module com { module sun { module star { module resource {
//=============================================================================
/**
Interface derived from XStringResourceManager containing
basic persistence functionality limited to operations that
are independend from a associated location or storage.
@see <type>XStringResourceManager</type>.
*/
interface XStringResourcePersistence: com::sun::star::resource::XStringResourceManager
{
/**
Stores all string table data respectively all data modified since
the last call to <member>store</member> to the location or storage
associated with the StringResourceManager. Each locale is stored
in a single file following the format of Java properties files.
This interface is supported by the services
<type>StringResourceWithLocation</type> and
<type>StringResourceWithStorage</type>
The StringResourceWithLocation is initialised with an URL
specifying a location used to load data from and store data to,
see <type>StringResourceWithLocation</type>.
The StringResourceWithStorage is initialised with an in-
stance of <type scope="com::sun::star::embed">XStorage</type>
used to load data from and store data to,
see <type>StringResourceWithStorage</type>.
If the string table isn't modified (see <member>isModified</member>)
this method does nothing.
This method can throw all exceptions thrown by the methods of
<type scope="com::sun::star::embed">XStorage</type> respectively
a <type scope="com::sun::star::ucb">CommandAbortedException in
case of a StringResourceWithLocation for all exceptions that are
not handled by a previously specified
<type scope="com::sun::star::task">XInteractionHandler</type>.
The handler to be used for the store operation can be specified
during initialisation of <type>StringResourceWithLocation</type>.
@throws <type scope="com::sun::star::lang">NoSupportException</type>
if no URL or no valid storage are provided.
*/
void store()
raises( com::sun::star::lang::NoSupportException,
com::sun::star::uno::Exception );
/**
provides the current modify state of the StringResourceManager instance.
@return
<TRUE/> if the string table has changed since the last call to
<member>store</member> or, if supported
<code>XStringResourceWithStorage::storeAsStorage</code>.
<FALSE/> if the table hasn't changed.
*/
boolean isModified();
/**
Sets the comment stored first in each locale data file.
This interface method can be used to overwrite the comment used
during initialisation of the services
<type>StringResourceWithLocation</type> or
<type>StringResourceWithStorage</type>
@param Comment
Comment stored first in each properties file followed by a line
feed character. The line feed character is added automatically
and hasn't to be part of the comment string. The caller is re-
sponsible that the passed string is a valid comment in a Java
properties file, e.g. "# My strings". The string may be empty.
*/
void setComment( [in] string Comment );
/**
Stores all string table data to the provided storage.
Calling this method does not affect the association with a location
(in case of a <type>StringResourceWithLocation</type> instance)
repectively with a storage (in case of a
<type>StringResourceWithStorage</type> instance).
The modified state isn't affected either.
This method can be used to make a copy of the current string
table data to a storage. This method can throw all exceptions
thrown by the methods of <type scope="com::sun::star::embed">XStorage</type>
@param Storage
all string table data will be stored to this storage.
@param BaseName
Base string for the file names used to store the locale data.
The locale data is stored in Java properties files also following
the corresponding naming sceme. The files will be named like this:
"[BaseName]_[Language]_[Country].properties",
e.g. "MyBaseName_en_US.properties"
If an empty string is passed for BaseName, "strings" will be used
as BaseName.
@param Comment
Comment stored first in each properties file,
for a detailed description see <member>setComment</member>.
This method can throw all exceptions thrown by the methods of
<type scope="com::sun::star::embed">XStorage</type>
*/
void storeToStorage( [in] ::com::sun::star::embed::XStorage Storage,
[in] string BaseName, [in] string Comment )
raises ( com::sun::star::uno::Exception );
/**
Stores all string table data to the location specified by the
passed URL string.
Calling this method does not affect the association with a location
(in case of a <type>StringResourceWithLocation</type> instance)
repectively with a storage (in case of a
<type>StringResourceWithStorage</type> instance).
The modified state isn't affected either.
This method can be used to make a copy of the current string
table data to a location.
@param URL
the location the string table data should be stored to.
@param BaseName
Base string for the file names used to store the locale data.
The locale data is stored in Java properties files also following
the corresponding naming sceme. The files will be named like this:
"[BaseName]_[Language]_[Country].properties",
e.g. "MyBaseName_en_US.properties"
If an empty string is passed for BaseName, "strings" will be used
as BaseName.
@param Comment
Comment stored first in each properties file,
for a detailed description see <member>setComment</member>.
@param Handler
a <type scope="com::sun::star::task">XInteractionHandler</type>.
It will be passed to ucb handle exceptions. Exceptions not processed
by this handler will be passed as com::sun::star::uno::Exception. If
this parameter is null this applies to all exceptions thrown by ucb.
@see com::sun::star::task::InteractionHandler
*/
void storeToURL( [in] string URL, [in] string BaseName, [in] string Comment,
[in] com::sun::star::task::XInteractionHandler Handler )
raises( com::sun::star::uno::Exception );
/**
Returns a sequence of byte representing the complete string resource
in a binary format.
This method is intended to support datatransfer functionality, e.g. provided
by <type scope="com::sun::star::datatransfer">XTransferable</type> and
related interfaces.
See <member>importBinary</member>).
@return a sequence of byte representing the string resource.
*/
sequence<byte> exportBinary();
/**
Initializes the string resource with binary data. This method
expects the data format returned by <member>exportBinary</member>.
All locales and strings previously added to the string resource
will be deleted. So after calling this method the string resource
only contains the locales and strings specified in the binary data.
This method is intended to support datatransfer functionality, e.g. provided
by <type scope="com::sun::star::datatransfer">XTransferable</type> and
related interfaces.
See <member>importBinary</member>).
@throws com::sun::star::lang::IllegalArgumentException
if Data is empty or does not meet the binary format returned by
the current or earlier version of <member>exportBinary</member>).
*/
void importBinary( [in] sequence<byte> Data )
raises ( com::sun::star::lang::IllegalArgumentException );
};
//=============================================================================
}; }; }; };
#endif
|
