From bd0f3345a938b35ce6a12f6150373b0955b8dd12 Mon Sep 17 00:00:00 2001 From: Timothy Pearson Date: Sun, 10 Jul 2011 15:24:15 -0500 Subject: Add Qt3 development HEAD version --- doc/html/qdomelement.html | 350 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 350 insertions(+) create mode 100644 doc/html/qdomelement.html (limited to 'doc/html/qdomelement.html') diff --git a/doc/html/qdomelement.html b/doc/html/qdomelement.html new file mode 100644 index 0000000..bbe4b0b --- /dev/null +++ b/doc/html/qdomelement.html @@ -0,0 +1,350 @@ + + + + + +QDomElement Class + + + + + + + +
+ +Home + | +All Classes + | +Main Classes + | +Annotated + | +Grouped Classes + | +Functions +

QDomElement Class Reference
[XML module]

+ +

The QDomElement class represents one element in the DOM tree. +More... +

All the functions in this class are reentrant when Qt is built with thread support.

+

#include <qdom.h> +

Inherits QDomNode. +

List of all member functions. +

Public Members

+ +

Detailed Description

+ + + +The QDomElement class represents one element in the DOM tree. + +

+ +

Elements have a tagName() and zero or more attributes associated +with them. The tag name can be changed with setTagName(). +

Element attributes are represented by QDomAttr objects that can +be queried using the attribute() and attributeNode() functions. +You can set attributes with the setAttribute() and +setAttributeNode() functions. Attributes can be removed with +removeAttribute(). There are namespace-aware equivalents to these +functions, i.e. setAttributeNS(), setAttributeNodeNS() and +removeAttributeNS(). +

If you want to access the text of a node use text(), e.g. +

+    QDomElement e = //...
+    //...
+    QString s = e.text()
+
+ +The text() function operates recursively to find the text (since +not all elements contain text). If you want to find all the text +in all of a node's children, iterate over the children looking for +QDomText nodes, e.g. +
+    QString text;
+    QDomElement element = doc.documentElement();
+    for( QDomNode n = element.firstChild(); !n.isNull(); n = n.nextSibling() )
+    {
+        QDomText t = n.toText();
+        if ( !t.isNull() )
+            text += t.data();
+    }
+
+ +Note that we attempt to convert each node to a text node and use +text() rather than using firstChild().toText().data() or +n.toText().data() directly on the node, because the node may not +be a text element. +

You can get a list of all the decendents of an element which have +a specified tag name with elementsByTagName() or +elementsByTagNameNS(). +

For further information about the Document Object Model see +http://www.w3.org/TR/REC-DOM-Level-1/ and +http://www.w3.org/TR/DOM-Level-2-Core/. +For a more general introduction of the DOM implementation see the +QDomDocument documentation. +

See also XML. + +

Member Function Documentation

+

QDomElement::QDomElement () +

+Constructs an empty element. Use the QDomDocument::createElement() +function to construct elements with content. + +

QDomElement::QDomElement ( const QDomElement & x ) +

+Constructs a copy of x. +

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(). + +

QDomElement::~QDomElement () +

+Destroys the object and frees its resources. + +

QString QDomElement::attribute ( const QString & name, const QString & defValue = QString::null ) const +

+Returns the attribute called name. If the attribute does not +exist defValue is returned. +

See also setAttribute(), attributeNode(), setAttributeNode(), and attributeNS(). + +

QString QDomElement::attributeNS ( const QString nsURI, const QString & localName, const QString & defValue ) const +

+Returns the attribute with the local name localName and the +namespace URI nsURI. If the attribute does not exist defValue is returned. +

See also setAttributeNS(), attributeNodeNS(), setAttributeNodeNS(), and attribute(). + +

QDomAttr QDomElement::attributeNode ( const QString & name ) +

+Returns the QDomAttr object that corresponds to the attribute +called name. If no such attribute exists a null attribute is returned. +

See also setAttributeNode(), attribute(), setAttribute(), and attributeNodeNS(). + +

QDomAttr QDomElement::attributeNodeNS ( const QString & nsURI, const QString & localName ) +

+Returns the QDomAttr object that corresponds to the attribute with +the local name localName and the namespace URI nsURI. If no +such attribute exists a null + attribute is returned. +

See also setAttributeNode(), attribute(), and setAttribute(). + +

QDomNamedNodeMap QDomElement::attributes () const [virtual] +

+Returns a QDomNamedNodeMap containing all this element's attributes. +

See also attribute(), setAttribute(), attributeNode(), and setAttributeNode(). + +

Reimplemented from QDomNode. +

QDomNodeList QDomElement::elementsByTagName ( const QString & tagname ) const [virtual] +

+Returns a QDomNodeList containing all descendent elements of this +element that are called tagname. The order they are in the node +list is the order they are encountered in a preorder traversal of +the element tree. +

See also elementsByTagNameNS() and QDomDocument::elementsByTagName(). + +

QDomNodeList QDomElement::elementsByTagNameNS ( const QString & nsURI, const QString & localName ) const [virtual] +

+Returns a QDomNodeList containing all the descendent elements of +this element with the local name localName and the namespace +URI nsURI. The order they are in the node list is the order +they are encountered in a preorder traversal of the element tree. +

See also elementsByTagName() and QDomDocument::elementsByTagNameNS(). + +

bool QDomElement::hasAttribute ( const QString & name ) const +

+Returns TRUE if this element has an attribute called name; +otherwise returns FALSE. + +

bool QDomElement::hasAttributeNS ( const QString & nsURI, const QString & localName ) const +

+Returns TRUE if this element has an attribute with the local name +localName and the namespace URI nsURI; otherwise returns +FALSE. + +

bool QDomElement::isElement () const [virtual] +

+Returns TRUE. + +

Reimplemented from QDomNode. +

QDomNode::NodeType QDomElement::nodeType () const [virtual] +

+Returns ElementNode. + +

Reimplemented from QDomNode. +

QDomElement & QDomElement::operator= ( const QDomElement & x ) +

+Assigns x to this DOM element. +

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(). + +

void QDomElement::removeAttribute ( const QString & name ) +

+Removes the attribute called name name from this element. +

See also setAttribute(), attribute(), and removeAttributeNS(). + +

void QDomElement::removeAttributeNS ( const QString & nsURI, const QString & localName ) +

+Removes the attribute with the local name localName and the +namespace URI nsURI from this element. +

See also setAttributeNS(), attributeNS(), and removeAttribute(). + +

QDomAttr QDomElement::removeAttributeNode ( const QDomAttr & oldAttr ) +

+Removes the attribute oldAttr from the element and returns it. +

See also attributeNode() and setAttributeNode(). + +

void QDomElement::setAttribute ( const QString & name, const QString & value ) +

+Adds an attribute called name with value value. If an +attribute with the same name exists, its value is replaced by value. +

See also attribute(), setAttributeNode(), and setAttributeNS(). + +

void QDomElement::setAttribute ( const QString & name, int value ) +

+This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +

+

void QDomElement::setAttribute ( const QString & name, uint value ) +

+This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +

+

void QDomElement::setAttribute ( const QString & name, long value ) +

+This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +

+

void QDomElement::setAttribute ( const QString & name, ulong value ) +

+This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +

+

void QDomElement::setAttribute ( const QString & name, double value ) +

+This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +

+

void QDomElement::setAttributeNS ( const QString nsURI, const QString & qName, const QString & value ) +

+Adds an attribute with the qualified name qName and the +namespace URI nsURI with the value value. If an attribute +with the same local name and namespace URI exists, its prefix is +replaced by the prefix of qName and its value is repaced by value. +

Although qName is the qualified name, the local name is used to +decide if an existing attribute's value should be replaced. +

See also attributeNS(), setAttributeNodeNS(), and setAttribute(). + +

void QDomElement::setAttributeNS ( const QString nsURI, const QString & qName, int value ) +

+This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +

+

void QDomElement::setAttributeNS ( const QString nsURI, const QString & qName, uint value ) +

+This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +

+

void QDomElement::setAttributeNS ( const QString nsURI, const QString & qName, long value ) +

+This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +

+

void QDomElement::setAttributeNS ( const QString nsURI, const QString & qName, ulong value ) +

+This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +

+

void QDomElement::setAttributeNS ( const QString nsURI, const QString & qName, double value ) +

+This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +

+

QDomAttr QDomElement::setAttributeNode ( const QDomAttr & newAttr ) +

+Adds the attribute newAttr to this element. +

If the element has another attribute that has the same name as newAttr, this function replaces that attribute and returns it; +otherwise the function returns a null + attribute. +

See also attributeNode(), setAttribute(), and setAttributeNodeNS(). + +

QDomAttr QDomElement::setAttributeNodeNS ( const QDomAttr & newAttr ) +

+Adds the attribute newAttr to this element. +

If the element has another attribute that has the same local name +and namespace URI as newAttr, this function replaces that +attribute and returns it; otherwise the function returns a null attribute. +

See also attributeNodeNS(), setAttributeNS(), and setAttributeNode(). + +

void QDomElement::setTagName ( const QString & name ) +

+Sets this element's tag name to name. +

See also tagName(). + +

QString QDomElement::tagName () const +

+Returns the tag name of this element. For an XML element like this: +
+    <img src="myimg.png">
+
+ +the tagname would return "img". +

See also setTagName(). + +

QString QDomElement::text () const +

+Returns the element's text or QString::null. +

Example: +

+    <h1>Hello <b>Qt</b> <![CDATA[<xml is cool>]]></h1>
+
+ +

The function text() of the QDomElement for the <h1> tag, +will return "Hello Qt <xml is cool>". +

Comments are ignored by this function. It only evaluates QDomText +and QDomCDATASection objects. + + +

+This file is part of the Qt toolkit. +Copyright © 1995-2007 +Trolltech. All Rights Reserved.

+ +
Copyright © 2007 +TrolltechTrademarks +
Qt 3.3.8
+
+ -- cgit v1.2.1