API reference - Class QXmlStreamReader

Characters

Signature: [static,const] QXmlStreamReader_TokenType Characters

Description: Enum constant QXmlStreamReader::Characters

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

Comment

Signature: [static,const] QXmlStreamReader_TokenType Comment

Description: Enum constant QXmlStreamReader::Comment

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

CustomError

Signature: [static,const] QXmlStreamReader_Error CustomError

Description: Enum constant QXmlStreamReader::CustomError

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

DTD

Signature: [static,const] QXmlStreamReader_TokenType DTD

Description: Enum constant QXmlStreamReader::DTD

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

EndDocument

Signature: [static,const] QXmlStreamReader_TokenType EndDocument

Description: Enum constant QXmlStreamReader::EndDocument

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

EndElement

Signature: [static,const] QXmlStreamReader_TokenType EndElement

Description: Enum constant QXmlStreamReader::EndElement

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

EntityReference

Signature: [static,const] QXmlStreamReader_TokenType EntityReference

Description: Enum constant QXmlStreamReader::EntityReference

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

ErrorOnUnexpectedElement

Signature: [static,const] QXmlStreamReader_ReadElementTextBehaviour ErrorOnUnexpectedElement

Description: Enum constant QXmlStreamReader::ErrorOnUnexpectedElement

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

IncludeChildElements

Signature: [static,const] QXmlStreamReader_ReadElementTextBehaviour IncludeChildElements

Description: Enum constant QXmlStreamReader::IncludeChildElements

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

Invalid

Signature: [static,const] QXmlStreamReader_TokenType Invalid

Description: Enum constant QXmlStreamReader::Invalid

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

NoError

Signature: [static,const] QXmlStreamReader_Error NoError

Description: Enum constant QXmlStreamReader::NoError

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

NoToken

Signature: [static,const] QXmlStreamReader_TokenType NoToken

Description: Enum constant QXmlStreamReader::NoToken

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

NotWellFormedError

Signature: [static,const] QXmlStreamReader_Error NotWellFormedError

Description: Enum constant QXmlStreamReader::NotWellFormedError

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

PrematureEndOfDocumentError

Signature: [static,const] QXmlStreamReader_Error PrematureEndOfDocumentError

Description: Enum constant QXmlStreamReader::PrematureEndOfDocumentError

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

ProcessingInstruction

Signature: [static,const] QXmlStreamReader_TokenType ProcessingInstruction

Description: Enum constant QXmlStreamReader::ProcessingInstruction

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

SkipChildElements

Signature: [static,const] QXmlStreamReader_ReadElementTextBehaviour SkipChildElements

Description: Enum constant QXmlStreamReader::SkipChildElements

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

StartDocument

Signature: [static,const] QXmlStreamReader_TokenType StartDocument

Description: Enum constant QXmlStreamReader::StartDocument

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

StartElement

Signature: [static,const] QXmlStreamReader_TokenType StartElement

Description: Enum constant QXmlStreamReader::StartElement

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

UnexpectedElementError

Signature: [static,const] QXmlStreamReader_Error UnexpectedElementError

Description: Enum constant QXmlStreamReader::UnexpectedElementError

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

_const_cast

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

addData

(1) Signature: void addData (bytes data)

Description: Method void QXmlStreamReader::addData(const QByteArray &data)

(2) Signature: void addData (string data)

Description: Method void QXmlStreamReader::addData(const QString &data)

addExtraNamespaceDeclaration

Signature: void addExtraNamespaceDeclaration (const QXmlStreamNamespaceDeclaration extraNamespaceDeclaraction)

Description: Method void QXmlStreamReader::addExtraNamespaceDeclaration(const QXmlStreamNamespaceDeclaration &extraNamespaceDeclaraction)

addExtraNamespaceDeclarations

Signature: void addExtraNamespaceDeclarations (QXmlStreamNamespaceDeclaration[] extraNamespaceDeclaractions)

Description: Method void QXmlStreamReader::addExtraNamespaceDeclarations(const QVector<QXmlStreamNamespaceDeclaration> &extraNamespaceDeclaractions)

atEnd

Signature: [const] bool atEnd

Description: Method bool QXmlStreamReader::atEnd()

attributes

Signature: [const] QXmlStreamAttributes attributes

Description: Method QXmlStreamAttributes QXmlStreamReader::attributes()

characterOffset

Signature: [const] long long characterOffset

Description: Method qint64 QXmlStreamReader::characterOffset()

clear

Signature: void clear

Description: Method void QXmlStreamReader::clear()

columnNumber

Signature: [const] long long columnNumber

Description: Method qint64 QXmlStreamReader::columnNumber()

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.

device

Signature: [const] QIODevice ptr device

Description: Method QIODevice *QXmlStreamReader::device()

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

device=

Signature: void device= (QIODevice ptr device)

Description: Method void QXmlStreamReader::setDevice(QIODevice *device)

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

documentEncoding

Signature: [const] string documentEncoding

Description: Method QStringRef QXmlStreamReader::documentEncoding()

documentVersion

Signature: [const] string documentVersion

Description: Method QStringRef QXmlStreamReader::documentVersion()

dtdName

Signature: [const] string dtdName

Description: Method QStringRef QXmlStreamReader::dtdName()

dtdPublicId

Signature: [const] string dtdPublicId

Description: Method QStringRef QXmlStreamReader::dtdPublicId()

dtdSystemId

Signature: [const] string dtdSystemId

Description: Method QStringRef QXmlStreamReader::dtdSystemId()

entityDeclarations

Signature: [const] QXmlStreamEntityDeclaration[] entityDeclarations

Description: Method QVector<QXmlStreamEntityDeclaration> QXmlStreamReader::entityDeclarations()

entityResolver

Signature: [const] QXmlStreamEntityResolver ptr entityResolver

Description: Method QXmlStreamEntityResolver *QXmlStreamReader::entityResolver()

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

entityResolver=

Signature: void entityResolver= (QXmlStreamEntityResolver ptr resolver)

Description: Method void QXmlStreamReader::setEntityResolver(QXmlStreamEntityResolver *resolver)

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

error

Signature: [const] QXmlStreamReader_Error error

Description: Method QXmlStreamReader::Error QXmlStreamReader::error()

errorString

Signature: [const] string errorString

Description: Method QString QXmlStreamReader::errorString()

hasError

Signature: [const] bool hasError

Description: Method bool QXmlStreamReader::hasError()

isCDATA?

Signature: [const] bool isCDATA?

Description: Method bool QXmlStreamReader::isCDATA()

isCharacters?

Signature: [const] bool isCharacters?

Description: Method bool QXmlStreamReader::isCharacters()

isComment?

Signature: [const] bool isComment?

Description: Method bool QXmlStreamReader::isComment()

isDTD?

Signature: [const] bool isDTD?

Description: Method bool QXmlStreamReader::isDTD()

isEndDocument?

Signature: [const] bool isEndDocument?

Description: Method bool QXmlStreamReader::isEndDocument()

isEndElement?

Signature: [const] bool isEndElement?

Description: Method bool QXmlStreamReader::isEndElement()

isEntityReference?

Signature: [const] bool isEntityReference?

Description: Method bool QXmlStreamReader::isEntityReference()

isProcessingInstruction?

Signature: [const] bool isProcessingInstruction?

Description: Method bool QXmlStreamReader::isProcessingInstruction()

isStandaloneDocument?

Signature: [const] bool isStandaloneDocument?

Description: Method bool QXmlStreamReader::isStandaloneDocument()

isStartDocument?

Signature: [const] bool isStartDocument?

Description: Method bool QXmlStreamReader::isStartDocument()

isStartElement?

Signature: [const] bool isStartElement?

Description: Method bool QXmlStreamReader::isStartElement()

isWhitespace?

Signature: [const] bool isWhitespace?

Description: Method bool QXmlStreamReader::isWhitespace()

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.

lineNumber

Signature: [const] long long lineNumber

Description: Method qint64 QXmlStreamReader::lineNumber()

name

Signature: [const] string name

Description: Method QStringRef QXmlStreamReader::name()

namespaceDeclarations

Signature: [const] QXmlStreamNamespaceDeclaration[] namespaceDeclarations

Description: Method QVector<QXmlStreamNamespaceDeclaration> QXmlStreamReader::namespaceDeclarations()

namespaceProcessing

Signature: [const] bool namespaceProcessing

Description: Method bool QXmlStreamReader::namespaceProcessing()

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

namespaceProcessing=

Signature: void namespaceProcessing= (bool arg1)

Description: Method void QXmlStreamReader::setNamespaceProcessing(bool)

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

namespaceUri

Signature: [const] string namespaceUri

Description: Method QStringRef QXmlStreamReader::namespaceUri()

new

(1) Signature: [static] new QXmlStreamReader new

Description: Constructor QXmlStreamReader::QXmlStreamReader()

This method creates an object of class QXmlStreamReader.

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

(2) Signature: [static] new QXmlStreamReader new (QIODevice ptr device)

Description: Constructor QXmlStreamReader::QXmlStreamReader(QIODevice *device)

This method creates an object of class QXmlStreamReader.

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

(3) Signature: [static] new QXmlStreamReader new (bytes data)

Description: Constructor QXmlStreamReader::QXmlStreamReader(const QByteArray &data)

This method creates an object of class QXmlStreamReader.

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

(4) Signature: [static] new QXmlStreamReader new (string data)

Description: Constructor QXmlStreamReader::QXmlStreamReader(const QString &data)

This method creates an object of class QXmlStreamReader.

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

notationDeclarations

Signature: [const] QXmlStreamNotationDeclaration[] notationDeclarations

Description: Method QVector<QXmlStreamNotationDeclaration> QXmlStreamReader::notationDeclarations()

prefix

Signature: [const] string prefix

Description: Method QStringRef QXmlStreamReader::prefix()

processingInstructionData

Signature: [const] string processingInstructionData

Description: Method QStringRef QXmlStreamReader::processingInstructionData()

processingInstructionTarget

Signature: [const] string processingInstructionTarget

Description: Method QStringRef QXmlStreamReader::processingInstructionTarget()

qualifiedName

Signature: [const] string qualifiedName

Description: Method QStringRef QXmlStreamReader::qualifiedName()

raiseError

Signature: void raiseError (string message = QString())

Description: Method void QXmlStreamReader::raiseError(const QString &message)

readElementText

Signature: string readElementText (const QXmlStreamReader_ReadElementTextBehaviour behaviour = QXmlStreamReader::ErrorOnUnexpectedElement)

Description: Method QString QXmlStreamReader::readElementText(QXmlStreamReader::ReadElementTextBehaviour behaviour)

readNext

Signature: QXmlStreamReader_TokenType readNext

Description: Method QXmlStreamReader::TokenType QXmlStreamReader::readNext()

readNextStartElement

Signature: bool readNextStartElement

Description: Method bool QXmlStreamReader::readNextStartElement()

setDevice

Signature: void setDevice (QIODevice ptr device)

Description: Method void QXmlStreamReader::setDevice(QIODevice *device)

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

setEntityResolver

Signature: void setEntityResolver (QXmlStreamEntityResolver ptr resolver)

Description: Method void QXmlStreamReader::setEntityResolver(QXmlStreamEntityResolver *resolver)

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

setNamespaceProcessing

Signature: void setNamespaceProcessing (bool arg1)

Description: Method void QXmlStreamReader::setNamespaceProcessing(bool)

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

skipCurrentElement

Signature: void skipCurrentElement

Description: Method void QXmlStreamReader::skipCurrentElement()

text

Signature: [const] string text

Description: Method QStringRef QXmlStreamReader::text()

tokenString

Signature: [const] string tokenString

Description: Method QString QXmlStreamReader::tokenString()

tokenType

Signature: [const] QXmlStreamReader_TokenType tokenType

Description: Method QXmlStreamReader::TokenType QXmlStreamReader::tokenType()