Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
QDomDocumentType Class Reference

\reentrant More...

#include <qdom.h>

+ Inheritance diagram for QDomDocumentType:
+ Collaboration diagram for QDomDocumentType:

Public Member Functions

 QDomDocumentType ()
 Creates an empty QDomDocumentType object.
 
 QDomDocumentType (const QDomDocumentType &documentType)
 Constructs a copy of documentType.
 
QDomDocumentTypeoperator= (const QDomDocumentType &other)
 Assigns other to this document type.
 
QString name () const
 Returns the name of the document type as specified in the <!DOCTYPE name> tag.
 
QDomNamedNodeMap entities () const
 Returns a map of all entities described in the DTD.
 
QDomNamedNodeMap notations () const
 Returns a map of all notations described in the DTD.
 
QString publicId () const
 Returns the public identifier of the external DTD subset or an empty string if there is no public identifier.
 
QString systemId () const
 Returns the system identifier of the external DTD subset or an empty string if there is no system identifier.
 
QString internalSubset () const
 Returns the internal subset of the document type or an empty string if there is no internal subset.
 
QDomNode::NodeType nodeType () const
 Returns DocumentTypeNode.
 
- Public Member Functions inherited from QDomNode
 QDomNode ()
 Constructs a \l{isNull()}{null} node.
 
 QDomNode (const QDomNode &node)
 Constructs a copy of node.
 
QDomNodeoperator= (const QDomNode &other)
 Assigns a copy of other to this DOM node.
 
bool operator== (const QDomNode &other) const
 Returns true if other and this DOM node are equal; otherwise returns false.
 
bool operator!= (const QDomNode &other) const
 Returns true if other and this DOM node are not equal; otherwise returns false.
 
 ~QDomNode ()
 Destroys the object and frees its resources.
 
QDomNode insertBefore (const QDomNode &newChild, const QDomNode &refChild)
 Inserts the node newChild before the child node refChild.
 
QDomNode insertAfter (const QDomNode &newChild, const QDomNode &refChild)
 Inserts the node newChild after the child node refChild.
 
QDomNode replaceChild (const QDomNode &newChild, const QDomNode &oldChild)
 Replaces oldChild with newChild.
 
QDomNode removeChild (const QDomNode &oldChild)
 Removes oldChild from the list of children.
 
QDomNode appendChild (const QDomNode &newChild)
 Appends newChild as the node's last child.
 
bool hasChildNodes () const
 Returns true if the node has one or more children; otherwise returns false.
 
QDomNode cloneNode (bool deep=true) const
 Creates a deep (not shallow) copy of the QDomNode.
 
void normalize ()
 Calling normalize() on an element converts all its children into a standard form.
 
bool isSupported (const QString &feature, const QString &version) const
 Returns true if the DOM implementation implements the feature feature and this feature is supported by this node in the version version; otherwise returns false.
 
QString nodeName () const
 Returns the name of the node.
 
NodeType nodeType () const
 Returns the type of the node.
 
QDomNode parentNode () const
 Returns the parent node.
 
QDomNodeList childNodes () const
 Returns a list of all direct child nodes.
 
QDomNode firstChild () const
 Returns the first child of the node.
 
QDomNode lastChild () const
 Returns the last child of the node.
 
QDomNode previousSibling () const
 Returns the previous sibling in the document tree.
 
QDomNode nextSibling () const
 Returns the next sibling in the document tree.
 
QDomNamedNodeMap attributes () const
 Returns a named node map of all attributes.
 
QDomDocument ownerDocument () const
 Returns the document to which this node belongs.
 
QString namespaceURI () const
 Returns the namespace URI of this node or an empty string if the node has no namespace URI.
 
QString localName () const
 If the node uses namespaces, this function returns the local name of the node; otherwise it returns an empty string.
 
bool hasAttributes () const
 Returns true if the node has attributes; otherwise returns false.
 
QString nodeValue () const
 Returns the value of the node.
 
void setNodeValue (const QString &value)
 Sets the node's value to value.
 
QString prefix () const
 Returns the namespace prefix of the node or an empty string if the node has no namespace prefix.
 
void setPrefix (const QString &pre)
 If the node has a namespace prefix, this function changes the namespace prefix of the node to pre.
 
bool isAttr () const
 Returns true if the node is an attribute; otherwise returns false.
 
bool isCDATASection () const
 Returns true if the node is a CDATA section; otherwise returns false.
 
bool isDocumentFragment () const
 Returns true if the node is a document fragment; otherwise returns false.
 
bool isDocument () const
 Returns true if the node is a document; otherwise returns false.
 
bool isDocumentType () const
 Returns true if the node is a document type; otherwise returns false.
 
bool isElement () const
 Returns true if the node is an element; otherwise returns false.
 
bool isEntityReference () const
 Returns true if the node is an entity reference; otherwise returns false.
 
bool isText () const
 Returns true if the node is a text node; otherwise returns false.
 
bool isEntity () const
 Returns true if the node is an entity; otherwise returns false.
 
bool isNotation () const
 Returns true if the node is a notation; otherwise returns false.
 
bool isProcessingInstruction () const
 Returns true if the node is a processing instruction; otherwise returns false.
 
bool isCharacterData () const
 Returns true if the node is a character data node; otherwise returns false.
 
bool isComment () const
 Returns true if the node is a comment; otherwise returns false.
 
QDomNode namedItem (const QString &name) const
 Returns the first direct child node for which nodeName() equals name.
 
bool isNull () const
 Returns true if this node is null (i.e.
 
void clear ()
 Converts the node into a null node; if it was not a null node before, its type and contents are deleted.
 
QDomAttr toAttr () const
 Converts a QDomNode into a QDomAttr.
 
QDomCDATASection toCDATASection () const
 Converts a QDomNode into a QDomCDATASection.
 
QDomDocumentFragment toDocumentFragment () const
 Converts a QDomNode into a QDomDocumentFragment.
 
QDomDocument toDocument () const
 Converts a QDomNode into a QDomDocument.
 
QDomDocumentType toDocumentType () const
 Converts a QDomNode into a QDomDocumentType.
 
QDomElement toElement () const
 Converts a QDomNode into a QDomElement.
 
QDomEntityReference toEntityReference () const
 Converts a QDomNode into a QDomEntityReference.
 
QDomText toText () const
 Converts a QDomNode into a QDomText.
 
QDomEntity toEntity () const
 Converts a QDomNode into a QDomEntity.
 
QDomNotation toNotation () const
 Converts a QDomNode into a QDomNotation.
 
QDomProcessingInstruction toProcessingInstruction () const
 Converts a QDomNode into a QDomProcessingInstruction.
 
QDomCharacterData toCharacterData () const
 Converts a QDomNode into a QDomCharacterData.
 
QDomComment toComment () const
 Converts a QDomNode into a QDomComment.
 
void save (QTextStream &, int, EncodingPolicy=QDomNode::EncodingFromDocument) const
 Writes the XML representation of the node and all its children to the stream stream.
 
QDomElement firstChildElement (const QString &tagName=QString(), const QString &namespaceURI=QString()) const
 Returns the first child element with tag name tagName and namespace URI namespaceURI.
 
QDomElement lastChildElement (const QString &tagName=QString(), const QString &namespaceURI=QString()) const
 Returns the last child element with tag name tagName and namespace URI namespaceURI.
 
QDomElement previousSiblingElement (const QString &tagName=QString(), const QString &namespaceURI=QString()) const
 Returns the previous sibling element with tag name tagName and namespace URI namespaceURI.
 
QDomElement nextSiblingElement (const QString &taName=QString(), const QString &namespaceURI=QString()) const
 Returns the next sibling element with tag name tagName and namespace URI namespaceURI.
 
int lineNumber () const
 
int columnNumber () const
 

Friends

class QDomImplementation
 
class QDomDocument
 
class QDomNode
 

Additional Inherited Members

- Public Types inherited from QDomNode
enum  NodeType {
  ElementNode = 1 , AttributeNode = 2 , TextNode = 3 , CDATASectionNode = 4 ,
  EntityReferenceNode = 5 , EntityNode = 6 , ProcessingInstructionNode = 7 , CommentNode = 8 ,
  DocumentNode = 9 , DocumentTypeNode = 10 , DocumentFragmentNode = 11 , NotationNode = 12 ,
  BaseNode = 21 , CharacterDataNode = 22
}
 This enum defines the type of the node: \value ElementNode \value AttributeNode \value TextNode \value CDATASectionNode \value EntityReferenceNode \value EntityNode \value ProcessingInstructionNode \value CommentNode \value DocumentNode \value DocumentTypeNode \value DocumentFragmentNode \value NotationNode \value BaseNode A QDomNode object, i.e. More...
 
enum  EncodingPolicy { EncodingFromDocument = 1 , EncodingFromTextStream = 2 }
 
- Protected Member Functions inherited from QDomNode
 QDomNode (QDomNodePrivate *)
 
- Protected Attributes inherited from QDomNode
QDomNodePrivateimpl
 

Detailed Description

\reentrant

The QDomDocumentType class is the representation of the DTD in the document tree.

\inmodule QtXml

The QDomDocumentType class allows read-only access to some of the data structures in the DTD: it can return a map of all entities() and notations(). In addition the function name() returns the name of the document type as specified in the <!DOCTYPE name> tag. This class also provides the publicId(), systemId() and internalSubset() functions.

See also
QDomDocument

Definition at line 242 of file qdom.h.

Constructor & Destructor Documentation

◆ QDomDocumentType() [1/2]

QDomDocumentType::QDomDocumentType ( )

Creates an empty QDomDocumentType object.

Definition at line 3114 of file qdom.cpp.

◆ QDomDocumentType() [2/2]

QDomDocumentType::QDomDocumentType ( const QDomDocumentType & documentType)

Constructs a copy of documentType.

The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode().

Definition at line 3125 of file qdom.cpp.

Member Function Documentation

◆ entities()

QDomNamedNodeMap QDomDocumentType::entities ( ) const

Returns a map of all entities described in the DTD.

Definition at line 3159 of file qdom.cpp.

References IMPL, QDomNode::impl, and QDomNode::QDomNamedNodeMap.

◆ internalSubset()

QString QDomDocumentType::internalSubset ( ) const

Returns the internal subset of the document type or an empty string if there is no internal subset.

See also
publicId(), systemId()

Definition at line 3208 of file qdom.cpp.

References IMPL, and QDomNode::impl.

◆ name()

QString QDomDocumentType::name ( ) const

Returns the name of the document type as specified in the <!DOCTYPE name> tag.

See also
nodeName()

Definition at line 3149 of file qdom.cpp.

References IMPL, and QDomNode::impl.

◆ nodeType()

QDomNode::NodeType QDomDocumentType::nodeType ( ) const
inline

Returns DocumentTypeNode.

See also
isDocumentType(), QDomNode::toDocumentType()

Definition at line 258 of file qdom.h.

◆ notations()

QDomNamedNodeMap QDomDocumentType::notations ( ) const

Returns a map of all notations described in the DTD.

Definition at line 3169 of file qdom.cpp.

References IMPL, QDomNode::impl, and QDomNode::QDomNamedNodeMap.

◆ operator=()

QDomDocumentType & QDomDocumentType::operator= ( const QDomDocumentType & other)
default

Assigns other to this document type.

The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode().

◆ publicId()

QString QDomDocumentType::publicId ( ) const

Returns the public identifier of the external DTD subset or an empty string if there is no public identifier.

See also
systemId(), internalSubset(), QDomImplementation::createDocumentType()

Definition at line 3182 of file qdom.cpp.

References IMPL, and QDomNode::impl.

◆ systemId()

QString QDomDocumentType::systemId ( ) const

Returns the system identifier of the external DTD subset or an empty string if there is no system identifier.

See also
publicId(), internalSubset(), QDomImplementation::createDocumentType()

Definition at line 3195 of file qdom.cpp.

References IMPL, and QDomNode::impl.

Friends And Related Symbol Documentation

◆ QDomDocument

friend class QDomDocument
friend

Definition at line 264 of file qdom.h.

◆ QDomImplementation

friend class QDomImplementation
friend

Definition at line 263 of file qdom.h.

◆ QDomNode

friend class QDomNode
friend

Definition at line 265 of file qdom.h.


The documentation for this class was generated from the following files: