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
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef __com_sun_star_ucb_XSimpleFileAccess_idl__
#define __com_sun_star_ucb_XSimpleFileAccess_idl__
#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/uno/RuntimeException.idl>
#include <com/sun/star/uno/Exception.idl>
#include <com/sun/star/ucb/CommandAbortedException.idl>
#include <com/sun/star/task/XInteractionHandler.idl>
#include <com/sun/star/util/DateTime.idl>
#include <com/sun/star/io/XOutputStream.idl>
#include <com/sun/star/io/XInputStream.idl>
#include <com/sun/star/io/XStream.idl>
module com { module sun { module star { module ucb {
/** This is the basic interface to read data from a stream.
*/
published interface XSimpleFileAccess: com::sun::star::uno::XInterface
{
/** Copies a file
@param SourceURL
URL of the file to be copied
@param DestURL
URL of the location the file should be copied to
@see move
*/
void copy( [in] string SourceURL, [in] string DestURL )
raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
/** Moves a file
@param SourceURL
URL of the file to be moved
@param DestURL
URL of the location the file should be moved to
@see move
*/
void move( [in] string SourceURL, [in] string DestURL )
raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
/** Removes a file. If the URL represents a folder, the folder will be
removed, even if it's not empty.
@param FileURL
File/folder to be removed
@see move
*/
void kill( [in] string FileURL )
raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
/** Checks if an URL represents a folder
@param FileURL
URL to be checked
@return
true, if the given URL represents a folder, otherwise false
*/
boolean isFolder( [in] string FileURL )
raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
/** Checks if a file is "read only"
@param FileURL
URL to be checked
@return
true, if the given File is "read only", false otherwise
*/
boolean isReadOnly( [in] string FileURL )
raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
/** Sets the "read only" of a file according to the boolean parameter,
if the actual process has the right to do so.
@param bReadOnly
true; "read only" flag will be set, false; "read only" flag will be reset
*/
void setReadOnly( [in] string FileURL, [in] boolean bReadOnly )
raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
/** Creates a new Folder
@param NewFolderURL
URL describing the location of the new folder
*/
void createFolder( [in] string NewFolderURL )
raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
/** Returns the size of a file.
@param FileURL
URL of the file
@return Size of the file in bytes
*/
long getSize( [in] string FileURL )
raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
/** Returns the content type of a file.
@see XContent::getContentType
@param FileURL
URL of the file
@return Content type of the file
*/
string getContentType( [in] string FileURL )
raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
/** Returns the last modified date for the file
@param FileURL
URL of the file
@return Last modified date for the file
*/
::com::sun::star::util::DateTime getDateTimeModified( [in] string FileURL )
raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
/** Returns the contents of a folder
@param FolderURL
URL of the folder
@param bIncludeFolders
true: Subfolders are included, false: No subfolders
@return The content of a folder, each file as one string
in a string sequence
*/
sequence<string> getFolderContents( [in] string FolderURL, [in] boolean bIncludeFolders )
raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
/** Checks if a file exists
@param FileURL
URL to be checked
@return
true, if the File exists, false otherwise
*/
boolean exists( [in] string FileURL )
raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
/** Opens file to read
@param FileURL
File to open
@return
An XInputStream, if the file can be opened for reading
*/
com::sun::star::io::XInputStream openFileRead( [in] string FileURL )
raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
/** Opens file to write.
@param FileURL
File to open
@return
An XOutputStream, if the file can be opened for writing
@throws
UnsupportedDataSinkException, if the file cannot be
opened for random write access. Some resources do not allow random
write access. To write data for those resources
XSimpleFileAccess2::writeFile() may be used.
*/
com::sun::star::io::XOutputStream openFileWrite( [in] string FileURL )
raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
/** Opens file to read and write
@param FileURL
File to open
@return
An XStream, if the file can be opened for reading and writing
@throws
UnsupportedDataSinkException, if the file cannot be
opened for random write access. Some resources do not allow random
write access. To write data for those resources
XSimpleFileAccess2::writeFile() may be used.
*/
com::sun::star::io::XStream openFileReadWrite( [in] string FileURL )
raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
/** Sets an interaction handler to be used for further operations.
<p>
A default interaction handler is available as service
com::sun::star::task::InteractionHandler.
The documentation of this service also contains further
information about the interaction handler concept.
</p>
@see com::sun::star::task::InteractionHandler
@param Handler
The interaction handler to be set
*/
void setInteractionHandler( [in] com::sun::star::task::XInteractionHandler Handler );
};
}; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
