LibreOffice: com/sun/star/ucb/XSimpleFileAccess.idl Source File

LibreOffice LibreOffice 6.3 SDK API Reference

XSimpleFileAccess.idl
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19 #ifndef __com_sun_star_ucb_XSimpleFileAccess_idl__
20 #define __com_sun_star_ucb_XSimpleFileAccess_idl__
21
22 #include <com/sun/star/uno/XInterface.idl>
23 #include <com/sun/star/uno/RuntimeException.idl>
24 #include <com/sun/star/uno/Exception.idl>
25 #include <com/sun/star/ucb/CommandAbortedException.idl>
26 #include <com/sun/star/task/XInteractionHandler.idl>
27 #include <com/sun/star/util/DateTime.idl>
28 #include <com/sun/star/io/XOutputStream.idl>
29 #include <com/sun/star/io/XInputStream.idl>
30 #include <com/sun/star/io/XStream.idl>
31
32
33
34
35 module com { module sun { module star { module ucb {
36
39 published interface XSimpleFileAccess: com::sun::star::uno::XInterface
40 {
41
51 void copy( [in] string SourceURL, [in] string DestURL )
52 raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
53
63 void move( [in] string SourceURL, [in] string DestURL )
64 raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
65
74 void kill( [in] string FileURL )
75 raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
76
85 boolean isFolder( [in] string FileURL )
86 raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
87
96 boolean isReadOnly( [in] string FileURL )
97 raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
98
108 void setReadOnly( [in] string FileURL, [in] boolean bReadOnly )
109 raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
110
116 void createFolder( [in] string NewFolderURL )
117 raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
118
126 long getSize( [in] string FileURL )
127 raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
128
138 string getContentType( [in] string FileURL )
139 raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
140
148 ::com::sun::star::util::DateTime getDateTimeModified( [in] string FileURL )
149 raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
150
161 sequence<string> getFolderContents( [in] string FolderURL, [in] boolean bIncludeFolders )
162 raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
163
172 boolean exists( [in] string FileURL )
173 raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
174
175
184 com::sun::star::io::XInputStream openFileRead( [in] string FileURL )
185 raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
186
201 com::sun::star::io::XOutputStream openFileWrite( [in] string FileURL )
202 raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
203
218 com::sun::star::io::XStream openFileReadWrite( [in] string FileURL )
219 raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
220
235 void setInteractionHandler( [in] com::sun::star::task::XInteractionHandler Handler );
236
237 };
238
239
240 }; }; }; };
241
242 #endif
243
244 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
XInterface.idl
com::sun::star::ucb::XSimpleFileAccess
This is the basic interface to read data from a stream.
Definition: XSimpleFileAccess.idl:39
DateTime.idl
CommandAbortedException.idl
com::sun::star::util::DateTime
represents a combined date+time value.
Definition: DateTime.idl:28
com::sun::star::task::XInteractionHandler
An interaction request handler.
Definition: XInteractionHandler.idl:32
Exception.idl
com::sun::star::io::XStream
offers read and write access to the same stream.
Definition: XStream.idl:32
com::sun::star::uno::Exception
the base of all UNO exceptions
Definition: Exception.idl:32
com::sun::star::io::XInputStream
This is the basic interface to read data from a stream.
Definition: XInputStream.idl:37
RuntimeException.idl
XInteractionHandler.idl
com::sun::star::ucb::CommandAbortedException
This exception is thrown to indicate that a command was aborted.
Definition: CommandAbortedException.idl:33
XOutputStream.idl
XStream.idl
com
Definition: Ambiguous.idl:22
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:47
XInputStream.idl
com::sun::star::io::XOutputStream
This is the basic interface to write data to a stream.
Definition: XOutputStream.idl:37