udkapi/com/sun/star/io/XActiveDataSink.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: XActiveDataSink.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_XActiveDataSink_idl__
  31 #define __com_sun_star_io_XActiveDataSink_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_XInputStream_idl__
  38 #include <com/sun/star/io/XInputStream.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::XActiveDataSink
  49 /** makes it possible to read the corresponding object from an input stream.
  50
  51     <p>If you want to allow control from outside, also implement the
  52     <type>XActiveDataControl</type> interface. </p>
  53  */
  54 published interface XActiveDataSink: com::sun::star::uno::XInterface
  55 {
  56     //-------------------------------------------------------------------------
  57
  58     // DocMerge from xml: method com::sun::star::io::XActiveDataSink::setInputStream
  59     /** plugs the input stream.
  60
  61         <p>If <type>XConnectable</type> is also implemented, this
  62         method should query <var>aStream</var> for an
  63         <type>XConnectable</type> and connect both.</p>
  64      */
  65     void setInputStream( [in] com::sun::star::io::XInputStream aStream );
  66
  67     //-------------------------------------------------------------------------
  68
  69     // DocMerge from idl: method com::sun::star::io::XActiveDataSink::getInputStream
  70     /** @returns
  71                 the plugged stream.
  72      */
  73     com::sun::star::io::XInputStream getInputStream();
  74
  75 };
  76
  77 //=============================================================================
  78
  79 }; }; }; };
  80
  81 /*=============================================================================
  82
  83 =============================================================================*/
  84 #endif