offapi/com/sun/star/document/XMLOasisBasicImporter.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: XMLOasisBasicImporter.idl,v $
  10  * $Revision: 1.4 $
  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_document_XMLOasisBasicImporter_idl__
  31 #define __com_sun_star_document_XMLOasisBasicImporter_idl__
  32
  33 #ifndef __com_sun_star_document_XImporter_idl__
  34 #include <com/sun/star/document/XImporter.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_xml_sax_XDocumentHandler_idl__
  38 #include <com/sun/star/xml/sax/XDocumentHandler.idl>
  39 #endif
  40
  41
  42 //=============================================================================
  43
  44 module com { module sun { module star { module document {
  45
  46 //=============================================================================
  47
  48 /** Filter for importing Basic macros from the OASIS Open Office file format.
  49
  50     <p>The <method>XImporter::setTargetDocument</method> method must be
  51     called in order to provide the import component with the target document
  52     to which the data should be imported.
  53     The <type scope="com::sun::star::xml::sax">XDocumentHandler</type>
  54     interface is used to stream the XML data into the filter.</p>
  55
  56     @since OOo 2.0.0
  57  */
  58 published service XMLOasisBasicImporter
  59 {
  60     //-------------------------------------------------------------------------
  61
  62     /** sets the target document for this filter.
  63      */
  64     interface com::sun::star::document::XImporter;
  65
  66     //-------------------------------------------------------------------------
  67
  68     /** receives notification of general document events.
  69      */
  70     interface com::sun::star::xml::sax::XDocumentHandler;
  71
  72 };
  73
  74 //=============================================================================
  75
  76 }; }; }; };
  77
  78 #endif