udkapi/com/sun/star/io/XActiveDataControl.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_io_XActiveDataControl_idl__
  20 #define __com_sun_star_io_XActiveDataControl_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/io/XStreamListener.idl>
  25
  26
  27
  28 module com {  module sun {  module star {  module io {
  29
  30 /** makes it possible to control an active data source.
  31
  32     <p>This interface should be supported by objects which implement
  33     XActiveDataSource or XActiveDataSink.</p>
  34  */
  35 published interface XActiveDataControl: com::sun::star::uno::XInterface
  36 {
  37     /** registers an object to receive events from this data source.
  38        <p>It is suggested to allow multiple registration of the same listener,
  39         thus for each time a listener is added, it has to be removed.
  40      */
  41     void addListener( [in] com::sun::star::io::XStreamListener aListener );
  42
  43     /** unregisters an object to receive events from this data source.
  44
  45        <p>It is suggested to allow multiple registration of the same listener,
  46         thus for each time a listener is added, it has to be removed.
  47      */
  48     void removeListener( [in] com::sun::star::io::XStreamListener aListener );
  49
  50     /** starts I/O.
  51
  52         <p>Either XActiveDataControl::setInputStream() or
  53         XActiveDataControl::setOutputStream() must be called beforehand.
  54         </p>
  55
  56         <p>This method does not block the thread, so reading is
  57         generally not finished when the method returns. </p>
  58      */
  59     void start();
  60
  61     /** does a weak abort.
  62
  63         <p>It closes all connected resources and calls
  64         XInputStream::close() or
  65         XOutputStream::close() and fires the
  66         XStreamListener::terminated()-event.</p>
  67      */
  68     void terminate();
  69
  70 };
  71
  72
  73 }; }; }; };
  74
  75 #endif
  76
  77 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */