offapi/com/sun/star/xml/sax/XSAXSerializable.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_xml_sax_XSAXSerializable_idl__
  21 #define __com_sun_star_xml_sax_XSAXSerializable_idl__
  22
  23 #include <com/sun/star/xml/sax/XDocumentHandler.idl>
  24 #include <com/sun/star/beans/StringPair.idl>
  25
  26 module com { module sun { module star { module xml { module sax {
  27
  28 /** serializes a DOM tree by generating SAX events.
  29
  30     <p>
  31     </p>
  32
  33     @since OOo 3.0
  34
  35 */
  36 interface XSAXSerializable
  37 {
  38
  39     /** serializes an object (e.g. a DOM tree) that represents an XML document
  40         by generating SAX events.
  41
  42         @param  handler
  43             the SAX event handler that should receive the generated events
  44         @param  namespaces
  45             a list of namespace declarations that will be added to the root
  46             element node of the XML document
  47             <p>
  48             This is necessary mostly because the DOM implementation does
  49             not permit attaching namespaces declarations directly to nodes,
  50             which may lead to duplicate namespace declarations on export,
  51             and thus larger documents.
  52             Note that the first part of each tuple is the prefix,
  53             e.g. "office", and the second is the full namespace URI.
  54             </p>
  55
  56         @throws com::sun::star::xml::sax::SAXException
  57                  if serializing the XML document fails
  58      */
  59     void serialize([in] com::sun::star::xml::sax::XDocumentHandler handler,
  60             [in] sequence< com::sun::star::beans::StringPair > namespaces)
  61         raises( com::sun::star::xml::sax::SAXException );
  62
  63 };
  64
  65 }; }; }; }; };
  66
  67 #endif
  68
  69 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */