xref: /aoo41x/main/udkapi/com/sun/star/io/XDataExporter.idl (revision 408a4873)

/**************************************************************
 *
 * 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
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_io_XDataExporter_idl__
#define __com_sun_star_io_XDataExporter_idl__

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

#ifndef __com_sun_star_io_XOutputStream_idl__
#include <com/sun/star/io/XOutputStream.idl>
#endif

#ifndef __com_sun_star_lang_XComponent_idl__
#include <com/sun/star/lang/XComponent.idl>
#endif

#ifndef __com_sun_star_io_XDataTransferEventListener_idl__
#include <com/sun/star/io/XDataTransferEventListener.idl>
#endif


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

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

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

// DocMerge from xml: interface com::sun::star::io::XDataExporter
/** makes it possible to export data from a component into a data sink.

	<p>Exporter objects are registered for specific components and data types.
	</p>
 */
published interface XDataExporter: com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------

	// DocMerge from xml: method com::sun::star::io::XDataExporter::exportData
	/** exports data for a component into an output stream.
	 */
	[oneway] void exportData( [in] com::sun::star::io::XOutputStream aOutputStream,
			 [in] com::sun::star::lang::XComponent Component,
			 [in] com::sun::star::io::XDataTransferEventListener aListener );

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

	// DocMerge from xml: method com::sun::star::io::XDataExporter::cancel
	/** cancels the export process.
	 */
	[oneway] void cancel();

};

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

}; }; }; };

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

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