offapi/com/sun/star/xml/csax/XCompressedDocumentHandler.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 //i20156 - new file for xmlsecurity module
  29
  30 #ifndef __com_sun_star_xml_csax_XCompressedDocumentHandler_idl__
  31 #define __com_sun_star_xml_csax_XCompressedDocumentHandler_idl__
  32
  33 #include <com/sun/star/uno/XInterface.idl>
  34 #include <com/sun/star/xml/sax/SAXException.idl>
  35
  36
  37 module com { module sun { module star { module xml { module csax {
  38
  39 /**
  40  * A struct to keep information of an element's attribute.
  41  */
  42 struct XMLAttribute
  43 {
  44     /**
  45      * the attribute name
  46      */
  47     string sName;
  48
  49     /**
  50      * the attribute value
  51      */
  52     string sValue;
  53 };
  54
  55 /**
  56  * A compressed XDocumentHandler interface.
  57  * <p>
  58  * All methods in this interface have the same function with methods
  59  * in the XDocumentHandler interface.
  60  * <p>
  61  * Because there is no interface parameter in these methods, so using
  62  * this interface to transfer SAX event is thought to have better
  63  * performance than using the XDocumentHandler interface, in case of
  64  * when UNO C++/Java bridge is involved.
  65  */
  66 interface XCompressedDocumentHandler: com::sun::star::uno::XInterface
  67 {
  68     void _startDocument()
  69         raises( com::sun::star::xml::sax::SAXException );
  70
  71     void _endDocument()
  72         raises( com::sun::star::xml::sax::SAXException );
  73
  74     void _startElement( [in] string aName, [in] sequence< XMLAttribute > aAttributes)
  75         raises( com::sun::star::xml::sax::SAXException );
  76
  77     void _endElement( [in] string aName )
  78         raises( com::sun::star::xml::sax::SAXException );
  79
  80     void _characters( [in] string aChars )
  81         raises( com::sun::star::xml::sax::SAXException );
  82
  83     void _ignorableWhitespace( [in] string aWhitespaces )
  84         raises( com::sun::star::xml::sax::SAXException );
  85
  86     void _processingInstruction( [in] string aTarget, [in] string aData )
  87         raises( com::sun::star::xml::sax::SAXException );
  88
  89     void _setDocumentLocator( [in] long columnNumber, [in] long lineNumber, [in] string publicId, [in] string systemId)
  90         raises( com::sun::star::xml::sax::SAXException );
  91
  92 };
  93
  94 } ; } ; } ; } ; } ;
  95
  96 #endif