LibreOffice
LibreOffice 7.4 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 
22 #include <com/sun/star/uno/XInterface.idl>
23 #include <com/sun/star/io/XStream.idl>
24 #include <com/sun/star/io/XInputStream.idl>
25 #include <com/sun/star/io/IOException.idl>
26 #include <com/sun/star/lang/XComponent.idl>
27 #include <com/sun/star/lang/IllegalArgumentException.idl>
28 #include <com/sun/star/embed/StorageWrappedTargetException.idl>
29 #include <com/sun/star/embed/InvalidStorageException.idl>
30 #include <com/sun/star/packages/WrongPasswordException.idl>
31 #include <com/sun/star/container/XNameAccess.idl>
32 #include <com/sun/star/container/NoSuchElementException.idl>
33 #include <com/sun/star/container/ElementExistException.idl>
34 #include <com/sun/star/packages/NoEncryptionException.idl>
35 #include <com/sun/star/packages/NoRawFormatException.idl>
36 
37 
38 
39  module com { module sun { module star { module embed {
40 
43 published 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 )
94  raises( ::com::sun::star::embed::InvalidStorageException,
95  ::com::sun::star::lang::IllegalArgumentException,
96  ::com::sun::star::io::IOException,
97  ::com::sun::star::embed::StorageWrappedTargetException );
98 
129  ::com::sun::star::io::XStream openStreamElement(
130  [in] string sStreamName,
131  [in] long nOpenMode )
132  raises( ::com::sun::star::embed::InvalidStorageException,
133  ::com::sun::star::lang::IllegalArgumentException,
134  ::com::sun::star::packages::WrongPasswordException,
135  ::com::sun::star::io::IOException,
136  ::com::sun::star::embed::StorageWrappedTargetException );
137 
181  ::com::sun::star::io::XStream openEncryptedStreamElement(
182  [in] string sStreamName,
183  [in] long nOpenMode,
184  [in] string sPassword )
185  raises( ::com::sun::star::embed::InvalidStorageException,
186  ::com::sun::star::lang::IllegalArgumentException,
187  ::com::sun::star::packages::NoEncryptionException,
188  ::com::sun::star::packages::WrongPasswordException,
189  ::com::sun::star::io::IOException,
190  ::com::sun::star::embed::StorageWrappedTargetException );
191 
220  XStorage openStorageElement( [in] string sStorName,
221  [in] long nOpenMode )
222  raises( ::com::sun::star::embed::InvalidStorageException,
223  ::com::sun::star::lang::IllegalArgumentException,
224  ::com::sun::star::io::IOException,
225  ::com::sun::star::embed::StorageWrappedTargetException );
226 
253  ::com::sun::star::io::XStream cloneStreamElement( [in] string sStreamName )
254  raises( ::com::sun::star::embed::InvalidStorageException,
255  ::com::sun::star::lang::IllegalArgumentException,
256  ::com::sun::star::packages::WrongPasswordException,
257  ::com::sun::star::io::IOException,
258  ::com::sun::star::embed::StorageWrappedTargetException );
259 
304  ::com::sun::star::io::XStream cloneEncryptedStreamElement(
305  [in] string sStreamName,
306  [in] string sPassword )
307  raises( ::com::sun::star::embed::InvalidStorageException,
308  ::com::sun::star::lang::IllegalArgumentException,
309  ::com::sun::star::packages::NoEncryptionException,
310  ::com::sun::star::packages::WrongPasswordException,
311  ::com::sun::star::io::IOException,
312  ::com::sun::star::embed::StorageWrappedTargetException );
313 
337  void copyLastCommitTo( [in] XStorage xTargetStorage )
338  raises( ::com::sun::star::embed::InvalidStorageException,
339  ::com::sun::star::lang::IllegalArgumentException,
340  ::com::sun::star::io::IOException,
341  ::com::sun::star::embed::StorageWrappedTargetException );
342 
369  void copyStorageElementLastCommitTo(
370  [in] string sStorName,
371  [in] XStorage xTargetStorage )
372  raises( ::com::sun::star::embed::InvalidStorageException,
373  ::com::sun::star::lang::IllegalArgumentException,
374  ::com::sun::star::io::IOException,
375  ::com::sun::star::embed::StorageWrappedTargetException );
376 
401  boolean isStreamElement( [in] string sElementName )
402  raises( ::com::sun::star::container::NoSuchElementException,
403  ::com::sun::star::lang::IllegalArgumentException,
404  ::com::sun::star::embed::InvalidStorageException );
405 
406 
431  boolean isStorageElement( [in] string sElementName )
432  raises( ::com::sun::star::container::NoSuchElementException,
433  ::com::sun::star::lang::IllegalArgumentException,
434  ::com::sun::star::embed::InvalidStorageException );
435 
457  void removeElement( [in] string sElementName )
458  raises( ::com::sun::star::embed::InvalidStorageException,
459  ::com::sun::star::lang::IllegalArgumentException,
460  ::com::sun::star::container::NoSuchElementException,
461  ::com::sun::star::io::IOException,
462  ::com::sun::star::embed::StorageWrappedTargetException );
463 
491  void renameElement( [in] string sElementName, [in] string sNewName )
492  raises( ::com::sun::star::embed::InvalidStorageException,
493  ::com::sun::star::lang::IllegalArgumentException,
494  ::com::sun::star::container::NoSuchElementException,
495  ::com::sun::star::container::ElementExistException,
496  ::com::sun::star::io::IOException,
497  ::com::sun::star::embed::StorageWrappedTargetException );
498 
531  void copyElementTo(
532  [in] string sElementName,
533  [in] XStorage xDest,
534  [in] string sNewName )
535  raises( ::com::sun::star::embed::InvalidStorageException,
536  ::com::sun::star::lang::IllegalArgumentException,
537  ::com::sun::star::container::NoSuchElementException,
538  ::com::sun::star::container::ElementExistException,
539  ::com::sun::star::io::IOException,
540  ::com::sun::star::embed::StorageWrappedTargetException );
541 
574  void moveElementTo(
575  [in] string sElementName,
576  [in] XStorage xDest,
577  [in] string sNewName )
578  raises( ::com::sun::star::embed::InvalidStorageException,
579  ::com::sun::star::lang::IllegalArgumentException,
580  ::com::sun::star::container::NoSuchElementException,
581  ::com::sun::star::container::ElementExistException,
582  ::com::sun::star::io::IOException,
583  ::com::sun::star::embed::StorageWrappedTargetException );
584 
585 };
586 
587 
588 }; }; }; };
589 
590 #endif
591 
592 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::container::ElementExistException
is thrown by container methods, if an element is added which is already a child of the container.
Definition: ElementExistException.idl:39
com::sun::star::container::NoSuchElementException
is thrown by child access methods of collections, if the addressed child does not exist.
Definition: NoSuchElementException.idl:35
com::sun::star::embed::InvalidStorageException
This exception can be thrown in case a storage is invalid.
Definition: InvalidStorageException.idl:36
com::sun::star::embed::StorageWrappedTargetException
This exception can wrap an exception thrown during XStorage methods execution.
Definition: StorageWrappedTargetException.idl:33
com::sun::star::io::IOException
is thrown when an input or output error has occurred.
Definition: IOException.idl:31
com::sun::star::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:31
com::sun::star::packages::NoEncryptionException
This exception can be thrown in case object is not encrypted one as expected.
Definition: NoEncryptionException.idl:31
com::sun::star::packages::WrongPasswordException
This exception can be thrown in case wrong password was provided.
Definition: WrongPasswordException.idl:31
com::sun::star::embed::XStorage
This interface represents main storage functionality.
Definition: XStorage.idl:44
com::sun::star::embed::XStorage::openStorageElement
XStorage openStorageElement([in] string sStorName, [in] long nOpenMode)
allows to get access to a child storage.
com::sun::star::embed::XStorage::openEncryptedStreamElement
::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.
com::sun::star::embed::XStorage::copyElementTo
void copyElementTo([in] string sElementName, [in] XStorage xDest, [in] string sNewName)
allows to copy an entry from one storage to another.
com::sun::star::embed::XStorage::cloneStreamElement
::com::sun::star::io::XStream cloneStreamElement([in] string sStreamName)
allows to get readonly copy of a child stream of the storage.
com::sun::star::embed::XStorage::isStorageElement
boolean isStorageElement([in] string sElementName)
allows to check if an element is a child storage with specified name.
com::sun::star::embed::XStorage::openStreamElement
::com::sun::star::io::XStream openStreamElement([in] string sStreamName, [in] long nOpenMode)
allows to get access to a child stream of the storage.
com::sun::star::embed::XStorage::copyLastCommitTo
void copyLastCommitTo([in] XStorage xTargetStorage)
allows to get copy of this storage at the state of its last commit.
com::sun::star::embed::XStorage::removeElement
void removeElement([in] string sElementName)
removes an element from a storage.
com::sun::star::embed::XStorage::isStreamElement
boolean isStreamElement([in] string sElementName)
allows to check if an element is a child stream with specified name.
com::sun::star::embed::XStorage::copyStorageElementLastCommitTo
void copyStorageElementLastCommitTo([in] string sStorName, [in] XStorage xTargetStorage)
allows to get copy of a child storage at the state of its last commit.
com::sun::star::embed::XStorage::moveElementTo
void moveElementTo([in] string sElementName, [in] XStorage xDest, [in] string sNewName)
allows to move an entry from one storage to another.
com::sun::star::embed::XStorage::cloneEncryptedStreamElement
::com::sun::star::io::XStream cloneEncryptedStreamElement([in] string sStreamName, [in] string sPassword)
allows to get readonly copy of a child encrypted stream with password.
com::sun::star::embed::XStorage::renameElement
void renameElement([in] string sElementName, [in] string sNewName)
renames an element in a storage.
com::sun::star::embed::XStorage::copyToStorage
void copyToStorage([in] XStorage xDest)
allows to copy current storage to another one
com::sun::star::io::XStream
offers read and write access to the same stream.
Definition: XStream.idl:33
com
Definition: Ambiguous.idl:22
Generated by doxygen 1.9.1