API reference - Class QXmlReader

DTDHandler

Signature: [const] QXmlDTDHandler ptr DTDHandler

Description: Method QXmlDTDHandler *QXmlReader::DTDHandler()

_const_cast

Signature: [const] QXmlReader 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.

contentHandler

Signature: [const] QXmlContentHandler ptr contentHandler

Description: Method QXmlContentHandler *QXmlReader::contentHandler()

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

contentHandler=

Signature: void contentHandler= (QXmlContentHandler ptr handler)

Description: Method void QXmlReader::setContentHandler(QXmlContentHandler *handler)

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

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.

declHandler

Signature: [const] QXmlDeclHandler ptr declHandler

Description: Method QXmlDeclHandler *QXmlReader::declHandler()

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

declHandler=

Signature: void declHandler= (QXmlDeclHandler ptr handler)

Description: Method void QXmlReader::setDeclHandler(QXmlDeclHandler *handler)

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

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.

entityResolver

Signature: [const] QXmlEntityResolver ptr entityResolver

Description: Method QXmlEntityResolver *QXmlReader::entityResolver()

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

entityResolver=

Signature: void entityResolver= (QXmlEntityResolver ptr handler)

Description: Method void QXmlReader::setEntityResolver(QXmlEntityResolver *handler)

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

errorHandler

Signature: [const] QXmlErrorHandler ptr errorHandler

Description: Method QXmlErrorHandler *QXmlReader::errorHandler()

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

errorHandler=

Signature: void errorHandler= (QXmlErrorHandler ptr handler)

Description: Method void QXmlReader::setErrorHandler(QXmlErrorHandler *handler)

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

feature

Signature: [const] bool feature (string name, bool ptr ok = nullptr)

Description: Method bool QXmlReader::feature(const QString &name, bool *ok)

hasFeature

Signature: [const] bool hasFeature (string name)

Description: Method bool QXmlReader::hasFeature(const QString &name)

hasProperty

Signature: [const] bool hasProperty (string name)

Description: Method bool QXmlReader::hasProperty(const QString &name)

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.

lexicalHandler

Signature: [const] QXmlLexicalHandler ptr lexicalHandler

Description: Method QXmlLexicalHandler *QXmlReader::lexicalHandler()

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

lexicalHandler=

Signature: void lexicalHandler= (QXmlLexicalHandler ptr handler)

Description: Method void QXmlReader::setLexicalHandler(QXmlLexicalHandler *handler)

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

new

Signature: [static] new QXmlReader ptr new

Description: Creates a new object of this class

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

parse

Signature: bool parse (const QXmlInputSource ptr input)

Description: Method bool QXmlReader::parse(const QXmlInputSource *input)

property

Signature: [const] void * property (string name, bool ptr ok = nullptr)

Description: Method void *QXmlReader::property(const QString &name, bool *ok)

setContentHandler

Signature: void setContentHandler (QXmlContentHandler ptr handler)

Description: Method void QXmlReader::setContentHandler(QXmlContentHandler *handler)

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

setDTDHandler

Signature: void setDTDHandler (QXmlDTDHandler ptr handler)

Description: Method void QXmlReader::setDTDHandler(QXmlDTDHandler *handler)

setDeclHandler

Signature: void setDeclHandler (QXmlDeclHandler ptr handler)

Description: Method void QXmlReader::setDeclHandler(QXmlDeclHandler *handler)

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

setEntityResolver

Signature: void setEntityResolver (QXmlEntityResolver ptr handler)

Description: Method void QXmlReader::setEntityResolver(QXmlEntityResolver *handler)

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

setErrorHandler

Signature: void setErrorHandler (QXmlErrorHandler ptr handler)

Description: Method void QXmlReader::setErrorHandler(QXmlErrorHandler *handler)

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

setFeature

Signature: void setFeature (string name, bool value)

Description: Method void QXmlReader::setFeature(const QString &name, bool value)

setLexicalHandler

Signature: void setLexicalHandler (QXmlLexicalHandler ptr handler)

Description: Method void QXmlReader::setLexicalHandler(QXmlLexicalHandler *handler)

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

setProperty

Signature: void setProperty (string name, void * value)

Description: Method void QXmlReader::setProperty(const QString &name, void *value)