xref: /aoo41x/main/udkapi/com/sun/star/io/XConnectable.idl (revision 408a4873)
1*408a4873SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3*408a4873SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*408a4873SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5*408a4873SAndrew Rist * distributed with this work for additional information
6*408a4873SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7*408a4873SAndrew Rist * to you under the Apache License, Version 2.0 (the
8*408a4873SAndrew Rist * "License"); you may not use this file except in compliance
9*408a4873SAndrew Rist * with the License.  You may obtain a copy of the License at
10*408a4873SAndrew Rist *
11*408a4873SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12*408a4873SAndrew Rist *
13*408a4873SAndrew Rist * Unless required by applicable law or agreed to in writing,
14*408a4873SAndrew Rist * software distributed under the License is distributed on an
15*408a4873SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*408a4873SAndrew Rist * KIND, either express or implied.  See the License for the
17*408a4873SAndrew Rist * specific language governing permissions and limitations
18*408a4873SAndrew Rist * under the License.
19*408a4873SAndrew Rist *
20*408a4873SAndrew Rist *************************************************************/
21*408a4873SAndrew Rist
22*408a4873SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_io_XConnectable_idl__
24cdf0e10cSrcweir#define __com_sun_star_io_XConnectable_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__
27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl>
28cdf0e10cSrcweir#endif
29cdf0e10cSrcweir
30cdf0e10cSrcweir
31cdf0e10cSrcweir//=============================================================================
32cdf0e10cSrcweir
33cdf0e10cSrcweir module com {  module sun {  module star {  module io {
34cdf0e10cSrcweir
35cdf0e10cSrcweir//=============================================================================
36cdf0e10cSrcweir
37cdf0e10cSrcweir// DocMerge from xml: interface com::sun::star::io::XConnectable
38cdf0e10cSrcweir/** makes it possible to connect data sinks and sources.
39cdf0e10cSrcweir
40cdf0e10cSrcweir	<p>The predecessor-member is the element in the connection that is
41cdf0e10cSrcweir	nearer to the source of the data. The successor-member is the element
42cdf0e10cSrcweir	that is further away from the source of the data. (Note that this
43cdf0e10cSrcweir	classification does not depend on whether the class implements
44cdf0e10cSrcweir	<type>XInputStream</type> or <type>XOutputStream</type>; it only
45cdf0e10cSrcweir	depends on the direction of data flow.) </p>
46cdf0e10cSrcweir	<p>This interface allows generic services to navigate between
47cdf0e10cSrcweir	arbitrary elements of a connection.</p>
48cdf0e10cSrcweir */
49cdf0e10cSrcweirpublished interface XConnectable: com::sun::star::uno::XInterface
50cdf0e10cSrcweir{
51cdf0e10cSrcweir	//-------------------------------------------------------------------------
52cdf0e10cSrcweir
53cdf0e10cSrcweir	// DocMerge from xml: method com::sun::star::io::XConnectable::setPredecessor
54cdf0e10cSrcweir	/** sets the source of the data flow for this object.
55cdf0e10cSrcweir	 */
56cdf0e10cSrcweir	void setPredecessor( [in] com::sun::star::io::XConnectable aPredecessor );
57cdf0e10cSrcweir
58cdf0e10cSrcweir	//-------------------------------------------------------------------------
59cdf0e10cSrcweir
60cdf0e10cSrcweir	// DocMerge from idl: method com::sun::star::io::XConnectable::getPredecessor
61cdf0e10cSrcweir	/** @returns
62cdf0e10cSrcweir			the predecessor of this object.
63cdf0e10cSrcweir	 */
64cdf0e10cSrcweir	com::sun::star::io::XConnectable getPredecessor();
65cdf0e10cSrcweir
66cdf0e10cSrcweir	//-------------------------------------------------------------------------
67cdf0e10cSrcweir
68cdf0e10cSrcweir	// DocMerge from xml: method com::sun::star::io::XConnectable::setSuccessor
69cdf0e10cSrcweir	/** sets the sink of the data flow for this object.
70cdf0e10cSrcweir	 */
71cdf0e10cSrcweir	void setSuccessor( [in] com::sun::star::io::XConnectable aSuccessor );
72cdf0e10cSrcweir
73cdf0e10cSrcweir	//-------------------------------------------------------------------------
74cdf0e10cSrcweir
75cdf0e10cSrcweir	// DocMerge from idl: method com::sun::star::io::XConnectable::getSuccessor
76cdf0e10cSrcweir	/** @returns
77cdf0e10cSrcweir			the successor of this object.
78cdf0e10cSrcweir	 */
79cdf0e10cSrcweir	com::sun::star::io::XConnectable getSuccessor();
80cdf0e10cSrcweir
81cdf0e10cSrcweir};
82cdf0e10cSrcweir
83cdf0e10cSrcweir//=============================================================================
84cdf0e10cSrcweir
85cdf0e10cSrcweir}; }; }; };
86cdf0e10cSrcweir
87cdf0e10cSrcweir/*=============================================================================
88cdf0e10cSrcweir
89cdf0e10cSrcweir=============================================================================*/
90cdf0e10cSrcweir#endif
91