summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/xml/ExportFilter.idl
blob: 79abaef8851f6932a67e36b354a2e62a4519d95d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   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 .
 */

#ifndef _COM_SUN_STAR_XML_EXPORTFILTER_IDL__
#define _COM_SUN_STAR_XML_EXPORTFILTER_IDL__

#include <com/sun/star/xml/XExportFilter.idl>


module com { module sun { module star { module xml {

/** describes an export filter for XML-based file formats.

   <p>First, the XExportFilter::exporter() method must be
   called to provide the export component with the target location to
   which the data should be exported. Then, the source document's XML
   representation will be generated by calling the appropriate methods
   of the com::sun::star::xml::sax::XDocumentHandler
   interface.  Error conditions must be signaled by throwing
   a com::sun::star::xml::sax::SAXException in the
   com::sun::star::xml::sax::XDocumentHandler calls.

    @since OOo 1.1.2
 */
published service ExportFilter
{
    /** The data will be passed in through the
        com::sun::star::xml::sax::XDocumentHandler calls. */
    interface com::sun::star::xml::sax::XDocumentHandler;

    /** The XExportFilter:exporter() call will provide the
        com::sun::star::document::TypeDetection user data
        required to perform the filtering correctly.
    */
    interface com::sun::star::xml::XExportFilter;
};

}; }; }; };
#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */