Syndication::ElementWrapper Class

Member Function Documentation

ElementWrapper::ElementWrapper()

Creates a element wrapper wrapping a null element. isNull() will return true for these instances.

ElementWrapper::ElementWrapper(const QDomElement &element)

Creates an element wrapper wrapping the DOM element element

element the element to wrap

ElementWrapper::ElementWrapper(const Syndication::ElementWrapper &other)

Copy constructor. The instances share the same element.

other the element wrapper to copy

QString ElementWrapper::attribute(const QString &name, const QString &defValue = QString()) const

Returns the attribute called name.

If the attribute does not exist defValue is returned. (which is a null string by default).

name tag name

defValue the default value

QString ElementWrapper::attributeNS(const QString &nsURI, const QString &localName, const QString &defValue = QString()) const

Returns the attribute with the local name localName and the namespace URI nsURI.

If the attribute does not exist defValue is returned (which is a null string by default).

nsURI namespace URI

localName local tag name

defValue the default value

QString ElementWrapper::childNodesAsXML() const

Returns the child nodes of the wrapped element as XML.

See childNodesAsXML(const QDomElement& parent) for details

Returns XML serialization of the wrapped element's children

[static] QString ElementWrapper::childNodesAsXML(const QDomElement &parent)

Concatenates the XML representations of all children.

Example: If parent is an xhtml:body element like

<xhtml:body><p>foo</p><blockquote>bar</blockquote></xhtml:body>

this function returns

<p>foo</p><blockquote>bar</blockquote>

namespace and xml:base information are preserved.

parent the DOM element whose children should be returned as XML

Returns XML serialization of parent's children

QString ElementWrapper::completeURI(const QString &uri) const

Completes relative URIs with a prefix specified via xml:base.

Example:

xml:base="http://www.foo.org/", uri="announcements/bar.html"

is completed to http://www.foo.org/announcements/bar.html

See also xmlBase().

uri a possibly relative URI

Returns the resolved, absolute URI (using xml:base), if uri is a relative, valid URI.

If uri is not valid, absolute, or no xml:base is set in the scope of this element, uri is returned unmodified.

const QDomElement &ElementWrapper::element() const

returns the wrapped resource.

QList<QDomElement> ElementWrapper::elementsByTagName(const QString &tagName) const

Returns all child elements with tag name tagName

Contrary to QDomElement::elementsByTagName() only direct descendents are returned.

tagName the tag name of the elements to extract

Returns a list of child elements with the given tag name

QList<QDomElement> ElementWrapper::elementsByTagNameNS(const QString &nsURI, const QString &tagName) const

Returns all child elements with tag name tagName and namespace URI nsURI.

Contrary to QDomElement::elementsByTagNameNS() only direct descendents are returned

nsURI the namespace URI

tagName the local name (local within its namespace) of the element to search for

Returns a list of child elements with the given namespace URI and tag name

QString ElementWrapper::extractElementText(const QString &tagName) const

Extracts the text from a child element, ignoring namespaces. For instance, when the wrapped element is <thisElement>:

<thisElement>
    <title>Hi there</title>
</thisElement>

extractElementText("title") will return the text content of title, "Hi there".

tagName the name of the element to extract

Returns the (trimmed) text content of tagName, or a null string if there is no such tag

QString ElementWrapper::extractElementTextNS(const QString &namespaceURI, const QString &localName) const

Extracts the text from a child element, respecting namespaces. If there is more than one child with the same tag name, the first one is processed.

For instance, when the wrapped element is <thisElement>:

<thisElement>
    <atom:title>Hi there</atom:title>
</thisElement>

extractElementText("http://www.w3.org/2005/Atom", "title")

will return the text content of atom:title, "Hi there". (Assuming that "atom" is defined as "http://www.w3.org/2005/Atom")

namespaceURI the namespace URI of the element to extract

localName the local name (local within its namespace) of the element to extract

Returns the (trimmed) text content of localName, or a null string if there is no such tag

QDomElement ElementWrapper::firstElementByTagNameNS(const QString &nsURI, const QString &tagName) const

Searches the direct children of the wrapped element for an element with a given namespace and tag name.

nsURI the namespace URI

tagName the local name (local within its namespace) of the element to search for

Returns the first child element with the given namespace URI and tag name, or a null element if no such element was found.

bool ElementWrapper::hasAttribute(const QString &name) const

Returns true if this element has an attribute called name; otherwise returns false.

name the attribute name (without namespace)

bool ElementWrapper::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.

nsURI namespace URI

localName local attribute name

bool ElementWrapper::isNull() const

Returns true if isNull() is true for the wrapped element, false otherwise

QString ElementWrapper::text() const

Returns the wrapped element's text or an empty string.

For more information, see QDomElement::text();

QString ElementWrapper::xmlBase() const

Returns the xml:base value to be used for the wrapped element.

The xml:base attribute establishes the base URI for resolving any relative references found in its scope (its own element and all descendants). (See also completeURI())

QString ElementWrapper::xmlLang() const

Returns the xml:lang value to be used for the wrapped element.

The xml:lang attribute indicates the natural language for its element and all descendants.

Syndication::ElementWrapper &ElementWrapper::operator=(const Syndication::ElementWrapper &other)

Assigns another element wrapper to this one. Both instances share the same wrapped element instance.

other the element wrapper to assign

Returns reference to this instance

bool ElementWrapper::operator==(const Syndication::ElementWrapper &other) const

Compares two wrappers.

Two wrappers are equal if and only if the wrapped elements are equal.

other another element wrapper to compare to