offapi/com/sun/star/embed/XExtendedStorageStream.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_XExtendedStorageStream_idl__
  20 #define __com_sun_star_embed_XExtendedStorageStream_idl__
  21
  22 #include <com/sun/star/io/XStream.idl>
  23 #include <com/sun/star/io/XSeekable.idl>
  24 #include <com/sun/star/embed/XEncryptionProtectedSource.idl>
  25 #include <com/sun/star/lang/XComponent.idl>
  26 #include <com/sun/star/beans/XPropertySet.idl>
  27 #include <com/sun/star/embed/XTransactedObject.idl>
  28 #include <com/sun/star/embed/XTransactionBroadcaster.idl>
  29
  30
  31  module com {  module sun {  module star {  module embed {
  32
  33 /** This interface allows access to an extended storage stream that might be
  34     transacted.
  35  */
  36 published interface XExtendedStorageStream
  37 {
  38     // INTERFACES
  39     /** Stream access.
  40      */
  41     interface ::com::sun::star::io::XStream;
  42
  43     /** allows to control object lifetime.
  44      */
  45     interface ::com::sun::star::lang::XComponent;
  46
  47     /** allows to seek to a specified position within the stream.
  48
  49         <p>
  50         This interface must be supported in case either seekable readonly
  51         or read-write access is requested.
  52         </p>
  53      */
  54     [optional] interface ::com::sun::star::io::XSeekable;
  55
  56     /** allows to set password to the stream.
  57
  58         <p>
  59         This interface must be supported by a stream with read-write access
  60         to allow to set a password that should be used next time the
  61         stream is stored if the encryption is supported.
  62         </p>
  63
  64         <p>
  65         If the password is set or changed by this interface and the
  66         stream is closed the new password should be used to get access to the
  67         stream next time.
  68         </p>
  69      */
  70     [optional] interface ::com::sun::star::embed::XEncryptionProtectedSource;
  71
  72     /** allows to get access to stream properties.
  73      */
  74     [optional] interface ::com::sun::star::beans::XPropertySet;
  75
  76     /** allows to have transacted access.
  77      */
  78     [optional] interface ::com::sun::star::embed::XTransactedObject;
  79
  80     /** allows to register a listener for transaction actions.
  81
  82         <p>
  83         If XTransactedObject interface is implemented this
  84         interface must be implemented as well.
  85         </p>
  86      */
  87     [optional] interface ::com::sun::star::embed::XTransactionBroadcaster;
  88
  89 };
  90
  91
  92 }; }; }; };
  93
  94 #endif
  95
  96 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */