xref: /aoo41x/main/udkapi/com/sun/star/io/XDataExporter.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_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