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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_embed_XExtendedStorageStream_idl__
  28 #define __com_sun_star_embed_XExtendedStorageStream_idl__
  29
  30 #ifndef __com_sun_star_io_XStream_idl__
  31 #include <com/sun/star/io/XStream.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_io_XSeekable_idl__
  35 #include <com/sun/star/io/XSeekable.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_embed_XEncryptionProtectedSource_idl__
  39 #include <com/sun/star/embed/XEncryptionProtectedSource.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_lang_XComponent_idl__
  43 #include <com/sun/star/lang/XComponent.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_beans_XPropertySet_idl__
  47 #include <com/sun/star/beans/XPropertySet.idl>
  48 #endif
  49
  50 #ifndef __com_sun_star_embed_XTransactedObject_idl__
  51 #include <com/sun/star/embed/XTransactedObject.idl>
  52 #endif
  53
  54 #ifndef __com_sun_star_embed_XTransactionBroadcaster_idl__
  55 #include <com/sun/star/embed/XTransactionBroadcaster.idl>
  56 #endif
  57
  58 //============================================================================
  59
  60  module com {  module sun {  module star {  module embed {
  61
  62 //============================================================================
  63 /** This interface allows access to an extended storage stream that might be
  64     transacted.
  65  */
  66 published interface XExtendedStorageStream
  67 {
  68     // INTERFACES
  69     //
  70     // -----------------------------------------------------------------------
  71     /** Stream access.
  72      */
  73     interface ::com::sun::star::io::XStream;
  74
  75     // -----------------------------------------------------------------------
  76     /** allows to control object lifetime.
  77      */
  78     interface ::com::sun::star::lang::XComponent;
  79
  80     // -----------------------------------------------------------------------
  81     /** allows to seek to a specified position within the stream.
  82
  83         <p>
  84         This interface must be supported in case either seekable readonly
  85         or read-write access is requested.
  86         </p>
  87      */
  88     [optional] interface ::com::sun::star::io::XSeekable;
  89
  90     // -----------------------------------------------------------------------
  91     /** allows to set password to the stream.
  92
  93         <p>
  94         This interface must be supported by a stream with readwrite access
  95         to allow to set a password that should be used next time the
  96         stream is stored if the encryption is supported.
  97         </p>
  98
  99         <p>
 100         If the password is set or changed by this interface and the
 101         stream is closed the new password should be used to get access to the
 102         stream next time.
 103         </p>
 104      */
 105     [optional] interface ::com::sun::star::embed::XEncryptionProtectedSource;
 106
 107     // -----------------------------------------------------------------------
 108     /** allows to get access to stream properties.
 109      */
 110     [optional] interface ::com::sun::star::beans::XPropertySet;
 111
 112     // -----------------------------------------------------------------------
 113     /** allows to have transacted access.
 114      */
 115     [optional] interface ::com::sun::star::embed::XTransactedObject;
 116
 117     // -----------------------------------------------------------------------
 118     /** allows to register a listener for transaction actions.
 119
 120         <p>
 121         If <type>XTransactedObject</type> interface is implemented this
 122         interface must be implemented as well.
 123         </p>
 124      */
 125     [optional] interface ::com::sun::star::embed::XTransactionBroadcaster;
 126
 127 };
 128
 129 //============================================================================
 130
 131 }; }; }; };
 132
 133 #endif
 134