offapi/com/sun/star/document/XMLBasicImporter.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_document_XMLBasicImporter_idl__
  28 #define __com_sun_star_document_XMLBasicImporter_idl__
  29
  30 #ifndef __com_sun_star_document_XImporter_idl__
  31 #include <com/sun/star/document/XImporter.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_xml_sax_XDocumentHandler_idl__
  35 #include <com/sun/star/xml/sax/XDocumentHandler.idl>
  36 #endif
  37
  38
  39 //=============================================================================
  40
  41 module com { module sun { module star { module document {
  42
  43 //=============================================================================
  44
  45 /** Filter for importing Basic macros from the OpenOffice.org file format.
  46
  47     <p>The <method>XImporter::setTargetDocument</method> method must be
  48     called in order to provide the import component with the target document
  49     to which the data should be imported.
  50     The <type scope="com::sun::star::xml::sax">XDocumentHandler</type>
  51     interface is used to stream the XML data into the filter.</p>
  52
  53     @since OOo 2.0.0
  54  */
  55 published service XMLBasicImporter
  56 {
  57     //-------------------------------------------------------------------------
  58
  59     /** sets the target document for this filter.
  60      */
  61     interface com::sun::star::document::XImporter;
  62
  63     //-------------------------------------------------------------------------
  64
  65     /** receives notification of general document events.
  66      */
  67     interface com::sun::star::xml::sax::XDocumentHandler;
  68
  69 };
  70
  71 //=============================================================================
  72
  73 }; }; }; };
  74
  75 #endif