udkapi/com/sun/star/io/XDataExporter.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XDataExporter.idl,v $
  10  * $Revision: 1.12 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_io_XDataExporter_idl__
  31 #define __com_sun_star_io_XDataExporter_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_io_XOutputStream_idl__
  38 #include <com/sun/star/io/XOutputStream.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_lang_XComponent_idl__
  42 #include <com/sun/star/lang/XComponent.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_io_XDataTransferEventListener_idl__
  46 #include <com/sun/star/io/XDataTransferEventListener.idl>
  47 #endif
  48
  49
  50 //=============================================================================
  51
  52 module com {  module sun {  module star {  module io {
  53
  54 //=============================================================================
  55
  56 // DocMerge from xml: interface com::sun::star::io::XDataExporter
  57 /** makes it possible to export data from a component into a data sink.
  58
  59     <p>Exporter objects are registered for specific components and data types.
  60     </p>
  61  */
  62 published interface XDataExporter: com::sun::star::uno::XInterface
  63 {
  64     //-------------------------------------------------------------------------
  65
  66     // DocMerge from xml: method com::sun::star::io::XDataExporter::exportData
  67     /** exports data for a component into an output stream.
  68      */
  69     [oneway] void exportData( [in] com::sun::star::io::XOutputStream aOutputStream,
  70              [in] com::sun::star::lang::XComponent Component,
  71              [in] com::sun::star::io::XDataTransferEventListener aListener );
  72
  73     //-------------------------------------------------------------------------
  74
  75     // DocMerge from xml: method com::sun::star::io::XDataExporter::cancel
  76     /** cancels the export process.
  77      */
  78     [oneway] void cancel();
  79
  80 };
  81
  82 //=============================================================================
  83
  84 }; }; }; };
  85
  86 /*=============================================================================
  87
  88 =============================================================================*/
  89 #endif