offapi/com/sun/star/xml/sax/XDTDHandler.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: XDTDHandler.idl,v $
  10  * $Revision: 1.8 $
  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 #ifndef __com_sun_star_xml_sax_XDTDHandler_idl__
  31 #define __com_sun_star_xml_sax_XDTDHandler_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37
  38 //=============================================================================
  39
  40 module com {  module sun {  module star {  module xml {  module sax {
  41
  42 //=============================================================================
  43
  44 /** receives events according to the DTD of the document.
  45
  46     <p>The SAX parser may report these events in any order, regardless of the
  47     order in which the notations and unparsed entities were declared; however,
  48     all DTD events must be reported after the document handler's
  49     <code>startDocument</code> event, and before the first <code>startElement</code>
  50     event.  It is up to the application to store the information for future
  51     use (perhaps in a hash table or object tree). If the application encounters
  52     attributes of type "NOTATION", "ENTITY", or "ENTITIES", it can use the
  53     information that it obtained through this interface to find the entity
  54     and/or notation that corresponds with the attribute value.
  55     </p>
  56  */
  57 published interface XDTDHandler: com::sun::star::uno::XInterface
  58 {
  59     //-------------------------------------------------------------------------
  60
  61     /** receives notification of a notation declaration event.
  62      */
  63     void notationDecl( [in] string sName,
  64              [in] string sPublicId,
  65              [in] string sSystemId );
  66
  67     //-------------------------------------------------------------------------
  68
  69     /** receives notification of an unparsed entity declaration event.
  70      */
  71     void unparsedEntityDecl( [in] string sName,
  72              [in] string sPublicId,
  73              [in] string sSystemId,
  74              [in] string sNotationName );
  75
  76 };
  77
  78 //=============================================================================
  79
  80 }; }; }; }; };
  81
  82 #endif