Document
has a doctype
whose value
* is either null
or a DocumentType
object.
*
* The DOM_DocumentType
class provides access
* to the list of entities and notations that are defined for the document.
* The DOM Level 1 doesn't support editing DocumentType
nodes.
*/
class CDOM_EXPORT DOM_DocumentType: public DOM_Node {
public:
/** @name Constructors and assignment operator */
//@{
/**
* Default constructor for DOM_DocumentType. The resulting object does not
* refer to an actual DocumentType node; it will compare == to 0, and is similar
* to a null object reference variable in Java. It may subsequently be
* assigned to refer to the actual DocumentType node.
*
* A new DocumentType node for a document that does not already have one
* can be created by DOM_Document::createDocumentType().
*
*/
DOM_DocumentType();
/**
* Constructor for a null DOM_DocumentType.
* This allows passing 0 directly as a null DOM_DocumentType to
* function calls that take DOM_DocumentType as parameters.
*
* @param nullPointer Must be 0.
*/
DOM_DocumentType(int nullPointer);
/**
* Copy constructor. Creates a new DOM_Comment
that refers to the
* same underlying node as the original.
*
*
* @param other The object to be copied.
*/
DOM_DocumentType(const DOM_DocumentType &other);
/**
* Assignment operator.
*
* @param other The object to be copied.
*/
DOM_DocumentType & operator = (const DOM_DocumentType &other);
/**
* Assignment operator. This overloaded variant is provided for
* the sole purpose of setting a DOM_Node reference variable to
* zero. Nulling out a reference variable in this way will decrement
* the reference count on the underlying Node object that the variable
* formerly referenced. This effect is normally obtained when reference
* variable goes out of scope, but zeroing them can be useful for
* global instances, or for local instances that will remain in scope
* for an extended time, when the storage belonging to the underlying
* node needs to be reclaimed.
*
* @param val Only a value of 0, or null, is allowed.
*/
DOM_DocumentType & operator = (const DOM_NullPtr *val);
//@}
/** @name Destructor. */
//@{
/**
* Destructor for DOM_DocumentType. The object being destroyed is the reference
* object, not the underlying DocumentType node itself.
*
*/
~DOM_DocumentType();
//@}
/** @name Getter functions. */
//@{
/**
* The name of DTD; i.e., the name immediately following the
* DOCTYPE
keyword in an XML source document.
*/
DOMString getName() const;
/**
* This function returns a NamedNodeMap
containing the general entities, both
* external and internal, declared in the DTD. Parameter entities are not contained.
* Duplicates are discarded.
*
* Note: this functionality is not implemented in the initial release * of the parser, and the returned NamedNodeMap will be empty. */ DOM_NamedNodeMap getEntities() const; /** * This function returns a named node map containing an entry for * each notation declared in a document's DTD. Duplicates are discarded. * *
* Note: this functionality is not implemented in the initial release * of the parser, and the returned NamedNodeMap will be empty. */ DOM_NamedNodeMap getNotations() const; //@} /** @name Functions introduced in DOM Level 2. */ //@{ /** * Get the public identifier of the external subset. * * @return The public identifier of the external subset. */ DOMString getPublicId() const; /** * Get the system identifier of the external subset. * * @return The system identifier of the external subset. */ DOMString getSystemId() const; /** * Get the internal subset as a string. * * @return The internal subset as a string. */ DOMString getInternalSubset() const; //@} protected: DOM_DocumentType(DocumentTypeImpl *); friend class DOM_Document; friend class DOM_DOMImplementation; }; XERCES_CPP_NAMESPACE_END #endif