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
28#ifndef __com_sun_star_xml_sax_XSAXSerializable_idl__
29#define __com_sun_star_xml_sax_XSAXSerializable_idl__
30
31#ifndef __com_sun_star_xml_sax_XDocumentHandler_idl__
32#include <com/sun/star/xml/sax/XDocumentHandler.idl>
33#endif
34
35#ifndef __com_sun_star_beans_StringPair_idl__
36#include <com/sun/star/beans/StringPair.idl>
37#endif
38
39module com { module sun { module star { module xml { module sax {
40
41//=============================================================================
42/** serializes a DOM tree by generating SAX events.
43
44    <p>
45    </p>
46
47    @since OOo 3.0
48
49*/
50interface XSAXSerializable
51{
52
53	//-------------------------------------------------------------------------
54    /** serializes an object (e.g. a DOM tree) that represents an XML document
55        by generating SAX events.
56
57        @param  handler
58            the SAX event handler that should receive the generated events
59        @param  namespaces
60            a list of namespace declarations that will be added to the root
61            element node of the XML document
62            <p>
63            This is necessary mostly because the DOM implementation does
64            not permit attaching namespaces declarations directly to nodes,
65            which may lead to duplicate namespace declarations on export,
66            and thus larger documents.
67            Note that the first part of each tuple is the prefix,
68            e.g. "office", and the second is the full namespace URI.
69            </p>
70
71        @throws com::sun::star::xml::sax::SAXException
72                 if serializing the XML document fails
73     */
74    void serialize([in] sax::XDocumentHandler handler,
75            [in] sequence< beans::StringPair > namespaces)
76        raises( com::sun::star::xml::sax::SAXException );
77
78};
79
80}; }; }; }; };
81
82#endif
83