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