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