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

LibreOffice LibreOffice 24.8 SDK API Reference

Loading...
Searching...
No Matches
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
20
21
22
23module com { module sun { module star { module ucb {
24
27published interface XSimpleFileAccess: com::sun::star::uno::XInterface
28{
29
39 void copy( [in] string SourceURL, [in] string DestURL )
40 raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
41
51 void move( [in] string SourceURL, [in] string DestURL )
52 raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
53
62 void kill( [in] string FileURL )
63 raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
64
73 boolean isFolder( [in] string FileURL )
74 raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
75
84 boolean isReadOnly( [in] string FileURL )
85 raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
86
96 void setReadOnly( [in] string FileURL, [in] boolean bReadOnly )
97 raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
98
104 void createFolder( [in] string NewFolderURL )
105 raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
106
114 long getSize( [in] string FileURL )
115 raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
116
126 string getContentType( [in] string FileURL )
127 raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
128
136 ::com::sun::star::util::DateTime getDateTimeModified( [in] string FileURL )
137 raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
138
149 sequence<string> getFolderContents( [in] string FolderURL, [in] boolean bIncludeFolders )
150 raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
151
160 boolean exists( [in] string FileURL )
161 raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
162
163
172 com::sun::star::io::XInputStream openFileRead( [in] string FileURL )
173 raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
174
189 com::sun::star::io::XOutputStream openFileWrite( [in] string FileURL )
190 raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
191
206 com::sun::star::io::XStream openFileReadWrite( [in] string FileURL )
207 raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
208
223 void setInteractionHandler( [in] com::sun::star::task::XInteractionHandler Handler );
224
225};
226
227
228}; }; }; };
229
230/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::ucb::CommandAbortedException
This exception is thrown to indicate that a command was aborted.
Definition CommandAbortedException.idl:30
com::sun::star::uno::Exception
the base of all UNO exceptions
Definition generated_idl_chapter_refs.idl:113
com::sun::star::io::XInputStream
This is the basic interface to read data from a stream.
Definition XInputStream.idl:30
com::sun::star::io::XOutputStream
This is the basic interface to write data to a stream.
Definition XOutputStream.idl:30
com::sun::star::io::XStream
offers read and write access to the same stream.
Definition XStream.idl:27
com::sun::star::task::XInteractionHandler
An interaction request handler.
Definition XInteractionHandler.idl:27
com::sun::star::ucb::XSimpleFileAccess
This is the basic interface to read data from a stream.
Definition XSimpleFileAccess.idl:28
com::sun::star::ucb::XSimpleFileAccess::exists
boolean exists([in] string FileURL)
Checks if a file exists.
com::sun::star::ucb::XSimpleFileAccess::setInteractionHandler
void setInteractionHandler([in] com::sun::star::task::XInteractionHandler Handler)
Sets an interaction handler to be used for further operations.
com::sun::star::ucb::XSimpleFileAccess::getContentType
string getContentType([in] string FileURL)
Returns the content type of a file.
com::sun::star::ucb::XSimpleFileAccess::setReadOnly
void setReadOnly([in] string FileURL, [in] boolean bReadOnly)
Sets the "read only" of a file according to the boolean parameter, if the actual process has the righ...
com::sun::star::ucb::XSimpleFileAccess::getDateTimeModified
::com::sun::star::util::DateTime getDateTimeModified([in] string FileURL)
Returns the last modified date for the file.
com::sun::star::ucb::XSimpleFileAccess::openFileRead
com::sun::star::io::XInputStream openFileRead([in] string FileURL)
Opens file to read.
com::sun::star::ucb::XSimpleFileAccess::getSize
long getSize([in] string FileURL)
Returns the size of a file.
com::sun::star::ucb::XSimpleFileAccess::openFileReadWrite
com::sun::star::io::XStream openFileReadWrite([in] string FileURL)
Opens file to read and write.
com::sun::star::ucb::XSimpleFileAccess::kill
void kill([in] string FileURL)
Removes a file.
com::sun::star::ucb::XSimpleFileAccess::openFileWrite
com::sun::star::io::XOutputStream openFileWrite([in] string FileURL)
Opens file to write.
com::sun::star::ucb::XSimpleFileAccess::createFolder
void createFolder([in] string NewFolderURL)
Creates a new Folder.
com::sun::star::ucb::XSimpleFileAccess::getFolderContents
sequence< string > getFolderContents([in] string FolderURL, [in] boolean bIncludeFolders)
Returns the contents of a folder.
com::sun::star::ucb::XSimpleFileAccess::move
void move([in] string SourceURL, [in] string DestURL)
Moves a file.
com::sun::star::ucb::XSimpleFileAccess::copy
void copy([in] string SourceURL, [in] string DestURL)
Copies a file.
com::sun::star::ucb::XSimpleFileAccess::isReadOnly
boolean isReadOnly([in] string FileURL)
Checks if a file is "read only".
com::sun::star::ucb::XSimpleFileAccess::isFolder
boolean isFolder([in] string FileURL)
Checks if a URL represents a folder.
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition generated_idl_chapter_refs.idl:452
com
Definition Ambiguous.idl:20
com::sun::star::util::DateTime
represents a combined date+time value.
Definition DateTime.idl:27