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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XSAXSerializable.idl,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_xml_sax_XSAXSerializable_idl__
  32 #define __com_sun_star_xml_sax_XSAXSerializable_idl__
  33
  34 #ifndef __com_sun_star_xml_sax_XDocumentHandler_idl__
  35 #include <com/sun/star/xml/sax/XDocumentHandler.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_beans_StringPair_idl__
  39 #include <com/sun/star/beans/StringPair.idl>
  40 #endif
  41
  42 module com { module sun { module star { module xml { module sax {
  43
  44 //=============================================================================
  45 /** serializes a DOM tree by generating SAX events.
  46
  47     <p>
  48     </p>
  49
  50     @since OOo 3.0
  51
  52 */
  53 interface XSAXSerializable
  54 {
  55
  56     //-------------------------------------------------------------------------
  57     /** serializes an object (e.g. a DOM tree) that represents an XML document
  58         by generating SAX events.
  59
  60         @param  handler
  61             the SAX event handler that should receive the generated events
  62         @param  namespaces
  63             a list of namespace declarations that will be added to the root
  64             element node of the XML document
  65             <p>
  66             This is necessary mostly because the DOM implementation does
  67             not permit attaching namespaces declarations directly to nodes,
  68             which may lead to duplicate namespace declarations on export,
  69             and thus larger documents.
  70             Note that the first part of each tuple is the prefix,
  71             e.g. "office", and the second is the full namespace URI.
  72             </p>
  73
  74         @throws com::sun::star::xml::sax::SAXException
  75                  if serializing the XML document fails
  76      */
  77     void serialize([in] sax::XDocumentHandler handler,
  78             [in] sequence< beans::StringPair > namespaces)
  79         raises( com::sun::star::xml::sax::SAXException );
  80
  81 };
  82
  83 }; }; }; }; };
  84
  85 #endif