PySide6.QtXml.QDomProcessingInstruction¶

class QDomProcessingInstruction¶

The QDomProcessingInstruction class represents an XML processing instruction.

Details

Processing instructions are used in XML to keep processor-specific information in the text of the document.

The XML declaration that appears at the top of an XML document, typically <?xml version='1.0' encoding='UTF-8'?>, is treated by QDom as a processing instruction. This is unfortunate, since the XML declaration is not a processing instruction; among other differences, it cannot be inserted into a document anywhere but on the first line.

Note

Do not use this function to create an XML declaration. Although the XML declaration shares the same syntax as a processing instruction, it is not one. According to the XML 1.0 Specification and the W3C DOM Structure Model , the XML declaration is part of the document prolog and not part of the DOM tree - meaning it should not be represented as a DOM node and cannot be created or inserted via the DOM API. If you need to generate a well-formed XML document that includes an XML declaration, use QXmlStreamWriter, which provides proper support for writing the declaration through writeStartDocument.

The content of the processing instruction is retrieved with data() and set with setData() . The processing instruction’s target is retrieved with target() .

For further information about the Document Object Model see Level 1 and Level 2 Core . For a more general introduction of the DOM implementation see the QDomDocument documentation.

Synopsis¶

Methods¶

def __init__()
def data()
def setData()
def target()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

__init__()¶

Constructs an empty processing instruction. Use createProcessingInstruction() to create a processing instruction with content.

__init__(processingInstruction)

Parameters:: processingInstruction – QDomProcessingInstruction

Constructs a copy of processingInstruction.

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

data()¶

Return type:: str

Returns the content of this processing instruction.

See also

setData() target()

setData(data)¶

Parameters:: data – str

Sets the data contained in the processing instruction to data.

See also

data()

target()¶

Return type:: str

Returns the target of this processing instruction.

See also

data()