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

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