QWebElement

Inheritance diagram of QWebElement

Note

This class was introduced in Qt 4.6

Synopsis

Functions

Detailed Description

The PySide.QtWebKit.QWebElement class provides convenient access to DOM elements in a PySide.QtWebKit.QWebFrame .

A PySide.QtWebKit.QWebElement object allows easy access to the document model, represented by a tree-like structure of DOM elements. The root of the tree is called the document element and can be accessed using QWebFrame.documentElement() .

Specific elements can be accessed using PySide.QtWebKit.QWebElement.findAll() and PySide.QtWebKit.QWebElement.findFirst() . These elements are identified using CSS selectors. The code snippet below demonstrates the use of PySide.QtWebKit.QWebElement.findAll() .

document = frame.documentElement()
# Assume the document has the following structure:
#
#   <p class=intro>
#     <span>Intro</span>
#     <span>Snippets</span>
#   </p>
#   <p>
#     <span>Content</span>
#     <span>Here</span>
#   </p>


allSpans = document.findAll("span")
introSpans = document.findAll("p.intro span")

The first list contains all span elements in the document. The second list contains span elements that are children of p , classified with intro .

Using PySide.QtWebKit.QWebElement.findFirst() is more efficient than calling PySide.QtWebKit.QWebElement.findAll() , and extracting the first element only in the list returned.

Alternatively you can traverse the document manually using PySide.QtWebKit.QWebElement.firstChild() and PySide.QtWebKit.QWebElement.nextSibling() :

frame.setHtml("<html><body><p>First Paragraph</p><p>Second Paragraph</p></body></html>")
doc = frame.documentElement()
body = doc.firstChild()
firstParagraph = body.firstChild()
secondParagraph = firstParagraph.nextSibling()

Individual elements can be inspected or changed using methods such as PySide.QtWebKit.QWebElement.attribute() or PySide.QtWebKit.QWebElement.setAttribute() . For examle, to capture the user’s input in a text field for later use (auto-completion), a browser could do something like this:

firstTextInput = document.findFirst("input[type=text]")
storedText = firstTextInput.attribute("value")

When the same page is later revisited, the browser can fill in the text field automatically by modifying the value attribute of the input element:

firstTextInput = document.findFirst("input[type=text]")
textInput.setAttribute("value", storedText)

Another use case is to emulate a click event on an element. The following code snippet demonstrates how to call the JavaScript DOM method click() of a submit button:

document = frame.documentElement()
# Assume that the document has the following structure:
#
#    <form name="myform" action="submit_form.asp" method="get">
#        <input type="text" name="myfield">
#        <input type="submit" value="Submit">
#    </form>

button = document.findFirst("input[type=submit]")
button.evaluateJavaScript("click()")

The underlying content of PySide.QtWebKit.QWebElement is explicitly shared. Creating a copy of a PySide.QtWebKit.QWebElement does not create a copy of the content. Instead, both instances point to the same element.

The contents of child elements can be converted to plain text with PySide.QtWebKit.QWebElement.toPlainText() ; to XHTML using PySide.QtWebKit.QWebElement.toInnerXml() . To include the element’s tag in the output, use PySide.QtWebKit.QWebElement.toOuterXml() .

It is possible to replace the contents of child elements using PySide.QtWebKit.QWebElement.setPlainText() and PySide.QtWebKit.QWebElement.setInnerXml() . To replace the element itself and its contents, use PySide.QtWebKit.QWebElement.setOuterXml() .

Examples

The DOM Traversal Example shows one way to traverse documents in a running example.

The Simple Selector Example can be used to experiment with the searching features of this class and provides sample code you can start working with.

class PySide.QtWebKit.QWebElement
class PySide.QtWebKit.QWebElement(arg__1)
Parameters:arg__1PySide.QtWebKit.QWebElement

Constructs a null web element.

Constructs a copy of other .

PySide.QtWebKit.QWebElement.StyleResolveStrategy

This enum describes how PySide.QtWebKit.QWebElement ‘s styleProperty resolves the given property name.

Constant Description
QWebElement.InlineStyle Return the property value as it is defined in the element, without respecting style inheritance and other CSS rules.
QWebElement.CascadedStyle The property’s value is determined using the inheritance and importance rules defined in the document’s stylesheet.
QWebElement.ComputedStyle The property’s value is the absolute value of the style property resolved from the environment.
PySide.QtWebKit.QWebElement.addClass(name)
Parameters:name – unicode

Adds the specified class with the given name to the element.

PySide.QtWebKit.QWebElement.appendInside(element)
Parameters:elementPySide.QtWebKit.QWebElement

Appends the given element as the element’s last child.

If element is the child of another element, it is re-parented to this element. If element is a child of this element, then its position in the list of children is changed.

Calling this function on a null element does nothing.

PySide.QtWebKit.QWebElement.appendInside(markup)
Parameters:markup – unicode

Appends the result of parsing markup as the element’s last child.

Calling this function on a null element does nothing.

PySide.QtWebKit.QWebElement.appendOutside(markup)
Parameters:markup – unicode

Inserts the result of parsing markup after this element.

Calling this function on a null element does nothing.

PySide.QtWebKit.QWebElement.appendOutside(element)
Parameters:elementPySide.QtWebKit.QWebElement

Inserts the given element after this element.

If element is the child of another element, it is re-parented to the parent of this element.

Calling this function on a null element does nothing.

PySide.QtWebKit.QWebElement.attribute(name[, defaultValue=""])
Parameters:
  • name – unicode
  • defaultValue – unicode
Return type:

unicode

Returns the attribute with the given name . If the attribute does not exist, defaultValue is returned.

PySide.QtWebKit.QWebElement.attributeNS(namespaceUri, name[, defaultValue=""])
Parameters:
  • namespaceUri – unicode
  • name – unicode
  • defaultValue – unicode
Return type:

unicode

Returns the attribute with the given name in namespaceUri . If the attribute does not exist, defaultValue is returned.

PySide.QtWebKit.QWebElement.attributeNames([namespaceUri=""])
Parameters:namespaceUri – unicode
Return type:list of strings

Return the list of attributes for the namespace given as namespaceUri .

PySide.QtWebKit.QWebElement.classes()
Return type:list of strings

Returns the list of classes of this element.

PySide.QtWebKit.QWebElement.clone()
Return type:PySide.QtWebKit.QWebElement

Returns a clone of this element.

The clone may be inserted at any point in the document.

PySide.QtWebKit.QWebElement.document()
Return type:PySide.QtWebKit.QWebElement

Returns the document which this element belongs to.

PySide.QtWebKit.QWebElement.encloseContentsWith(markup)
Parameters:markup – unicode

Encloses the contents of this element with the result of parsing markup . This element becomes the child of the deepest descendant within markup .

PySide.QtWebKit.QWebElement.encloseContentsWith(element)
Parameters:elementPySide.QtWebKit.QWebElement

Encloses the contents of this element with element . This element becomes the child of the deepest descendant within element .

### illustration

PySide.QtWebKit.QWebElement.encloseWith(element)
Parameters:elementPySide.QtWebKit.QWebElement

Encloses this element with element . This element becomes the child of the deepest descendant within element .

PySide.QtWebKit.QWebElement.encloseWith(markup)
Parameters:markup – unicode

Encloses this element with the result of parsing markup . This element becomes the child of the deepest descendant within markup .

PySide.QtWebKit.QWebElement.evaluateJavaScript(scriptSource)
Parameters:scriptSource – unicode
Return type:object

Executes scriptSource with this element as this object.

PySide.QtWebKit.QWebElement.findAll(selectorQuery)
Parameters:selectorQuery – unicode
Return type:PySide.QtWebKit.QWebElementCollection

Returns a new list of child elements matching the given CSS selector selectorQuery . If there are no matching elements, an empty list is returned.

Standard CSS2 selector syntax is used for the query.

Note

This search is performed recursively.

PySide.QtWebKit.QWebElement.findFirst(selectorQuery)
Parameters:selectorQuery – unicode
Return type:PySide.QtWebKit.QWebElement

Returns the first child element that matches the given CSS selector selectorQuery .

Standard CSS2 selector syntax is used for the query.

Note

This search is performed recursively.

PySide.QtWebKit.QWebElement.firstChild()
Return type:PySide.QtWebKit.QWebElement

Returns the element’s first child.

PySide.QtWebKit.QWebElement.geometry()
Return type:PySide.QtCore.QRect

Returns the geometry of this element, relative to its containing frame.

PySide.QtWebKit.QWebElement.hasAttribute(name)
Parameters:name – unicode
Return type:PySide.QtCore.bool

Returns true if this element has an attribute with the given name ; otherwise returns false.

PySide.QtWebKit.QWebElement.hasAttributeNS(namespaceUri, name)
Parameters:
  • namespaceUri – unicode
  • name – unicode
Return type:

PySide.QtCore.bool

Returns true if this element has an attribute with the given name , in namespaceUri ; otherwise returns false.

PySide.QtWebKit.QWebElement.hasAttributes()
Return type:PySide.QtCore.bool

Returns true if the element has any attributes defined; otherwise returns false;

PySide.QtWebKit.QWebElement.hasClass(name)
Parameters:name – unicode
Return type:PySide.QtCore.bool

Returns true if this element has a class with the given name ; otherwise returns false.

PySide.QtWebKit.QWebElement.hasFocus()
Return type:PySide.QtCore.bool

Returns true if the element has keyboard input focus; otherwise, returns false

PySide.QtWebKit.QWebElement.isNull()
Return type:PySide.QtCore.bool

Returns true if the element is a null element; otherwise returns false.

PySide.QtWebKit.QWebElement.lastChild()
Return type:PySide.QtWebKit.QWebElement

Returns the element’s last child.

PySide.QtWebKit.QWebElement.localName()
Return type:unicode

Returns the local name of the element. If the element does not use namespaces, an empty string is returned.

PySide.QtWebKit.QWebElement.namespaceUri()
Return type:unicode

Returns the namespace URI of this element. If the element has no namespace URI, an empty string is returned.

PySide.QtWebKit.QWebElement.nextSibling()
Return type:PySide.QtWebKit.QWebElement

Returns the element’s next sibling.

PySide.QtWebKit.QWebElement.__ne__(o)
Parameters:oPySide.QtWebKit.QWebElement
Return type:PySide.QtCore.bool

Returns true if this element points to a different underlying DOM object than o ; otherwise returns false.

PySide.QtWebKit.QWebElement.__eq__(o)
Parameters:oPySide.QtWebKit.QWebElement
Return type:PySide.QtCore.bool

Returns true if this element points to the same underlying DOM object as o ; otherwise returns false.

PySide.QtWebKit.QWebElement.parent()
Return type:PySide.QtWebKit.QWebElement

Returns the parent element of this elemen. If this element is the root document element, a null element is returned.

PySide.QtWebKit.QWebElement.prefix()
Return type:unicode

Returns the namespace prefix of the element. If the element has no namespace prefix, empty string is returned.

PySide.QtWebKit.QWebElement.prependInside(element)
Parameters:elementPySide.QtWebKit.QWebElement

Prepends element as the element’s first child.

If element is the child of another element, it is re-parented to this element. If element is a child of this element, then its position in the list of children is changed.

Calling this function on a null element does nothing.

PySide.QtWebKit.QWebElement.prependInside(markup)
Parameters:markup – unicode

Prepends the result of parsing markup as the element’s first child.

Calling this function on a null element does nothing.

PySide.QtWebKit.QWebElement.prependOutside(markup)
Parameters:markup – unicode

Inserts the result of parsing markup before this element.

Calling this function on a null element does nothing.

PySide.QtWebKit.QWebElement.prependOutside(element)
Parameters:elementPySide.QtWebKit.QWebElement

Inserts the given element before this element.

If element is the child of another element, it is re-parented to the parent of this element.

Calling this function on a null element does nothing.

PySide.QtWebKit.QWebElement.previousSibling()
Return type:PySide.QtWebKit.QWebElement

Returns the element’s previous sibling.

PySide.QtWebKit.QWebElement.removeAllChildren()

Removes all children from this element.

PySide.QtWebKit.QWebElement.removeAttribute(name)
Parameters:name – unicode

Removes the attribute with the given name from this element.

PySide.QtWebKit.QWebElement.removeAttributeNS(namespaceUri, name)
Parameters:
  • namespaceUri – unicode
  • name – unicode

Removes the attribute with the given name , in namespaceUri , from this element.

PySide.QtWebKit.QWebElement.removeClass(name)
Parameters:name – unicode

Removes the specified class with the given name from the element.

PySide.QtWebKit.QWebElement.removeFromDocument()

Removes this element from the document and makes it a null element.

PySide.QtWebKit.QWebElement.render(painter)
Parameters:painterPySide.QtGui.QPainter

Render the element into painter .

PySide.QtWebKit.QWebElement.render(painter, clipRect)
Parameters:
PySide.QtWebKit.QWebElement.replace(element)
Parameters:elementPySide.QtWebKit.QWebElement

Replaces this element with element .

This method will not replace the <html>, <head> or <body> elements.

PySide.QtWebKit.QWebElement.replace(markup)
Parameters:markup – unicode

Replaces this element with the result of parsing markup .

This method will not replace the <html>, <head> or <body> elements.

PySide.QtWebKit.QWebElement.setAttribute(name, value)
Parameters:
  • name – unicode
  • value – unicode

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

PySide.QtWebKit.QWebElement.setAttributeNS(namespaceUri, name, value)
Parameters:
  • namespaceUri – unicode
  • name – unicode
  • value – unicode

Adds an attribute with the given name in namespaceUri with value . If an attribute with the same name exists, its value is replaced by value .

PySide.QtWebKit.QWebElement.setFocus()

Gives keyboard input focus to this element

PySide.QtWebKit.QWebElement.setInnerXml(markup)
Parameters:markup – unicode

Replaces the contents of this element with markup . The string may contain HTML or XML tags, which is parsed and formatted before insertion into the document.

Note

This is currently implemented for (X)HTML elements only.

PySide.QtWebKit.QWebElement.setOuterXml(markup)
Parameters:markup – unicode

Replaces the contents of this element as well as its own tag with markup . The string may contain HTML or XML tags, which is parsed and formatted before insertion into the document.

Note

This is currently only implemented for (X)HTML elements.

PySide.QtWebKit.QWebElement.setPlainText(text)
Parameters:text – unicode

Replaces the existing content of this element with text .

This is equivalent to setting the HTML innerText property.

PySide.QtWebKit.QWebElement.setStyleProperty(name, value)
Parameters:
  • name – unicode
  • value – unicode

Sets the value of the inline style with the given name to value .

Setting a value, does not necessarily mean that it will become the applied value, due to the fact that the style property’s value might have been set earlier with a higher priority in external or embedded style declarations.

In order to ensure that the value will be applied, you may have to append ”!important” to the value.

PySide.QtWebKit.QWebElement.styleProperty(name, strategy)
Parameters:
Return type:

unicode

Returns the value of the style with the given name using the specified strategy . If a style with name does not exist, an empty string is returned.

In CSS, the cascading part depends on which CSS rule has priority and is thus applied. Generally, the last defined rule has priority. Thus, an inline style rule has priority over an embedded block style rule, which in return has priority over an external style rule.

If the ”!important” declaration is set on one of those, the declaration receives highest priority, unless other declarations also use the ”!important” declaration. Then, the last ”!important” declaration takes predecence.

PySide.QtWebKit.QWebElement.tagName()
Return type:unicode

Returns the tag name of this element.

PySide.QtWebKit.QWebElement.takeFromDocument()
Return type:PySide.QtWebKit.QWebElement

Removes this element from the document and returns a reference to it.

The element is still valid after removal, and can be inserted into other parts of the document.

PySide.QtWebKit.QWebElement.toInnerXml()
Return type:unicode

Returns the XML content between the element’s start and end tags.

Note

This is currently implemented for (X)HTML elements only.

PySide.QtWebKit.QWebElement.toOuterXml()
Return type:unicode

Returns this element converted to XML, including the start and the end tags as well as its attributes.

Note

This is currently implemented for (X)HTML elements only.

PySide.QtWebKit.QWebElement.toPlainText()
Return type:unicode

Returns the text between the start and the end tag of this element.

This is equivalent to reading the HTML innerText property.

PySide.QtWebKit.QWebElement.toggleClass(name)
Parameters:name – unicode

Adds the specified class with the given name if it is not present. If the class is already present, it will be removed.

PySide.QtWebKit.QWebElement.webFrame()
Return type:PySide.QtWebKit.QWebFrame

Returns the web frame which this element is a part of. If the element is a null element, null is returned.