udkapi/com/sun/star/io/XActiveDataStreamer.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: XActiveDataStreamer.idl,v $
  10  * $Revision: 1.12 $
  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_io_XActiveDataStreamer_idl__
  31 #define __com_sun_star_io_XActiveDataStreamer_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_io_XStream_idl__
  38 #include <com/sun/star/io/XStream.idl>
  39 #endif
  40
  41
  42 //=============================================================================
  43
  44 module com {  module sun {  module star {  module io {
  45
  46 //=============================================================================
  47
  48 // DocMerge from xml: interface com::sun::star::io::XActiveDataStreamer
  49 /** makes it possible to read and write the corresponding stream.
  50
  51
  52     <p>If you want to allow control from outside, also implement the
  53     <type>XActiveDataControl</type> interface. </p>
  54  */
  55 published interface XActiveDataStreamer: com::sun::star::uno::XInterface
  56 {
  57     //-------------------------------------------------------------------------
  58
  59     // DocMerge from xml: method com::sun::star::io::XActiveDataStreamer::setStream
  60     /** plugs the input/output stream.
  61
  62         <p>If <type>XConnectable</type> is also implemented, this
  63         method should query <var>aStream</var> for a
  64         <type>XConnectable</type> and connect both.</p>
  65      */
  66     void setStream( [in] com::sun::star::io::XStream aStream );
  67
  68     //-------------------------------------------------------------------------
  69
  70     // DocMerge from idl: method com::sun::star::io::XActiveDataStreamer::getStream
  71     /** @returns
  72                 the plugged stream.
  73      */
  74     com::sun::star::io::XStream getStream();
  75
  76 };
  77
  78 //=============================================================================
  79
  80 }; }; }; };
  81
  82 /*=============================================================================
  83
  84 =============================================================================*/
  85 #endif