xref: /trunk/main/offapi/com/sun/star/document/XMLOasisBasicExporter.idl (revision 34c958ab)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_document_XMLOasisBasicExporter_idl__
#define __com_sun_star_document_XMLOasisBasicExporter_idl__

#ifndef __com_sun_star_document_XExporter_idl__
#include <com/sun/star/document/XExporter.idl>
#endif

#ifndef __com_sun_star_document_XFilter_idl__
#include <com/sun/star/document/XFilter.idl>
#endif

#ifndef __com_sun_star_lang_XInitialization_idl__
#include <com/sun/star/lang/XInitialization.idl>
#endif


//=============================================================================

module com { module sun { module star { module document {

//=============================================================================

/** Filter for exporting Basic macros to the OASIS Open Office file format.

    <p>First the <method>XExporter::setSourceDocument</method> method must be
    called in order to provide the export component with the source document
    from which the data should be exported. After that, the export is started
    by calling the <method>XFilter::filter</method> method.</p>

    @since OpenOffice 2.0
 */
published service XMLOasisBasicExporter
{
	//-------------------------------------------------------------------------

    /** sets the source document for this filter.
     */
    interface com::sun::star::document::XExporter;

	//-------------------------------------------------------------------------

    /** filters the document.
     */
    interface com::sun::star::document::XFilter;

	//-------------------------------------------------------------------------

    /** initializes the component.
     */
	[optional] interface com::sun::star::lang::XInitialization;

};

//=============================================================================

}; }; }; };

#endif