LibreOffice LibreOffice 25.8 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
20
21
22 module com { module sun { module star { module embed {
23
26published interface XStorage
27{
28 // INTERFACES
40 interface ::com::sun::star::container::XNameAccess;
41
49 interface ::com::sun::star::lang::XComponent;
50
51
52 // METHODS
76 void copyToStorage( [in] XStorage xDest )
77 raises( ::com::sun::star::embed::InvalidStorageException,
78 ::com::sun::star::lang::IllegalArgumentException,
79 ::com::sun::star::io::IOException,
80 ::com::sun::star::embed::StorageWrappedTargetException );
81
112 ::com::sun::star::io::XStream openStreamElement(
113 [in] string sStreamName,
114 [in] long nOpenMode )
115 raises( ::com::sun::star::embed::InvalidStorageException,
116 ::com::sun::star::lang::IllegalArgumentException,
117 ::com::sun::star::packages::WrongPasswordException,
118 ::com::sun::star::io::IOException,
119 ::com::sun::star::embed::StorageWrappedTargetException );
120
164 ::com::sun::star::io::XStream openEncryptedStreamElement(
165 [in] string sStreamName,
166 [in] long nOpenMode,
167 [in] string sPassword )
168 raises( ::com::sun::star::embed::InvalidStorageException,
169 ::com::sun::star::lang::IllegalArgumentException,
170 ::com::sun::star::packages::NoEncryptionException,
171 ::com::sun::star::packages::WrongPasswordException,
172 ::com::sun::star::io::IOException,
173 ::com::sun::star::embed::StorageWrappedTargetException );
174
203 XStorage openStorageElement( [in] string sStorName,
204 [in] long nOpenMode )
205 raises( ::com::sun::star::embed::InvalidStorageException,
206 ::com::sun::star::lang::IllegalArgumentException,
207 ::com::sun::star::io::IOException,
208 ::com::sun::star::embed::StorageWrappedTargetException );
209
236 ::com::sun::star::io::XStream cloneStreamElement( [in] string sStreamName )
237 raises( ::com::sun::star::embed::InvalidStorageException,
238 ::com::sun::star::lang::IllegalArgumentException,
239 ::com::sun::star::packages::WrongPasswordException,
240 ::com::sun::star::io::IOException,
241 ::com::sun::star::embed::StorageWrappedTargetException );
242
287 ::com::sun::star::io::XStream cloneEncryptedStreamElement(
288 [in] string sStreamName,
289 [in] string sPassword )
290 raises( ::com::sun::star::embed::InvalidStorageException,
291 ::com::sun::star::lang::IllegalArgumentException,
292 ::com::sun::star::packages::NoEncryptionException,
293 ::com::sun::star::packages::WrongPasswordException,
294 ::com::sun::star::io::IOException,
295 ::com::sun::star::embed::StorageWrappedTargetException );
296
320 void copyLastCommitTo( [in] XStorage xTargetStorage )
321 raises( ::com::sun::star::embed::InvalidStorageException,
322 ::com::sun::star::lang::IllegalArgumentException,
323 ::com::sun::star::io::IOException,
324 ::com::sun::star::embed::StorageWrappedTargetException );
325
352 void copyStorageElementLastCommitTo(
353 [in] string sStorName,
354 [in] XStorage xTargetStorage )
355 raises( ::com::sun::star::embed::InvalidStorageException,
356 ::com::sun::star::lang::IllegalArgumentException,
357 ::com::sun::star::io::IOException,
358 ::com::sun::star::embed::StorageWrappedTargetException );
359
384 boolean isStreamElement( [in] string sElementName )
385 raises( ::com::sun::star::container::NoSuchElementException,
386 ::com::sun::star::lang::IllegalArgumentException,
387 ::com::sun::star::embed::InvalidStorageException );
388
389
414 boolean isStorageElement( [in] string sElementName )
415 raises( ::com::sun::star::container::NoSuchElementException,
416 ::com::sun::star::lang::IllegalArgumentException,
417 ::com::sun::star::embed::InvalidStorageException );
418
440 void removeElement( [in] string sElementName )
441 raises( ::com::sun::star::embed::InvalidStorageException,
442 ::com::sun::star::lang::IllegalArgumentException,
443 ::com::sun::star::container::NoSuchElementException,
444 ::com::sun::star::io::IOException,
445 ::com::sun::star::embed::StorageWrappedTargetException );
446
474 void renameElement( [in] string sElementName, [in] string sNewName )
475 raises( ::com::sun::star::embed::InvalidStorageException,
476 ::com::sun::star::lang::IllegalArgumentException,
477 ::com::sun::star::container::NoSuchElementException,
478 ::com::sun::star::container::ElementExistException,
479 ::com::sun::star::io::IOException,
480 ::com::sun::star::embed::StorageWrappedTargetException );
481
514 void copyElementTo(
515 [in] string sElementName,
516 [in] XStorage xDest,
517 [in] string sNewName )
518 raises( ::com::sun::star::embed::InvalidStorageException,
519 ::com::sun::star::lang::IllegalArgumentException,
520 ::com::sun::star::container::NoSuchElementException,
521 ::com::sun::star::container::ElementExistException,
522 ::com::sun::star::io::IOException,
523 ::com::sun::star::embed::StorageWrappedTargetException );
524
557 void moveElementTo(
558 [in] string sElementName,
559 [in] XStorage xDest,
560 [in] string sNewName )
561 raises( ::com::sun::star::embed::InvalidStorageException,
562 ::com::sun::star::lang::IllegalArgumentException,
563 ::com::sun::star::container::NoSuchElementException,
564 ::com::sun::star::container::ElementExistException,
565 ::com::sun::star::io::IOException,
566 ::com::sun::star::embed::StorageWrappedTargetException );
567
568};
569
570
571}; }; }; };
572
573/* 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:35
com::sun::star::container::NoSuchElementException
is thrown by child access methods of collections, if the addressed child does not exist.
Definition: NoSuchElementException.idl:31
com::sun::star::embed::InvalidStorageException
This exception can be thrown in case a storage is invalid.
Definition: InvalidStorageException.idl:32
com::sun::star::embed::StorageWrappedTargetException
This exception can wrap an exception thrown during XStorage methods execution.
Definition: StorageWrappedTargetException.idl:29
com::sun::star::io::IOException
is thrown when an input or output error has occurred.
Definition: IOException.idl:27
com::sun::star::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:27
com::sun::star::packages::NoEncryptionException
This exception can be thrown in case object is not encrypted one as expected.
Definition: NoEncryptionException.idl:27
com::sun::star::packages::WrongPasswordException
This exception can be thrown in case wrong password was provided.
Definition: WrongPasswordException.idl:27
com::sun::star::embed::XStorage
This interface represents main storage functionality.
Definition: XStorage.idl:27
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:27
com
Definition: Ambiguous.idl:20