API reference - Class QXmlQuery

XPath20

Signature: [static,const] QXmlQuery_QueryLanguage XPath20

Description: Enum constant QXmlQuery::XPath20

Python specific notes:
The object exposes a readable attribute 'XPath20'. This is the getter.

XQuery10

Signature: [static,const] QXmlQuery_QueryLanguage XQuery10

Description: Enum constant QXmlQuery::XQuery10

Python specific notes:
The object exposes a readable attribute 'XQuery10'. This is the getter.

XSLT20

Signature: [static,const] QXmlQuery_QueryLanguage XSLT20

Description: Enum constant QXmlQuery::XSLT20

Python specific notes:
The object exposes a readable attribute 'XSLT20'. This is the getter.

XmlSchema11IdentityConstraintField

Signature: [static,const] QXmlQuery_QueryLanguage XmlSchema11IdentityConstraintField

Description: Enum constant QXmlQuery::XmlSchema11IdentityConstraintField

Python specific notes:
The object exposes a readable attribute 'XmlSchema11IdentityConstraintField'. This is the getter.

XmlSchema11IdentityConstraintSelector

Signature: [static,const] QXmlQuery_QueryLanguage XmlSchema11IdentityConstraintSelector

Description: Enum constant QXmlQuery::XmlSchema11IdentityConstraintSelector

Python specific notes:
The object exposes a readable attribute 'XmlSchema11IdentityConstraintSelector'. This is the getter.

_assign

Signature: void _assign (const QXmlQuery other)

Description: Assigns another object to self

_const_cast

Signature: [const] QXmlQuery 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: QXmlQuery assign (const QXmlQuery other)

Description: Method QXmlQuery &QXmlQuery::operator=(const QXmlQuery &other)

bindVariable

(1) Signature: void bindVariable (const QXmlName name, const QXmlItem value)

Description: Method void QXmlQuery::bindVariable(const QXmlName &name, const QXmlItem &value)

(2) Signature: void bindVariable (string localName, const QXmlItem value)

Description: Method void QXmlQuery::bindVariable(const QString &localName, const QXmlItem &value)

(3) Signature: void bindVariable (const QXmlName name, QIODevice ptr arg2)

Description: Method void QXmlQuery::bindVariable(const QXmlName &name, QIODevice *)

(4) Signature: void bindVariable (string localName, QIODevice ptr arg2)

Description: Method void QXmlQuery::bindVariable(const QString &localName, QIODevice *)

(5) Signature: void bindVariable (const QXmlName name, const QXmlQuery query)

Description: Method void QXmlQuery::bindVariable(const QXmlName &name, const QXmlQuery &query)

(6) Signature: void bindVariable (string localName, const QXmlQuery query)

Description: Method void QXmlQuery::bindVariable(const QString &localName, const QXmlQuery &query)

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.

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.

dup

Signature: [const] new QXmlQuery ptr dup

Description: Creates a copy of self

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

evaluateTo

(1) Signature: [const] void evaluateTo (QXmlResultItems ptr result)

Description: Method void QXmlQuery::evaluateTo(QXmlResultItems *result)

(2) Signature: [const] bool evaluateTo (QAbstractXmlReceiver ptr callback)

Description: Method bool QXmlQuery::evaluateTo(QAbstractXmlReceiver *callback)

(3) Signature: [const] bool evaluateTo (string[] ptr target)

Description: Method bool QXmlQuery::evaluateTo(QStringList *target)

(4) Signature: [const] bool evaluateTo (QIODevice ptr target)

Description: Method bool QXmlQuery::evaluateTo(QIODevice *target)

(5) Signature: [const] bool evaluateTo (string ptr output)

Description: Method bool QXmlQuery::evaluateTo(QString *output)

initialTemplateName

Signature: [const] QXmlName initialTemplateName

Description: Method QXmlName QXmlQuery::initialTemplateName()

Python specific notes:
The object exposes a readable attribute 'initialTemplateName'. This is the getter.

initialTemplateName=

(1) Signature: void initialTemplateName= (const QXmlName name)

Description: Method void QXmlQuery::setInitialTemplateName(const QXmlName &name)

Python specific notes:
The object exposes a writable attribute 'initialTemplateName'. This is the setter.

(2) Signature: void initialTemplateName= (string name)

Description: Method void QXmlQuery::setInitialTemplateName(const QString &name)

Python specific notes:
The object exposes a writable attribute 'initialTemplateName'. This is the setter.

isValid?

Signature: [const] bool isValid?

Description: Method bool QXmlQuery::isValid()

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.

messageHandler

Signature: [const] QAbstractMessageHandler ptr messageHandler

Description: Method QAbstractMessageHandler *QXmlQuery::messageHandler()

Python specific notes:
The object exposes a readable attribute 'messageHandler'. This is the getter.

messageHandler=

Signature: void messageHandler= (QAbstractMessageHandler ptr messageHandler)

Description: Method void QXmlQuery::setMessageHandler(QAbstractMessageHandler *messageHandler)

Python specific notes:
The object exposes a writable attribute 'messageHandler'. This is the setter.

namePool

Signature: [const] QXmlNamePool namePool

Description: Method QXmlNamePool QXmlQuery::namePool()

networkAccessManager

Signature: [const] QNetworkAccessManager ptr networkAccessManager

Description: Method QNetworkAccessManager *QXmlQuery::networkAccessManager()

Python specific notes:
The object exposes a readable attribute 'networkAccessManager'. This is the getter.

networkAccessManager=

Signature: void networkAccessManager= (QNetworkAccessManager ptr newManager)

Description: Method void QXmlQuery::setNetworkAccessManager(QNetworkAccessManager *newManager)

Python specific notes:
The object exposes a writable attribute 'networkAccessManager'. This is the setter.

new

(1) Signature: [static] new QXmlQuery new

Description: Constructor QXmlQuery::QXmlQuery()

This method creates an object of class QXmlQuery.

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

(2) Signature: [static] new QXmlQuery new (const QXmlQuery other)

Description: Constructor QXmlQuery::QXmlQuery(const QXmlQuery &other)

This method creates an object of class QXmlQuery.

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

(3) Signature: [static] new QXmlQuery new (const QXmlNamePool np)

Description: Constructor QXmlQuery::QXmlQuery(const QXmlNamePool &np)

This method creates an object of class QXmlQuery.

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

(4) Signature: [static] new QXmlQuery new (const QXmlQuery_QueryLanguage queryLanguage, const QXmlNamePool np = QXmlNamePool())

Description: Constructor QXmlQuery::QXmlQuery(QXmlQuery::QueryLanguage queryLanguage, const QXmlNamePool &np)

This method creates an object of class QXmlQuery.

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

queryLanguage

Signature: [const] QXmlQuery_QueryLanguage queryLanguage

Description: Method QXmlQuery::QueryLanguage QXmlQuery::queryLanguage()

setFocus

(1) Signature: void setFocus (const QXmlItem item)

Description: Method void QXmlQuery::setFocus(const QXmlItem &item)

(2) Signature: bool setFocus (const QUrl documentURI)

Description: Method bool QXmlQuery::setFocus(const QUrl &documentURI)

(3) Signature: bool setFocus (QIODevice ptr document)

Description: Method bool QXmlQuery::setFocus(QIODevice *document)

(4) Signature: bool setFocus (string focus)

Description: Method bool QXmlQuery::setFocus(const QString &focus)

setInitialTemplateName

(1) Signature: void setInitialTemplateName (const QXmlName name)

Description: Method void QXmlQuery::setInitialTemplateName(const QXmlName &name)

Python specific notes:
The object exposes a writable attribute 'initialTemplateName'. This is the setter.

(2) Signature: void setInitialTemplateName (string name)

Description: Method void QXmlQuery::setInitialTemplateName(const QString &name)

Python specific notes:
The object exposes a writable attribute 'initialTemplateName'. This is the setter.

setMessageHandler

Signature: void setMessageHandler (QAbstractMessageHandler ptr messageHandler)

Description: Method void QXmlQuery::setMessageHandler(QAbstractMessageHandler *messageHandler)

Python specific notes:
The object exposes a writable attribute 'messageHandler'. This is the setter.

setNetworkAccessManager

Signature: void setNetworkAccessManager (QNetworkAccessManager ptr newManager)

Description: Method void QXmlQuery::setNetworkAccessManager(QNetworkAccessManager *newManager)

Python specific notes:
The object exposes a writable attribute 'networkAccessManager'. This is the setter.

setQuery

(1) Signature: void setQuery (string sourceCode, const QUrl documentURI = QUrl())

Description: Method void QXmlQuery::setQuery(const QString &sourceCode, const QUrl &documentURI)

(2) Signature: void setQuery (QIODevice ptr sourceCode, const QUrl documentURI = QUrl())

Description: Method void QXmlQuery::setQuery(QIODevice *sourceCode, const QUrl &documentURI)

(3) Signature: void setQuery (const QUrl queryURI, const QUrl baseURI = QUrl())

Description: Method void QXmlQuery::setQuery(const QUrl &queryURI, const QUrl &baseURI)

setUriResolver

Signature: void setUriResolver (const QAbstractUriResolver ptr resolver)

Description: Method void QXmlQuery::setUriResolver(const QAbstractUriResolver *resolver)

Python specific notes:
The object exposes a writable attribute 'uriResolver'. This is the setter.

uriResolver

Signature: [const] const QAbstractUriResolver ptr uriResolver

Description: Method const QAbstractUriResolver *QXmlQuery::uriResolver()

Python specific notes:
The object exposes a readable attribute 'uriResolver'. This is the getter.

uriResolver=

Signature: void uriResolver= (const QAbstractUriResolver ptr resolver)

Description: Method void QXmlQuery::setUriResolver(const QAbstractUriResolver *resolver)

Python specific notes:
The object exposes a writable attribute 'uriResolver'. This is the setter.