1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_io_XActiveDataControl_idl__
28#define __com_sun_star_io_XActiveDataControl_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34#ifndef __com_sun_star_io_XStreamListener_idl__
35#include <com/sun/star/io/XStreamListener.idl>
36#endif
37
38
39//=============================================================================
40
41module com {  module sun {  module star {  module io {
42
43//=============================================================================
44
45// DocMerge from xml: interface com::sun::star::io::XActiveDataControl
46/** makes it possible to control an active data source.
47
48	<p>This interface should be supported by objects which implement
49	<type>XActiveDataSource</type> or <type>XActiveDataSink</type>.</p>
50 */
51published interface XActiveDataControl: com::sun::star::uno::XInterface
52{
53	//-------------------------------------------------------------------------
54
55	// DocMerge from xml: method com::sun::star::io::XActiveDataControl::addListener
56	/** registers an object to receive events from this data source.
57       <p>It is suggested to allow multiple registration of the same listener,
58	    thus for each time a listener is added, it has to be removed.
59	 */
60	void addListener( [in] com::sun::star::io::XStreamListener aListener );
61
62	//-------------------------------------------------------------------------
63
64	// DocMerge from xml: method com::sun::star::io::XActiveDataControl::removeListener
65	/** unregisters an object to receive events from this data source.
66
67       <p>It is suggested to allow multiple registration of the same listener,
68	    thus for each time a listener is added, it has to be removed.
69	 */
70	void removeListener( [in] com::sun::star::io::XStreamListener aListener );
71
72	//-------------------------------------------------------------------------
73
74	// DocMerge from xml: method com::sun::star::io::XActiveDataControl::start
75	/** starts I/O.
76
77		<p>Either <member>XActiveDataControl::setInputStream()</member> or
78		<member>XActiveDataControl::setOutputStream()</member> must be called beforehand.
79		</p>
80
81		<p>This method does not block the thread, so reading is
82		generally not finished when the method returns. </p>
83	 */
84	void start();
85
86	//-------------------------------------------------------------------------
87
88	// DocMerge from xml: method com::sun::star::io::XActiveDataControl::terminate
89	/** does a weak abort.
90
91		<p>It closes all connected resources and calls
92		<member>XInputStream::close</member> or
93		<member>XOutputStream::close</member> and fires the
94		<member>XStreamListener::terminated</member>-event.</p>
95	 */
96	void terminate();
97
98};
99
100//=============================================================================
101
102}; }; }; };
103
104/*=============================================================================
105
106=============================================================================*/
107#endif
108