xref: /aoo41x/main/udkapi/com/sun/star/io/XConnectable.idl (revision cdf0e10c)
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_XConnectable_idl__
28#define __com_sun_star_io_XConnectable_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34
35//=============================================================================
36
37 module com {  module sun {  module star {  module io {
38
39//=============================================================================
40
41// DocMerge from xml: interface com::sun::star::io::XConnectable
42/** makes it possible to connect data sinks and sources.
43
44	<p>The predecessor-member is the element in the connection that is
45	nearer to the source of the data. The successor-member is the element
46	that is further away from the source of the data. (Note that this
47	classification does not depend on whether the class implements
48	<type>XInputStream</type> or <type>XOutputStream</type>; it only
49	depends on the direction of data flow.) </p>
50	<p>This interface allows generic services to navigate between
51	arbitrary elements of a connection.</p>
52 */
53published interface XConnectable: com::sun::star::uno::XInterface
54{
55	//-------------------------------------------------------------------------
56
57	// DocMerge from xml: method com::sun::star::io::XConnectable::setPredecessor
58	/** sets the source of the data flow for this object.
59	 */
60	void setPredecessor( [in] com::sun::star::io::XConnectable aPredecessor );
61
62	//-------------------------------------------------------------------------
63
64	// DocMerge from idl: method com::sun::star::io::XConnectable::getPredecessor
65	/** @returns
66			the predecessor of this object.
67	 */
68	com::sun::star::io::XConnectable getPredecessor();
69
70	//-------------------------------------------------------------------------
71
72	// DocMerge from xml: method com::sun::star::io::XConnectable::setSuccessor
73	/** sets the sink of the data flow for this object.
74	 */
75	void setSuccessor( [in] com::sun::star::io::XConnectable aSuccessor );
76
77	//-------------------------------------------------------------------------
78
79	// DocMerge from idl: method com::sun::star::io::XConnectable::getSuccessor
80	/** @returns
81			the successor of this object.
82	 */
83	com::sun::star::io::XConnectable getSuccessor();
84
85};
86
87//=============================================================================
88
89}; }; }; };
90
91/*=============================================================================
92
93=============================================================================*/
94#endif
95