LibreOffice
LibreOffice 6.4 SDK API Reference
XOptimizedStorage.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_XOptimizedStorage_idl__
20 #define __com_sun_star_embed_XOptimizedStorage_idl__
21 
37 
38 
39  module com { module sun { module star { module embed {
40 
46 published interface XOptimizedStorage
47 {
52  [in] string sStreamName,
53  [in] ::com::sun::star::io::XInputStream xInStream )
60 
65  [in] string sStreamName,
66  [in] ::com::sun::star::io::XInputStream xInStream,
67  [in] sequence < ::com::sun::star::beans::PropertyValue > aProperties )
73 
77  [in] string sSourceName,
78  [in] ::com::sun::star::embed::XOptimizedStorage xTargetStorage,
79  [in] string sTargetName )
86 
93  [in] ::com::sun::star::io::XStream xStream )
98 
105  void attachToURL( [in] string sURL,
106  [in] boolean bReadOnly )
111 
116  any getElementPropertyValue( [in] string sElementName,
117  [in] string sPropertyName )
125 
150  void copyStreamElementData( [in] string sStreamName,
151  [in] ::com::sun::star::io::XStream xTargetStream )
157 
158 };
159 
160 
161 }; }; }; };
162 
163 #endif
164 
165 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
XInterface.idl
PropertyVetoException.idl
com::sun::star::embed::XOptimizedStorage::writeAndAttachToStream
void writeAndAttachToStream([in] ::com::sun::star::io::XStream xStream)
allows to switch storage persistence to the provided stream.
com::sun::star::embed::XOptimizedStorage
This is a temporary interface that is introduced to temporarily optimize the document storing process...
Definition: XOptimizedStorage.idl:47
com::sun::star::embed::StorageWrappedTargetException
This exception can wrap an exception thrown during XStorage methods execution.
Definition: StorageWrappedTargetException.idl:33
com::sun::star::embed::XOptimizedStorage::attachToURL
void attachToURL([in] string sURL, [in] boolean bReadOnly)
allows to switch storage persistence to the provided URL.
com::sun::star::beans::UnknownPropertyException
This exception is thrown to indicate that the property name is unknown to the implementation.
Definition: UnknownPropertyException.idl:35
com::sun::star::embed::XOptimizedStorage::copyElementDirectlyTo
void copyElementDirectlyTo([in] string sSourceName, [in] ::com::sun::star::embed::XOptimizedStorage xTargetStorage, [in] string sTargetName)
allows to copy storage element directly, not guaranteed to work.
com::sun::star::packages::NoRawFormatException
This exception can be thrown in case provided stream is not a raw stream representing encrypted packa...
Definition: NoRawFormatException.idl:32
ElementExistException.idl
com::sun::star::container::NoSuchElementException
is thrown by child access methods of collections, if the addressed child does not exist.
Definition: NoSuchElementException.idl:35
WrongPasswordException.idl
com::sun::star::packages::WrongPasswordException
This exception can be thrown in case wrong password was provided.
Definition: WrongPasswordException.idl:31
com::sun::star::embed::XOptimizedStorage::insertStreamElementDirect
void insertStreamElementDirect([in] string sStreamName, [in] ::com::sun::star::io::XInputStream xInStream, [in] sequence< ::com::sun::star::beans::PropertyValue > aProperties)
allows to insert a stream to the storage directly.
com::sun::star::embed::XOptimizedStorage::getElementPropertyValue
any getElementPropertyValue([in] string sElementName, [in] string sPropertyName)
allows to get property of the child element with the specified name.
com::sun::star::io::IOException
is thrown when an input or output error has occurred.
Definition: IOException.idl:31
PropertyValue.idl
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::io::XStream
offers read and write access to the same stream.
Definition: XStream.idl:33
NoRawFormatException.idl
IOException.idl
com::sun::star::io::XInputStream
This is the basic interface to read data from a stream.
Definition: XInputStream.idl:38
com::sun::star::embed::XOptimizedStorage::insertRawNonEncrStreamElementDirect
void insertRawNonEncrStreamElementDirect([in] string sStreamName, [in] ::com::sun::star::io::XInputStream xInStream)
allows to insert a raw stream representing non-encrypted stream with header.
InvalidStorageException.idl
com::sun::star::beans::PropertyVetoException
This exception is thrown when a proposed change to a property represents an unacceptable value.
Definition: PropertyVetoException.idl:35
XStream.idl
com::sun::star::embed::XOptimizedStorage::copyStreamElementData
void copyStreamElementData([in] string sStreamName, [in] ::com::sun::star::io::XStream xTargetStream)
fills the provided stream with the last flushed version of data from the child stream of the storage.
com
Definition: Ambiguous.idl:22
NoSuchElementException.idl
EncryptionNotAllowedException.idl
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
StorageWrappedTargetException.idl
IllegalArgumentException.idl
XInputStream.idl
UnknownPropertyException.idl
com::sun::star::embed::InvalidStorageException
This exception can be thrown in case a storage is invalid.
Definition: InvalidStorageException.idl:36