offapi/com/sun/star/document/XMLBasicExporter.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: XMLBasicExporter.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_XMLBasicExporter_idl__
  31 #define __com_sun_star_document_XMLBasicExporter_idl__
  32
  33 #ifndef __com_sun_star_document_XExporter_idl__
  34 #include <com/sun/star/document/XExporter.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_document_XFilter_idl__
  38 #include <com/sun/star/document/XFilter.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_lang_XInitialization_idl__
  42 #include <com/sun/star/lang/XInitialization.idl>
  43 #endif
  44
  45
  46 //=============================================================================
  47
  48 module com { module sun { module star { module document {
  49
  50 //=============================================================================
  51
  52 /** Filter for exporting Basic macros to the OpenOffice.org file format.
  53
  54     <p>First the <method>XExporter::setSourceDocument</method> method must be
  55     called in order to provide the export component with the source document
  56     from which the data should be exported. After that, the export is started
  57     by calling the <method>XFilter::filter</method> method.</p>
  58
  59     @since OOo 2.0.0
  60  */
  61 published service XMLBasicExporter
  62 {
  63     //-------------------------------------------------------------------------
  64
  65     /** sets the source document for this filter.
  66      */
  67     interface com::sun::star::document::XExporter;
  68
  69     //-------------------------------------------------------------------------
  70
  71     /** filters the document.
  72      */
  73     interface com::sun::star::document::XFilter;
  74
  75     //-------------------------------------------------------------------------
  76
  77     /** initializes the component.
  78      */
  79     [optional] interface com::sun::star::lang::XInitialization;
  80
  81 };
  82
  83 //=============================================================================
  84
  85 }; }; }; };
  86
  87 #endif