offapi/com/sun/star/embed/OLESimpleStorage.idl

   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_OLESimpleStorage_idl__
  20 #define __com_sun_star_embed_OLESimpleStorage_idl__
  21
  22 #include <com/sun/star/embed/XOLESimpleStorage.idl>
  23 #include <com/sun/star/io/XInputStream.idl>
  24 #include <com/sun/star/io/XStream.idl>
  25
  26 module com { module sun { module star { module embed {
  27 /** This service provides a simple functionality to allow
  28     read/write the storages in OLE storage format.
  29 */
  30 published service OLESimpleStorage: XOLESimpleStorage
  31 {
  32     // CONSTRUCTORS ----------------------------------------------------------
  33     /** is used to initialize the object on it's creation.
  34
  35         @param xInputStream
  36                 [in] the InputStream that contains data in OLE storage format.
  37
  38         @param bNoTempCopy
  39                 [in] specifies whether a temporary copy should be created during
  40                 substreams opening. If the copy is not created the storage must
  41                 stay alive while the opened substreams are used.
  42
  43      */
  44     createFromInputStream ([in] ::com::sun::star::io::XInputStream xInputStream, [in] boolean bNoTempCopy);
  45
  46     /** is used to initialize the object on it's creation.
  47
  48         @param xStream
  49                 [in] the Stream that contains data in OLE storage format.
  50
  51         @param bNoTempCopy
  52                 [in] specifies whether a temporary copy should be created during
  53                 substreams opening. If the copy is not created the storage must
  54                 stay alive while the opened substreams are used.
  55
  56      */
  57     createFromStream ([in] ::com::sun::star::io::XStream xStream, [in] boolean bNoTempCopy);
  58 };
  59
  60
  61 }; }; }; };
  62
  63 #endif
  64
  65 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */