LibreOffice
LibreOffice 7.3 SDK API Reference
XStorage.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_embed_XStorage_idl__
20#define __com_sun_star_embed_XStorage_idl__
21
36
37
38
39 module com { module sun { module star { module embed {
40
43published interface XStorage
44{
45 // INTERFACES
57 interface ::com::sun::star::container::XNameAccess;
58
66 interface ::com::sun::star::lang::XComponent;
67
68
69 // METHODS
93 void copyToStorage( [in] XStorage xDest )
98
130 [in] string sStreamName,
131 [in] long nOpenMode )
137
182 [in] string sStreamName,
183 [in] long nOpenMode,
184 [in] string sPassword )
191
220 XStorage openStorageElement( [in] string sStorName,
221 [in] long nOpenMode )
226
259
305 [in] string sStreamName,
306 [in] string sPassword )
313
337 void copyLastCommitTo( [in] XStorage xTargetStorage )
342
370 [in] string sStorName,
371 [in] XStorage xTargetStorage )
376
401 boolean isStreamElement( [in] string sElementName )
405
406
431 boolean isStorageElement( [in] string sElementName )
435
457 void removeElement( [in] string sElementName )
463
491 void renameElement( [in] string sElementName, [in] string sNewName )
498
532 [in] string sElementName,
533 [in] XStorage xDest,
534 [in] string sNewName )
541
575 [in] string sElementName,
576 [in] XStorage xDest,
577 [in] string sNewName )
584
585};
586
587
588}; }; }; };
589
590#endif
591
592/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
is thrown by container methods, if an element is added which is already a child of the container.
Definition: ElementExistException.idl:39
is thrown by child access methods of collections, if the addressed child does not exist.
Definition: NoSuchElementException.idl:35
This exception can be thrown in case a storage is invalid.
Definition: InvalidStorageException.idl:36
This exception can wrap an exception thrown during XStorage methods execution.
Definition: StorageWrappedTargetException.idl:33
is thrown when an input or output error has occurred.
Definition: IOException.idl:31
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:31
This exception can be thrown in case object is not encrypted one as expected.
Definition: NoEncryptionException.idl:31
This exception can be thrown in case wrong password was provided.
Definition: WrongPasswordException.idl:31
This interface represents main storage functionality.
Definition: XStorage.idl:44
XStorage openStorageElement([in] string sStorName, [in] long nOpenMode)
allows to get access to a child storage.
::com::sun::star::io::XStream openEncryptedStreamElement([in] string sStreamName, [in] long nOpenMode, [in] string sPassword)
allows to get access to a child encrypted stream with password.
void copyElementTo([in] string sElementName, [in] XStorage xDest, [in] string sNewName)
allows to copy an entry from one storage to another.
::com::sun::star::io::XStream cloneStreamElement([in] string sStreamName)
allows to get readonly copy of a child stream of the storage.
boolean isStorageElement([in] string sElementName)
allows to check if an element is a child storage with specified name.
::com::sun::star::io::XStream openStreamElement([in] string sStreamName, [in] long nOpenMode)
allows to get access to a child stream of the storage.
void copyLastCommitTo([in] XStorage xTargetStorage)
allows to get copy of this storage at the state of its last commit.
void removeElement([in] string sElementName)
removes an element from a storage.
boolean isStreamElement([in] string sElementName)
allows to check if an element is a child stream with specified name.
void copyStorageElementLastCommitTo([in] string sStorName, [in] XStorage xTargetStorage)
allows to get copy of a child storage at the state of its last commit.
void moveElementTo([in] string sElementName, [in] XStorage xDest, [in] string sNewName)
allows to move an entry from one storage to another.
::com::sun::star::io::XStream cloneEncryptedStreamElement([in] string sStreamName, [in] string sPassword)
allows to get readonly copy of a child encrypted stream with password.
void renameElement([in] string sElementName, [in] string sNewName)
renames an element in a storage.
void copyToStorage([in] XStorage xDest)
allows to copy current storage to another one
offers read and write access to the same stream.
Definition: XStream.idl:33
Definition: Ambiguous.idl:22