Base Framework
Public Member Functions | List of all members
XMLReader::DTDHandler Class Reference

Receive notification of basic DTD-related events. More...

#include <base/xml/XMLReader.h>

Public Member Functions

virtual void comment (const String &data) noexcept
 
virtual void startDTD (const String &name, const String &publicId, const String &systemId) noexcept
 
virtual void endDTD () noexcept
 
virtual void startEntity (const String &name) noexcept
 
virtual void endEntity (const String &name) noexcept
 
virtual void startCDATA () noexcept
 
virtual void endCDATA () noexcept
 
virtual void attributeDecl (const String &name, const String &element, AttributeDecl::ValueType type, AttributeDecl::DefaultType defaultType, const String &defaultValue, const Array< String > &enumeration) noexcept
 
virtual void elementDecl (const String &name, ElementDecl::ValueType type) noexcept
 
virtual void internalEntityDecl (const String &name, const String &text) noexcept
 
virtual void externalEntityDecl (const String &name, const String &publicId, const String &systemId) noexcept
 
virtual void notationDecl (const String &name, const String &publicId, const String &systemId) noexcept
 
virtual void unparsedEntityDecl (const String &name, const String &publicId, const String &systemId, const String &notationName) noexcept
 

Detailed Description

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.

Version
1.0
Examples
testsuite/sax.cpp.

Member Function Documentation

◆ attributeDecl()

virtual void XMLReader::DTDHandler::attributeDecl ( const String name,
const String element,
AttributeDecl::ValueType  type,
AttributeDecl::DefaultType  defaultType,
const String defaultValue,
const Array< String > &  enumeration 
)
virtualnoexcept

Receive notification of an attribute declaration event.

Parameters
nameThe name of the attribute.
elementThe element name.
typeThe element name.
defaultTypeThe default value constraint.
defaultValueThe default value.
enumerationThe enumeration names if type is ATTRIBUTE_ENUMERATION.

◆ comment()

virtual void XMLReader::DTDHandler::comment ( const String data)
virtualnoexcept

Receives notification of a comment.

◆ elementDecl()

virtual void XMLReader::DTDHandler::elementDecl ( const String name,
ElementDecl::ValueType  type 
)
virtualnoexcept

Receive notification of an element declaration event.

Parameters
nameThe name of the element.
typeThe type of the element.

◆ endCDATA()

virtual void XMLReader::DTDHandler::endCDATA ( )
virtualnoexcept

Receives notification of the end of a CDATA section.

◆ endDTD()

virtual void XMLReader::DTDHandler::endDTD ( )
virtualnoexcept

Receive notification of end of document type declaration.

◆ endEntity()

virtual void XMLReader::DTDHandler::endEntity ( const String name)
virtualnoexcept

Receives notification of the end of an entity.

◆ externalEntityDecl()

virtual void XMLReader::DTDHandler::externalEntityDecl ( const String name,
const String publicId,
const String systemId 
)
virtualnoexcept

Receive notification of an external entity declaration event.

Parameters
nameThe name of the entity.
publicIdThe entities public identifier.
systemIdThe entities system identifier.

◆ internalEntityDecl()

virtual void XMLReader::DTDHandler::internalEntityDecl ( const String name,
const String text 
)
virtualnoexcept

Receive notification of an internal entity declaration event.

Parameters
nameThe name of the entity.
textThe text.

◆ notationDecl()

virtual void XMLReader::DTDHandler::notationDecl ( const String name,
const String publicId,
const String systemId 
)
virtualnoexcept

Receive notification of a notation declaration event.

Parameters
nameThe notation name.
publicIdThe notation's public identifier.
systemIdThe notation's system identifier.

◆ startCDATA()

virtual void XMLReader::DTDHandler::startCDATA ( )
virtualnoexcept

Receives notification of the start of a CDATA section.

◆ startDTD()

virtual void XMLReader::DTDHandler::startDTD ( const String name,
const String publicId,
const String systemId 
)
virtualnoexcept

Receive notification of a document type declaration.

Parameters
nameThe name of the attribute.
publicIdThe public identifier.
systemIdThe system identifier.

◆ startEntity()

virtual void XMLReader::DTDHandler::startEntity ( const String name)
virtualnoexcept

Receives notification of the start of an entity.

◆ unparsedEntityDecl()

virtual void XMLReader::DTDHandler::unparsedEntityDecl ( const String name,
const String publicId,
const String systemId,
const String notationName 
)
virtualnoexcept

Receive notification of an unparsed entity declaration event.

Parameters
nameThe unparsed entity's name.
publicIdThe entity's public identifier.
systemIdThe entity's system identifier.
notationThe name of the associated notation.