class DOM_DocumentType : public DOM_Node

Each Document has a doctype whose value is either null or a DocumentType object

Inheritance:


Public

Constructors and assignment operator
DOM_DocumentType ()
Default constructor for DOM_DocumentType
DOM_DocumentType (const DOM_DocumentType &other)
Copy constructor
DOM_DocumentType& operator = (const DOM_DocumentType &other)
Assignment operator
DOM_DocumentType& operator = (const DOM_NullPtr *val)
Assignment operator
Destructor.
~DOM_DocumentType ()
Destructor for DOM_DocumentType
Functions introduced in DOM Level 2.
DOMString getPublicID () const
Get the public identifier of the external subset
DOMString getSystemID () const
Get the system identifier of the external subset
DOMString getInternalSubset () const
Get the internal subset as a string
Getter functions.
DOMString getName () const
The name of DTD; i
DOM_NamedNodeMap getEntities () const
This function returns a NamedNodeMap containing the general entities, both external and internal, declared in the DTD
DOM_NamedNodeMap getNotations () const
This function returns a named node map containing an entry for each notation declared in a document's DTD

Inherited from DOM_Node:

Public

Cloning function.

DOM_Node cloneNode(bool deep) const
Returns a duplicate of this node

Constructors and assignment operators

DOM_Node()
Default constructor for DOM_Node
DOM_Node(const DOM_Node &other)
Copy constructor
DOM_Node& operator = (const DOM_Node &other)
Assignment operator
DOM_Node& operator = (const DOM_NullPtr *val)
Assignment operator

Equality and Inequality operators.

bool operator == (const DOM_Node & other) const
The equality operator
bool operator == (const DOM_NullPtr *other) const
Compare with a pointer
bool operator != (const DOM_Node & other) const
The inequality operator
bool operator != (const DOM_NullPtr * other) const
Compare with a pointer

Functions to modify the DOM Node.

DOM_Node insertBefore(const DOM_Node &newChild, const DOM_Node &refChild)
Inserts the node newChild before the existing child node refChild
DOM_Node replaceChild(const DOM_Node &newChild, const DOM_Node &oldChild)
Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node
DOM_Node removeChild(const DOM_Node &oldChild)
Removes the child node indicated by oldChild from the list of children, and returns it
DOM_Node appendChild(const DOM_Node &newChild)
Adds the node newChild to the end of the list of children of this node

Get functions.

DOMString getNodeName() const
The name of this node, depending on its type; see the table above
DOMString getNodeValue() const
Gets the value of this node, depending on its type
short getNodeType() const
An enum value representing the type of the underlying object
DOM_Node getParentNode() const
Gets the parent of this node
DOM_NodeList getChildNodes() const
Gets a NodeList that contains all children of this node
DOM_Node getFirstChild() const
Gets the first child of this node
DOM_Node getLastChild() const
Gets the last child of this node
DOM_Node getPreviousSibling() const
Gets the node immediately preceding this node
DOM_Node getNextSibling() const
Gets the node immediately following this node
DOM_NamedNodeMap getAttributes() const
Gets a NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise
DOM_Document getOwnerDocument() const
Gets the Document object associated with this node
void* getUserData() const
Return the user data pointer

Query functions.

bool hasChildNodes() const
This is a convenience method to allow easy determination of whether a node has any children
bool isNull() const
Test whether this node is null

Set functions.

void setNodeValue(const DOMString &nodeValue)
Sets the value of the node
void setUserData(void *p)
Set the user data for a node

Documentation

Each 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.

Constructors and assignment operator

DOM_DocumentType()
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(const DOM_DocumentType &other)
Copy constructor. Creates a new DOM_Comment that refers to the same underlying node as the original.
Parameters:
other - The object to be copied.

DOM_DocumentType& operator = (const DOM_DocumentType &other)
Assignment operator.
Parameters:
other - The object to be copied.

DOM_DocumentType& operator = (const DOM_NullPtr *val)
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.
Parameters:
val. - Only a value of 0, or null, is allowed.

Destructor.

~DOM_DocumentType()
Destructor for DOM_DocumentType. The object being destroyed is the reference object, not the underlying DocumentType node itself.

Getter functions.

DOMString getName() const
The name of DTD; i.e., the name immediately following the DOCTYPE keyword in an XML source document.

DOM_NamedNodeMap getEntities() const
This function returns a NamedNodeMap containing the general entities, both external and internal, declared in the 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
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.

Functions introduced in DOM Level 2.

DOMString getPublicID() const
Get the public identifier of the external subset
Returns:
The public identifier of the external subset.

DOMString getSystemID() const
Get the system identifier of the external subset
Returns:
The system identifier of the external subset.

DOMString getInternalSubset() const
Get the internal subset as a string
Returns:
The internal subset as a string.


This class has no child classes.

alphabetic index hierarchy of classes


XML Parser for C++ 2.0
Copyright © IBM Corp, 1999
Center for Java Technology
10275 N. De Anza Blvd.
Cupertino CA 95014 USA
Email: xml4c@us.ibm.com

IBM Logo