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 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XCompressedDocumentHandler.idl,v $
  10  * $Revision: 1.4 $
  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 //i20156 - new file for xmlsecurity module
  32
  33 #ifndef __com_sun_star_xml_csax_XCompressedDocumentHandler_idl__
  34 #define __com_sun_star_xml_csax_XCompressedDocumentHandler_idl__
  35
  36 #include <com/sun/star/uno/XInterface.idl>
  37 #include <com/sun/star/xml/sax/SAXException.idl>
  38
  39
  40 module com { module sun { module star { module xml { module csax {
  41
  42 /**
  43  * A struct to keep information of an element's attribute.
  44  */
  45 struct XMLAttribute
  46 {
  47     /**
  48      * the attribute name
  49      */
  50     string sName;
  51
  52     /**
  53      * the attribute value
  54      */
  55     string sValue;
  56 };
  57
  58 /**
  59  * A compressed XDocumentHandler interface.
  60  * <p>
  61  * All methods in this interface have the same function with methods
  62  * in the XDocumentHandler interface.
  63  * <p>
  64  * Because there is no interface parameter in these methods, so using
  65  * this interface to transfer SAX event is thought to have better
  66  * performance than using the XDocumentHandler interface, in case of
  67  * when UNO C++/Java bridge is involved.
  68  */
  69 interface XCompressedDocumentHandler: com::sun::star::uno::XInterface
  70 {
  71     void _startDocument()
  72         raises( com::sun::star::xml::sax::SAXException );
  73
  74     void _endDocument()
  75         raises( com::sun::star::xml::sax::SAXException );
  76
  77     void _startElement( [in] string aName, [in] sequence< XMLAttribute > aAttributes)
  78         raises( com::sun::star::xml::sax::SAXException );
  79
  80     void _endElement( [in] string aName )
  81         raises( com::sun::star::xml::sax::SAXException );
  82
  83     void _characters( [in] string aChars )
  84         raises( com::sun::star::xml::sax::SAXException );
  85
  86     void _ignorableWhitespace( [in] string aWhitespaces )
  87         raises( com::sun::star::xml::sax::SAXException );
  88
  89     void _processingInstruction( [in] string aTarget, [in] string aData )
  90         raises( com::sun::star::xml::sax::SAXException );
  91
  92     void _setDocumentLocator( [in] long columnNumber, [in] long lineNumber, [in] string publicId, [in] string systemId)
  93         raises( com::sun::star::xml::sax::SAXException );
  94
  95 };
  96
  97 } ; } ; } ; } ; } ;
  98
  99 #endif