xref: /AOO41X/main/udkapi/com/sun/star/io/XStreamListener.idl (revision 408a4873fc8bcc602c90ea4598886bb71abf0675)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_io_XStreamListener_idl__
24#define __com_sun_star_io_XStreamListener_idl__
25
26#ifndef __com_sun_star_lang_XEventListener_idl__
27#include <com/sun/star/lang/XEventListener.idl>
28#endif
29
30
31//=============================================================================
32
33module com {  module sun {  module star {  module io {
34
35//=============================================================================
36
37// DocMerge from xml: interface com::sun::star::io::XStreamListener
38/** makes it possible to receive events from an active data control.
39 */
40published interface XStreamListener: com::sun::star::lang::XEventListener
41{
42    //-------------------------------------------------------------------------
43
44    // DocMerge from xml: method com::sun::star::io::XStreamListener::started
45    /** gets called as soon as data transfer has started.
46     */
47    void started();
48
49    //-------------------------------------------------------------------------
50
51    // DocMerge from xml: method com::sun::star::io::XStreamListener::closed
52    /** gets called when data transfer terminates normally or when data
53        transfer is terminated from outside.
54
55        <p>The termination could be done using the method
56        <member>XActiveDataControl::terminate()</member>.</p>
57     */
58    void closed();
59
60    //-------------------------------------------------------------------------
61
62    // DocMerge from xml: method com::sun::star::io::XStreamListener::terminated
63    /** gets called when <member>XActiveDataControl::terminate()</member> is called.
64     */
65    void terminated();
66
67    //-------------------------------------------------------------------------
68
69    // DocMerge from xml: method com::sun::star::io::XStreamListener::error
70    /** gets called when an internal error in source or sink has occurred.
71
72        <p>After the method is called, the close is called on the
73        connected streams.</p>
74     */
75    void error( [in] any aException );
76
77};
78
79//=============================================================================
80
81}; }; }; };
82
83/*=============================================================================
84
85=============================================================================*/
86#endif
87