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 module com { module sun { module star { module xml { module sax {
  21
  22 /** serializes a DOM tree by generating SAX events.
  23
  24     <p>
  25     </p>
  26
  27     @since OOo 3.0
  28
  29 */
  30 interface XSAXSerializable
  31 {
  32
  33     /** serializes an object (e.g. a DOM tree) that represents an XML document
  34         by generating SAX events.
  35
  36         @param  handler
  37             the SAX event handler that should receive the generated events
  38         @param  namespaces
  39             a list of namespace declarations that will be added to the root
  40             element node of the XML document
  41             <p>
  42             This is necessary mostly because the DOM implementation does
  43             not permit attaching namespaces declarations directly to nodes,
  44             which may lead to duplicate namespace declarations on export,
  45             and thus larger documents.
  46             Note that the first part of each tuple is the prefix,
  47             e.g. "office", and the second is the full namespace URI.
  48             </p>
  49
  50         @throws com::sun::star::xml::sax::SAXException
  51                  if serializing the XML document fails
  52      */
  53     void serialize([in] com::sun::star::xml::sax::XDocumentHandler handler,
  54             [in] sequence< com::sun::star::beans::StringPair > namespaces)
  55         raises( com::sun::star::xml::sax::SAXException );
  56
  57 };
  58
  59 }; }; }; }; };
  60
  61 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */