udkapi/com/sun/star/io/XActiveDataControl.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: XActiveDataControl.idl,v $
  10  * $Revision: 1.13 $
  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_XActiveDataControl_idl__
  31 #define __com_sun_star_io_XActiveDataControl_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_XStreamListener_idl__
  38 #include <com/sun/star/io/XStreamListener.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::XActiveDataControl
  49 /** makes it possible to control an active data source.
  50
  51     <p>This interface should be supported by objects which implement
  52     <type>XActiveDataSource</type> or <type>XActiveDataSink</type>.</p>
  53  */
  54 published interface XActiveDataControl: com::sun::star::uno::XInterface
  55 {
  56     //-------------------------------------------------------------------------
  57
  58     // DocMerge from xml: method com::sun::star::io::XActiveDataControl::addListener
  59     /** registers an object to receive events from this data source.
  60        <p>It is suggested to allow multiple registration of the same listener,
  61         thus for each time a listener is added, it has to be removed.
  62      */
  63     void addListener( [in] com::sun::star::io::XStreamListener aListener );
  64
  65     //-------------------------------------------------------------------------
  66
  67     // DocMerge from xml: method com::sun::star::io::XActiveDataControl::removeListener
  68     /** unregisters an object to receive events from this data source.
  69
  70        <p>It is suggested to allow multiple registration of the same listener,
  71         thus for each time a listener is added, it has to be removed.
  72      */
  73     void removeListener( [in] com::sun::star::io::XStreamListener aListener );
  74
  75     //-------------------------------------------------------------------------
  76
  77     // DocMerge from xml: method com::sun::star::io::XActiveDataControl::start
  78     /** starts I/O.
  79
  80         <p>Either <member>XActiveDataControl::setInputStream()</member> or
  81         <member>XActiveDataControl::setOutputStream()</member> must be called beforehand.
  82         </p>
  83
  84         <p>This method does not block the thread, so reading is
  85         generally not finished when the method returns. </p>
  86      */
  87     void start();
  88
  89     //-------------------------------------------------------------------------
  90
  91     // DocMerge from xml: method com::sun::star::io::XActiveDataControl::terminate
  92     /** does a weak abort.
  93
  94         <p>It closes all connected resources and calls
  95         <member>XInputStream::close</member> or
  96         <member>XOutputStream::close</member> and fires the
  97         <member>XStreamListener::terminated</member>-event.</p>
  98      */
  99     void terminate();
 100
 101 };
 102
 103 //=============================================================================
 104
 105 }; }; }; };
 106
 107 /*=============================================================================
 108
 109 =============================================================================*/
 110 #endif