API reference - Class QXmlSimpleReader

Notation used in Ruby API documentation

Module: QtXml

Description: Binding of QXmlSimpleReader

Class hierarchy: QXmlSimpleReader » QXmlReader

Public constructors

new QXmlSimpleReadernewConstructor QXmlSimpleReader::QXmlSimpleReader()

Public methods

[const]QXmlDTDHandler ptrDTDHandlerVirtual method QXmlDTDHandler *QXmlSimpleReader::DTDHandler()
void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
[const]QXmlContentHandler ptrcontentHandlerVirtual method QXmlContentHandler *QXmlSimpleReader::contentHandler()
voidcontentHandler=(QXmlContentHandler ptr handler)Method void QXmlSimpleReader::setContentHandler(QXmlContentHandler *handler)
[const]QXmlDeclHandler ptrdeclHandlerVirtual method QXmlDeclHandler *QXmlSimpleReader::declHandler()
voiddeclHandler=(QXmlDeclHandler ptr handler)Method void QXmlSimpleReader::setDeclHandler(QXmlDeclHandler *handler)
[const]QXmlEntityResolver ptrentityResolverVirtual method QXmlEntityResolver *QXmlSimpleReader::entityResolver()
voidentityResolver=(QXmlEntityResolver ptr handler)Method void QXmlSimpleReader::setEntityResolver(QXmlEntityResolver *handler)
[const]QXmlErrorHandler ptrerrorHandlerVirtual method QXmlErrorHandler *QXmlSimpleReader::errorHandler()
voiderrorHandler=(QXmlErrorHandler ptr handler)Method void QXmlSimpleReader::setErrorHandler(QXmlErrorHandler *handler)
[const]boolfeature(string name,
bool ptr ok)
Virtual method bool QXmlSimpleReader::feature(const QString &name, bool *ok)
[const]boolhasFeature(string name)Virtual method bool QXmlSimpleReader::hasFeature(const QString &name)
[const]boolhasProperty(string name)Virtual method bool QXmlSimpleReader::hasProperty(const QString &name)
[const]QXmlLexicalHandler ptrlexicalHandlerVirtual method QXmlLexicalHandler *QXmlSimpleReader::lexicalHandler()
voidlexicalHandler=(QXmlLexicalHandler ptr handler)Method void QXmlSimpleReader::setLexicalHandler(QXmlLexicalHandler *handler)
boolparse(const QXmlInputSource ptr input)Virtual method bool QXmlSimpleReader::parse(const QXmlInputSource *input)
boolparse(const QXmlInputSource ptr input,
bool incremental)
Virtual method bool QXmlSimpleReader::parse(const QXmlInputSource *input, bool incremental)
boolparseContinueVirtual method bool QXmlSimpleReader::parseContinue()
[const]void *property(string name,
bool ptr ok)
Virtual method void *QXmlSimpleReader::property(const QString &name, bool *ok)
voidsetContentHandler(QXmlContentHandler ptr handler)Virtual method void QXmlSimpleReader::setContentHandler(QXmlContentHandler *handler)
voidsetDTDHandler(QXmlDTDHandler ptr handler)Virtual method void QXmlSimpleReader::setDTDHandler(QXmlDTDHandler *handler)
voidsetDeclHandler(QXmlDeclHandler ptr handler)Virtual method void QXmlSimpleReader::setDeclHandler(QXmlDeclHandler *handler)
voidsetEntityResolver(QXmlEntityResolver ptr handler)Virtual method void QXmlSimpleReader::setEntityResolver(QXmlEntityResolver *handler)
voidsetErrorHandler(QXmlErrorHandler ptr handler)Virtual method void QXmlSimpleReader::setErrorHandler(QXmlErrorHandler *handler)
voidsetFeature(string name,
bool value)
Virtual method void QXmlSimpleReader::setFeature(const QString &name, bool value)
voidsetLexicalHandler(QXmlLexicalHandler ptr handler)Virtual method void QXmlSimpleReader::setLexicalHandler(QXmlLexicalHandler *handler)
voidsetProperty(string name,
void * value)
Virtual method void QXmlSimpleReader::setProperty(const QString &name, void *value)

Detailed description

DTDHandler

Signature: [const] QXmlDTDHandler ptr DTDHandler

Description: Virtual method QXmlDTDHandler *QXmlSimpleReader::DTDHandler()

This method can be reimplemented in a derived class.

_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: Virtual method QXmlContentHandler *QXmlSimpleReader::contentHandler()

This method can be reimplemented in a derived class.

contentHandler=

Signature: void contentHandler= (QXmlContentHandler ptr handler)

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

This is a reimplementation of QXmlReader::setContentHandler

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

declHandler

Signature: [const] QXmlDeclHandler ptr declHandler

Description: Virtual method QXmlDeclHandler *QXmlSimpleReader::declHandler()

This method can be reimplemented in a derived class.

declHandler=

Signature: void declHandler= (QXmlDeclHandler ptr handler)

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

This is a reimplementation of QXmlReader::setDeclHandler

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

entityResolver

Signature: [const] QXmlEntityResolver ptr entityResolver

Description: Virtual method QXmlEntityResolver *QXmlSimpleReader::entityResolver()

This method can be reimplemented in a derived class.

entityResolver=

Signature: void entityResolver= (QXmlEntityResolver ptr handler)

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

This is a reimplementation of QXmlReader::setEntityResolver

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

errorHandler

Signature: [const] QXmlErrorHandler ptr errorHandler

Description: Virtual method QXmlErrorHandler *QXmlSimpleReader::errorHandler()

This method can be reimplemented in a derived class.

errorHandler=

Signature: void errorHandler= (QXmlErrorHandler ptr handler)

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

This is a reimplementation of QXmlReader::setErrorHandler

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

feature

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

Description: Virtual method bool QXmlSimpleReader::feature(const QString &name, bool *ok)

This method can be reimplemented in a derived class.

hasFeature

Signature: [const] bool hasFeature (string name)

Description: Virtual method bool QXmlSimpleReader::hasFeature(const QString &name)

This method can be reimplemented in a derived class.

hasProperty

Signature: [const] bool hasProperty (string name)

Description: Virtual method bool QXmlSimpleReader::hasProperty(const QString &name)

This method can be reimplemented in a derived class.

lexicalHandler

Signature: [const] QXmlLexicalHandler ptr lexicalHandler

Description: Virtual method QXmlLexicalHandler *QXmlSimpleReader::lexicalHandler()

This method can be reimplemented in a derived class.

lexicalHandler=

Signature: void lexicalHandler= (QXmlLexicalHandler ptr handler)

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

This is a reimplementation of QXmlReader::setLexicalHandler

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

new

Signature: [static] new QXmlSimpleReader new

Description: Constructor QXmlSimpleReader::QXmlSimpleReader()

This method creates an object of class QXmlSimpleReader.

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

parse

(1) Signature: bool parse (const QXmlInputSource ptr input)

Description: Virtual method bool QXmlSimpleReader::parse(const QXmlInputSource *input)

This method can be reimplemented in a derived class.

(2) Signature: bool parse (const QXmlInputSource ptr input, bool incremental)

Description: Virtual method bool QXmlSimpleReader::parse(const QXmlInputSource *input, bool incremental)

This method can be reimplemented in a derived class.

parseContinue

Signature: bool parseContinue

Description: Virtual method bool QXmlSimpleReader::parseContinue()

This method can be reimplemented in a derived class.

property

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

Description: Virtual method void *QXmlSimpleReader::property(const QString &name, bool *ok)

This method can be reimplemented in a derived class.

setContentHandler

Signature: void setContentHandler (QXmlContentHandler ptr handler)

Description: Virtual method void QXmlSimpleReader::setContentHandler(QXmlContentHandler *handler)

This method can be reimplemented in a derived class.

setDTDHandler

Signature: void setDTDHandler (QXmlDTDHandler ptr handler)

Description: Virtual method void QXmlSimpleReader::setDTDHandler(QXmlDTDHandler *handler)

This method can be reimplemented in a derived class.

setDeclHandler

Signature: void setDeclHandler (QXmlDeclHandler ptr handler)

Description: Virtual method void QXmlSimpleReader::setDeclHandler(QXmlDeclHandler *handler)

This method can be reimplemented in a derived class.

setEntityResolver

Signature: void setEntityResolver (QXmlEntityResolver ptr handler)

Description: Virtual method void QXmlSimpleReader::setEntityResolver(QXmlEntityResolver *handler)

This method can be reimplemented in a derived class.

setErrorHandler

Signature: void setErrorHandler (QXmlErrorHandler ptr handler)

Description: Virtual method void QXmlSimpleReader::setErrorHandler(QXmlErrorHandler *handler)

This method can be reimplemented in a derived class.

setFeature

Signature: void setFeature (string name, bool value)

Description: Virtual method void QXmlSimpleReader::setFeature(const QString &name, bool value)

This method can be reimplemented in a derived class.

setLexicalHandler

Signature: void setLexicalHandler (QXmlLexicalHandler ptr handler)

Description: Virtual method void QXmlSimpleReader::setLexicalHandler(QXmlLexicalHandler *handler)

This method can be reimplemented in a derived class.

setProperty

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

Description: Virtual method void QXmlSimpleReader::setProperty(const QString &name, void *value)

This method can be reimplemented in a derived class.