1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_xml_sax_XSAXSerializable_idl__ 25*b1cdbd2cSJim Jagielski#define __com_sun_star_xml_sax_XSAXSerializable_idl__ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_xml_sax_XDocumentHandler_idl__ 28*b1cdbd2cSJim Jagielski#include <com/sun/star/xml/sax/XDocumentHandler.idl> 29*b1cdbd2cSJim Jagielski#endif 30*b1cdbd2cSJim Jagielski 31*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_beans_StringPair_idl__ 32*b1cdbd2cSJim Jagielski#include <com/sun/star/beans/StringPair.idl> 33*b1cdbd2cSJim Jagielski#endif 34*b1cdbd2cSJim Jagielski 35*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module xml { module sax { 36*b1cdbd2cSJim Jagielski 37*b1cdbd2cSJim Jagielski//============================================================================= 38*b1cdbd2cSJim Jagielski/** serializes a DOM tree by generating SAX events. 39*b1cdbd2cSJim Jagielski 40*b1cdbd2cSJim Jagielski <p> 41*b1cdbd2cSJim Jagielski </p> 42*b1cdbd2cSJim Jagielski 43*b1cdbd2cSJim Jagielski @since OpenOffice 3.0 44*b1cdbd2cSJim Jagielski 45*b1cdbd2cSJim Jagielski*/ 46*b1cdbd2cSJim Jagielskiinterface XSAXSerializable 47*b1cdbd2cSJim Jagielski{ 48*b1cdbd2cSJim Jagielski 49*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 50*b1cdbd2cSJim Jagielski /** serializes an object (e.g. a DOM tree) that represents an XML document 51*b1cdbd2cSJim Jagielski by generating SAX events. 52*b1cdbd2cSJim Jagielski 53*b1cdbd2cSJim Jagielski @param handler 54*b1cdbd2cSJim Jagielski the SAX event handler that should receive the generated events 55*b1cdbd2cSJim Jagielski @param namespaces 56*b1cdbd2cSJim Jagielski a list of namespace declarations that will be added to the root 57*b1cdbd2cSJim Jagielski element node of the XML document 58*b1cdbd2cSJim Jagielski <p> 59*b1cdbd2cSJim Jagielski This is necessary mostly because the DOM implementation does 60*b1cdbd2cSJim Jagielski not permit attaching namespaces declarations directly to nodes, 61*b1cdbd2cSJim Jagielski which may lead to duplicate namespace declarations on export, 62*b1cdbd2cSJim Jagielski and thus larger documents. 63*b1cdbd2cSJim Jagielski Note that the first part of each tuple is the prefix, 64*b1cdbd2cSJim Jagielski e.g. "office", and the second is the full namespace URI. 65*b1cdbd2cSJim Jagielski </p> 66*b1cdbd2cSJim Jagielski 67*b1cdbd2cSJim Jagielski @throws com::sun::star::xml::sax::SAXException 68*b1cdbd2cSJim Jagielski if serializing the XML document fails 69*b1cdbd2cSJim Jagielski */ 70*b1cdbd2cSJim Jagielski void serialize([in] sax::XDocumentHandler handler, 71*b1cdbd2cSJim Jagielski [in] sequence< beans::StringPair > namespaces) 72*b1cdbd2cSJim Jagielski raises( com::sun::star::xml::sax::SAXException ); 73*b1cdbd2cSJim Jagielski 74*b1cdbd2cSJim Jagielski}; 75*b1cdbd2cSJim Jagielski 76*b1cdbd2cSJim Jagielski}; }; }; }; }; 77*b1cdbd2cSJim Jagielski 78*b1cdbd2cSJim Jagielski#endif 79