LibreOffice
LibreOffice 24.2 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 
20 
21  module com { module sun { module star { module embed {
22 
28 published interface XOptimizedStorage
29 {
34  [in] string sStreamName,
35  [in] ::com::sun::star::io::XInputStream xInStream )
42 
47  [in] string sStreamName,
48  [in] ::com::sun::star::io::XInputStream xInStream,
49  [in] sequence < ::com::sun::star::beans::PropertyValue > aProperties )
55 
59  [in] string sSourceName,
60  [in] ::com::sun::star::embed::XOptimizedStorage xTargetStorage,
61  [in] string sTargetName )
68 
75  [in] ::com::sun::star::io::XStream xStream )
80 
87  void attachToURL( [in] string sURL,
88  [in] boolean bReadOnly )
93 
98  any getElementPropertyValue( [in] string sElementName,
99  [in] string sPropertyName )
107 
132  void copyStreamElementData( [in] string sStreamName,
133  [in] ::com::sun::star::io::XStream xTargetStream )
139 
140 };
141 
142 
143 }; }; }; };
144 
145 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
This exception is thrown when a proposed change to a property represents an unacceptable value.
Definition: PropertyVetoException.idl:31
This exception is thrown to indicate that the property name is unknown to the implementation.
Definition: UnknownPropertyException.idl:31
is thrown by container methods, if an element is added which is already a child of the container.
Definition: ElementExistException.idl:35
is thrown by child access methods of collections, if the addressed child does not exist.
Definition: NoSuchElementException.idl:31
This exception can be thrown in case a storage is invalid.
Definition: InvalidStorageException.idl:32
This exception can wrap an exception thrown during XStorage methods execution.
Definition: StorageWrappedTargetException.idl:29
is thrown when an input or output error has occurred.
Definition: IOException.idl:27
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:27
This exception can be thrown in case provided stream is not a raw stream representing encrypted packa...
Definition: NoRawFormatException.idl:28
This exception can be thrown in case wrong password was provided.
Definition: WrongPasswordException.idl:27
This is a temporary interface that is introduced to temporarily optimize the document storing process...
Definition: XOptimizedStorage.idl:29
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.
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.
void attachToURL([in] string sURL, [in] boolean bReadOnly)
allows to switch storage persistence to the provided URL.
any getElementPropertyValue([in] string sElementName, [in] string sPropertyName)
allows to get property of the child element with the specified name.
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.
void writeAndAttachToStream([in] ::com::sun::star::io::XStream xStream)
allows to switch storage persistence to the provided stream.
void insertRawNonEncrStreamElementDirect([in] string sStreamName, [in] ::com::sun::star::io::XInputStream xInStream)
allows to insert a raw stream representing non-encrypted stream with header.
This is the basic interface to read data from a stream.
Definition: XInputStream.idl:30
offers read and write access to the same stream.
Definition: XStream.idl:27
Definition: Ambiguous.idl:20