xref: /trunk/main/udkapi/com/sun/star/io/XConnectable.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_io_XConnectable_idl__
#define __com_sun_star_io_XConnectable_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif


//=============================================================================

 module com {  module sun {  module star {  module io {

//=============================================================================

// DocMerge from xml: interface com::sun::star::io::XConnectable
/** makes it possible to connect data sinks and sources.

	<p>The predecessor-member is the element in the connection that is
	nearer to the source of the data. The successor-member is the element
	that is further away from the source of the data. (Note that this
	classification does not depend on whether the class implements
	<type>XInputStream</type> or <type>XOutputStream</type>; it only
	depends on the direction of data flow.) </p>
	<p>This interface allows generic services to navigate between
	arbitrary elements of a connection.</p>
 */
published interface XConnectable: com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------

	// DocMerge from xml: method com::sun::star::io::XConnectable::setPredecessor
	/** sets the source of the data flow for this object.
	 */
	void setPredecessor( [in] com::sun::star::io::XConnectable aPredecessor );

	//-------------------------------------------------------------------------

	// DocMerge from idl: method com::sun::star::io::XConnectable::getPredecessor
	/** @returns
			the predecessor of this object.
	 */
	com::sun::star::io::XConnectable getPredecessor();

	//-------------------------------------------------------------------------

	// DocMerge from xml: method com::sun::star::io::XConnectable::setSuccessor
	/** sets the sink of the data flow for this object.
	 */
	void setSuccessor( [in] com::sun::star::io::XConnectable aSuccessor );

	//-------------------------------------------------------------------------

	// DocMerge from idl: method com::sun::star::io::XConnectable::getSuccessor
	/** @returns
			the successor of this object.
	 */
	com::sun::star::io::XConnectable getSuccessor();

};

//=============================================================================

}; }; }; };

/*=============================================================================

=============================================================================*/
#endif