1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef _COM_SUN_STAR_XML_EXPORTFILTER_IDL__
25#define _COM_SUN_STAR_XML_EXPORTFILTER_IDL__
26
27#ifndef _COM_SUN_STAR_XML_XEXPORTFILTER_IDL__
28#include <com/sun/star/xml/XExportFilter.idl>
29#endif
30
31
32module com { module sun { module star { module xml {
33
34/** describes an export filter for XML-based file formats.
35
36   <p>First, the <method>XExportFilter::exporter</method> method must be
37   called to provide the export component with the target location to
38   which the data should be exported. Then, the source document's XML
39   representation will be generated by calling the appropriate methods
40   of the <type scope="com::sun::star::xml::sax">XDocumentHandler</type>
41   interface.  Error conditions must be signalled by throwing
42   a <type scope="com::sun::star::xml::sax">SAXException</type> in the
43   <type scope="com::sun::star::xml::sax">XDocumentHandler</type> calls.
44
45    @since OpenOffice 1.1.2
46 */
47published service ExportFilter
48{
49    /** The data will be passed in through the
50		<type scope="com::sun::star::xml::sax">XDocumentHandler</type> calls. */
51    interface com::sun::star::xml::sax::XDocumentHandler;
52
53    /** The <method>XExportFilter:exporter()</method> call will provide the
54		<type scope="com::sun::star::document">TypeDetection</type> user data
55		required to perform the filtering correctly.
56	*/
57    interface com::sun::star::xml::XExportFilter;
58};
59
60}; }; }; };
61#endif
62