diff options
Diffstat (limited to 'parser/xml/nsISAXDTDHandler.idl')
-rw-r--r-- | parser/xml/nsISAXDTDHandler.idl | 77 |
1 files changed, 77 insertions, 0 deletions
diff --git a/parser/xml/nsISAXDTDHandler.idl b/parser/xml/nsISAXDTDHandler.idl new file mode 100644 index 0000000000..b4cb51d1b8 --- /dev/null +++ b/parser/xml/nsISAXDTDHandler.idl @@ -0,0 +1,77 @@ +/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ +/* This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ + +#include "nsISupports.idl" + +/** + * Receive notification of basic DTD-related events. + * + * If a SAX application needs information about notations and + * unparsed entities, then the application implements this interface + * and registers an instance with the SAX parser using the parser's + * setDTDHandler method. The parser uses the instance to report + * notation and unparsed entity declarations to the application. + * + * Note that this interface includes only those DTD events that the + * XML recommendation requires processors to report: notation and + * unparsed entity declarations. + * + * The SAX parser may report these events in any order, regardless + * of the order in which the notations and unparsed entities were + * declared; however, all DTD events must be reported after the + * document handler's startDocument event, and before the first + * startElement event. (If the LexicalHandler is used, these events + * must also be reported before the endDTD event.) + */ +[scriptable, uuid(4d01f225-6cc5-11da-be43-001422106990)] +interface nsISAXDTDHandler : nsISupports { + + /** + * Receive notification of a notation declaration event. + * + * It is up to the application to record the notation for later + * reference, if necessary; notations may appear as attribute values + * and in unparsed entity declarations, and are sometime used with + * processing instruction target names. + * + * At least one of publicId and systemId must be non-null. If a + * system identifier is present, and it is a URL, the SAX parser + * must resolve it fully before passing it to the application + * through this event. + * + * There is no guarantee that the notation declaration will be + * reported before any unparsed entities that use it. + * + * @param name The notation name. + * @param publicId The notation's public identifier, or null if none was + * given. + * @param systemId The notation's system identifier, or null if none was + * given. + */ + void notationDecl(in AString name, + in AString publicId, + in AString systemId); + + /** + * Receive notification of an unparsed entity declaration event. + * + * Note that the notation name corresponds to a notation reported + * by the notationDecl event. It is up to the application to record + * the entity for later reference, if necessary; unparsed entities + * may appear as attribute values. + * + * If the system identifier is a URL, the parser must resolve it + * fully before passing it to the application. + * + * @param name The unparsed entity's name. + * @param publicId The entity's public identifier, or null if none was + * given. + * @param systemId The entity's system identifier, or null if none was + * given. + * @param notationName The name of the associated notation. + */ + void unparsedEntityDecl(in AString name, in AString publicId, + in AString systemId, in AString notationName); +}; |