offapi/com/sun/star/xml/sax/XDTDHandler.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
  21
  22 module com {  module sun {  module star {  module xml {  module sax {
  23
  24
  25 /** receives events according to the DTD of the document.
  26
  27     <p>The SAX parser may report these events in any order, regardless of the
  28     order in which the notations and unparsed entities were declared; however,
  29     all DTD events must be reported after the document handler's
  30     <code>startDocument</code> event, and before the first <code>startElement</code>
  31     event.  It is up to the application to store the information for future
  32     use (perhaps in a hash table or object tree). If the application encounters
  33     attributes of type "NOTATION", "ENTITY", or "ENTITIES", it can use the
  34     information that it obtained through this interface to find the entity
  35     and/or notation that corresponds with the attribute value.
  36     </p>
  37  */
  38 published interface XDTDHandler: com::sun::star::uno::XInterface
  39 {
  40
  41     /** receives notification of a notation declaration event.
  42      */
  43     void notationDecl( [in] string sName,
  44              [in] string sPublicId,
  45              [in] string sSystemId );
  46
  47
  48     /** receives notification of an unparsed entity declaration event.
  49      */
  50     void unparsedEntityDecl( [in] string sName,
  51              [in] string sPublicId,
  52              [in] string sSystemId,
  53              [in] string sNotationName );
  54
  55 };
  56
  57
  58 }; }; }; }; };
  59
  60 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */