offapi/com/sun/star/xml/sax/XFastSAXSerializable.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_XFastSAXSerializable_idl__
  21 #define __com_sun_star_xml_sax_XFastSAXSerializable_idl__
  22
  23 #include <com/sun/star/xml/sax/XFastDocumentHandler.idl>
  24 #include <com/sun/star/xml/sax/XFastTokenHandler.idl>
  25 #include <com/sun/star/beans/StringPair.idl>
  26 #include <com/sun/star/beans/Pair.idl>
  27
  28 module com { module sun { module star { module xml { module sax {
  29
  30 /** serializes a DOM tree by generating FastSAX events.
  31
  32     <p>
  33     </p>
  34
  35     @since OOo 3.1
  36
  37 */
  38 interface XFastSAXSerializable
  39 {
  40
  41     /** serializes an object (e.g. a DOM tree) that represents an XML document
  42         by generating fast SAX events.
  43
  44         @param  handler
  45             the SAX event handler that should receive the generated events
  46         @param  tokenHandler
  47             the fast SAX token handler that is used to translate names
  48         @param  namespaces
  49             a list of namespace declarations that will be added to the root
  50             element node of the XML document
  51             <p>
  52             This is necessary mostly because the DOM implementation does
  53             not permit attaching namespaces declarations directly to nodes,
  54             which may lead to duplicate namespace declarations on export,
  55             and thus larger documents.
  56             Note that the first part of each tuple is the prefix,
  57             e.g. "office", and the second is the numeric namespace identifier.
  58             </p>
  59         @param  registerNamespaces
  60             a list of namespace url / namespace token pairs. you need
  61             to register all namespace in order to have them recognized
  62             during export. Namespace tokens must be greater than
  63             FastToken::NAMESPACE.
  64             </p>
  65
  66         @throws com::sun::star::xml::sax::SAXException
  67                  if serializing the XML document fails
  68      */
  69     void fastSerialize([in] com::sun::star::xml::sax::XFastDocumentHandler handler,
  70                        [in] com::sun::star::xml::sax::XFastTokenHandler tokenHandler,
  71                        [in] sequence< com::sun::star::beans::StringPair > namespaces,
  72                        [in] sequence< com::sun::star::beans::Pair<string, long> > registerNamespaces)
  73         raises( com::sun::star::xml::sax::SAXException );
  74 };
  75
  76 }; }; }; }; };
  77
  78 #endif
  79
  80 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */