API reference - Class QDomDocument

_assign

Signature: void _assign (const QDomDocument other)

Description: Assigns another object to self

_const_cast

Signature: [const] QDomDocument ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

assign

Signature: QDomDocument assign (const QDomDocument arg1)

Description: Method QDomDocument &QDomDocument::operator=(const QDomDocument &)

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

createAttribute

Signature: QDomAttr createAttribute (string name)

Description: Method QDomAttr QDomDocument::createAttribute(const QString &name)

createAttributeNS

Signature: QDomAttr createAttributeNS (string nsURI, string qName)

Description: Method QDomAttr QDomDocument::createAttributeNS(const QString &nsURI, const QString &qName)

createCDATASection

Signature: QDomCDATASection createCDATASection (string data)

Description: Method QDomCDATASection QDomDocument::createCDATASection(const QString &data)

createComment

Signature: QDomComment createComment (string data)

Description: Method QDomComment QDomDocument::createComment(const QString &data)

createDocumentFragment

Signature: QDomDocumentFragment createDocumentFragment

Description: Method QDomDocumentFragment QDomDocument::createDocumentFragment()

createElement

Signature: QDomElement createElement (string tagName)

Description: Method QDomElement QDomDocument::createElement(const QString &tagName)

createElementNS

Signature: QDomElement createElementNS (string nsURI, string qName)

Description: Method QDomElement QDomDocument::createElementNS(const QString &nsURI, const QString &qName)

createEntityReference

Signature: QDomEntityReference createEntityReference (string name)

Description: Method QDomEntityReference QDomDocument::createEntityReference(const QString &name)

createProcessingInstruction

Signature: QDomProcessingInstruction createProcessingInstruction (string target, string data)

Description: Method QDomProcessingInstruction QDomDocument::createProcessingInstruction(const QString &target, const QString &data)

createTextNode

Signature: QDomText createTextNode (string data)

Description: Method QDomText QDomDocument::createTextNode(const QString &data)

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

destroyed?

Signature: [const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

doctype

Signature: [const] QDomDocumentType doctype

Description: Method QDomDocumentType QDomDocument::doctype()

documentElement

Signature: [const] QDomElement documentElement

Description: Method QDomElement QDomDocument::documentElement()

dup

Signature: [const] new QDomDocument ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__' and '__deepcopy__'.

elementById

Signature: QDomElement elementById (string elementId)

Description: Method QDomElement QDomDocument::elementById(const QString &elementId)

elementsByTagName

Signature: [const] QDomNodeList elementsByTagName (string tagname)

Description: Method QDomNodeList QDomDocument::elementsByTagName(const QString &tagname)

elementsByTagNameNS

Signature: QDomNodeList elementsByTagNameNS (string nsURI, string localName)

Description: Method QDomNodeList QDomDocument::elementsByTagNameNS(const QString &nsURI, const QString &localName)

implementation

Signature: [const] QDomImplementation implementation

Description: Method QDomImplementation QDomDocument::implementation()

importNode

Signature: QDomNode importNode (const QDomNode importedNode, bool deep)

Description: Method QDomNode QDomDocument::importNode(const QDomNode &importedNode, bool deep)

is_const_object?

Signature: [const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

Use of this method is deprecated. Use _is_const_object? instead

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

new

(1) Signature: [static] new QDomDocument new

Description: Constructor QDomDocument::QDomDocument()

This method creates an object of class QDomDocument.

Python specific notes:
This method is the default initializer of the object.

(2) Signature: [static] new QDomDocument new (string name)

Description: Constructor QDomDocument::QDomDocument(const QString &name)

This method creates an object of class QDomDocument.

Python specific notes:
This method is the default initializer of the object.

(3) Signature: [static] new QDomDocument new (const QDomDocumentType doctype)

Description: Constructor QDomDocument::QDomDocument(const QDomDocumentType &doctype)

This method creates an object of class QDomDocument.

Python specific notes:
This method is the default initializer of the object.

(4) Signature: [static] new QDomDocument new (const QDomDocument x)

Description: Constructor QDomDocument::QDomDocument(const QDomDocument &x)

This method creates an object of class QDomDocument.

Python specific notes:
This method is the default initializer of the object.

nodeType

Signature: [const] QDomNode_NodeType nodeType

Description: Method QDomNode::NodeType QDomDocument::nodeType()

setContent

(1) Signature: bool setContent (string text, bool namespaceProcessing, string ptr errorMsg = nullptr, int ptr errorLine = nullptr, int ptr errorColumn = nullptr)

Description: Method bool QDomDocument::setContent(const QString &text, bool namespaceProcessing, QString *errorMsg, int *errorLine, int *errorColumn)

(2) Signature: bool setContent (QIODevice ptr dev, bool namespaceProcessing, string ptr errorMsg = nullptr, int ptr errorLine = nullptr, int ptr errorColumn = nullptr)

Description: Method bool QDomDocument::setContent(QIODevice *dev, bool namespaceProcessing, QString *errorMsg, int *errorLine, int *errorColumn)

(3) Signature: bool setContent (QXmlInputSource ptr source, bool namespaceProcessing, string ptr errorMsg = nullptr, int ptr errorLine = nullptr, int ptr errorColumn = nullptr)

Description: Method bool QDomDocument::setContent(QXmlInputSource *source, bool namespaceProcessing, QString *errorMsg, int *errorLine, int *errorColumn)

(4) Signature: bool setContent (string text, string ptr errorMsg = nullptr, int ptr errorLine = nullptr, int ptr errorColumn = nullptr)

Description: Method bool QDomDocument::setContent(const QString &text, QString *errorMsg, int *errorLine, int *errorColumn)

(5) Signature: bool setContent (QIODevice ptr dev, string ptr errorMsg = nullptr, int ptr errorLine = nullptr, int ptr errorColumn = nullptr)

Description: Method bool QDomDocument::setContent(QIODevice *dev, QString *errorMsg, int *errorLine, int *errorColumn)

(6) Signature: bool setContent (QXmlInputSource ptr source, QXmlReader ptr reader, string ptr errorMsg = nullptr, int ptr errorLine = nullptr, int ptr errorColumn = nullptr)

Description: Method bool QDomDocument::setContent(QXmlInputSource *source, QXmlReader *reader, QString *errorMsg, int *errorLine, int *errorColumn)

toByteArray

Signature: [const] bytes toByteArray (int arg1 = 1)

Description: Method QByteArray QDomDocument::toByteArray(int)

toString

Signature: [const] string toString (int arg1 = 1)

Description: Method QString QDomDocument::toString(int)